Package io.prometheus.metrics.config

Class ExemplarsProperties

java.lang.Object

io.prometheus.metrics.config.ExemplarsProperties

public class ExemplarsProperties
extends Object

Properties starting with io.prometheus.exemplars

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExemplarsProperties.Builder

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	MAX_RETENTION_PERIOD_SECONDS
private final Integer	maxRetentionPeriodSeconds
private static final String	MIN_RETENTION_PERIOD_SECONDS
private final Integer	minRetentionPeriodSeconds
private static final String	PREFIX
private static final String	SAMPLE_INTERVAL_MILLISECONDS
private final Integer	sampleIntervalMilliseconds

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ExemplarsProperties(Integer minRetentionPeriodSeconds, Integer maxRetentionPeriodSeconds, Integer sampleIntervalMilliseconds)

Method Summary

Modifier and Type	Method	Description
static ExemplarsProperties.Builder	builder()
Integer	getMaxRetentionPeriodSeconds()	Maximum time how long Exemplars are kept before they are evicted.
Integer	getMinRetentionPeriodSeconds()	Minimum time how long Exemplars are kept before they may be replaced by new Exemplars.
Integer	getSampleIntervalMilliseconds()	Time between attempts to sample new Exemplars.
(package private) static ExemplarsProperties	load(PropertySource propertySource)	Note that this will remove entries from propertySource.

Methods inherited from class java.lang.Object

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

Field Details

PREFIX

private static final String PREFIX

See Also:

• Constant Field Values

MIN_RETENTION_PERIOD_SECONDS

private static final String MIN_RETENTION_PERIOD_SECONDS

See Also:

• Constant Field Values

MAX_RETENTION_PERIOD_SECONDS

private static final String MAX_RETENTION_PERIOD_SECONDS

See Also:

• Constant Field Values

SAMPLE_INTERVAL_MILLISECONDS

private static final String SAMPLE_INTERVAL_MILLISECONDS

See Also:

• Constant Field Values

minRetentionPeriodSeconds

private final Integer minRetentionPeriodSeconds

maxRetentionPeriodSeconds

private final Integer maxRetentionPeriodSeconds

sampleIntervalMilliseconds

private final Integer sampleIntervalMilliseconds

Constructor Details

ExemplarsProperties

private ExemplarsProperties(Integer minRetentionPeriodSeconds,
 Integer maxRetentionPeriodSeconds,
 Integer sampleIntervalMilliseconds)

Method Details

getMinRetentionPeriodSeconds

public Integer getMinRetentionPeriodSeconds()

Minimum time how long Exemplars are kept before they may be replaced by new Exemplars.

Default see ExemplarSamplerConfig.DEFAULT_MIN_RETENTION_PERIOD_SECONDS

getMaxRetentionPeriodSeconds

public Integer getMaxRetentionPeriodSeconds()

Maximum time how long Exemplars are kept before they are evicted.

Default see ExemplarSamplerConfig.DEFAULT_MAX_RETENTION_PERIOD_SECONDS

getSampleIntervalMilliseconds

public Integer getSampleIntervalMilliseconds()

Time between attempts to sample new Exemplars. This is a performance improvement for high-frequency applications, because with the sample interval we make sure that the exemplar sampler is not called for every single request.

Default see ExemplarSamplerConfig.DEFAULT_SAMPLE_INTERVAL_MILLISECONDS

load

static ExemplarsProperties load(PropertySource propertySource)
                         throws PrometheusPropertiesException

Note that this will remove entries from propertySource. This is because we want to know if there are unused properties remaining after all properties have been loaded.

Throws:

PrometheusPropertiesException

builder

public static ExemplarsProperties.Builder builder()