Package io.micrometer.core.instrument

Class DistributionSummary.Builder

java.lang.Object
io.micrometer.core.instrument.DistributionSummary.Builder
Enclosing interface:
DistributionSummary
public static class DistributionSummary.Builder extends Object
Fluent builder for distribution summaries.

  • Method Details

    • tags

      public DistributionSummary.Builder tags(String... tags)
      Parameters:
      tags - Must be an even number of arguments representing key/value pairs of tags.
      Returns:
      The distribution summmary builder with added tags.

    • tags

      public DistributionSummary.Builder tags(Iterable<Tag> tags)
      Parameters:
      tags - Tags to add to the eventual distribution summary.
      Returns:
      The distribution summary builder with added tags.

    • tag

      public DistributionSummary.Builder tag(String key, String value)
      Parameters:
      key - The tag key.
      value - The tag value.
      Returns:
      The distribution summary builder with a single added tag.

    • description

      public DistributionSummary.Builder description(@Nullable String description)
      Parameters:
      description - Description text of the eventual distribution summary.
      Returns:
      The distribution summary builder with added description.

    • baseUnit

      public DistributionSummary.Builder baseUnit(@Nullable String unit)
      Parameters:
      unit - Base unit of the eventual distribution summary.
      Returns:
      The distribution summary builder with added base unit.

    • publishPercentiles

      public DistributionSummary.Builder publishPercentiles(@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 publishPercentileHistogram() 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 DistributionSummary.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.

    • publishPercentileHistogram

      public DistributionSummary.Builder publishPercentileHistogram()
      Adds histogram buckets used to generate aggregable percentile approximations in monitoring systems that have query facilities to do so (e.g. Prometheus' histogram_quantile, Atlas' :percentiles).
      Returns:
      This builder.

    • publishPercentileHistogram

      public DistributionSummary.Builder publishPercentileHistogram(@Nullable Boolean enabled)
      Adds histogram buckets used to generate aggregable percentile approximations in monitoring systems that have query facilities to do so (e.g. Prometheus' histogram_quantile, Atlas' :percentiles).
      Parameters:
      enabled - Determines whether percentile histograms should be published.
      Returns:
      This builder.

    • sla

      @Deprecated public DistributionSummary.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 service level objective (SLO) boundaries. When used in conjunction with Timer.Builder.publishPercentileHistogram(), the boundaries defined here are included alongside other buckets used to generate aggregable percentile approximations.
      Parameters:
      sla - Publish SLO boundaries in the set of histogram buckets shipped to the monitoring system.
      Returns:
      This builder.

    • sla

      @Deprecated public DistributionSummary.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 service level objective (SLO) boundaries. When used in conjunction with Timer.Builder.publishPercentileHistogram(), the boundaries defined here are included alongside other buckets used to generate aggregable percentile approximations.
      Parameters:
      sla - Publish SLO boundaries in the set of histogram buckets shipped to the monitoring system.
      Returns:
      This builder.
      Since:
      1.4.0

    • serviceLevelObjectives

      public DistributionSummary.Builder serviceLevelObjectives(@Nullable double... slos)
      Publish at a minimum a histogram containing your defined service level objective (SLO) boundaries. When used in conjunction with Timer.Builder.publishPercentileHistogram(), the boundaries defined here are included alongside other buckets used to generate aggregable percentile approximations.
      Parameters:
      slos - Publish SLO boundaries in the set of histogram buckets shipped to the monitoring system.
      Returns:
      This builder.
      Since:
      1.5.0

    • minimumExpectedValue

      @Deprecated public DistributionSummary.Builder minimumExpectedValue(@Nullable Long min)
      Deprecated.
      Use minimumExpectedValue(Double) instead since 1.4.0.
      Sets the minimum value that this distribution summary 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 DistributionSummary.Builder minimumExpectedValue(@Nullable Double min)
      Sets the minimum value that this distribution summary 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 DistributionSummary.Builder maximumExpectedValue(@Nullable Long max)
      Deprecated.
      Use maximumExpectedValue(Double) instead since 1.4.0.
      Sets the maximum value that this distribution summary 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 this distribution summary is expected to observe.
      Returns:
      This builder.

    • maximumExpectedValue

      public DistributionSummary.Builder maximumExpectedValue(@Nullable Double max)
      Sets the maximum value that this distribution summary 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 this distribution summary is expected to observe.
      Returns:
      This builder.
      Since:
      1.3.10

    • distributionStatisticExpiry

      public DistributionSummary.Builder distributionStatisticExpiry(@Nullable Duration expiry)
      Statistics emanating from a distribution summary 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 distributionStatisticBufferLength(Integer).
      Parameters:
      expiry - The amount of time samples are accumulated to a histogram before it is reset and rotated.
      Returns:
      This builder.

    • distributionStatisticBufferLength

      public DistributionSummary.Builder distributionStatisticBufferLength(@Nullable Integer bufferLength)
      Statistics emanating from a distribution summary 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 distributionStatisticExpiry(Duration), with this buffer length.
      Parameters:
      bufferLength - The number of histograms to keep in the ring buffer.
      Returns:
      This builder.

    • scale

      public DistributionSummary.Builder scale(double scale)
      Multiply values recorded to the distribution summary by a scaling factor.
      Parameters:
      scale - Factor to scale each recorded value by.
      Returns:
      This builder.

    • withRegistry

      public Meter.MeterProvider<DistributionSummary> withRegistry(MeterRegistry registry)
      Convenience method to create meters from the builder that only differ in tags. This method can be used for dynamic tagging by creating the builder once and applying the dynamically changing tags using the returned Meter.MeterProvider.
      Parameters:
      registry - A registry to add the meter to, if it doesn't already exist.
      Returns:
      A Meter.MeterProvider that returns a meter based on the provided tags.
      Since:
      1.12.0

    • register

      public DistributionSummary register(MeterRegistry registry)
      Add the distribution summary to a single registry, or return an existing distribution summary in that registry. The returned distribution summary will be unique for each registry, but each registry is guaranteed to only create one distribution summary for the same combination of name and tags.
      Parameters:
      registry - A registry to add the distribution summary to, if it doesn't already exist.
      Returns:
      A new or existing distribution summary.