io.micrometer.core.instrument

Class Gauge.Builder<T>

java.lang.Object

io.micrometer.core.instrument.Gauge.Builder<T>

Type Parameters:

T - The type of the state object from which the gauge value is extracted.

Enclosing interface:

Gauge

public static class Gauge.Builder<T>
extends java.lang.Object

Fluent builder for gauges.

Method Summary

Modifier and Type	Method and Description
Gauge.Builder<T>	baseUnit(java.lang.String unit)
Gauge.Builder<T>	description(java.lang.String description)
Gauge	register(MeterRegistry registry) Add the gauge to a single registry, or return an existing gauge in that registry.
Gauge.Builder<T>	tag(java.lang.String key, java.lang.String value)
Gauge.Builder<T>	tags(java.lang.Iterable<Tag> tags)
Gauge.Builder<T>	tags(java.lang.String... tags)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

tags

public Gauge.Builder<T> tags(java.lang.String... tags)

Parameters:

tags - Must be an even number of arguments representing key/value pairs of tags.

Returns:

The gauge builder with added tags.

tags

public Gauge.Builder<T> tags(java.lang.Iterable<Tag> tags)

Parameters:

tags - Tags to add to the eventual meter.

Returns:

The gauge builder with added tags.

tag

public Gauge.Builder<T> tag(java.lang.String key,
                            java.lang.String value)

Parameters:

key - The tag key.

value - The tag value.

Returns:

The gauge builder with a single added tag.

description

public Gauge.Builder<T> description(@Nullable
                                    java.lang.String description)

Parameters:

description - Description text of the eventual gauge.

Returns:

The gauge builder with added description.

baseUnit

public Gauge.Builder<T> baseUnit(@Nullable
                                 java.lang.String unit)

Parameters:

unit - Base unit of the eventual gauge.

Returns:

The gauge builder with added base unit.

register

public Gauge register(MeterRegistry registry)

Add the gauge to a single registry, or return an existing gauge in that registry. The returned gauge will be unique for each registry, but each registry is guaranteed to only create one gauge for the same combination of name and tags.

Parameters:

registry - A registry to add the gauge to, if it doesn't already exist.

Returns:

A new or existing gauge.