io.prometheus.metrics.config.PrometheusProperties Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jmx_prometheus_httpserver Show documentation
See https://github.com/prometheus/jmx_exporter/blob/master/README.md
There is a newer version: 1.0.1
Show newest version
package io.prometheus.metrics.config;

import java.util.HashMap;
import java.util.Map;

/**
 * The Prometheus Java client library can be configured at runtime (e.g. using a properties file).
 * 
 * This class represents the runtime configuration.
 */
public class PrometheusProperties {

    private static final PrometheusProperties instance = PrometheusPropertiesLoader.load();

    private final MetricsProperties defaultMetricsProperties;
    private final Map metricProperties = new HashMap<>();
    private final ExemplarsProperties exemplarProperties;
    private final ExporterProperties exporterProperties;
    private final ExporterFilterProperties exporterFilterProperties;
    private final ExporterHttpServerProperties exporterHttpServerProperties;
    private final ExporterOpenTelemetryProperties exporterOpenTelemetryProperties;
    private final ExporterPushgatewayProperties exporterPushgatewayProperties;

    /**
     * Get the properties instance. When called for the first time, {@code get()} loads the properties from the following locations:
     * 

     *     {@code prometheus.properties} file found in the classpath.
     *     Properties file specified in the {@code PROMETHEUS_CONFIG} environment variable or the {@code prometheus.config} system property.
     *     Individual properties from system properties.
     * 
     */
    public static PrometheusProperties get() throws PrometheusPropertiesException {
        return instance;
    }

    public PrometheusProperties(
            MetricsProperties defaultMetricsProperties,
            Map metricProperties,
            ExemplarsProperties exemplarProperties,
            ExporterProperties exporterProperties,
            ExporterFilterProperties exporterFilterProperties,
            ExporterHttpServerProperties httpServerConfig,
            ExporterPushgatewayProperties pushgatewayProperties,
            ExporterOpenTelemetryProperties otelConfig) {
        this.defaultMetricsProperties = defaultMetricsProperties;
        this.metricProperties.putAll(metricProperties);
        this.exemplarProperties = exemplarProperties;
        this.exporterProperties = exporterProperties;
        this.exporterFilterProperties = exporterFilterProperties;
        this.exporterHttpServerProperties = httpServerConfig;
        this.exporterPushgatewayProperties = pushgatewayProperties;
        this.exporterOpenTelemetryProperties = otelConfig;
    }

    /**
     * The default metric properties apply for metrics where {@link #getMetricProperties(String)} is {@code null}.
     */
    public MetricsProperties getDefaultMetricProperties() {
        return defaultMetricsProperties;
    }

    /**
     * Properties specific for one metric. Should be merged with {@link #getDefaultMetricProperties()}.
     * May return {@code null} if no metric-specific properties are configured for a metric name.
     */
    public MetricsProperties getMetricProperties(String metricName) {
        return metricProperties.get(metricName.replace(".", "_"));
    }

    public ExemplarsProperties getExemplarProperties() {
        return exemplarProperties;
    }

    public ExporterProperties getExporterProperties() {
        return exporterProperties;
    }

    public ExporterFilterProperties getExporterFilterProperties() {
        return exporterFilterProperties;
    }

    public ExporterHttpServerProperties getExporterHttpServerProperties() {
        return exporterHttpServerProperties;
    }

    public ExporterPushgatewayProperties getExporterPushgatewayProperties() {
        return exporterPushgatewayProperties;
    }

    public ExporterOpenTelemetryProperties getExporterOpenTelemetryProperties() {
        return exporterOpenTelemetryProperties;
    }
}