Class PrometheusProperties

Object

PrometheusProperties

@StableApi
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

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()

Methods inherited from class Object

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

Method Details

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

@Nullable
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()