io.micrometer.core.instrument

Class MultiGauge.Builder

java.lang.Object

io.micrometer.core.instrument.MultiGauge.Builder

Enclosing class:

MultiGauge

public static class MultiGauge.Builder
extends Object

Fluent builder for multi-gauges.

Method Summary

Modifier and Type	Method and Description
MultiGauge.Builder	baseUnit(String unit)
MultiGauge.Builder	description(String description)
MultiGauge	register(MeterRegistry registry)
MultiGauge.Builder	tag(String key, String value)
MultiGauge.Builder	tags(Iterable<Tag> tags)
MultiGauge.Builder	tags(String... tags)

Methods inherited from class java.lang.Object

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

Method Detail

tags

public MultiGauge.Builder tags(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 MultiGauge.Builder tags(Iterable<Tag> tags)

Parameters:

tags - Tags to add to the eventual gauge.

Returns:

The gauge builder with added tags.

tag

public MultiGauge.Builder tag(String key,
                              String value)

Parameters:

key - The tag key.

value - The tag value.

Returns:

The gauge builder with a single added tag.

description

public MultiGauge.Builder description(@Nullable
                                      String description)

Parameters:

description - Description text of the eventual gauge.

Returns:

The gauge builder with added description.

baseUnit

public MultiGauge.Builder baseUnit(@Nullable
                                   String unit)

Parameters:

unit - Base unit of the eventual gauge.

Returns:

The gauge builder with added base unit.

register

public MultiGauge register(MeterRegistry registry)