org.adroitlogic.x.metrics

Class ESMetricsCollector

java.lang.Object

org.adroitlogic.x.metrics.ESMetricsCollector

All Implemented Interfaces:

XMetricsCollector

public class ESMetricsCollector
extends Object
implements XMetricsCollector

Elasticsearch based metrics collector

Since:

17.01

Author:

manjula, Udith Gunaratna

Constructor Summary

Constructors

Constructor and Description
ESMetricsCollector(ESStatisticsPublisher esStatisticsPublisher)

Method Summary

Modifier and Type	Method and Description
void	addCompletedTemplate(MetricsTemplate metricsTemplate)
void	addToMetricsWindow(MetricsTemplate metricsTemplate) Add given primary and secondary MetricsTemplate objects to the metrics template map in the metrics engine
void	computeStream(MetricsStream metricsStream, MetricsStreamNames.MetricsRecordType type, String templateType, MetricsStreamNames.StreamCreationType streamCreationType, String entityId, String projectID, String projectVersion, String flowID, Map<String,String> additionalProps) Handles the stream creation logic related to elasticsearch metrics collecting process
void	decrement(String entityId, int stream) Decrements the given counter type stream of the entity with the given entityId
void	decrementCounterMap(String entityId, int stream, String key) Decrements the counter map record value for the given key of the entity which is given by the entityId and the stream which is given by the stream
void	destroy() Cleans out the resources used by the metrics engine and destroys the engine
void	generateRecords() Generates statistic records which are collected by the metrics engine.
int	getMetricsReportGenerationTimePeriod()
int	getMetricsTemplateSyncTimePeriod()
String	getNodeName()
long	getPrimaryTemplateLifeTime()
void	increment(String entityId, int stream) Increments the given counter type stream of the entity with the given entityId
void	incrementCounterMap(String entityId, int stream, String key) Increments the counter map record value for the given key of the entity which is given by the entityId and the stream which is given by the streamId
void	init(String nodeName, String confDir) Initializes the metrics collector by creating the default metrics templates such as SystemMetrics
void	reportGauge(String entityId, int stream, double gaugeValue) Increments the gauge counter of the entity which is given by the entityId and the stream which is given
void	setCustomFields(Map<String,String> customFields)
void	setMetricsReportGenerationTimePeriod(int metricsReportGenerationTimePeriod)
void	setMetricsTemplateSyncTimePeriod(int metricsTemplateSyncTimePeriod)
void	setPrimaryMetricsTemplateValidTime(int primaryMetricsTemplateValidTime)
void	setStatisticsPublisher(XStatisticsPublisher statisticsPublisher)
void	shiftMetricsWindow() Syncs primary MetricsTemplate and secondary MetricsTemplate based on the expire time of the primary metrics template of each entity type.
void	submitTask(Runnable task)

Methods inherited from class java.lang.Object

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

Constructor Detail

ESMetricsCollector

public ESMetricsCollector(ESStatisticsPublisher esStatisticsPublisher)

Method Detail

init

public void init(String nodeName,
                 String confDir)

Initializes the metrics collector by creating the default metrics templates such as SystemMetrics

Specified by:

init in interface XMetricsCollector

Parameters:

nodeName - the name of the node to be used for the initialization

confDir - the configuration directory path of the server

addToMetricsWindow

public void addToMetricsWindow(MetricsTemplate metricsTemplate)

Add given primary and secondary MetricsTemplate objects to the metrics template map in the metrics engine

Specified by:

addToMetricsWindow in interface XMetricsCollector

Parameters:

metricsTemplate - the metrics template object to add to the metrics window

destroy

public void destroy()

Description copied from interface: XMetricsCollector

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

Specified by:

destroy in interface XMetricsCollector

increment

public void increment(String entityId,
                      int stream)

Increments the given counter type stream of the entity with the given entityId

Specified by:

increment in interface XMetricsCollector

Parameters:

entityId - the id of the metrics entity to identity the metrics template to increment the counter value

stream - the name of the stream to identify the counter in the above metrics entity

decrement

public void decrement(String entityId,
                      int stream)

Decrements the given counter type stream of the entity with the given entityId

Specified by:

decrement in interface XMetricsCollector

Parameters:

entityId - the id of the metrics entity to identity the metrics template to decrement the counter value

