Package io.micrometer.core.instrument.internal

Class DefaultLongTaskTimer

java.lang.Object

io.micrometer.core.instrument.AbstractMeter

io.micrometer.core.instrument.internal.DefaultLongTaskTimer

All Implemented Interfaces:

HistogramSupport, LongTaskTimer, Meter

Direct Known Subclasses:

CumulativeHistogramLongTaskTimer

public class DefaultLongTaskTimer
extends AbstractMeter
implements LongTaskTimer

Nested Class Summary

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

LongTaskTimer.Builder, LongTaskTimer.Sample

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
DefaultLongTaskTimer(Meter.Id id, Clock clock)	Deprecated. Use DefaultLongTaskTimer(Meter.Id, Clock, TimeUnit, DistributionStatisticConfig, boolean) instead.
DefaultLongTaskTimer(Meter.Id id, Clock clock, TimeUnit baseTimeUnit, DistributionStatisticConfig distributionStatisticConfig, boolean supportsAggregablePercentiles)	Create a DefaultLongTaskTimer instance.

Method Summary

Modifier and Type	Method	Description
int	activeTasks()
TimeUnit	baseTimeUnit()
double	duration(TimeUnit unit)
protected void	forEachActive(Consumer<LongTaskTimer.Sample> sample)
double	max(TimeUnit unit)	The amount of time the longest running task has been running
LongTaskTimer.Sample	start()	Start keeping time for a task.
HistogramSnapshot	takeSnapshot()	Summary statistics should be published off of a single snapshot instance so that, for example, there isn't disagreement between the distribution's bucket counts because more events continue to stream in.

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.distribution.HistogramSupport

takeSnapshot

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

duration, mean, measure, record, record, record, record, record, record, record, recordCallable, stop

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

close, getId, match, use

Constructor Details

DefaultLongTaskTimer

@Deprecated
public DefaultLongTaskTimer(Meter.Id id,
 Clock clock)

Deprecated.

Use DefaultLongTaskTimer(Meter.Id, Clock, TimeUnit, DistributionStatisticConfig, boolean) instead.

Create a DefaultLongTaskTimer instance.

Parameters:

id - ID

clock - clock

DefaultLongTaskTimer

public DefaultLongTaskTimer(Meter.Id id,
 Clock clock,
 TimeUnit baseTimeUnit,
 DistributionStatisticConfig distributionStatisticConfig,
 boolean supportsAggregablePercentiles)

Create a DefaultLongTaskTimer instance.

Parameters:

id - ID

clock - clock

baseTimeUnit - base time unit

distributionStatisticConfig - distribution statistic configuration

supportsAggregablePercentiles - whether it supports aggregable percentiles

Since:

1.5.0

Method Details

start

public LongTaskTimer.Sample start()

Description copied from interface: LongTaskTimer

Start keeping time for a task.

Specified by:

start in interface LongTaskTimer

Returns:

A task id that can be used to look up how long the task has been running.

duration

public double duration(TimeUnit unit)

Specified by:

duration in interface LongTaskTimer

Parameters:

unit - The time unit to scale the duration to.

Returns:

The cumulative duration of all current tasks.

max

public double max(TimeUnit unit)

Description copied from interface: LongTaskTimer

The amount of time the longest running task has been running

Specified by:

max in interface LongTaskTimer

Parameters:

unit - The time unit to scale the max to.

Returns:

The maximum active task duration.

activeTasks

public int activeTasks()

Specified by:

activeTasks in interface LongTaskTimer

Returns:

The current number of tasks being executed.

forEachActive

protected void forEachActive(Consumer<LongTaskTimer.Sample> sample)

baseTimeUnit

public TimeUnit baseTimeUnit()

Specified by:

baseTimeUnit in interface LongTaskTimer

Returns:

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

takeSnapshot

public HistogramSnapshot takeSnapshot()

Description copied from interface: HistogramSupport

Summary statistics should be published off of a single snapshot instance so that, for example, there isn't disagreement between the distribution's bucket counts because more events continue to stream in.

Specified by:

takeSnapshot in interface HistogramSupport

Returns:

A snapshot of all distribution statistics at a point in time.