Use properties from Prometheus config in PrometheusScrapeEndpoint

Closes gh-40904
spring-projects · Jun 11, 2024 · 3c37e45 · 3c37e45
1 parent c470ce2
commit 3c37e45
Show file tree

Hide file tree

Showing 9 changed files with 64 additions and 23 deletions.
diff --git a/...ate/autoconfigure/metrics/export/prometheus/PrometheusMetricsExportAutoConfiguration.java b/...ate/autoconfigure/metrics/export/prometheus/PrometheusMetricsExportAutoConfiguration.java
@@ -82,8 +82,9 @@ static class PrometheusScrapeEndpointConfiguration {
 		@SuppressWarnings("removal")
 		@Bean
 		@ConditionalOnMissingBean({ PrometheusScrapeEndpoint.class, PrometheusSimpleclientScrapeEndpoint.class })
-		PrometheusScrapeEndpoint prometheusEndpoint(PrometheusRegistry prometheusRegistry) {
-			return new PrometheusScrapeEndpoint(prometheusRegistry);
+		PrometheusScrapeEndpoint prometheusEndpoint(PrometheusRegistry prometheusRegistry,
+				PrometheusConfig prometheusConfig) {
+			return new PrometheusScrapeEndpoint(prometheusRegistry, prometheusConfig.prometheusProperties());
 		}
 
 	}

diff --git a/...ot/actuate/autoconfigure/metrics/export/prometheus/PrometheusPropertiesConfigAdapter.java b/...ot/actuate/autoconfigure/metrics/export/prometheus/PrometheusPropertiesConfigAdapter.java
@@ -63,13 +63,15 @@ public Properties prometheusProperties() {
 	}
 
 	private Properties fromPropertiesMap(PrometheusProperties prometheusProperties) {
-		Map<String, String> map = prometheusProperties.getProperties();
-		if (map.isEmpty()) {
+		Map<String, String> additionalProperties = prometheusProperties.getProperties();
+		if (additionalProperties.isEmpty()) {
 			return null;
 		}
 		Properties properties = PrometheusConfig.super.prometheusProperties();
-		properties = (properties != null) ? properties : new Properties();
-		properties.putAll(map);
+		if (properties == null) {
+			properties = new Properties();
+		}
+		properties.putAll(additionalProperties);
 		return properties;
 	}
 

diff --git a/.../autoconfigure/endpoint/web/documentation/PrometheusScrapeEndpointDocumentationTests.java b/.../autoconfigure/endpoint/web/documentation/PrometheusScrapeEndpointDocumentationTests.java
@@ -16,6 +16,8 @@
 
 package org.springframework.boot.actuate.autoconfigure.endpoint.web.documentation;
 
+import java.util.Properties;
+
 import io.micrometer.core.instrument.Clock;
 import io.micrometer.core.instrument.binder.jvm.JvmMemoryMetrics;
 import io.micrometer.prometheusmetrics.PrometheusMeterRegistry;
@@ -78,7 +80,7 @@ PrometheusScrapeEndpoint endpoint() {
 			PrometheusMeterRegistry meterRegistry = new PrometheusMeterRegistry((key) -> null, prometheusRegistry,
 					Clock.SYSTEM);
 			new JvmMemoryMetrics().bindTo(meterRegistry);
-			return new PrometheusScrapeEndpoint(prometheusRegistry);
+			return new PrometheusScrapeEndpoint(prometheusRegistry, new Properties());
 		}
 
 	}

diff --git a/...onfigure/metrics/export/prometheus/DualPrometheusMetricsExportAutoConfigurationTests.java b/...onfigure/metrics/export/prometheus/DualPrometheusMetricsExportAutoConfigurationTests.java
@@ -17,6 +17,7 @@
 package org.springframework.boot.actuate.autoconfigure.metrics.export.prometheus;
 
 import io.micrometer.core.instrument.Clock;
+import io.micrometer.prometheusmetrics.PrometheusConfig;
 import io.prometheus.client.CollectorRegistry;
 import io.prometheus.client.exemplars.ExemplarSampler;
 import io.prometheus.client.exemplars.tracer.common.SpanContextSupplier;
@@ -358,8 +359,9 @@ PrometheusSimpleclientScrapeEndpoint customEndpoint(CollectorRegistry collectorR
 	static class CustomSecondEndpointConfiguration {
 
 		@Bean
-		PrometheusScrapeEndpoint prometheusScrapeEndpoint(PrometheusRegistry prometheusRegistry) {
-			return new PrometheusScrapeEndpoint(prometheusRegistry);
+		PrometheusScrapeEndpoint prometheusScrapeEndpoint(PrometheusRegistry prometheusRegistry,
+				PrometheusConfig prometheusConfig) {
+			return new PrometheusScrapeEndpoint(prometheusRegistry, prometheusConfig.prometheusProperties());
 		}
 
 		@Bean

diff --git a/...utoconfigure/metrics/export/prometheus/PrometheusMetricsExportAutoConfigurationTests.java b/...utoconfigure/metrics/export/prometheus/PrometheusMetricsExportAutoConfigurationTests.java
@@ -17,6 +17,7 @@
 package org.springframework.boot.actuate.autoconfigure.metrics.export.prometheus;
 
 import io.micrometer.core.instrument.Clock;
+import io.micrometer.prometheusmetrics.PrometheusConfig;
 import io.micrometer.prometheusmetrics.PrometheusMeterRegistry;
 import io.prometheus.metrics.model.registry.PrometheusRegistry;
 import io.prometheus.metrics.tracer.common.SpanContext;
@@ -207,8 +208,9 @@ PrometheusRegistry customPrometheusRegistry() {
 	static class CustomEndpointConfiguration {
 
 		@Bean
-		PrometheusScrapeEndpoint customEndpoint(PrometheusRegistry prometheusRegistry) {
-			return new PrometheusScrapeEndpoint(prometheusRegistry);
+		PrometheusScrapeEndpoint customEndpoint(PrometheusRegistry prometheusRegistry,
+				PrometheusConfig prometheusConfig) {
+			return new PrometheusScrapeEndpoint(prometheusRegistry, prometheusConfig.prometheusProperties());
 		}
 
 	}

diff --git a/...va/org/springframework/boot/actuate/metrics/export/prometheus/PrometheusOutputFormat.java b/...va/org/springframework/boot/actuate/metrics/export/prometheus/PrometheusOutputFormat.java
@@ -43,8 +43,9 @@ public enum PrometheusOutputFormat implements Producible<PrometheusOutputFormat>
 	CONTENT_TYPE_004(PrometheusTextFormatWriter.CONTENT_TYPE) {
 
 		@Override
-		void write(OutputStream outputStream, MetricSnapshots snapshots) throws IOException {
-			EXPOSITION_FORMATS.getPrometheusTextFormatWriter().write(outputStream, snapshots);
+		void write(ExpositionFormats expositionFormats, OutputStream outputStream, MetricSnapshots snapshots)
+				throws IOException {
+			expositionFormats.getPrometheusTextFormatWriter().write(outputStream, snapshots);
 		}
 
 		@Override
@@ -60,8 +61,9 @@ public boolean isDefault() {
 	CONTENT_TYPE_OPENMETRICS_100(OpenMetricsTextFormatWriter.CONTENT_TYPE) {
 
 		@Override
-		void write(OutputStream outputStream, MetricSnapshots snapshots) throws IOException {
-			EXPOSITION_FORMATS.getOpenMetricsTextFormatWriter().write(outputStream, snapshots);
+		void write(ExpositionFormats expositionFormats, OutputStream outputStream, MetricSnapshots snapshots)
+				throws IOException {
+			expositionFormats.getOpenMetricsTextFormatWriter().write(outputStream, snapshots);
 		}
 
 	},
@@ -72,14 +74,13 @@ void write(OutputStream outputStream, MetricSnapshots snapshots) throws IOExcept
 	CONTENT_TYPE_PROTOBUF(PrometheusProtobufWriter.CONTENT_TYPE) {
 
 		@Override
-		void write(OutputStream outputStream, MetricSnapshots snapshots) throws IOException {
-			EXPOSITION_FORMATS.getPrometheusProtobufWriter().write(outputStream, snapshots);
+		void write(ExpositionFormats expositionFormats, OutputStream outputStream, MetricSnapshots snapshots)
+				throws IOException {
+			expositionFormats.getPrometheusProtobufWriter().write(outputStream, snapshots);
 		}
 
 	};
 
-	private static final ExpositionFormats EXPOSITION_FORMATS = ExpositionFormats.init();
-
 	private final MimeType mimeType;
 
 	PrometheusOutputFormat(String mimeType) {
@@ -91,6 +92,7 @@ public MimeType getProducedMimeType() {
 		return this.mimeType;
 	}
 
-	abstract void write(OutputStream outputStream, MetricSnapshots snapshots) throws IOException;
+	abstract void write(ExpositionFormats expositionFormats, OutputStream outputStream, MetricSnapshots snapshots)
+			throws IOException;
 
 }
diff --git a/.../org/springframework/boot/actuate/metrics/export/prometheus/PrometheusScrapeEndpoint.java b/.../org/springframework/boot/actuate/metrics/export/prometheus/PrometheusScrapeEndpoint.java
@@ -18,8 +18,12 @@
 
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
+import java.util.Properties;
 import java.util.Set;
 
+import io.prometheus.metrics.config.PrometheusProperties;
+import io.prometheus.metrics.config.PrometheusPropertiesLoader;
+import io.prometheus.metrics.expositionformats.ExpositionFormats;
 import io.prometheus.metrics.model.registry.PrometheusRegistry;
 import io.prometheus.metrics.model.snapshots.MetricSnapshots;
 
@@ -45,10 +49,32 @@ public class PrometheusScrapeEndpoint {
 
 	private final PrometheusRegistry prometheusRegistry;
 
+	private final ExpositionFormats expositionFormats;
+
 	private volatile int nextMetricsScrapeSize = 16;
 
+	/**
+	 * Creates a new {@link PrometheusScrapeEndpoint}.
+	 * @param prometheusRegistry the Prometheus registry to use
+	 * @deprecated since 3.3.1 for removal in 3.5.0 in favor of
+	 * {@link #PrometheusScrapeEndpoint(PrometheusRegistry, Properties)}
+	 */
+	@Deprecated(since = "3.3.1", forRemoval = true)
 	public PrometheusScrapeEndpoint(PrometheusRegistry prometheusRegistry) {
+		this(prometheusRegistry, null);
+	}
+
+	/**
+	 * Creates a new {@link PrometheusScrapeEndpoint}.
+	 * @param prometheusRegistry the Prometheus registry to use
+	 * @param expositionFormatsProperties the properties used to configure Prometheus'
+	 * {@link ExpositionFormats}
+	 */
+	public PrometheusScrapeEndpoint(PrometheusRegistry prometheusRegistry, Properties expositionFormatsProperties) {
 		this.prometheusRegistry = prometheusRegistry;
+		PrometheusProperties prometheusProperties = (expositionFormatsProperties != null)
+				? PrometheusPropertiesLoader.load(expositionFormatsProperties) : PrometheusPropertiesLoader.load();
+		this.expositionFormats = ExpositionFormats.init(prometheusProperties.getExporterProperties());
 	}
 
 	@ReadOperation(producesFrom = PrometheusOutputFormat.class)
@@ -57,7 +83,7 @@ public WebEndpointResponse<byte[]> scrape(PrometheusOutputFormat format, @Nullab
 			ByteArrayOutputStream outputStream = new ByteArrayOutputStream(this.nextMetricsScrapeSize);
 			MetricSnapshots metricSnapshots = (includedNames != null)
 					? this.prometheusRegistry.scrape(includedNames::contains) : this.prometheusRegistry.scrape();
-			format.write(outputStream, metricSnapshots);
+			format.write(this.expositionFormats, outputStream, metricSnapshots);
 			byte[] content = outputStream.toByteArray();
 			this.nextMetricsScrapeSize = content.length + METRICS_SCRAPE_CHARS_EXTRA;
 			return new WebEndpointResponse<>(content, format);

diff --git a/...work/boot/actuate/metrics/export/prometheus/PrometheusScrapeEndpointIntegrationTests.java b/...work/boot/actuate/metrics/export/prometheus/PrometheusScrapeEndpointIntegrationTests.java
@@ -16,6 +16,8 @@
 
 package org.springframework.boot.actuate.metrics.export.prometheus;
 
+import java.util.Properties;
+
 import io.micrometer.core.instrument.Clock;
 import io.micrometer.core.instrument.Counter;
 import io.micrometer.core.instrument.MeterRegistry;
@@ -141,7 +143,7 @@ static class TestConfiguration {
 
 		@Bean
 		PrometheusScrapeEndpoint prometheusScrapeEndpoint(PrometheusRegistry prometheusRegistry) {
-			return new PrometheusScrapeEndpoint(prometheusRegistry);
+			return new PrometheusScrapeEndpoint(prometheusRegistry, new Properties());
 		}
 
 		@Bean

diff --git a/...tuate/metrics/export/prometheus/SecondCustomPrometheusScrapeEndpointIntegrationTests.java b/...tuate/metrics/export/prometheus/SecondCustomPrometheusScrapeEndpointIntegrationTests.java
@@ -16,6 +16,8 @@
 
 package org.springframework.boot.actuate.metrics.export.prometheus;
 
+import java.util.Properties;
+
 import io.micrometer.core.instrument.Clock;
 import io.micrometer.core.instrument.Counter;
 import io.micrometer.core.instrument.composite.CompositeMeterRegistry;
@@ -183,7 +185,7 @@ static class TestConfiguration {
 
 		@Bean
 		PrometheusScrapeEndpoint prometheusScrapeEndpoint(PrometheusRegistry prometheusRegistry) {
-			return new PrometheusScrapeEndpoint(prometheusRegistry);
+			return new PrometheusScrapeEndpoint(prometheusRegistry, new Properties());
 		}
 
 		@Bean