Package io.micrometer.core.instrument
Interface DistributionSummary
-
- All Superinterfaces:
HistogramSupport
,Meter
- All Known Implementing Classes:
AbstractDistributionSummary
,CumulativeDistributionSummary
,DropwizardDistributionSummary
,NoopDistributionSummary
,StepDistributionSummary
public interface DistributionSummary extends Meter, HistogramSupport
Track the sample distribution of events. An example would be the response sizes for requests hitting an http server.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
DistributionSummary.Builder
Fluent builder for distribution summaries.-
Nested classes/interfaces inherited from interface io.micrometer.core.instrument.Meter
Meter.Id, Meter.Type
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description static DistributionSummary.Builder
builder(java.lang.String name)
long
count()
default double
histogramCountAtValue(long value)
Deprecated.UseHistogramSupport.takeSnapshot()
to retrieve bucket counts.double
max()
default double
mean()
default java.lang.Iterable<Measurement>
measure()
Get a set of measurements.default double
percentile(double percentile)
Deprecated.UseHistogramSupport.takeSnapshot()
to retrieve percentiles.void
record(double amount)
Updates the statistics kept by the summary with the specified amount.double
totalAmount()
-
Methods inherited from interface io.micrometer.core.instrument.distribution.HistogramSupport
takeSnapshot, takeSnapshot
-
-
-
-
Method Detail
-
builder
static DistributionSummary.Builder builder(java.lang.String name)
-
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 number of times that record has been called since this timer was created.
-
totalAmount
double totalAmount()
- Returns:
- The total amount of all recorded events.
-
mean
default double mean()
- Returns:
- The distribution average for all recorded events.
-
max
double max()
- Returns:
- The maximum time of a single event.
-
histogramCountAtValue
@Deprecated default double histogramCountAtValue(long value)
Deprecated.UseHistogramSupport.takeSnapshot()
to retrieve bucket counts.Provides cumulative histogram counts.- Parameters:
value
- The histogram bucket to retrieve a count for.- Returns:
- The count of all events less than or equal to the bucket. If value does not match a preconfigured bucket boundary, returns NaN.
-
percentile
@Deprecated default double percentile(double percentile)
Deprecated.UseHistogramSupport.takeSnapshot()
to retrieve percentiles.- Parameters:
percentile
- A percentile in the domain [0, 1]. For example, 0.5 represents the 50th percentile of the distribution.- Returns:
- The latency at a specific percentile. This value is non-aggregable across dimensions. Returns NaN if percentile is not a preconfigured percentile that Micrometer is tracking.
-
measure
default java.lang.Iterable<Measurement> measure()
Description copied from interface:Meter
Get a set of measurements. Should always return the same number of measurements and in the same order, regardless of the level of activity or the lack thereof.
-
-