Package eu.rarogsoftware.rarog.platform.core.metrics.prometheus

Class PrometheusMetricsService

java.lang.Object

eu.rarogsoftware.rarog.platform.core.metrics.prometheus.PrometheusMetricsService

All Implemented Interfaces:

MetricsService

@Component
public class PrometheusMetricsService
extends Object
implements MetricsService

Constructor Summary

Constructors

Constructor	Description
PrometheusMetricsService()
PrometheusMetricsService(Clock clock)

Method Summary

Modifier and Type	Method	Description
void	closeMetric(BasicMetric metric)	Close instance of metric.
Counter	createCounter(MetricSettings settings)
Gauge	createGauge(MetricSettings settings)
Histogram	createHistogram(HistogramSettings settings)
Info	createInfo(MetricSettings settings)
void	resetMetrics()
Collection<MetricSamples>	sample()	Get last known state of all metrics in system.
MetricsSnapshot	snapshot()	Gets snapshot state of metrics active in current moment.

Methods inherited from class java.lang.Object

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

Constructor Details

PrometheusMetricsService

public PrometheusMetricsService(Clock clock)

PrometheusMetricsService

public PrometheusMetricsService()

Method Details

createCounter

public Counter createCounter(MetricSettings settings)

Specified by:

createCounter in interface MetricsService

Parameters:

settings - metric settings

Returns:

new instance of Counter metric

createGauge

public Gauge createGauge(MetricSettings settings)

Specified by:

createGauge in interface MetricsService

Parameters:

settings - metric settings

Returns:

new instance of Gauge metric

createHistogram

public Histogram createHistogram(HistogramSettings settings)

Specified by:

createHistogram in interface MetricsService

Parameters:

settings - metric settings

Returns:

new instance of Histogram metric

createInfo

public Info createInfo(MetricSettings settings)

Specified by:

createInfo in interface MetricsService

Parameters:

settings - metric settings

Returns:

new instance of Info metric

closeMetric

public void closeMetric(BasicMetric metric)

Description copied from interface: MetricsService

Close instance of metric.

Closed metric are no longer exported as part of snapshot. They will still be part of exposed metrics, but they are not stored in snapshot nor exported to external systems. Closed metric will be included in the nearest snapshot.

Specified by:

closeMetric in interface MetricsService

Parameters:

metric - metric to close. Must be metric created by the same instance of MetricsService

snapshot

public MetricsSnapshot snapshot()

Description copied from interface: MetricsService

Gets snapshot state of metrics active in current moment.

Specified by:

snapshot in interface MetricsService

Returns:

snapshot of metrics state in current moment

sample

public Collection<MetricSamples> sample()

Description copied from interface: MetricsService

Get last known state of all metrics in system.

Specified by:

sample in interface MetricsService

Returns:

collection of last known samples of all metrics in system

resetMetrics

public void resetMetrics()