Package io.micrometer.core.instrument

Interface TimeGauge

All Superinterfaces:
Gauge, Meter
All Known Implementing Classes:
NoopTimeGauge
public interface TimeGauge
extends Gauge
A specialized gauge that tracks a time value, to be scaled to the base unit of time expected by each registry implementation.

  • Nested Class Summary

    Nested Classes
    Modifier and Type Interface Description
    static class  TimeGauge.Builder<T>
    Fluent builder for time gauges.

    Nested classes/interfaces inherited from interface io.micrometer.core.instrument.Meter

    Meter.Id, Meter.Type

  • Method Summary

    Modifier and Type Method Description
    java.util.concurrent.TimeUnit baseTimeUnit()  
    static TimeGauge.Builder<java.util.function.Supplier<java.lang.Number>> builder​(java.lang.String name, java.util.function.Supplier<java.lang.Number> f, java.util.concurrent.TimeUnit fUnits)
    A convenience method for building a time gauge from a supplying function, holding a strong reference to this function.
    static <T> TimeGauge.Builder<T> builder​(java.lang.String name, T obj, java.util.concurrent.TimeUnit fUnits, java.util.function.ToDoubleFunction<T> f)  
    default double value​(java.util.concurrent.TimeUnit unit)
    The act of observing the value by calling this method triggers sampling of the underlying number or user-defined function that defines the value for the gauge.

    Methods inherited from interface io.micrometer.core.instrument.Gauge

    measure, value

    Methods inherited from interface io.micrometer.core.instrument.Meter

    close, getId, match, use

  • Method Details

    • builder

      static <T> TimeGauge.Builder<T> builder​(java.lang.String name, @Nullable T obj, java.util.concurrent.TimeUnit fUnits, java.util.function.ToDoubleFunction<T> f)

    • builder

      @Incubating(since="1.7.0") static TimeGauge.Builder<java.util.function.Supplier<java.lang.Number>> builder​(java.lang.String name, java.util.function.Supplier<java.lang.Number> f, java.util.concurrent.TimeUnit fUnits)
      A convenience method for building a time gauge from a supplying function, holding a strong reference to this function.
      Parameters:
      name - The time gauge's name.
      f - A function that yields a double value for the time gauge.
      fUnits - time unit
      Returns:
      A new time gauge builder.
      Since:
      1.7.0

    • baseTimeUnit

      java.util.concurrent.TimeUnit baseTimeUnit()
      Returns:
      The base time unit of the timer to which all published metrics will be scaled

    • value

      default double value​(java.util.concurrent.TimeUnit unit)
      The act of observing the value by calling this method triggers sampling of the underlying number or user-defined function that defines the value for the gauge.
      Parameters:
      unit - The base unit of time to scale the value to.
      Returns:
      The current value, scaled to the appropriate base unit.