org.ballerinalang.util.metrics

Interface Summary

All Superinterfaces:

Metric

All Known Implementing Classes:

NoOpSummary

public interface Summary
extends Metric

Track the sample distribution of events.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Summary.Builder Builder for Summarys.

Method Summary

Modifier and Type	Method and Description
static Summary.Builder	builder(String name) Create new builder for Summary.
long	count()
double	max()
double	mean()
double	percentile(double percentile)
void	record(double amount) Updates the statistics kept by the summary with the specified amount.

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

getId

Method Detail

builder

static Summary.Builder builder(String name)

Create new builder for Summary.

Parameters:

name - The name of the metric.

Returns:

The builder for Summary.

record

void record(double amount)

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

Parameters:

amount - Amount for an event being measured.

count

long count()

Returns:

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

mean

double mean()

Returns:

The distribution average for all recorded events.

max

double max()

Returns:

The maximum time of a single event.

percentile

double percentile(double percentile)

Parameters:

percentile - A percentile in the domain [0, 1]. For example, 0.5 represents the 50th percentile of the distribution.

Returns:

The value at a specific percentile. This value is non-aggregable across dimensions.