org.ballerinalang.util.metrics

Interface Timer

All Superinterfaces:

Metric

All Known Implementing Classes:

NoOpTimer

public interface Timer
extends Metric

Track the duration distribution of events.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Timer.Builder Builder for Timers.

Method Summary

Modifier and Type	Method and Description
static Timer.Builder	builder(String name) Create new builder for Timer.
long	count()
double	max(TimeUnit unit)
double	mean(TimeUnit unit)
SortedMap<Double,Double>	percentileValues(TimeUnit unit) Return a sorted map of latencies at specific percentiles.
default void	record(Duration duration) Updates the statistics kept by the counter with the specified amount.
void	record(long amount, TimeUnit unit) Updates the statistics kept by the timer with the specified amount.

Methods inherited from interface org.ballerinalang.util.metrics.Metric

getId

Method Detail

builder

static Timer.Builder builder(String name)

Create new builder for Timer.

Parameters:

name - The name of the metric.

Returns:

The builder for Timer.

record

void record(long amount,
            TimeUnit unit)

Updates the statistics kept by the timer with the specified amount.

Parameters:

amount - Duration of a single event being measured by this timer.

unit - Time unit for the amount being recorded.

record

default void record(Duration duration)

Updates the statistics kept by the counter with the specified amount.

Parameters:

duration - Duration of a single event being measured by this timer.

count

long count()

Returns:

The number of times that record has been called since this timer was created.

mean

double mean(TimeUnit unit)

Parameters:

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

Returns:

The distribution average for all recorded events.

max

double max(TimeUnit unit)

Parameters:

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

Returns:

The maximum time of a single event.

percentileValues

SortedMap<Double,Double> percentileValues(TimeUnit unit)

Return a sorted map of latencies at specific percentiles. The percentile is the key, which is in the domain [0, 1]. For example, 0.5 represents the 50th percentile of the distribution. The keys will be specific to underlying implementation. These value are non-aggregable across dimensions.

Parameters:

unit - The base unit of time to scale the percentile value to.

Returns:

A map of latencies at specific percentiles.