Package io.prometheus.client.dropwizard.samplebuilder

Interface SampleBuilder

All Known Implementing Classes:

CustomMappingSampleBuilder, DefaultSampleBuilder

public interface SampleBuilder

SampleBuilder defines the action of creating a Collector.MetricFamilySamples.Sample for the given parameters.

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.

Method Detail

createSample

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.

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.