public static class DistributionSummary.Builder
extends java.lang.Object
Modifier and Type | Method and Description |
---|---|
DistributionSummary.Builder |
baseUnit(java.lang.String unit) |
DistributionSummary.Builder |
description(java.lang.String description) |
DistributionSummary.Builder |
distributionStatisticBufferLength(java.lang.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).
|
DistributionSummary.Builder |
distributionStatisticExpiry(java.time.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).
|
DistributionSummary.Builder |
maximumExpectedValue(java.lang.Double max)
Sets the maximum value that this distribution summary is expected to observe.
|
DistributionSummary.Builder |
maximumExpectedValue(java.lang.Long max)
Deprecated.
Use
maximumExpectedValue(Double) instead since 1.4.0. |
DistributionSummary.Builder |
minimumExpectedValue(java.lang.Double min)
Sets the minimum value that this distribution summary is expected to observe.
|
DistributionSummary.Builder |
minimumExpectedValue(java.lang.Long min)
Deprecated.
Use
minimumExpectedValue(Double) instead since 1.4.0. |
DistributionSummary.Builder |
percentilePrecision(java.lang.Integer digitsOfPrecision)
Determines the number of digits of precision to maintain on the dynamic range histogram used to compute
percentile approximations.
|
DistributionSummary.Builder |
publishPercentileHistogram()
Adds histogram buckets used to generate aggregable percentile approximations in monitoring
systems that have query facilities to do so (e.g.
|
DistributionSummary.Builder |
publishPercentileHistogram(java.lang.Boolean enabled)
Adds histogram buckets used to generate aggregable percentile approximations in monitoring
systems that have query facilities to do so (e.g.
|
DistributionSummary.Builder |
publishPercentiles(double... percentiles)
Produces an additional time series for each requested percentile.
|
DistributionSummary |
register(MeterRegistry registry)
Add the distribution summary to a single registry, or return an existing distribution summary in that registry.
|
DistributionSummary.Builder |
scale(double scale)
Multiply values recorded to the distribution summary by a scaling factor.
|
DistributionSummary.Builder |
serviceLevelObjectives(double... slos)
Publish at a minimum a histogram containing your defined service level objective (SLO) boundaries.
|
DistributionSummary.Builder |
sla(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. |
DistributionSummary.Builder |
sla(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. |
DistributionSummary.Builder |
tag(java.lang.String key,
java.lang.String value) |
DistributionSummary.Builder |
tags(java.lang.Iterable<Tag> tags) |
DistributionSummary.Builder |
tags(java.lang.String... tags) |
public DistributionSummary.Builder tags(java.lang.String... tags)
tags
- Must be an even number of arguments representing key/value pairs of tags.public DistributionSummary.Builder tags(java.lang.Iterable<Tag> tags)
tags
- Tags to add to the eventual distribution summary.public DistributionSummary.Builder tag(java.lang.String key, java.lang.String value)
key
- The tag key.value
- The tag value.public DistributionSummary.Builder description(@Nullable java.lang.String description)
description
- Description text of the eventual distribution summary.public DistributionSummary.Builder baseUnit(@Nullable java.lang.String unit)
unit
- Base unit of the eventual distribution summary.public DistributionSummary.Builder publishPercentiles(@Nullable double... percentiles)
publishPercentileHistogram()
to publish a histogram that can be used to generate aggregable percentile approximations.percentiles
- Percentiles to compute and publish. The 95th percentile should be expressed as 0.95
.public DistributionSummary.Builder percentilePrecision(@Nullable java.lang.Integer digitsOfPrecision)
digitsOfPrecision
- The digits of precision to maintain for percentile approximations.public DistributionSummary.Builder publishPercentileHistogram()
histogram_quantile
,
Atlas' :percentiles
).public DistributionSummary.Builder publishPercentileHistogram(@Nullable java.lang.Boolean enabled)
histogram_quantile
,
Atlas' :percentiles
).enabled
- Determines whether percentile histograms should be published.@Deprecated public DistributionSummary.Builder sla(@Nullable long... sla)
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.Timer.Builder.publishPercentileHistogram()
, the boundaries defined
here are included alongside other buckets used to generate aggregable percentile approximations.sla
- Publish SLO boundaries in the set of histogram buckets shipped to the monitoring system.@Deprecated public DistributionSummary.Builder sla(@Nullable double... sla)
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.Timer.Builder.publishPercentileHistogram()
, the boundaries defined
here are included alongside other buckets used to generate aggregable percentile approximations.sla
- Publish SLO boundaries in the set of histogram buckets shipped to the monitoring system.public DistributionSummary.Builder serviceLevelObjectives(@Nullable double... slos)
Timer.Builder.publishPercentileHistogram()
, the boundaries defined
here are included alongside other buckets used to generate aggregable percentile approximations.slos
- Publish SLO boundaries in the set of histogram buckets shipped to the monitoring system.@Deprecated public DistributionSummary.Builder minimumExpectedValue(@Nullable java.lang.Long min)
minimumExpectedValue(Double)
instead since 1.4.0.min
- The minimum value that this distribution summary is expected to observe.public DistributionSummary.Builder minimumExpectedValue(@Nullable java.lang.Double min)
min
- The minimum value that this distribution summary is expected to observe.@Deprecated public DistributionSummary.Builder maximumExpectedValue(@Nullable java.lang.Long max)
maximumExpectedValue(Double)
instead since 1.4.0.max
- The maximum value that this distribution summary is expected to observe.public DistributionSummary.Builder maximumExpectedValue(@Nullable java.lang.Double max)
max
- The maximum value that this distribution summary is expected to observe.public DistributionSummary.Builder distributionStatisticExpiry(@Nullable java.time.Duration expiry)
distributionStatisticBufferLength(Integer)
.expiry
- The amount of time samples are accumulated to a histogram before it is reset and rotated.public DistributionSummary.Builder distributionStatisticBufferLength(@Nullable java.lang.Integer bufferLength)
distributionStatisticExpiry(Duration)
, with this buffer length.bufferLength
- The number of histograms to keep in the ring buffer.public DistributionSummary.Builder scale(double scale)
scale
- Factor to scale each recorded value by.public DistributionSummary register(MeterRegistry registry)
registry
- A registry to add the distribution summary to, if it doesn't already exist.