Package io.prometheus.metrics.core.exemplars

Class ExemplarSamplerConfig

java.lang.Object

io.prometheus.metrics.core.exemplars.ExemplarSamplerConfig

public class ExemplarSamplerConfig
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_MAX_RETENTION_PERIOD_SECONDS	See ExemplarsProperties.getMaxRetentionPeriodSeconds()
static final int	DEFAULT_MIN_RETENTION_PERIOD_SECONDS	See ExemplarsProperties.getMinRetentionPeriodSeconds()
private static final int	DEFAULT_SAMPLE_INTERVAL_MILLISECONDS	See ExemplarsProperties.getSampleIntervalMilliseconds()
private final double[]	histogramClassicUpperBounds
private final long	maxRetentionPeriodMillis
private final long	minRetentionPeriodMillis
private final int	numberOfExemplars
private final long	sampleIntervalMillis

Constructor Summary

Constructors

Modifier	Constructor	Description
(package private)	ExemplarSamplerConfig(long minRetentionPeriodMillis, long maxRetentionPeriodMillis, long sampleIntervalMillis, int numberOfExemplars, double[] histogramClassicUpperBounds)
	ExemplarSamplerConfig(ExemplarsProperties properties, double[] histogramClassicUpperBounds)	Constructor for classic histogram metrics.
	ExemplarSamplerConfig(ExemplarsProperties properties, int numberOfExemplars)	Constructor for all metric types except classic histograms.
private	ExemplarSamplerConfig(ExemplarsProperties properties, int numberOfExemplars, double[] histogramClassicUpperBounds)

Method Summary

Modifier and Type	Method	Description
double[]	getHistogramClassicUpperBounds()
long	getMaxRetentionPeriodMillis()	See ExemplarsProperties.getMaxRetentionPeriodSeconds()
long	getMinRetentionPeriodMillis()	See ExemplarsProperties.getMinRetentionPeriodSeconds()
int	getNumberOfExemplars()	Defaults: Counters have one Exemplar, native histograms and summaries have 4 Exemplars, classic histograms have one Exemplar per bucket.
private static <T> T	getOrDefault(T result, T defaultValue)
long	getSampleIntervalMillis()	See ExemplarsProperties.getSampleIntervalMilliseconds()
private void	validate()

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_MIN_RETENTION_PERIOD_SECONDS

public static final int DEFAULT_MIN_RETENTION_PERIOD_SECONDS

See ExemplarsProperties.getMinRetentionPeriodSeconds()

See Also:

• Constant Field Values

DEFAULT_MAX_RETENTION_PERIOD_SECONDS

public static final int DEFAULT_MAX_RETENTION_PERIOD_SECONDS

See ExemplarsProperties.getMaxRetentionPeriodSeconds()

See Also:

• Constant Field Values

DEFAULT_SAMPLE_INTERVAL_MILLISECONDS

private static final int DEFAULT_SAMPLE_INTERVAL_MILLISECONDS

See ExemplarsProperties.getSampleIntervalMilliseconds()

See Also:

• Constant Field Values

minRetentionPeriodMillis

private final long minRetentionPeriodMillis

maxRetentionPeriodMillis

private final long maxRetentionPeriodMillis

sampleIntervalMillis

private final long sampleIntervalMillis

histogramClassicUpperBounds

private final double[] histogramClassicUpperBounds

numberOfExemplars

private final int numberOfExemplars

Constructor Details

ExemplarSamplerConfig

public ExemplarSamplerConfig(ExemplarsProperties properties,
 int numberOfExemplars)

Constructor for all metric types except classic histograms.

Parameters:

properties - See PrometheusProperties.getExemplarProperties().

numberOfExemplars - Counters have 1 Exemplar, native histograms and summaries have 4 Exemplars by default. For classic histogram use ExemplarSamplerConfig(ExemplarsProperties, double[]).

ExemplarSamplerConfig

public ExemplarSamplerConfig(ExemplarsProperties properties,
 double[] histogramClassicUpperBounds)

Constructor for classic histogram metrics.

Parameters:

properties - See PrometheusProperties.getExemplarProperties().

histogramClassicUpperBounds - the ExemplarSampler will provide one Exemplar per histogram bucket. Must be sorted, and must include the +Inf bucket.

ExemplarSamplerConfig

private ExemplarSamplerConfig(ExemplarsProperties properties,
 int numberOfExemplars,
 double[] histogramClassicUpperBounds)

ExemplarSamplerConfig

ExemplarSamplerConfig(long minRetentionPeriodMillis,
 long maxRetentionPeriodMillis,
 long sampleIntervalMillis,
 int numberOfExemplars,
 double[] histogramClassicUpperBounds)

Method Details

validate

private void validate()

getOrDefault

private static <T> T getOrDefault(T result,
 T defaultValue)

getHistogramClassicUpperBounds

public double[] getHistogramClassicUpperBounds()

getMinRetentionPeriodMillis

public long getMinRetentionPeriodMillis()

See ExemplarsProperties.getMinRetentionPeriodSeconds()

getMaxRetentionPeriodMillis

public long getMaxRetentionPeriodMillis()

See ExemplarsProperties.getMaxRetentionPeriodSeconds()

getSampleIntervalMillis

public long getSampleIntervalMillis()

See ExemplarsProperties.getSampleIntervalMilliseconds()

getNumberOfExemplars

public int getNumberOfExemplars()

Defaults: Counters have one Exemplar, native histograms and summaries have 4 Exemplars, classic histograms have one Exemplar per bucket.