Package io.prometheus.client.dropwizard.samplebuilder

Class DefaultSampleBuilder

java.lang.Object

io.prometheus.client.dropwizard.samplebuilder.DefaultSampleBuilder

All Implemented Interfaces:

SampleBuilder

public class DefaultSampleBuilder
extends Object
implements SampleBuilder

Default implementation of SampleBuilder. Sanitises the metric name if necessary.

See Also:

Collector.sanitizeMetricName(String)

Constructor Summary

Constructors

Constructor	Description
DefaultSampleBuilder()

Method Summary

Modifier and Type	Method	Description
io.prometheus.client.Collector.MetricFamilySamples.Sample	createSample(String dropwizardName, String nameSuffix, List<String> additionalLabelNames, List<String> additionalLabelValues, double value)	Creates a new Collector.MetricFamilySamples.Sample for the given parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSampleBuilder

public DefaultSampleBuilder()

Method Detail

createSample

public io.prometheus.client.Collector.MetricFamilySamples.Sample createSample(String dropwizardName,
                                                                              String nameSuffix,
                                                                              List<String> additionalLabelNames,
                                                                              List<String> additionalLabelValues,
                                                                              double value)

Description copied from interface: SampleBuilder

Creates a new Collector.MetricFamilySamples.Sample for the given parameters.

Specified by:

createSample in interface SampleBuilder

Parameters:

dropwizardName - Metric name coming from Dropwizard.

nameSuffix - Optional suffix to add.

additionalLabelNames - Optional additional label names. Needs to have same size as additionalLabelValues.

additionalLabelValues - Optional additional label values. Needs to have same size as additionalLabelNames.

value - Metric value

Returns:

A new Collector.MetricFamilySamples.Sample.