Package org.dhatim.dropwizard.prometheus

Class PrometheusReporter.Builder

java.lang.Object

org.dhatim.dropwizard.prometheus.PrometheusReporter.Builder

Enclosing class:

PrometheusReporter

public static class PrometheusReporter.Builder
extends Object

A builder for PrometheusReporter instances. Defaults to not using a prefix, and not filtering metrics.

Method Summary

Modifier and Type	Method	Description
PrometheusReporter	build(PrometheusSender prometheus)	Builds a PrometheusReporter with the given properties, sending metrics using the given PrometheusSender.
PrometheusReporter	build(Pushgateway prometheus)	Builds a PrometheusReporter with the given properties, sending metrics using the given PrometheusSender.
PrometheusReporter.Builder	filter(com.codahale.metrics.MetricFilter filter)	Only report metrics which match the given filter.
PrometheusReporter.Builder	prefixedWith(String prefix)	Prefix all metric names with the given string.
PrometheusReporter.Builder	scheduleOn(ScheduledExecutorService executor)	Specifies the executor to use while scheduling reporting of metrics.
PrometheusReporter.Builder	shutdownExecutorOnStop(boolean shutdownExecutorOnStop)	Specifies whether or not, the executor (used for reporting) will be stopped with same time with reporter.

Methods inherited from class java.lang.Object

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

Method Detail

shutdownExecutorOnStop

public PrometheusReporter.Builder shutdownExecutorOnStop(boolean shutdownExecutorOnStop)

Specifies whether or not, the executor (used for reporting) will be stopped with same time with reporter. Default value is true. Setting this parameter to false, has the sense in combining with providing external managed executor via scheduleOn(ScheduledExecutorService).

Parameters:

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

Returns:

this

scheduleOn

public PrometheusReporter.Builder scheduleOn(ScheduledExecutorService executor)

Specifies the executor to use while scheduling reporting of metrics. Default value is null. Null value leads to executor will be auto created on start.

Parameters:

executor - the executor to use while scheduling reporting of metrics.

Returns:

this

prefixedWith

public PrometheusReporter.Builder prefixedWith(String prefix)

Prefix all metric names with the given string.

Parameters:

prefix - the prefix for all metric names

Returns:

this

filter

public PrometheusReporter.Builder filter(com.codahale.metrics.MetricFilter filter)

Only report metrics which match the given filter.

Parameters:

filter - a MetricFilter

Returns:

this

build

public PrometheusReporter build(Pushgateway prometheus)

Builds a PrometheusReporter with the given properties, sending metrics using the given PrometheusSender. Present for binary compatibility

Parameters:

prometheus - a Pushgateway

Returns:

a PrometheusReporter

build

public PrometheusReporter build(PrometheusSender prometheus)

Builds a PrometheusReporter with the given properties, sending metrics using the given PrometheusSender.

Parameters:

prometheus - a PrometheusSender

Returns:

a PrometheusReporter