Package io.micrometer.core.instrument.cumulative

Class CumulativeFunctionTimer<T>

java.lang.Object

io.micrometer.core.instrument.AbstractMeter

io.micrometer.core.instrument.cumulative.CumulativeFunctionTimer<T>

All Implemented Interfaces:

FunctionTimer, Meter

public class CumulativeFunctionTimer<T>
extends AbstractMeter
implements FunctionTimer

A timer that tracks monotonically increasing functions for count and totalTime.

Nested Class Summary

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

FunctionTimer.Builder<T>

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

Meter.Builder, Meter.Id, Meter.MeterProvider<T extends Meter>, Meter.Type

Constructor Summary

Constructors

Constructor	Description
CumulativeFunctionTimer(Meter.Id id, T obj, ToLongFunction<T> countFunction, ToDoubleFunction<T> totalTimeFunction, TimeUnit totalTimeFunctionUnit, TimeUnit baseTimeUnit)

Method Summary

Modifier and Type	Method	Description
TimeUnit	baseTimeUnit()
double	count()	The total number of occurrences of the timed event.
double	totalTime(TimeUnit unit)	The total time of all occurrences of the timed event.
Meter.Type	type()

Methods inherited from class io.micrometer.core.instrument.AbstractMeter

equals, getId, hashCode

Methods inherited from class java.lang.Object

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

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

mean, measure

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

close, getId, match, use

Constructor Details

CumulativeFunctionTimer

public CumulativeFunctionTimer(Meter.Id id,
 T obj,
 ToLongFunction<T> countFunction,
 ToDoubleFunction<T> totalTimeFunction,
 TimeUnit totalTimeFunctionUnit,
 TimeUnit baseTimeUnit)

Method Details

count

public double count()

The total number of occurrences of the timed event.

Specified by:

count in interface FunctionTimer

Returns:

The total number of occurrences of the timed event.

totalTime

public double totalTime(TimeUnit unit)

The total time of all occurrences of the timed event.

Specified by:

totalTime in interface FunctionTimer

Parameters:

unit - The base unit of time to scale the total to.

Returns:

The total time of all occurrences of the timed event.

baseTimeUnit

public TimeUnit baseTimeUnit()

Specified by:

baseTimeUnit in interface FunctionTimer

Returns:

The base time unit of the timer to which all published metrics will be scaled

type

public Meter.Type type()