Package io.prometheus.client.dropwizard.samplebuilder

Class CustomMappingSampleBuilder

java.lang.Object

io.prometheus.client.dropwizard.samplebuilder.CustomMappingSampleBuilder

All Implemented Interfaces:

SampleBuilder

public class CustomMappingSampleBuilder
extends Object
implements SampleBuilder

Custom SampleBuilder implementation to allow Dropwizard metrics to be translated to Prometheus metrics including custom labels and names. Prometheus metric name and labels are extracted from the Dropwizard name based on the provided list of MapperConfigs. The FIRST matching config will be used. If no config is matched, the DefaultSampleBuilder is used.

Constructor Summary

Constructors

Constructor	Description
CustomMappingSampleBuilder(List<MapperConfig> mapperConfigs)

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.
protected io.prometheus.client.dropwizard.samplebuilder.CustomMappingSampleBuilder.NameAndLabels	getNameAndLabels(MapperConfig config, Map<String,String> parameters)

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomMappingSampleBuilder

public CustomMappingSampleBuilder(List<MapperConfig> mapperConfigs)

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.

getNameAndLabels

protected io.prometheus.client.dropwizard.samplebuilder.CustomMappingSampleBuilder.NameAndLabels getNameAndLabels(MapperConfig config,
                                                                                                                  Map<String,String> parameters)