Interface DistributionSummary.Builder

All Superinterfaces:

Meter.Builder<DistributionSummary.Builder, DistributionSummary>, Wrapper, Wrapper

Enclosing interface:

DistributionSummary

public static interface DistributionSummary.Builder
extends Meter.Builder<DistributionSummary.Builder, DistributionSummary>

Builder for a DistributionSummary.

See Also:

• MeterRegistry.getOrCreate(Meter.Builder)

Method Summary

Modifier and Type	Method	Description
Optional<DistributionStatisticsConfig.Builder>	distributionStatisticsConfig()	Returns the statistics config set on the builder, if any.
DistributionSummary.Builder	distributionStatisticsConfig(DistributionStatisticsConfig.Builder distributionStatisticsConfigBuilder)	Sets the config for distribution statistics for the distribution summary.
Optional<Boolean>	publishPercentileHistogram()	Returns whether to publsh percentile histogram.
DistributionSummary.Builder	publishPercentileHistogram(boolean value)	Sets whether to publish a percentile histogram.
Optional<Double>	scale()	Returns the scale set on the builder.
DistributionSummary.Builder	scale(double scale)	Sets the scale factor for observations recorded by the summary.

Methods inherited from interface Meter.Builder

addTag, baseUnit, baseUnit, description, description, identity, name, origin, origin, scope, scope, tags, tags

Modifier and Type	Method	Description
DistributionSummary.Builder	addTag(Tag tag)	Adds a single tag to the builder's collection.
Optional<String>	baseUnit()	Returns the base unit the builder will use.
DistributionSummary.Builder	baseUnit(String baseUnit)	Sets the units.
Optional<String>	description()	Returns the description the builder will use.
DistributionSummary.Builder	description(String description)	Sets the description.
default DistributionSummary.Builder	identity()	Returns the type-correct "this".
String	name()	Returns the name the builder will use.
default Optional<String>	origin()	Returns the fully-qualified name of the type which originated the meter, if set.
default DistributionSummary.Builder	origin(String origin)	Sets the fully-qualified name of the type which originated the meter.
default Optional<String>	scope()	Deprecated, for removal: This API element is subject to removal in a future version. Core metrics does not assign scopes, and this method will be removed.
default DistributionSummary.Builder	scope(String scope)	Deprecated, for removal: This API element is subject to removal in a future version. No-op, will be removed.
Map<String,String>	tags()	Returns the tags the builder will use.
DistributionSummary.Builder	tags(Iterable<Tag> tags)	Sets the tags to use in identifying the build meter.

Methods inherited from interface Wrapper

unwrap

Modifier and Type	Method	Description
<T> T	unwrap(Class<? extends T> type)	Unwraps the delegate as the specified type.

Method Details

scale

DistributionSummary.Builder scale(double scale)

Sets the scale factor for observations recorded by the summary.

Parameters:

scale - scaling factor to apply to each observation

Returns:

updated builder

distributionStatisticsConfig

DistributionSummary.Builder distributionStatisticsConfig(DistributionStatisticsConfig.Builder distributionStatisticsConfigBuilder)

Sets the config for distribution statistics for the distribution summary.

Parameters:

distributionStatisticsConfigBuilder - builder for the distribution statistics config

Returns:

updated builder

publishPercentileHistogram

DistributionSummary.Builder publishPercentileHistogram(boolean value)

Sets whether to publish a percentile histogram.

Parameters:

value - true/false

Returns:

updated builder

scale

Optional<Double> scale()

Returns the scale set on the builder.

Returns:

the scale

distributionStatisticsConfig

Optional<DistributionStatisticsConfig.Builder> distributionStatisticsConfig()

Returns the statistics config set on the builder, if any.

Returns:

distribution statistics config, if set; empty otherwise

publishPercentileHistogram

Optional<Boolean> publishPercentileHistogram()

Returns whether to publsh percentile histogram.

Returns:

true/false