Package org.forgerock.monitoring.api.instrument

Class TimeGauge.Builder<T>

java.lang.Object
org.forgerock.monitoring.api.instrument.TimeGauge.Builder<T>
Enclosing interface:
TimeGauge
public static class TimeGauge.Builder<T> extends Object
Fluent builder for time gauges.

  • Method Details

    • tags

      public TimeGauge.Builder<T> tags(String... tags)
      Parameters:
      tags - Must be an even number of arguments representing key/value pairs of tags.
      Returns:
      The time gauge builder with added tags.

    • tags

      public TimeGauge.Builder<T> tags(Iterable<Tag> tags)
      Parameters:
      tags - Tags to add to the eventual meter.
      Returns:
      The time gauge builder with added tags.

    • tag

      public TimeGauge.Builder<T> tag(String key, String value)
      Parameters:
      key - The tag key.
      value - The tag value.
      Returns:
      The time gauge builder with a single added tag.

    • description

      public TimeGauge.Builder<T> description(@Nullable String description)
      Parameters:
      description - Description text of the eventual time gauge.
      Returns:
      The time gauge builder with added description.

    • hierarchicalName

      public TimeGauge.Builder hierarchicalName(String hierarchicalName)
      Parameters:
      hierarchicalName - the hierarchical representation of the meter name
      Returns:
      The time gauge builder with added hierarchical name.

    • register

      public TimeGauge register(MeterRegistry registry)
      Add the time gauge to a single registry, or return an existing time gauge in that registry. The returned time gauge will be unique for each registry, but each registry is guaranteed to only create one time gauge for the same combination of name and tags.
      Parameters:
      registry - A registry to add the time gauge to, if it doesn't already exist.
      Returns:
      A new or existing time gauge.