Package io.prometheus.metrics.core.metrics

Class Summary

Object
Metric
MetricWithFixedMetadata
Summary
All Implemented Interfaces:
DataPoint, DistributionDataPoint, TimerApi, Collector
public class Summary extends MetricWithFixedMetadata implements DistributionDataPoint
Summary metric. Example: 

 Summary summary = Summary.builder()
         .name("http_request_duration_seconds_hi")
         .help("HTTP request service time in seconds")
         .unit(SECONDS)
         .labelNames("method", "path", "status_code")
         .quantile(0.5, 0.01)
         .quantile(0.95, 0.001)
         .quantile(0.99, 0.001)
         .register();

 long start = System.nanoTime();
 // process a request, duration will be observed
 summary.labelValues("GET", "/", "200").observe(Unit.nanosToSeconds(System.nanoTime() - start));
See Summary.Builder for configuration options.

  • Method Details

    • observe

      public void observe(double amount)
      Description copied from interface: DistributionDataPoint
      Observe value.
      Specified by:
      observe in interface DistributionDataPoint

    • observeWithExemplar

      public void observeWithExemplar(double amount, Labels labels)
      Description copied from interface: DistributionDataPoint
      Observe value, and create a custom exemplar with the given labels.
      Specified by:
      observeWithExemplar in interface DistributionDataPoint

    • collect

      public SummarySnapshot collect()
      Description copied from interface: Collector
      Called when the Prometheus server scrapes metrics.
      Specified by:
      collect in interface Collector

    • builder

      public static Summary.Builder builder()

    • builder

      public static Summary.Builder builder(PrometheusProperties config)

    • initLabelValues

      public void initLabelValues(String... labelValues)
      Initialize label values.

      Example: Imagine you have a counter for payments as follows 

       payment_transactions_total{payment_type="credit card"} 7.0
 payment_transactions_total{payment_type="paypal"} 3.0
      Now, the data points for the payment_type label values get initialized when they are first used, i.e. the first time you call 
      
 counter.labelValues("paypal").inc();
      the data point with label payment_type="paypal" will go from non-existent to having value 1.0.

      In some cases this is confusing, and you want to have data points initialized on application start with an initial value of 0.0: 

       payment_transactions_total{payment_type="credit card"} 0.0
 payment_transactions_total{payment_type="paypal"} 0.0
      initLabelValues(...) can be used to initialize label value, so that the data points show up in the exposition format with an initial value of zero.

    • labelValues

      public DistributionDataPoint labelValues(String... labelValues)

    • remove

      public void remove(String... labelValues)
      Remove the data point with the given label values. See https://prometheus.io/docs/instrumenting/writing_clientlibs/#labels.

    • removeIf

      public void removeIf(Function<List<String>,Boolean> f)
      Remove the data points when the given function.

    • clear

      public void clear()
      Reset the metric (remove all data points).