Package io.prometheus.metrics.config

Class ExporterProperties

java.lang.Object

io.prometheus.metrics.config.ExporterProperties

public class ExporterProperties
extends Object

Properties starting with io.prometheus.exporter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExporterProperties.Builder

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	EXEMPLARS_ON_ALL_METRIC_TYPES
private final Boolean	exemplarsOnAllMetricTypes
private static final String	INCLUDE_CREATED_TIMESTAMPS
private final Boolean	includeCreatedTimestamps
private static final String	PREFIX
private static final String	PROMETHEUS_TIMESTAMPS_IN_MS
private final Boolean	prometheusTimestampsInMs

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ExporterProperties(Boolean includeCreatedTimestamps, Boolean prometheusTimestampsInMs, Boolean exemplarsOnAllMetricTypes)

Method Summary

Modifier and Type	Method	Description
static ExporterProperties.Builder	builder()
boolean	getExemplarsOnAllMetricTypes()	Allow Exemplars on all metric types in OpenMetrics format? Default is false, which means Exemplars will only be added for Counters and Histogram buckets.
boolean	getIncludeCreatedTimestamps()	Include the _created timestamps in text format? Default is false.
boolean	getPrometheusTimestampsInMs()	Use milliseconds for timestamps in prometheus text format? Default is false.
(package private) static ExporterProperties	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

INCLUDE_CREATED_TIMESTAMPS

private static final String INCLUDE_CREATED_TIMESTAMPS

See Also:

• Constant Field Values

PROMETHEUS_TIMESTAMPS_IN_MS

private static final String PROMETHEUS_TIMESTAMPS_IN_MS

See Also:

• Constant Field Values

EXEMPLARS_ON_ALL_METRIC_TYPES

private static final String EXEMPLARS_ON_ALL_METRIC_TYPES

See Also:

• Constant Field Values

PREFIX

private static final String PREFIX

See Also:

• Constant Field Values

includeCreatedTimestamps

private final Boolean includeCreatedTimestamps

prometheusTimestampsInMs

private final Boolean prometheusTimestampsInMs

exemplarsOnAllMetricTypes

private final Boolean exemplarsOnAllMetricTypes

Constructor Details

ExporterProperties

private ExporterProperties(Boolean includeCreatedTimestamps,
 Boolean prometheusTimestampsInMs,
 Boolean exemplarsOnAllMetricTypes)

Method Details

getIncludeCreatedTimestamps

public boolean getIncludeCreatedTimestamps()

Include the _created timestamps in text format? Default is false.

getPrometheusTimestampsInMs

public boolean getPrometheusTimestampsInMs()

Use milliseconds for timestamps in prometheus text format? Default is false.

getExemplarsOnAllMetricTypes

public boolean getExemplarsOnAllMetricTypes()

Allow Exemplars on all metric types in OpenMetrics format? Default is false, which means Exemplars will only be added for Counters and Histogram buckets.

load

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