Interface DistributionSummary

All Superinterfaces:

Meter, Wrapper, Wrapper

public interface DistributionSummary
extends Meter

Records a distribution of samples (e.g., sizes of responses returned by a server), each with a long value, and reports statistics over all samples (count, total, mean, max) as well as grouping samples using percentiles or bucket boundaries.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	DistributionSummary.Builder	Builder for a DistributionSummary.

Nested classes/interfaces inherited from interface Meter

Meter.BaseUnits, Meter.Id, Meter.Scope, Meter.Type

Modifier and Type	Interface	Description
static class	Meter.BaseUnits	Common unit declarations (inspired by the list from MicroProfile metrics).
static interface	Meter.Id	Unique idenfier for a meter.
static class	Meter.Scope	Deprecated, for removal: This API element is subject to removal in a future version. Core metrics ignores scope values, and this type will be removed.
static enum	Meter.Type	Type of meter.

Method Summary

Modifier and Type	Method	Description
static DistributionSummary.Builder	builder(String name)	Deprecated, for removal: This API element is subject to removal in a future version. this method uses service registry to get a MetricsFactory instance, which may be inefficient, use MetricsFactory.distributionSummaryBuilder(String, io.helidon.metrics.api.DistributionStatisticsConfig.Builder) instead
static DistributionSummary.Builder	builder(String name, DistributionStatisticsConfig.Builder configBuilder)	Deprecated, for removal: This API element is subject to removal in a future version. this method uses service registry to get a MetricsFactory instance, which may be inefficient, use MetricsFactory.distributionSummaryBuilder(String, io.helidon.metrics.api.DistributionStatisticsConfig.Builder) instead
long	count()	Returns the current count of observations in the distribution summary.
double	max()	Returns the maximum value among the observations recorded by the distribution summary.
double	mean()	Returns the mean of the observations recorded by the distribution summary.
void	record(double amount)	Updates the statistics kept by the summary with the specified amount.
HistogramSnapshot	snapshot()	Returns a HistogramSnapshot of the current state of the distribution summary.
double	totalAmount()	Returns the total of the observations recorded by the distribution summary.

Methods inherited from interface Meter

baseUnit, description, id, scope, type

Modifier and Type	Method	Description
Optional<String>	baseUnit()	Returns the meter's base unit.
Optional<String>	description()	Returns the meter's description.
Meter.Id	id()	Returns the meter ID.
default Optional<String>	scope()	Deprecated, for removal: This API element is subject to removal in a future version. Core metrics does not assign scopes, and this method will be removed.
Meter.Type	type()	Returns the meter type.

Methods inherited from interface Wrapper

unwrap

Modifier and Type	Method	Description
<T> T	unwrap(Class<? extends T> type)	Unwraps the delegate as the specified type.

Method Details

builder

@Deprecated(forRemoval=true,
            since="27.0.0")
static DistributionSummary.Builder builder(String name,
 DistributionStatisticsConfig.Builder configBuilder)

Deprecated, for removal: This API element is subject to removal in a future version.

this method uses service registry to get a MetricsFactory instance, which may be inefficient, use MetricsFactory.distributionSummaryBuilder(String, io.helidon.metrics.api.DistributionStatisticsConfig.Builder) instead

Creates a builder for a new DistributionSummary using the specified statistics builder.

Parameters:

name - name for the summary

configBuilder - distribution stats config for the summary

Returns:

new builder

builder

@Deprecated(forRemoval=true,
            since="27.0.0")
static DistributionSummary.Builder builder(String name)

Deprecated, for removal: This API element is subject to removal in a future version.

this method uses service registry to get a MetricsFactory instance, which may be inefficient, use MetricsFactory.distributionSummaryBuilder(String, io.helidon.metrics.api.DistributionStatisticsConfig.Builder) instead

Creates a builder for a new DistributionSummary using default distribution statistics.

Parameters:

name - name for the summary

Returns:

new builder

record

void record(double amount)

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

Parameters:

amount - Amount for an event being measured. For example, if the size in bytes of responses from a server. If the amount is less than 0 the value will be dropped.

count

long count()

Returns the current count of observations in the distribution summary.

Returns:

number of observations recorded in the summary

totalAmount

double totalAmount()

Returns the total of the observations recorded by the distribution summary.

Returns:

total across all recorded events

mean

double mean()

Returns the mean of the observations recorded by the distribution summary.

Returns:

average value of events recorded in the summary

max

double max()

Returns the maximum value among the observations recorded by the distribution summary.

Returns:

maximum value of recorded events

snapshot

HistogramSnapshot snapshot()

Returns a HistogramSnapshot of the current state of the distribution summary.

Returns:

snapshot