com.nt.udc.util.misc.metrics

Class MetricsService

java.lang.Object

com.nt.udc.util.misc.metrics.MetricsService

public class MetricsService
extends java.lang.Object

This class creates a Prometheus registry and http metrics service endpoint that can be scraped for ECE application, Coherence, JVM, and system metrics.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	METRICS_APPLICATION_ROLE_TAG Tag name to use to distinguish between application components.
static java.lang.String	METRICS_HTTP_PORT_DEFAULT Default por the metrics HTTP server will listen on.
static java.lang.String	METRICS_HTTP_PORT_PROPERTY_NAME Property used to configure the HTTP Metrics port.
static java.lang.String	METRICS_HTTP_SERVICE_ENABLED_PROPERTY_NAME Property used to control if the metric server is enabled (true) or disabled.
static java.lang.String	METRICS_SERVICE_ENABLED_DEFAULT Default property used to indicate if the HTTP Metric server is enabled.
static java.lang.String	METRICS_SERVICE_PATH HTTP path that metrics will be served on.

Constructor Summary

Constructors

Constructor and Description
MetricsService() Public default constructor.

Method Summary

Modifier and Type	Method and Description
MetricsService	bindAllMetrics() Creates the PrometheusMeterRegistry and binds the following component metrics to it so they are also provided when the service is scraped.
int	getMetricsHttpPort() Get the metrics http port the service is running on.
boolean	isMetricsHttpServiceEnabled() Get the enabled status of this metrics service.
MetricsService	setApplicationRole(java.lang.String applicationName) Add the Application tag to the registry.
MetricsService	setCommonTags()
MetricsService	setCommonTags(java.util.List<Tag> tagList) Adds a list of Common Tags to the registry.
MetricsService	setCommonTags(java.util.Map<java.lang.String,java.lang.String> tagMap)
MetricsService	setLogger(Logger logger)
void	setNM(com.nt.udc.nodemgr.OSANodeMgr inNM)
boolean	startMetricsHttpService() Starts the ECE Prometheus metrics service endpoint which provides metrics from the ECE application and other components using a common Prometheus registry.

Methods inherited from class java.lang.Object

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

Field Detail

METRICS_SERVICE_PATH

public static final java.lang.String METRICS_SERVICE_PATH

HTTP path that metrics will be served on.

See Also:

Constant Field Values

METRICS_HTTP_PORT_DEFAULT

public static final java.lang.String METRICS_HTTP_PORT_DEFAULT

Default por the metrics HTTP server will listen on.

See Also:

Constant Field Values

METRICS_HTTP_PORT_PROPERTY_NAME

public static final java.lang.String METRICS_HTTP_PORT_PROPERTY_NAME

Property used to configure the HTTP Metrics port.

See Also:

Constant Field Values

METRICS_SERVICE_ENABLED_DEFAULT

public static final java.lang.String METRICS_SERVICE_ENABLED_DEFAULT

Default property used to indicate if the HTTP Metric server is enabled.

See Also:

Constant Field Values

METRICS_HTTP_SERVICE_ENABLED_PROPERTY_NAME

public static final java.lang.String METRICS_HTTP_SERVICE_ENABLED_PROPERTY_NAME

Property used to control if the metric server is enabled (true) or disabled.

See Also:

Constant Field Values

METRICS_APPLICATION_ROLE_TAG

public static final java.lang.String METRICS_APPLICATION_ROLE_TAG

Tag name to use to distinguish between application components.

See Also:

Constant Field Values

Constructor Detail

MetricsService

public MetricsService()

Public default constructor.

Method Detail

setCommonTags

public MetricsService setCommonTags(java.util.List<Tag> tagList)

Adds a list of Common Tags to the registry. All metrics will include these tags.

Parameters:

tagList - List of Tags to apply to all metrics.

Returns:

the metric service

setApplicationRole

public MetricsService setApplicationRole(java.lang.String applicationName)

Add the Application tag to the registry. This will be added to all metrics.

Parameters:

applicationName - name of the application

Returns:

the metric service

setCommonTags

public MetricsService setCommonTags()

setCommonTags

public MetricsService setCommonTags(java.util.Map<java.lang.String,java.lang.String> tagMap)

bindAllMetrics

public MetricsService bindAllMetrics()

Creates the PrometheusMeterRegistry and binds the following component metrics to it so they are also provided when the service is scraped. 1) Coherence Metrics 2) JVM GC Metrics 3) JVM Thread Metrics 4) Processor Metrics

Returns:

This MetricsService instance.

startMetricsHttpService

public boolean startMetricsHttpService()

Starts the ECE Prometheus metrics service endpoint which provides metrics from the ECE application and other components using a common Prometheus registry.

Returns:

True if the service is started or already started. False if the configuration property ece.metrics.http.service.enabled is false or the service fails to start.

getMetricsHttpPort

public int getMetricsHttpPort()

Get the metrics http port the service is running on.

Returns:

The configured http port

isMetricsHttpServiceEnabled

public boolean isMetricsHttpServiceEnabled()

Get the enabled status of this metrics service.

Returns:

true if the service is enabled, false otherwise.

setNM

public void setNM(com.nt.udc.nodemgr.OSANodeMgr inNM)

setLogger

public MetricsService setLogger(Logger logger)