Class 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 Detail

      • labelNames

        private final java.util.List<java.lang.String> labelNames
    • Constructor Detail

      • CounterMetricFamily

        public CounterMetricFamily​(java.lang.String name,
                                   java.lang.String help,
                                   double value)
      • CounterMetricFamily

        public CounterMetricFamily​(java.lang.String name,
                                   java.lang.String help,
                                   java.util.List<java.lang.String> labelNames)
    • Method Detail

      • addMetric

        public CounterMetricFamily addMetric​(java.util.List<java.lang.String> labelValues,
                                             double value)