Package org.forgerock.monitoring.api.instrument

Class FunctionCounter.Builder<T>

java.lang.Object
org.forgerock.monitoring.api.instrument.FunctionCounter.Builder<T>
Type Parameters:
T - The type of the state object from which the counter value is extracted.
Enclosing interface:
FunctionCounter
public static final class FunctionCounter.Builder<T> extends Object
Fluent builder for function counters.

  • Method Details

    • tags

      public FunctionCounter.Builder<T> tags(String... tags)
      Add tags to a FunctionCounter as an ellipsis of Tag.
      Parameters:
      tags - Must be an even number of arguments representing key/value pairs of tags.
      Returns:
      The function counter builder with added tags.

    • tags

      public FunctionCounter.Builder<T> tags(Iterable<Tag> tags)
      Add tags to a FunctionCounter in Iterable form.
      Parameters:
      tags - Tags to add to the eventual counter.
      Returns:
      The function counter builder with added tags.

    • tag

      public FunctionCounter.Builder<T> tag(String key, String value)
      Add String-value pair of tags to a FunctionCounter.
      Parameters:
      key - The tag key.
      value - The tag value.
      Returns:
      The function counter builder with a single added tag.

    • description

      public FunctionCounter.Builder<T> description(@Nullable String description)
      Associate a description with the FunctionCounter.
      Parameters:
      description - Description text of the eventual function counter.
      Returns:
      The function counter builder with added description.

    • baseUnit

      public FunctionCounter.Builder<T> baseUnit(@Nullable String unit)
      Associate a BaseUnit with the FunctionCounter.
      Parameters:
      unit - Base unit of the eventual counter.
      Returns:
      The function counter builder with added base unit.

    • hierarchicalName

      public FunctionCounter.Builder<T> hierarchicalName(String hierarchicalName)
      Set the hierarchical name of the FunctionCounter.
      Parameters:
      hierarchicalName - the hierarchical representation of the meter name.
      Returns:
      The function counter builder with added hierarchical name.

    • register

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