Interface Timer.Builder

All Superinterfaces:

Meter.Builder<Timer.Builder, Timer>, Wrapper, Wrapper

Enclosing interface:

Timer

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

Builder for a new Timer.

See Also:

• MeterRegistry.getOrCreate(Meter.Builder)

Method Summary

Modifier and Type	Method	Description
Timer.Builder	baseUnit(String baseUnit)	Units for the timer; developers are encouraged to use baseUnit(java.util.concurrent.TimeUnit) instead.
default Timer.Builder	baseUnit(TimeUnit baseUnit)	Units for the timer.
Iterable<Duration>	buckets()	Returns the bucket boundary values set in the builder, if any.
Timer.Builder	buckets(Duration... buckets)	Sets the boundary boundaries.
Optional<Duration>	maximumExpectedValue()	Returns the maximum expected value set in the builder, if any.
Timer.Builder	maximumExpectedValue(Duration max)	Sets the maximum expected value the timer is expected to record.
Optional<Duration>	minimumExpectedValue()	Returns the minimum expected value set in the builder, if any.
Timer.Builder	minimumExpectedValue(Duration min)	Sets the minimum expected value the timer is expected to record.
Iterable<Double>	percentiles()	Returns the percentiles set in the builder, if any.
Timer.Builder	percentiles(double... percentiles)	Sets the percentiles to compute and publish (expressing, for example, the 95th percentile as 0.95).
Optional<Boolean>	publishPercentileHistogram()	Returns the setting for publishing percentile histogram.
Timer.Builder	publishPercentileHistogram(boolean value)	Prepares the timer to publish a percentile histogram.

Methods inherited from interface Meter.Builder

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

Modifier and Type	Method	Description
Timer.Builder	addTag(Tag tag)	Adds a single tag to the builder's collection.
Optional<String>	baseUnit()	Returns the base unit the builder will use.
Optional<String>	description()	Returns the description the builder will use.
Timer.Builder	description(String description)	Sets the description.
default Timer.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 Timer.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 Timer.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.
Timer.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

baseUnit

Timer.Builder baseUnit(String baseUnit)

Units for the timer; developers are encouraged to use baseUnit(java.util.concurrent.TimeUnit) instead.

By convention and specification, Prometheus output always uses SECONDS. Helidon's JSON output honors the baseUnit setting if configuration so indicates, and Helidon requires the value to be one of the TimeUnit enum values. (See the Helidon SE metrics documentation about understanding the JSON metrics data format.)

Specified by:

baseUnit in interface Meter.Builder<Timer.Builder, Timer>

Parameters:

baseUnit - timer unit

Returns:

updated builder

baseUnit

default Timer.Builder baseUnit(TimeUnit baseUnit)

Units for the timer.

By convention and specification, Prometheus output always uses SECONDS. Helidon's JSON output honors the baseUnit setting if configuration so indicates. (See the Helidon SE metrics documentation about understanding the JSON metrics data format.)

Parameters:

baseUnit - timer unit

Returns:

updated builder

percentiles

Timer.Builder percentiles(double... percentiles)

Sets the percentiles to compute and publish (expressing, for example, the 95th percentile as 0.95).

Parameters:

percentiles - percentiles to compute and publish

Returns:

updated builder

buckets

Timer.Builder buckets(Duration... buckets)

Sets the boundary boundaries.

Parameters:

buckets - boundary boundaries

Returns:

updated builder

minimumExpectedValue

Timer.Builder minimumExpectedValue(Duration min)

Sets the minimum expected value the timer is expected to record.

Parameters:

min - minimum expected value

Returns:

updated builder

maximumExpectedValue

Timer.Builder maximumExpectedValue(Duration max)

Sets the maximum expected value the timer is expected to record.

Parameters:

max - maximum expected value

Returns:

updated builder

publishPercentileHistogram

Timer.Builder publishPercentileHistogram(boolean value)

Prepares the timer to publish a percentile histogram.

Parameters:

value - whether to publish a percentile histogram

Returns:

updated builder

percentiles

Iterable<Double> percentiles()

Returns the percentiles set in the builder, if any.

Returns:

percentiles

buckets

Iterable<Duration> buckets()

Returns the bucket boundary values set in the builder, if any.

Returns:

bucket boundary values

minimumExpectedValue

Optional<Duration> minimumExpectedValue()

Returns the minimum expected value set in the builder, if any.

Returns:

minimum expected value if set; empty otherwise

maximumExpectedValue

Optional<Duration> maximumExpectedValue()

Returns the maximum expected value set in the builder, if any.

Returns:

maximum expected value if set; empty otherwise

publishPercentileHistogram

Optional<Boolean> publishPercentileHistogram()

Returns the setting for publishing percentile histogram.

Returns:

whether to publish percentile histogram