Package io.micrometer.prometheus

Class PrometheusDistributionSummary

java.lang.Object
io.micrometer.core.instrument.AbstractMeter
io.micrometer.core.instrument.AbstractDistributionSummary
io.micrometer.prometheus.PrometheusDistributionSummary
All Implemented Interfaces:
io.micrometer.core.instrument.distribution.HistogramSupport, io.micrometer.core.instrument.DistributionSummary, io.micrometer.core.instrument.Meter
public class PrometheusDistributionSummary extends io.micrometer.core.instrument.AbstractDistributionSummary
DistributionSummary for Prometheus.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface io.micrometer.core.instrument.DistributionSummary

    io.micrometer.core.instrument.DistributionSummary.Builder

    Nested classes/interfaces inherited from interface io.micrometer.core.instrument.Meter

    io.micrometer.core.instrument.Meter.Builder, io.micrometer.core.instrument.Meter.Id, io.micrometer.core.instrument.Meter.Type

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    count()
     
    io.micrometer.core.instrument.distribution.CountAtBucket[]
    histogramCounts()
    For Prometheus we cannot use the histogram counts from HistogramSnapshot, as it is based on a rolling histogram.
    HistogramFlavor
    histogramFlavor()
     
    double
    max()
     
    protected void
    recordNonNegative(double amount)
     
    io.micrometer.core.instrument.distribution.HistogramSnapshot
    takeSnapshot()
     
    double
    totalAmount()
     

    Methods inherited from class io.micrometer.core.instrument.AbstractDistributionSummary

    defaultHistogram, record

    Methods inherited from class io.micrometer.core.instrument.AbstractMeter

    equals, getId, hashCode

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface io.micrometer.core.instrument.DistributionSummary

    histogramCountAtValue, mean, measure, percentile

    Methods inherited from interface io.micrometer.core.instrument.distribution.HistogramSupport

    takeSnapshot

    Methods inherited from interface io.micrometer.core.instrument.Meter

    close, getId, match, use

  • Method Details

    • recordNonNegative

      protected void recordNonNegative(double amount)
      Specified by:
      recordNonNegative in class io.micrometer.core.instrument.AbstractDistributionSummary

    • count

      public long count()

    • totalAmount

      public double totalAmount()

    • max

      public double max()

    • histogramFlavor

      public HistogramFlavor histogramFlavor()

    • histogramCounts

      public io.micrometer.core.instrument.distribution.CountAtBucket[] histogramCounts()
      For Prometheus we cannot use the histogram counts from HistogramSnapshot, as it is based on a rolling histogram. Prometheus requires a histogram that accumulates values over the lifetime of the app.
      Returns:
      Cumulative histogram buckets.

    • takeSnapshot

      public io.micrometer.core.instrument.distribution.HistogramSnapshot takeSnapshot()
      Specified by:
      takeSnapshot in interface io.micrometer.core.instrument.distribution.HistogramSupport
      Overrides:
      takeSnapshot in class io.micrometer.core.instrument.AbstractDistributionSummary