MultiGauge.Builder (micrometer-core 1.5.3 API)

java.lang.Object

io.micrometer.core.instrument.MultiGauge.Builder

Enclosing class:: MultiGauge

public static class MultiGauge.Builder
extends java.lang.Object

Fluent builder for multi-gauges.

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Details
- tags
  
  public MultiGauge.Builder 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 MultiGauge.Builder tags(java.lang.Iterable<Tag> tags)
  
  Parameters:
  
  tags - Tags to add to the eventual gauge.
  
  Returns:
  
  The gauge builder with added tags.
- tag
  
  public MultiGauge.Builder 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 MultiGauge.Builder description(@Nullable java.lang.String description)
  
  Parameters:
  
  description - Description text of the eventual gauge.
  
  Returns:
  
  The gauge builder with added description.
- baseUnit
  
  public MultiGauge.Builder baseUnit(@Nullable java.lang.String unit)
  
  Parameters:
  
  unit - Base unit of the eventual gauge.
  
  Returns:
  
  The gauge builder with added base unit.
- register
  
  public MultiGauge register(MeterRegistry registry)