Package io.prometheus.metrics.core.metrics

Class Summary.Builder

Object

MetricWithFixedMetadata.Builder<Summary.Builder,Summary>

Builder

Enclosing class:

Summary

public static class Summary.Builder
extends MetricWithFixedMetadata.Builder<Summary.Builder,Summary>

Field Summary

Fields

Modifier and Type	Field	Description
static final long	DEFAULT_MAX_AGE_SECONDS	5 minutes.
static final int	DEFAULT_NUMBER_OF_AGE_BUCKETS	5.

Method Summary

Modifier and Type	Method	Description
Summary	build()
MetricsProperties	getDefaultProperties()	Default properties for summary metrics.
Summary.Builder	maxAgeSeconds(long maxAgeSeconds)	The quantiles are relative to a moving time window.
Summary.Builder	numberOfAgeBuckets(int ageBuckets)	The quantiles are relative to a moving time window.
Summary.Builder	quantile(double quantile)	Add a quantile.
Summary.Builder	quantile(double quantile, double error)	Add a quantile.
Summary.Builder	withExemplars()	Allow Exemplars for this metric.
Summary.Builder	withoutExemplars()	Turn off Exemplars for this metric.

Methods inherited from class MetricWithFixedMetadata.Builder

constLabels, help, labelNames, name, unit

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_MAX_AGE_SECONDS

public static final long DEFAULT_MAX_AGE_SECONDS

5 minutes. See maxAgeSeconds(long).

DEFAULT_NUMBER_OF_AGE_BUCKETS

public static final int DEFAULT_NUMBER_OF_AGE_BUCKETS

5. See numberOfAgeBuckets(int)

See Also:

• Constant Field Values

Method Details

quantile

public Summary.Builder quantile(double quantile)

Add a quantile. See quantile(double, double).

Default errors are:

• error = 0.001 if quantile <= 0.01 or quantile >= 0.99
• error = 0.005 if quantile <= 0.02 or quantile >= 0.98
• error = 0.01 else.

quantile

public Summary.Builder quantile(double quantile,
 double error)

Add a quantile. Call multiple times to add multiple quantiles.

Example: The following will track the 0.95 quantile:

 .quantile(0.95, 0.001)
 

The second argument is the acceptable error margin, i.e. with the code above the quantile will not be exactly the 0.95 quantile but something between 0.949 and 0.951.

There are two special cases:

• .quantile(0.0, 0.0) gives you the minimum observed value
• .quantile(1.0, 0.0) gives you the maximum observed value

maxAgeSeconds

public Summary.Builder maxAgeSeconds(long maxAgeSeconds)

The quantiles are relative to a moving time window. maxAgeSeconds is the size of that time window. Default is DEFAULT_MAX_AGE_SECONDS.

numberOfAgeBuckets

public Summary.Builder numberOfAgeBuckets(int ageBuckets)

The quantiles are relative to a moving time window. The numberOfAgeBuckets defines how smoothly the time window moves forward. For example, if the time window is 5 minutes and has 5 age buckets, then it is moving forward every minute by one minute. Default is DEFAULT_NUMBER_OF_AGE_BUCKETS.

getDefaultProperties

public MetricsProperties getDefaultProperties()

Default properties for summary metrics.

build

public Summary build()

Specified by:

build in class MetricWithFixedMetadata.Builder<Summary.Builder,Summary>

withExemplars

public Summary.Builder withExemplars()

Allow Exemplars for this metric.

withoutExemplars

public Summary.Builder withoutExemplars()

Turn off Exemplars for this metric.