Package org.dhatim.dropwizard.prometheus

Class PrometheusReporter

java.lang.Object

com.codahale.metrics.ScheduledReporter

org.dhatim.dropwizard.prometheus.PrometheusReporter

All Implemented Interfaces:

com.codahale.metrics.Reporter, Closeable, AutoCloseable

public class PrometheusReporter
extends com.codahale.metrics.ScheduledReporter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PrometheusReporter.Builder	A builder for PrometheusReporter instances.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PrometheusReporter(com.codahale.metrics.MetricRegistry registry, PrometheusSender prometheus, String prefix, com.codahale.metrics.MetricFilter filter, ScheduledExecutorService executor, boolean shutdownExecutorOnStop)	Creates a new PrometheusReporter instance.

Method Summary

Modifier and Type	Method	Description
static PrometheusReporter.Builder	forRegistry(com.codahale.metrics.MetricRegistry registry)	Returns a new PrometheusReporter.Builder for PrometheusReporter.
void	report(SortedMap<String,com.codahale.metrics.Gauge> gauges, SortedMap<String,com.codahale.metrics.Counter> counters, SortedMap<String,com.codahale.metrics.Histogram> histograms, SortedMap<String,com.codahale.metrics.Meter> meters, SortedMap<String,com.codahale.metrics.Timer> timers)
void	stop()

Methods inherited from class com.codahale.metrics.ScheduledReporter

close, convertDuration, convertRate, getDisabledMetricAttributes, getDurationUnit, getRateUnit, getScheduledFuture, getScheduledFuture, isShutdownExecutorOnStop, report, start, start

Methods inherited from class java.lang.Object

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

Constructor Detail

PrometheusReporter

protected PrometheusReporter(com.codahale.metrics.MetricRegistry registry,
                             PrometheusSender prometheus,
                             String prefix,
                             com.codahale.metrics.MetricFilter filter,
                             ScheduledExecutorService executor,
                             boolean shutdownExecutorOnStop)

Creates a new PrometheusReporter instance.

Parameters:

registry - the MetricRegistry containing the metrics this reporter will report

prometheus - the PrometheusSender which is responsible for sending metrics to a Carbon server via a transport protocol

prefix - the prefix of all metric names (may be null)

filter - the filter for which metrics to report

executor - the executor to use while scheduling reporting of metrics (may be null).

shutdownExecutorOnStop - if true, then executor will be stopped in same time with this reporter

Method Detail

stop

public void stop()

Overrides:

stop in class com.codahale.metrics.ScheduledReporter

report

public void report(SortedMap<String,com.codahale.metrics.Gauge> gauges,
                   SortedMap<String,com.codahale.metrics.Counter> counters,
                   SortedMap<String,com.codahale.metrics.Histogram> histograms,
                   SortedMap<String,com.codahale.metrics.Meter> meters,
                   SortedMap<String,com.codahale.metrics.Timer> timers)

Specified by:

report in class com.codahale.metrics.ScheduledReporter

forRegistry

public static PrometheusReporter.Builder forRegistry(com.codahale.metrics.MetricRegistry registry)

Returns a new PrometheusReporter.Builder for PrometheusReporter.

Parameters:

registry - the registry to report

Returns:

a PrometheusReporter.Builder instance for a PrometheusReporter