Module io.prometheus.metrics.config

Package io.prometheus.metrics.config

Class MetricsProperties

java.lang.Object

io.prometheus.metrics.config.MetricsProperties

public class MetricsProperties
extends Object

Properties starting with io.prometheus.metrics

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MetricsProperties.Builder

Constructor Summary

Constructors

Constructor

Description

MetricsProperties(Boolean exemplarsEnabled, Boolean histogramNativeOnly, Boolean histogramClassicOnly, List<Double> histogramClassicUpperBounds, Integer histogramNativeInitialSchema, Double histogramNativeMinZeroThreshold, Double histogramNativeMaxZeroThreshold, Integer histogramNativeMaxNumberOfBuckets, Long histogramNativeResetDurationSeconds, List<Double> summaryQuantiles, List<Double> summaryQuantileErrors, Long summaryMaxAgeSeconds, Integer summaryNumberOfAgeBuckets)

Method Summary

Modifier and Type	Method	Description
static MetricsProperties.Builder	builder()
Boolean	getExemplarsEnabled()	This is the only configuration property that can be applied to all metric types.
Boolean	getHistogramClassicOnly()	See Histogram.Builder.classicOnly()
List<Double>	getHistogramClassicUpperBounds()	See Histogram.Builder.classicUpperBounds()
Integer	getHistogramNativeInitialSchema()	See Histogram.Builder.nativeInitialSchema()
Integer	getHistogramNativeMaxNumberOfBuckets()	See Histogram.Builder.nativeMaxNumberOfBuckets()
Double	getHistogramNativeMaxZeroThreshold()	See Histogram.Builder.nativeMaxZeroThreshold()
Double	getHistogramNativeMinZeroThreshold()	See Histogram.Builder.nativeMinZeroThreshold()
Boolean	getHistogramNativeOnly()	See Histogram.Builder.nativeOnly()
Long	getHistogramNativeResetDurationSeconds()	See Histogram.Builder.nativeResetDuration()
Long	getSummaryMaxAgeSeconds()	See Summary.Builder.maxAgeSeconds()
Integer	getSummaryNumberOfAgeBuckets()	See Summary.Builder.numberOfAgeBuckets()
List<Double>	getSummaryQuantileErrors()	See Summary.Builder.quantile()
List<Double>	getSummaryQuantiles()	See Summary.Builder.quantile()

Methods inherited from class java.lang.Object

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

Constructor Details

MetricsProperties

public MetricsProperties(@Nullable
 Boolean exemplarsEnabled,
 @Nullable
 Boolean histogramNativeOnly,
 @Nullable
 Boolean histogramClassicOnly,
 @Nullable
 List<Double> histogramClassicUpperBounds,
 @Nullable
 Integer histogramNativeInitialSchema,
 @Nullable
 Double histogramNativeMinZeroThreshold,
 @Nullable
 Double histogramNativeMaxZeroThreshold,
 @Nullable
 Integer histogramNativeMaxNumberOfBuckets,
 @Nullable
 Long histogramNativeResetDurationSeconds,
 @Nullable
 List<Double> summaryQuantiles,
 @Nullable
 List<Double> summaryQuantileErrors,
 @Nullable
 Long summaryMaxAgeSeconds,
 @Nullable
 Integer summaryNumberOfAgeBuckets)

Method Details

getExemplarsEnabled

@Nullable
public Boolean getExemplarsEnabled()

This is the only configuration property that can be applied to all metric types. You can use it to turn Exemplar support off. Default is true.

getHistogramNativeOnly

@Nullable
public Boolean getHistogramNativeOnly()

See Histogram.Builder.nativeOnly()

getHistogramClassicOnly

@Nullable
public Boolean getHistogramClassicOnly()

See Histogram.Builder.classicOnly()

getHistogramClassicUpperBounds

@Nullable
public List<Double> getHistogramClassicUpperBounds()

See Histogram.Builder.classicUpperBounds()

getHistogramNativeInitialSchema

@Nullable
public Integer getHistogramNativeInitialSchema()

See Histogram.Builder.nativeInitialSchema()

getHistogramNativeMinZeroThreshold

@Nullable
public Double getHistogramNativeMinZeroThreshold()

See Histogram.Builder.nativeMinZeroThreshold()

getHistogramNativeMaxZeroThreshold

@Nullable
public Double getHistogramNativeMaxZeroThreshold()

See Histogram.Builder.nativeMaxZeroThreshold()

getHistogramNativeMaxNumberOfBuckets

@Nullable
public Integer getHistogramNativeMaxNumberOfBuckets()

See Histogram.Builder.nativeMaxNumberOfBuckets()

getHistogramNativeResetDurationSeconds

@Nullable
public Long getHistogramNativeResetDurationSeconds()

See Histogram.Builder.nativeResetDuration()

getSummaryQuantiles

@Nullable
public List<Double> getSummaryQuantiles()

See Summary.Builder.quantile()

getSummaryQuantileErrors

@Nullable
public List<Double> getSummaryQuantileErrors()

See Summary.Builder.quantile()

Returns null only if getSummaryQuantiles() is also null. Returns an empty list if getSummaryQuantiles() are specified without specifying errors. If the list is not empty, it has the same size as getSummaryQuantiles().

getSummaryMaxAgeSeconds

@Nullable
public Long getSummaryMaxAgeSeconds()

See Summary.Builder.maxAgeSeconds()

getSummaryNumberOfAgeBuckets

@Nullable
public Integer getSummaryNumberOfAgeBuckets()

See Summary.Builder.numberOfAgeBuckets()

builder

public static MetricsProperties.Builder builder()