org.adroitlogic.x.metrics

Class NoMetricsEngine

java.lang.Object

org.adroitlogic.x.metrics.NoMetricsEngine

All Implemented Interfaces:

Initializable, XMetricsEngine

public class NoMetricsEngine
extends Object
implements XMetricsEngine

This is a dummy metrics engine implementation which neither stores nor publishes the reported metrics. This should be used only in case of the absence of a real metrics engine implementation to avoid probable NPEs.

Since:

17.01

Author:

Udith Gunaratna

Constructor Summary

Constructors

Constructor and Description
NoMetricsEngine()

Method Summary

Modifier and Type	Method and Description
MetricsStream	computeStream(String stream, MetricsStreamNames.MetricsRecordType recordType, String templateType, MetricsStreamNames.StreamCreationType creationType, String entityID, String projectName, String projectVersion, String flowID, Map<String,String> additionalProps) Computes metrics collecting stream for the given stream name
void	computeStreams(MetricsReportable reportingEntity) Computes all the metrics streams of the given metrics reporting entity.
void	decrement(int stream) Decrements the metrics for the given MetricsStreamNames.MetricsRecordType.COUNTER type metrics stream, mainly used by scenarios where a in-flight count is maintained as the metrics value, for example like the active processing message count
void	decrementCounterMap(int stream, String key) Decrements the metrics stream for the given key of the MetricsStreamNames.MetricsRecordType.COUNTER_MAP type map of metrics streams
void	destroy() Cleans out the resources used by the metrics engine and destroys the engine
XMetricsCollector	getMetricsCollector() Retrieves the XMetricsCollector associated with this metrics engine
void	increment(int stream) Increments the metrics for the given MetricsStreamNames.MetricsRecordType.COUNTER type metrics stream
void	incrementCounterMap(int stream, String key) Increments the metrics stream for the given key of the MetricsStreamNames.MetricsRecordType.COUNTER_MAP type map of metrics streams
void	init(org.springframework.context.ApplicationContext context) Initializes the metrics engine
boolean	isRealMetricsEngine() Checks whether this metrics engine is a real implementation
void	reportGauge(int stream, double value) Reports a value into the given MetricsStreamNames.MetricsRecordType.AVG_GAUGE or MetricsStreamNames.MetricsRecordType.SUM_GAUGE type metrics stream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NoMetricsEngine

public NoMetricsEngine()

Method Detail

init

public void init(org.springframework.context.ApplicationContext context)

Initializes the metrics engine

Specified by:

init in interface Initializable

Specified by:

init in interface XMetricsEngine

Parameters:

context - application context

destroy

public void destroy()

Cleans out the resources used by the metrics engine and destroys the engine

Specified by:

destroy in interface Initializable

Specified by:

destroy in interface XMetricsEngine

reportGauge

public void reportGauge(int stream,
                        double value)

Reports a value into the given MetricsStreamNames.MetricsRecordType.AVG_GAUGE or MetricsStreamNames.MetricsRecordType.SUM_GAUGE type metrics stream

Specified by:

reportGauge in interface XMetricsEngine

Parameters:

stream - the stream to which the metrics are reported

value - the value to be reported

increment

public void increment(int stream)

Increments the metrics for the given MetricsStreamNames.MetricsRecordType.COUNTER type metrics stream

Specified by:

increment in interface XMetricsEngine

Parameters:

stream - the metrics stream which is being incremented

decrement

public void decrement(int stream)

Decrements the metrics for the given MetricsStreamNames.MetricsRecordType.COUNTER type metrics stream, mainly used by scenarios where a in-flight count is maintained as the metrics value, for example like the active processing message count

Specified by:

decrement in interface XMetricsEngine

Parameters:

stream - the stream being decremented

incrementCounterMap

public void incrementCounterMap(int stream,
                                String key)

Increments the metrics stream for the given key of the MetricsStreamNames.MetricsRecordType.COUNTER_MAP type map of metrics streams

Specified by:

incrementCounterMap in interface XMetricsEngine

Parameters:

stream - the map of metrics streams

key - the key of the metrics stream to be incremented

decrementCounterMap

public void decrementCounterMap(int stream,
                                String key)

Decrements the metrics stream for the given key of the MetricsStreamNames.MetricsRecordType.COUNTER_MAP type map of metrics streams

Specified by:

decrementCounterMap in interface XMetricsEngine

Parameters:

stream - the map of metrics streams

key - the key of the metrics stream to be decremented

computeStream

public MetricsStream computeStream(String stream,
                                   MetricsStreamNames.MetricsRecordType recordType,
                                   String templateType,
                                   MetricsStreamNames.StreamCreationType creationType,
                                   String entityID,
                                   String projectName,
                                   String projectVersion,
                                   String flowID,
                                   Map<String,String> additionalProps)

Computes metrics collecting stream for the given stream name

Specified by:

computeStream in interface XMetricsEngine

Parameters:

stream - the name of the stream

recordType - the record type of the stream

templateType - type of the metrics template which includes this stream

creationType - the type of the stream creation to indicate whether this is a normal stream or either global or system one

entityID - the id of the metrics entity which belongs this metrics stream

projectName - the name of the project to which the metrics entity of this metrics stream belongs

projectVersion - the version of the project to which the metrics entity of this metrics stream belongs

flowID - the ID of the integration flow to which the metrics entity of this metrics stream belongs

additionalProps - additional properties to be added to metrics record

Returns:

the metrics stream after handling in memory metrics collecting process related logic

computeStreams

public void computeStreams(MetricsReportable reportingEntity)

Description copied from interface: XMetricsEngine

Computes all the metrics streams of the given metrics reporting entity.

Specified by:

computeStreams in interface XMetricsEngine

Parameters:

reportingEntity - an implementation of MetricsReportable to compute the metrics streams for

getMetricsCollector

public XMetricsCollector getMetricsCollector()

Retrieves the XMetricsCollector associated with this metrics engine

Specified by:

getMetricsCollector in interface XMetricsEngine

Returns:

XMetricsCollector implementation if this is a real metrics engine, null otherwise

isRealMetricsEngine

public boolean isRealMetricsEngine()

Description copied from interface: XMetricsEngine

Checks whether this metrics engine is a real implementation

Specified by:

isRealMetricsEngine in interface XMetricsEngine

Returns:

true by real implementations, false by dummy metrics engine implementations