Package io.prometheus.client.dropwizard

Class DropwizardExports

java.lang.Object

io.prometheus.client.Collector

io.prometheus.client.dropwizard.DropwizardExports

All Implemented Interfaces:

io.prometheus.client.Collector.Describable

public class DropwizardExports
extends io.prometheus.client.Collector
implements io.prometheus.client.Collector.Describable

Collect Dropwizard metrics from a MetricRegistry.

Nested Class Summary

Nested classes/interfaces inherited from class io.prometheus.client.Collector

io.prometheus.client.Collector.Describable, io.prometheus.client.Collector.MetricFamilySamples, io.prometheus.client.Collector.Type

Field Summary

Fields inherited from class io.prometheus.client.Collector

MILLISECONDS_PER_SECOND, NANOSECONDS_PER_SECOND

Constructor Summary

Constructors

Constructor	Description
DropwizardExports(com.codahale.metrics.MetricRegistry registry)	Creates a new DropwizardExports with a DefaultSampleBuilder and MetricFilter.ALL.
DropwizardExports(com.codahale.metrics.MetricRegistry registry, com.codahale.metrics.MetricFilter metricFilter)	Creates a new DropwizardExports with a DefaultSampleBuilder and custom MetricFilter.
DropwizardExports(com.codahale.metrics.MetricRegistry registry, com.codahale.metrics.MetricFilter metricFilter, SampleBuilder sampleBuilder)
DropwizardExports(com.codahale.metrics.MetricRegistry registry, SampleBuilder sampleBuilder)

Method Summary

Modifier and Type	Method	Description
List<io.prometheus.client.Collector.MetricFamilySamples>	collect()
List<io.prometheus.client.Collector.MetricFamilySamples>	describe()

Methods inherited from class io.prometheus.client.Collector

checkMetricLabelName, checkMetricName, collect, doubleToGoString, register, register, sanitizeMetricName

Methods inherited from class java.lang.Object

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

Constructor Detail

DropwizardExports

public DropwizardExports(com.codahale.metrics.MetricRegistry registry)

Creates a new DropwizardExports with a DefaultSampleBuilder and MetricFilter.ALL.

Parameters:

registry - a metric registry to export in prometheus.

DropwizardExports

public DropwizardExports(com.codahale.metrics.MetricRegistry registry,
                         com.codahale.metrics.MetricFilter metricFilter)

Creates a new DropwizardExports with a DefaultSampleBuilder and custom MetricFilter.

Parameters:

registry - a metric registry to export in prometheus.

metricFilter - a custom metric filter.

DropwizardExports

public DropwizardExports(com.codahale.metrics.MetricRegistry registry,
                         SampleBuilder sampleBuilder)

Parameters:

registry - a metric registry to export in prometheus.

sampleBuilder - sampleBuilder to use to create prometheus samples.

DropwizardExports

public DropwizardExports(com.codahale.metrics.MetricRegistry registry,
                         com.codahale.metrics.MetricFilter metricFilter,
                         SampleBuilder sampleBuilder)

Parameters:

registry - a metric registry to export in prometheus.

metricFilter - a custom metric filter.

sampleBuilder - sampleBuilder to use to create prometheus samples.

Method Detail

collect

public List<io.prometheus.client.Collector.MetricFamilySamples> collect()

Specified by:

collect in class io.prometheus.client.Collector

describe

public List<io.prometheus.client.Collector.MetricFamilySamples> describe()

Specified by:

describe in interface io.prometheus.client.Collector.Describable