org.adroitlogic.x.metrics

Class ESStatisticsPublisher

java.lang.Object

org.adroitlogic.x.metrics.ESStatisticsPublisher

All Implemented Interfaces:

XStatisticsPublisher

public class ESStatisticsPublisher
extends Object
implements XStatisticsPublisher

ElasticSearch based statistics publisher

Since:

17.01

Author:

Ruwan Linton, Manjula, Udith Gunaratna

Nested Class Summary

Nested classes/interfaces inherited from interface org.adroitlogic.x.api.metrics.XStatisticsPublisher

XStatisticsPublisher.CustomMetricsField, XStatisticsPublisher.CustomMetricsFieldType

Constructor Summary

Constructors

Constructor and Description
ESStatisticsPublisher(ESStatisticsServer esStatisticsServer)

Method Summary

Modifier and Type	Method and Description
void	destroy()
void	generateRecords(ConcurrentLinkedQueue<MetricsTemplate> completedMetricsTemplates) Generate metrics records for the provided metrics templates and publishes them to the external collector.
void	init(String confDir, String nodeName, String spaceName)
void	publish(Map<String,Object> contentMap) Publishes a map of contents to the external metrics collector.
<T> void	publish(T content, Class<T> clz) Publishes an object containing the metrics to the external metrics collector.
void	setActiveIndexAliasName(String activeIndexAliasName)
void	setBackOffExponentialRetryAttempts(int backOffExponentialRetryAttempts)
void	setBackOffExponentialTimeInMillis(int backOffExponentialTimeInMillis)
void	setBulkActions(int bulkActions)
void	setBulkSizeInMB(int bulkSizeInMB)
void	setConcurrentRequests(int concurrentRequests)
void	setCustomFields(Map<String,String> customFields) Defines the custom fields to be added for the published records.
void	setDeleteInactiveIndicesAtDestroy(boolean deleteInactiveIndicesAtDestroy)
void	setDeleteInactiveIndicesAtInit(boolean deleteInactiveIndicesAtInit)
void	setDeleteOldestIndexAfterRollOver(boolean deleteOldestIndexAfterRollOver)
void	setEsHealthTimeoutMillis(int esHealthTimeoutMillis)
void	setFlushIntervalInSeconds(int flushIntervalInSeconds)
void	setInactiveIndexAliasName(String inactiveIndexAliasName)
void	setInactiveSettingFile(String inactiveSettingFile)
void	setIndexMappingType(String indexMappingType)
void	setIndexRollOverEnabled(boolean indexRollOverEnabled)
void	setIndexTemplateName(String indexTemplateName)
void	setInitialIndexName(String initialIndexName)
void	setMaxAgeInMinutes(long maxAgeInMinutes)
void	setMaxDocs(long maxDocs)
void	setOptimized(boolean optimized)
void	setRollOverTimePeriodInMinutes(long rollOverTimePeriodInMinutes)
void	setTemplateFile(String templateFile)

Methods inherited from class java.lang.Object

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

Constructor Detail

ESStatisticsPublisher

public ESStatisticsPublisher(ESStatisticsServer esStatisticsServer)

Method Detail

init

public void init(String confDir,
                 String nodeName,
                 String spaceName)

Specified by:

init in interface XStatisticsPublisher

destroy

public void destroy()

Specified by:

destroy in interface XStatisticsPublisher

publish

public void publish(Map<String,Object> contentMap)

Publishes a map of contents to the external metrics collector. The publisher will also add any custom defined fields as well as some framework specific fields (e.g.: Node name, Space name, record time) to the published record.

Specified by:

publish in interface XStatisticsPublisher

Parameters:

contentMap - key-value pairs of metrics records

publish

public <T> void publish(T content,
                        Class<T> clz)

Description copied from interface: XStatisticsPublisher

Publishes an object containing the metrics to the external metrics collector. The publisher will also add any custom defined fields as well as some framework specific fields (e.g.: Node name, Space name, record time) to the published record.

Specified by:

publish in interface XStatisticsPublisher

Type Parameters:

T - type of the published object

Parameters:

content - object containing the metrics

clz - class of the published object

setBulkActions

public void setBulkActions(int bulkActions)

setBulkSizeInMB

public void setBulkSizeInMB(int bulkSizeInMB)

setFlushIntervalInSeconds

public void setFlushIntervalInSeconds(int flushIntervalInSeconds)

setConcurrentRequests

public void setConcurrentRequests(int concurrentRequests)

setBackOffExponentialTimeInMillis

public void setBackOffExponentialTimeInMillis(int backOffExponentialTimeInMillis)

setBackOffExponentialRetryAttempts

public void setBackOffExponentialRetryAttempts(int backOffExponentialRetryAttempts)

setEsHealthTimeoutMillis

public void setEsHealthTimeoutMillis(int esHealthTimeoutMillis)

setOptimized

public void setOptimized(boolean optimized)

setInitialIndexName

public void setInitialIndexName(String initialIndexName)

setIndexMappingType

public void setIndexMappingType(String indexMappingType)

setIndexTemplateName

public void setIndexTemplateName(String indexTemplateName)

setActiveIndexAliasName

public void setActiveIndexAliasName(String activeIndexAliasName)

setInactiveIndexAliasName

public void setInactiveIndexAliasName(String inactiveIndexAliasName)

setMaxDocs

public void setMaxDocs(long maxDocs)

setMaxAgeInMinutes

public void setMaxAgeInMinutes(long maxAgeInMinutes)

setRollOverTimePeriodInMinutes

public void setRollOverTimePeriodInMinutes(long rollOverTimePeriodInMinutes)

setIndexRollOverEnabled

public void setIndexRollOverEnabled(boolean indexRollOverEnabled)

setTemplateFile

public void setTemplateFile(String templateFile)

setInactiveSettingFile

public void setInactiveSettingFile(String inactiveSettingFile)

setDeleteOldestIndexAfterRollOver

public void setDeleteOldestIndexAfterRollOver(boolean deleteOldestIndexAfterRollOver)

setDeleteInactiveIndicesAtInit

public void setDeleteInactiveIndicesAtInit(boolean deleteInactiveIndicesAtInit)

setDeleteInactiveIndicesAtDestroy

public void setDeleteInactiveIndicesAtDestroy(boolean deleteInactiveIndicesAtDestroy)

setCustomFields

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

Description copied from interface: XStatisticsPublisher

Defines the custom fields to be added for the published records.

These field values should be defined according to the following format.

Value type	Format
A constant	CONSTANT_VALUE
An environment variable	env:ENV_VAR_NAME
A system property	sys:SYS_PROP_KEY

Specified by:

setCustomFields in interface XStatisticsPublisher

Parameters:

customFields - custom fields as key-value pairs

generateRecords

public void generateRecords(ConcurrentLinkedQueue<MetricsTemplate> completedMetricsTemplates)

Description copied from interface: XStatisticsPublisher

Generate metrics records for the provided metrics templates and publishes them to the external collector. The publisher will also add any custom defined fields as well as some framework specific fields (e.g.: Node name, Space name, record time) to the published record.

Specified by:

generateRecords in interface XStatisticsPublisher

Parameters:

completedMetricsTemplates - the completed MetricsTemplates