Package io.prometheus.metrics.config

Class OpenMetrics2Properties

java.lang.Object

io.prometheus.metrics.config.OpenMetrics2Properties

public class OpenMetrics2Properties
extends Object

Properties starting with io.prometheus.openmetrics2. These properties are experimental and subject to change.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpenMetrics2Properties.Builder

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	COMPOSITE_VALUES
private final Boolean	compositeValues
private static final String	CONTENT_NEGOTIATION
private final Boolean	contentNegotiation
private final Boolean	enabled
private static final String	ENABLED
private static final String	EXEMPLAR_COMPLIANCE
private final Boolean	exemplarCompliance
private static final String	NATIVE_HISTOGRAMS
private final Boolean	nativeHistograms
private static final String	PREFIX

Constructor Summary

Constructors

Modifier	Constructor	Description
private	OpenMetrics2Properties(Boolean enabled, Boolean contentNegotiation, Boolean compositeValues, Boolean exemplarCompliance, Boolean nativeHistograms)

Method Summary

Modifier and Type	Method	Description
static OpenMetrics2Properties.Builder	builder()
boolean	getCompositeValues()	Single-line histogram/summary with st@.
boolean	getContentNegotiation()	Gate OM2 features behind content negotiation.
boolean	getEnabled()	Enable the OpenMetrics 2.0 text format writer.
boolean	getExemplarCompliance()	Mandatory timestamps, no 128-char limit for exemplars.
boolean	getNativeHistograms()	Exponential buckets support for native histograms.
(package private) static OpenMetrics2Properties	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

ENABLED

private static final String ENABLED

See Also:

• Constant Field Values

CONTENT_NEGOTIATION

private static final String CONTENT_NEGOTIATION

See Also:

• Constant Field Values

COMPOSITE_VALUES

private static final String COMPOSITE_VALUES

See Also:

• Constant Field Values

EXEMPLAR_COMPLIANCE

private static final String EXEMPLAR_COMPLIANCE

See Also:

• Constant Field Values

NATIVE_HISTOGRAMS

private static final String NATIVE_HISTOGRAMS

See Also:

• Constant Field Values

enabled

private final Boolean enabled

contentNegotiation

private final Boolean contentNegotiation

compositeValues

private final Boolean compositeValues

exemplarCompliance

private final Boolean exemplarCompliance

nativeHistograms

private final Boolean nativeHistograms

Constructor Details

OpenMetrics2Properties

private OpenMetrics2Properties(Boolean enabled,
 Boolean contentNegotiation,
 Boolean compositeValues,
 Boolean exemplarCompliance,
 Boolean nativeHistograms)

Method Details

getEnabled

public boolean getEnabled()

Enable the OpenMetrics 2.0 text format writer. When true, the OM2 writer is used instead of OM1 for OpenMetrics responses. Default is false.

getContentNegotiation

public boolean getContentNegotiation()

Gate OM2 features behind content negotiation. Default is false.

getCompositeValues

public boolean getCompositeValues()

Single-line histogram/summary with st@. Default is false.

getExemplarCompliance

public boolean getExemplarCompliance()

Mandatory timestamps, no 128-char limit for exemplars. Default is false.

getNativeHistograms

public boolean getNativeHistograms()

Exponential buckets support for native histograms. Default is false.

load

static OpenMetrics2Properties 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 OpenMetrics2Properties.Builder builder()