Package io.prometheus.client

Class SummaryMetricFamily

  • public class SummaryMetricFamily
extends Collector.MetricFamilySamples
    Summary metric family, for custom collectors and exporters.

    Most users want a normal Summary instead. Example usage: 

     
   class YourCustomCollector extends Collector {
     List<MetricFamilySamples> collect() {
       List<MetricFamilySamples> mfs = new ArrayList<MetricFamilySamples>();
       // With no labels.
       mfs.add(new SummaryMetricFamily("my_summary", "help", 1, 42));
       // With labels. Record 95th percentile as 3, and 99th percentile as 5.
       SummaryMetricFamily labeledSummary = new SummaryMetricFamily("my_other_summary", "help", 
           Arrays.asList("labelname"), Arrays.asList(.95, .99));
       labeledSummary.addMetric(Arrays.asList("foo"), 2, 10, Arrays.asList(3.0, 5.0));
       mfs.add(labeledSummary);
       return mfs;
     }
   }