Module io.helidon.metrics.api

Package io.helidon.metrics.api

Interface DistributionSummary

All Superinterfaces:

Meter, 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 io.helidon.metrics.api.Meter

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

Method Summary

Modifier and Type	Method	Description
static DistributionSummary.Builder	builder(String name)	Creates a builder for a new DistributionSummary using default distribution statistics.
static DistributionSummary.Builder	builder(String name, DistributionStatisticsConfig.Builder configBuilder)	Creates a builder for a new DistributionSummary using the specified statistics builder.
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 io.helidon.metrics.api.Meter

baseUnit, description, id, scope, type

Methods inherited from interface io.helidon.metrics.api.Wrapper

unwrap

Method Details

builder

static DistributionSummary.Builder builder(String name,
 DistributionStatisticsConfig.Builder configBuilder)

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

For new code, prefer MetricsFactory.distributionSummaryBuilder(String, DistributionStatisticsConfig.Builder) on the MetricsFactory instance used by the application.

Parameters:

name - name for the summary

configBuilder - distribution stats config for the summary

Returns:

new builder

builder

static DistributionSummary.Builder builder(String name)

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

For new code, prefer MetricsFactory.distributionSummaryBuilder(String, DistributionStatisticsConfig.Builder) with a MetricsFactory.distributionStatisticsConfigBuilder() from the MetricsFactory instance used by the application.

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