Package io.micrometer.core.instrument.distribution

Class DistributionStatisticConfig.Builder

java.lang.Object
io.micrometer.core.instrument.distribution.DistributionStatisticConfig.Builder
Enclosing class:
DistributionStatisticConfig
public static class DistributionStatisticConfig.Builder extends Object

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • percentilesHistogram

      public DistributionStatisticConfig.Builder percentilesHistogram(@Nullable Boolean enabled)

    • percentiles

      public DistributionStatisticConfig.Builder percentiles(@Nullable double... percentiles)
      Produces an additional time series for each requested percentile. This percentile is computed locally, and so can't be aggregated with percentiles computed across other dimensions (e.g. in a different instance). Use DistributionStatisticConfig.percentileHistogram to publish a histogram that can be used to generate aggregable percentile approximations.
      Parameters:
      percentiles - Percentiles to compute and publish. The 95th percentile should be expressed as 0.95.
      Returns:
      This builder.

    • percentilePrecision

      public DistributionStatisticConfig.Builder percentilePrecision(@Nullable Integer digitsOfPrecision)
      Determines the number of digits of precision to maintain on the dynamic range histogram used to compute percentile approximations. The higher the degrees of precision, the more accurate the approximation is at the cost of more memory.
      Parameters:
      digitsOfPrecision - The digits of precision to maintain for percentile approximations.
      Returns:
      This builder.

    • serviceLevelObjectives

      public DistributionStatisticConfig.Builder serviceLevelObjectives(@Nullable double... slos)
      Publish at a minimum a histogram containing your defined Service Level Objective (SLO) boundaries. When used in conjunction with DistributionStatisticConfig.percentileHistogram, the boundaries defined here are included alongside other buckets used to generate aggregable percentile approximations. If the DistributionStatisticConfig is meant for use with a Timer, the SLO unit is in nanoseconds.
      Parameters:
      slos - The SLO boundaries to include the set of histogram buckets shipped to the monitoring system.
      Returns:
      This builder.
      Since:
      1.5.0

    • sla

      @Deprecated public DistributionStatisticConfig.Builder sla(@Nullable double... sla)
      Deprecated.
      Use serviceLevelObjectives(double...) instead. "Service Level Agreement" is more formally the agreement between an engineering organization and the business. Service Level Objectives are set more conservatively than the SLA to provide some wiggle room while still satisfying the business requirement. SLOs are the threshold we intend to measure against, then.
      Publish at a minimum a histogram containing your defined SLA boundaries. When used in conjunction with DistributionStatisticConfig.percentileHistogram, the boundaries defined here are included alongside other buckets used to generate aggregable percentile approximations. If the DistributionStatisticConfig is meant for use with a Timer, the SLA unit is in nanoseconds.
      Parameters:
      sla - The SLA boundaries to include the set of histogram buckets shipped to the monitoring system.
      Returns:
      This builder.
      Since:
      1.4.0

    • sla

      @Deprecated public DistributionStatisticConfig.Builder sla(@Nullable long... sla)
      Deprecated.
      Use serviceLevelObjectives(double...) instead. "Service Level Agreement" is more formally the agreement between an engineering organization and the business. Service Level Objectives are set more conservatively than the SLA to provide some wiggle room while still satisfying the business requirement. SLOs are the threshold we intend to measure against, then.
      Publish at a minimum a histogram containing your defined SLA boundaries. When used in conjunction with DistributionStatisticConfig.percentileHistogram, the boundaries defined here are included alongside other buckets used to generate aggregable percentile approximations. If the DistributionStatisticConfig is meant for use with a Timer, the SLA unit is in nanoseconds.
      Parameters:
      sla - The SLA boundaries to include the set of histogram buckets shipped to the monitoring system.
      Returns:
      This builder.

    • minimumExpectedValue

      @Deprecated public DistributionStatisticConfig.Builder minimumExpectedValue(@Nullable Long min)
      Deprecated.
      Use minimumExpectedValue(Double) instead since 1.4.0.
      The minimum value that the meter is expected to observe. Sets a lower bound on histogram buckets that are shipped to monitoring systems that support aggregable percentile approximations.
      Parameters:
      min - The minimum value that this distribution summary is expected to observe.
      Returns:
      This builder.

    • minimumExpectedValue

      public DistributionStatisticConfig.Builder minimumExpectedValue(@Nullable Double min)
      The minimum value that the meter is expected to observe. Sets a lower bound on histogram buckets that are shipped to monitoring systems that support aggregable percentile approximations.
      Parameters:
      min - The minimum value that this distribution summary is expected to observe.
      Returns:
      This builder.
      Since:
      1.3.10

    • maximumExpectedValue

      @Deprecated public DistributionStatisticConfig.Builder maximumExpectedValue(@Nullable Long max)
      Deprecated.
      Use maximumExpectedValue(Double) instead since 1.4.0.
      The maximum value that the meter is expected to observe. Sets an upper bound on histogram buckets that are shipped to monitoring systems that support aggregable percentile approximations.
      Parameters:
      max - The maximum value that the meter is expected to observe.
      Returns:
      This builder.

    • maximumExpectedValue

      public DistributionStatisticConfig.Builder maximumExpectedValue(@Nullable Double max)
      The maximum value that the meter is expected to observe. Sets an upper bound on histogram buckets that are shipped to monitoring systems that support aggregable percentile approximations.
      Parameters:
      max - The maximum value that the meter is expected to observe.
      Returns:
      This builder.
      Since:
      1.3.10

    • expiry

      public DistributionStatisticConfig.Builder expiry(@Nullable Duration expiry)
      Statistics like max, percentiles, and histogram counts decay over time to give greater weight to recent samples (exception: histogram counts are cumulative for those systems that expect cumulative histogram buckets). Samples are accumulated to such statistics in ring buffers which rotate after this expiry, with a buffer length of bufferLength(java.lang.Integer), hence complete expiry happens after this expiry * buffer length.
      Parameters:
      expiry - The amount of time samples are accumulated to decaying distribution statistics before they are reset and rotated.
      Returns:
      This builder.

    • bufferLength

      public DistributionStatisticConfig.Builder bufferLength(@Nullable Integer bufferLength)
      Statistics like max, percentiles, and histogram counts decay over time to give greater weight to recent samples (exception: histogram counts are cumulative for those systems that expect cumulative histogram buckets). Samples are accumulated to such statistics in ring buffers which rotate after expiry(java.time.Duration), with this buffer length.
      Parameters:
      bufferLength - The number of histograms to keep in the ring buffer.
      Returns:
      This builder.

    • build

      public DistributionStatisticConfig build()
      Returns:
      A new immutable distribution configuration.