Package io.prometheus.metrics.config

Class PrometheusProperties

java.lang.Object

io.prometheus.metrics.config.PrometheusProperties

public class PrometheusProperties
extends Object

The Prometheus Java client library can be configured at runtime (e.g. using a properties file).

This class represents the runtime configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PrometheusProperties.Builder
(package private) static class	PrometheusProperties.MetricPropertiesMap	Map that stores metric-specific properties keyed by metric name in exposition format (underscores instead of dots).

Field Summary

Fields

Modifier and Type	Field	Description
private final MetricsProperties	defaultMetricsProperties
private final ExemplarsProperties	exemplarProperties
private final ExporterFilterProperties	exporterFilterProperties
private final ExporterHttpServerProperties	exporterHttpServerProperties
private final ExporterOpenTelemetryProperties	exporterOpenTelemetryProperties
private final ExporterProperties	exporterProperties
private final ExporterPushgatewayProperties	exporterPushgatewayProperties
private static final PrometheusProperties	instance
private final PrometheusProperties.MetricPropertiesMap	metricProperties
private final OpenMetrics2Properties	openMetrics2Properties

Constructor Summary

Constructors

Constructor

Description

PrometheusProperties(MetricsProperties defaultMetricsProperties, PrometheusProperties.MetricPropertiesMap metricProperties, ExemplarsProperties exemplarProperties, ExporterProperties exporterProperties, ExporterFilterProperties exporterFilterProperties, ExporterHttpServerProperties httpServerConfig, ExporterPushgatewayProperties pushgatewayProperties, ExporterOpenTelemetryProperties otelConfig, OpenMetrics2Properties openMetrics2Properties)

Method Summary

Modifier and Type	Method	Description
static PrometheusProperties.Builder	builder()
static PrometheusProperties	get()	Get the properties instance.
MetricsProperties	getDefaultMetricProperties()	The default metric properties apply for metrics where getMetricProperties(String) is null.
ExemplarsProperties	getExemplarProperties()
ExporterFilterProperties	getExporterFilterProperties()
ExporterHttpServerProperties	getExporterHttpServerProperties()
ExporterOpenTelemetryProperties	getExporterOpenTelemetryProperties()
ExporterProperties	getExporterProperties()
ExporterPushgatewayProperties	getExporterPushgatewayProperties()
MetricsProperties	getMetricProperties(String metricName)	Properties specific for one metric.
OpenMetrics2Properties	getOpenMetrics2Properties()
private static boolean	isValidLegacyChar(int c, int i)

Methods inherited from class java.lang.Object

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

Field Details

instance

private static final PrometheusProperties instance

defaultMetricsProperties

private final MetricsProperties defaultMetricsProperties

metricProperties

private final PrometheusProperties.MetricPropertiesMap metricProperties

exemplarProperties

private final ExemplarsProperties exemplarProperties

exporterProperties

private final ExporterProperties exporterProperties

exporterFilterProperties

private final ExporterFilterProperties exporterFilterProperties

exporterHttpServerProperties

private final ExporterHttpServerProperties exporterHttpServerProperties

exporterOpenTelemetryProperties

private final ExporterOpenTelemetryProperties exporterOpenTelemetryProperties

exporterPushgatewayProperties

private final ExporterPushgatewayProperties exporterPushgatewayProperties

openMetrics2Properties

private final OpenMetrics2Properties openMetrics2Properties

Constructor Details

PrometheusProperties

PrometheusProperties(MetricsProperties defaultMetricsProperties,
 PrometheusProperties.MetricPropertiesMap metricProperties,
 ExemplarsProperties exemplarProperties,
 ExporterProperties exporterProperties,
 ExporterFilterProperties exporterFilterProperties,
 ExporterHttpServerProperties httpServerConfig,
 ExporterPushgatewayProperties pushgatewayProperties,
 ExporterOpenTelemetryProperties otelConfig,
 OpenMetrics2Properties openMetrics2Properties)

Method Details

isValidLegacyChar

private static boolean isValidLegacyChar(int c,
 int i)

get

public static PrometheusProperties get()
                                throws PrometheusPropertiesException

Get the properties instance. When called for the first time, get() loads the properties from the following locations:

• prometheus.properties file found in the classpath.
• Properties file specified in the PROMETHEUS_CONFIG environment variable or the prometheus.config system property.
• Individual properties from system properties.

Throws:

PrometheusPropertiesException

builder

public static PrometheusProperties.Builder builder()

getDefaultMetricProperties

public MetricsProperties getDefaultMetricProperties()

The default metric properties apply for metrics where getMetricProperties(String) is null.

getMetricProperties

public MetricsProperties getMetricProperties(String metricName)

Properties specific for one metric. Should be merged with getDefaultMetricProperties(). May return null if no metric-specific properties are configured for a metric name.

Parameters:

metricName - the metric name (dots will be automatically converted to underscores to match exposition format)

getExemplarProperties

public ExemplarsProperties getExemplarProperties()

getExporterProperties

public ExporterProperties getExporterProperties()

getExporterFilterProperties

public ExporterFilterProperties getExporterFilterProperties()

getExporterHttpServerProperties

public ExporterHttpServerProperties getExporterHttpServerProperties()

getExporterPushgatewayProperties

public ExporterPushgatewayProperties getExporterPushgatewayProperties()

getExporterOpenTelemetryProperties

public ExporterOpenTelemetryProperties getExporterOpenTelemetryProperties()

getOpenMetrics2Properties

public OpenMetrics2Properties getOpenMetrics2Properties()