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;
    }
  }

  • Field Details

    • labelNames

      private final List<String> labelNames

  • Constructor Details

    • CounterMetricFamily

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

    • CounterMetricFamily

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

  • Method Details