Class PrometheusPropertiesLoader

java.lang.Object

io.prometheus.metrics.config.PrometheusPropertiesLoader

public class PrometheusPropertiesLoader
extends Object

The Properties Loader is early stages.

It would be great to implement a subset of Spring Boot's Externalized Configuration, like support for YAML, Properties, and env vars, or support for Spring's naming conventions for properties.

Constructor Summary

Constructors

Constructor	Description
PrometheusPropertiesLoader()

Method Summary

Modifier and Type	Method	Description
static PrometheusProperties	load()	See PrometheusProperties.get().
static PrometheusProperties	load(Map<Object,Object> externalProperties)
(package private) static PrometheusProperties.MetricPropertiesMap	loadMetricsConfigs(PropertySource propertySource)
private static PropertySource	loadProperties(Map<Object,Object> externalProperties)
private static Properties	loadPropertiesFromClasspath()
private static Map<Object,Object>	loadPropertiesFromEnvironment()	Load properties from environment variables.
private static Properties	loadPropertiesFromFile()
private static void	normalizeAndPutAll(Map<Object,Object> target, Map<Object,Object> source)
(package private) static String	normalizePropertyKey(String key)	Normalize a property key for consistent lookup.
private static void	validateAllPropertiesProcessed(PropertySource propertySource)

Methods inherited from class Object

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

Constructor Details

PrometheusPropertiesLoader

public PrometheusPropertiesLoader()

Method Details

load

public static PrometheusProperties load()
                                 throws PrometheusPropertiesException

See PrometheusProperties.get().

Throws:

PrometheusPropertiesException

load

public static PrometheusProperties load(Map<Object,Object> externalProperties)
                                 throws PrometheusPropertiesException

Throws:

PrometheusPropertiesException

loadMetricsConfigs

static PrometheusProperties.MetricPropertiesMap loadMetricsConfigs(PropertySource propertySource)

validateAllPropertiesProcessed

private static void validateAllPropertiesProcessed(PropertySource propertySource)

loadProperties

private static PropertySource loadProperties(Map<Object,Object> externalProperties)

normalizeAndPutAll

private static void normalizeAndPutAll(Map<Object,Object> target,
 Map<Object,Object> source)

loadPropertiesFromClasspath

private static Properties loadPropertiesFromClasspath()

loadPropertiesFromFile

private static Properties loadPropertiesFromFile()
                                          throws PrometheusPropertiesException

Throws:

PrometheusPropertiesException

loadPropertiesFromEnvironment

private static Map<Object,Object> loadPropertiesFromEnvironment()

Load properties from environment variables.

Environment variables are converted to lowercase but keep underscores as-is. For example, the environment variable IO_PROMETHEUS_METRICS_EXEMPLARS_ENABLED becomes io_prometheus_metrics_exemplars_enabled.

The transformation to dot notation happens at access time in PropertySource.

Only environment variables starting with IO_PROMETHEUS are considered.

Returns:

properties loaded from environment variables (with lowercase keys and underscores)

normalizePropertyKey

static String normalizePropertyKey(String key)

Normalize a property key for consistent lookup.

Converts camelCase property keys to snake_case. This allows both snake_case (preferred) and camelCase (deprecated) property names to be used.

For example: exemplarsEnabled → exemplars_enabled exemplars_enabled → exemplars_enabled (unchanged)

Parameters:

key - the property key

Returns:

the normalized property key