org.springframework.metrics.instrument

Interface DistributionSummary

All Superinterfaces:

Meter

All Known Implementing Classes:

PrometheusDistributionSummary, SimpleDistributionSummary, SpectatorDistributionSummary

public interface DistributionSummary
extends Meter

Track the sample distribution of events. An example would be the response sizes for requests hitting and http server.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DistributionSummary.Builder

Nested classes/interfaces inherited from interface org.springframework.metrics.instrument.Meter

Meter.Type

Method Summary

Modifier and Type	Method and Description
long	count() The number of times that record has been called since this timer was created.
default Meter.Type	getType()
void	record(double amount) Updates the statistics kept by the summary with the specified amount.
double	totalAmount() The total amount of all recorded events since this summary was created.

Methods inherited from interface org.springframework.metrics.instrument.Meter

getName, getTags, measure

Method Detail

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()

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

totalAmount

double totalAmount()

The total amount of all recorded events since this summary was created.

getType

default Meter.Type getType()

Specified by:

getType in interface Meter