stream - the name of the stream to identify the counter in the above metrics entity

reportGauge

public void reportGauge(String entityId,
                        int stream,
                        double gaugeValue)

Increments the gauge counter of the entity which is given by the entityId and the stream which is given

Specified by:

reportGauge in interface XMetricsCollector

Parameters:

entityId - the id of the metrics entity to identity the metrics template to do the decrement of the gauge record

stream - the name of the stream to identify the counter in the above metrics entity

gaugeValue - the value to be added to gauge

incrementCounterMap

public void incrementCounterMap(String entityId,
                                int stream,
                                String key)

Increments the counter map record value for the given key of the entity which is given by the entityId and the stream which is given by the streamId

Specified by:

incrementCounterMap in interface XMetricsCollector

Parameters:

entityId - the id of the metrics entity to identity the metrics template to do the increment of the map counter value

stream - the name of the stream to identify the map counter in the above metrics entity

key - the key of the map entry to be incremented

decrementCounterMap

public void decrementCounterMap(String entityId,
                                int stream,
                                String key)

Decrements the counter map record value for the given key of the entity which is given by the entityId and the stream which is given by the stream

Specified by:

decrementCounterMap in interface XMetricsCollector

Parameters:

entityId - the id of the metrics entity to identity the metrics template to do the decrement of the map counter record

stream - the name of the stream to identify the map counter in the above metrics entity

key - the key of the map entry to be decremented

generateRecords

public void generateRecords()

Generates statistic records which are collected by the metrics engine. This is triggered periodically by a timer task and generates the records for the collected statistics

Specified by:

generateRecords in interface XMetricsCollector

shiftMetricsWindow

public void shiftMetricsWindow()

Syncs primary MetricsTemplate and secondary MetricsTemplate based on the expire time of the primary metrics template of each entity type. If the current primary metrics template is expired this will swap primary and secondary metrics templates for this entity type

Specified by:

shiftMetricsWindow in interface XMetricsCollector

computeStream

public void computeStream(MetricsStream metricsStream,
                          MetricsStreamNames.MetricsRecordType type,
                          String templateType,
                          MetricsStreamNames.StreamCreationType streamCreationType,
                          String entityId,
                          String projectID,
                          String projectVersion,
                          String flowID,
                          Map<String,String> additionalProps)

Handles the stream creation logic related to elasticsearch metrics collecting process

Specified by:

computeStream in interface XMetricsCollector

Parameters:

metricsStream - the metrics stream created for the given metrics stream name

type - the type of the metrics record

templateType - the type of the metrics template which belongs this metrics stream

streamCreationType - the type of the stream creation to indicate whether this is a normal metrics stream or a system stream or a global stream

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

projectID - 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

addCompletedTemplate

public void addCompletedTemplate(MetricsTemplate metricsTemplate)

Specified by:

addCompletedTemplate in interface XMetricsCollector

submitTask

public void submitTask(Runnable task)

Specified by:

submitTask in interface XMetricsCollector

getPrimaryTemplateLifeTime

public long getPrimaryTemplateLifeTime()

Specified by:

getPrimaryTemplateLifeTime in interface XMetricsCollector

getMetricsReportGenerationTimePeriod

public int getMetricsReportGenerationTimePeriod()

Specified by:

getMetricsReportGenerationTimePeriod in interface XMetricsCollector

getMetricsTemplateSyncTimePeriod

public int getMetricsTemplateSyncTimePeriod()

Specified by:

getMetricsTemplateSyncTimePeriod in interface XMetricsCollector

getNodeName

public String getNodeName()

Specified by:

getNodeName in interface XMetricsCollector

setStatisticsPublisher

public void setStatisticsPublisher(XStatisticsPublisher statisticsPublisher)

Specified by:

setStatisticsPublisher in interface XMetricsCollector

setPrimaryMetricsTemplateValidTime

public void setPrimaryMetricsTemplateValidTime(int primaryMetricsTemplateValidTime)

setMetricsReportGenerationTimePeriod

public void setMetricsReportGenerationTimePeriod(int metricsReportGenerationTimePeriod)

setMetricsTemplateSyncTimePeriod

public void setMetricsTemplateSyncTimePeriod(int metricsTemplateSyncTimePeriod)

setCustomFields

public void setCustomFields(Map<String,String> customFields)