io.prometheus.client

Class CounterMetricFamily

java.lang.Object

io.prometheus.client.Collector.MetricFamilySamples

io.prometheus.client.CounterMetricFamily

public class CounterMetricFamily
extends Collector.MetricFamilySamples

Counter metric family, for custom collectors and exporters.

Most users want a normal Counter instead. Example usage:

 
   class YourCustomCollector extends Collector {
     List<MetricFamilySamples> collect() {
       List<MetricFamilySamples> mfs = new ArrayList<MetricFamilySamples>();
       // With no labels.
       mfs.add(new CounterMetricFamily("my_counter_total", "help", 42));
       // With labels
       CounterMetricFamily labeledCounter = new CounterMetricFamily("my_other_counter_total", "help", Arrays.asList("labelname"));
       labeledCounter.addMetric(Arrays.asList("foo"), 4);
       labeledCounter.addMetric(Arrays.asList("bar"), 5);
       mfs.add(labeledCounter);
       return mfs;
     }
   }
 
 

Nested Class Summary

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

Collector.MetricFamilySamples.Sample

Field Summary

Fields inherited from class io.prometheus.client.Collector.MetricFamilySamples

help, name, samples, type, unit

Constructor Summary

Constructors

Constructor and Description
CounterMetricFamily(String name, String help, double value)
CounterMetricFamily(String name, String help, List<String> labelNames)

Method Summary

Modifier and Type	Method and Description
CounterMetricFamily	addMetric(List<String> labelValues, double value)

Methods inherited from class io.prometheus.client.Collector.MetricFamilySamples

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CounterMetricFamily

public CounterMetricFamily(String name,
                           String help,
                           double value)

CounterMetricFamily

public CounterMetricFamily(String name,
                           String help,
                           List<String> labelNames)

Method Detail

addMetric

public CounterMetricFamily addMetric(List<String> labelValues,
                                     double value)