Package de.iip_ecosphere.platform.support.metrics

Interface MetricsBuilder<M extends Meter,B extends MetricsBuilder<M,B>>

Type Parameters:
B - the builder type
All Known Subinterfaces:
Counter.CounterBuilder, Gauge.GaugeBuilder<T>, Timer.TimerBuilder
public interface MetricsBuilder<M extends Meter,B extends MetricsBuilder<M,B>>
Builder interface.
Author:
Holger Eichelberger, SSE

  • Method Summary

    Modifier and Type
    Method
    Description
    B
    description(String description)
    Adds a description to the object to build.
    M
    register(MeterRegistry registry)
    Add the meter to be built to a single registry, or returns an meter in that registry.
    B
    tags(String... tags)
    Adds tags to the object to build.

  • Method Details

    • tags

      B tags(String... tags)
      Adds tags to the object to build.
      Parameters:
      tags - must be an even number of arguments representing key/value pairs of tags
      Returns:
      this for chaining

    • description

      B description(String description)
      Adds a description to the object to build.
      Parameters:
      description - Description text of the eventual timer, may be null.
      Returns:
      this for chaining

    • register

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