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;
         }
       }
     
     
    • Field Detail

      • labelNames

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

        private final java.util.List<java.lang.Double> quantiles
    • Constructor Detail

      • SummaryMetricFamily

        public SummaryMetricFamily​(java.lang.String name,
                                   java.lang.String help,
                                   double count,
                                   double sum)
      • SummaryMetricFamily

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

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

      • addMetric

        public SummaryMetricFamily addMetric​(java.util.List<java.lang.String> labelValues,
                                             double count,
                                             double sum)
      • addMetric

        public SummaryMetricFamily addMetric​(java.util.List<java.lang.String> labelValues,
                                             double count,
                                             double sum,
                                             java.util.List<java.lang.Double> quantiles)