io.micrometer.core.instrument.cumulative

Class CumulativeFunctionTimer<T>

java.lang.Object

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

All Implemented Interfaces:

FunctionTimer, Meter

public class CumulativeFunctionTimer<T>
extends Object
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.Id, Meter.Type

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

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

builder, mean, measure

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

builder, close, match, use

Constructor Detail

CumulativeFunctionTimer

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

Method Detail

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.

getId

public Meter.Id getId()

Specified by:

getId in interface Meter

Returns:

A unique combination of name and tags

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()