Support Pushgateway with new Prometheus client

Closes gh-43923

Author: wilkinsona

spring-boot-project/spring-boot-actuator-autoconfigure/build.gradle

@@ -54,9 +54,6 @@ dependencies {
 		exclude group: "commons-logging", module: "commons-logging"
 		exclude group: "javax.annotation", module: "javax.annotation-api"
 	}
-	optional("io.prometheus:simpleclient_pushgateway") {
-		exclude group: "javax.xml.bind", module: "jaxb-api"
-	}
 	optional("io.micrometer:micrometer-registry-signalfx")
 	optional("io.micrometer:micrometer-registry-statsd")
 	optional("io.micrometer:micrometer-registry-wavefront")
@@ -65,6 +62,7 @@ dependencies {
 	optional("io.opentelemetry:opentelemetry-exporter-zipkin")
 	optional("io.opentelemetry:opentelemetry-exporter-otlp")
 	optional("io.projectreactor.netty:reactor-netty-http")
+	optional("io.prometheus:prometheus-metrics-exporter-pushgateway")
 	optional("io.r2dbc:r2dbc-pool")
 	optional("io.r2dbc:r2dbc-proxy")
 	optional("io.r2dbc:r2dbc-spi")

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/prometheus/PrometheusMetricsExportAutoConfiguration.java

@@ -19,6 +19,10 @@
 import io.micrometer.core.instrument.Clock;
 import io.micrometer.prometheusmetrics.PrometheusConfig;
 import io.micrometer.prometheusmetrics.PrometheusMeterRegistry;
+import io.prometheus.metrics.exporter.pushgateway.Format;
+import io.prometheus.metrics.exporter.pushgateway.PushGateway;
+import io.prometheus.metrics.exporter.pushgateway.PushGateway.Builder;
+import io.prometheus.metrics.exporter.pushgateway.Scheme;
 import io.prometheus.metrics.model.registry.PrometheusRegistry;
 import io.prometheus.metrics.tracer.common.SpanContext;
 
@@ -28,15 +32,20 @@
 import org.springframework.boot.actuate.autoconfigure.metrics.MetricsAutoConfiguration;
 import org.springframework.boot.actuate.autoconfigure.metrics.export.ConditionalOnEnabledMetricsExport;
 import org.springframework.boot.actuate.autoconfigure.metrics.export.simple.SimpleMetricsExportAutoConfiguration;
+import org.springframework.boot.actuate.metrics.export.prometheus.PrometheusPushGatewayManager;
 import org.springframework.boot.actuate.metrics.export.prometheus.PrometheusScrapeEndpoint;
 import org.springframework.boot.autoconfigure.AutoConfiguration;
 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.boot.context.properties.source.MutuallyExclusiveConfigurationPropertiesException;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
+import org.springframework.core.env.Environment;
+import org.springframework.util.StringUtils;
 
 /**
  * {@link EnableAutoConfiguration Auto-configuration} for exporting metrics to Prometheus.
@@ -87,4 +96,74 @@ PrometheusScrapeEndpoint prometheusEndpoint(PrometheusRegistry prometheusRegistr
 
 	}
 
+	/**
+	 * Configuration for <a href="https://github.com/prometheus/pushgateway">Prometheus
+	 * Pushgateway</a>.
+	 */
+	@Configuration(proxyBeanMethods = false)
+	@ConditionalOnClass(PushGateway.class)
+	@ConditionalOnProperty(prefix = "management.prometheus.metrics.export.pushgateway", name = "enabled")
+	static class PrometheusPushGatewayConfiguration {
+
+		/**
+		 * The fallback job name. We use 'spring' since there's a history of Prometheus
+		 * spring integration defaulting to that name from when Prometheus integration
+		 * didn't exist in Spring itself.
+		 */
+		private static final String FALLBACK_JOB = "spring";
+
+		@Bean
+		@ConditionalOnMissingBean
+		PrometheusPushGatewayManager prometheusPushGatewayManager(PrometheusRegistry registry,
+				PrometheusProperties prometheusProperties, Environment environment) {
+			PrometheusProperties.Pushgateway properties = prometheusProperties.getPushgateway();
+			PushGateway pushGateway = initializePushGateway(registry, properties, environment);
+			return new PrometheusPushGatewayManager(pushGateway, properties.getPushRate(),
+					properties.getShutdownOperation());
+		}
+
+		private PushGateway initializePushGateway(PrometheusRegistry registry,
+				PrometheusProperties.Pushgateway properties, Environment environment) {
+			Builder builder = PushGateway.builder()
+				.address(properties.getAddress())
+				.scheme(scheme(properties))
+				.format(format(properties))
+				.job(getJob(properties, environment))
+				.registry(registry);
+			MutuallyExclusiveConfigurationPropertiesException.throwIfMultipleNonNullValuesIn((entries) -> {
+				entries.put("management.prometheus.metrics.export.pushgateway.token", properties.getToken());
+				entries.put("management.prometheus.metrics.export.pushgateway.username", properties.getUsername());
+			});
+			if (StringUtils.hasText(properties.getToken())) {
+				builder.bearerToken(properties.getToken());
+			}
+			else if (StringUtils.hasText(properties.getUsername())) {
+				builder.basicAuth(properties.getUsername(), properties.getPassword());
+			}
+			properties.getGroupingKey().forEach(builder::groupingKey);
+			return builder.build();
+		}
+
+		private Scheme scheme(PrometheusProperties.Pushgateway properties) {
+			return switch (properties.getScheme()) {
+				case HTTP -> Scheme.HTTP;
+				case HTTPS -> Scheme.HTTPS;
+			};
+		}
+
+		private Format format(PrometheusProperties.Pushgateway properties) {
+			return switch (properties.getFormat()) {
+				case PROTOBUF -> Format.PROMETHEUS_PROTOBUF;
+				case TEXT -> Format.PROMETHEUS_TEXT;
+			};
+		}
+
+		private String getJob(PrometheusProperties.Pushgateway properties, Environment environment) {
+			String job = properties.getJob();
+			job = (job != null) ? job : environment.getProperty("spring.application.name");
+			return (job != null) ? job : FALLBACK_JOB;
+		}
+
+	}
+
 }

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/prometheus/PrometheusProperties.java

@@ -104,9 +104,14 @@ public static class Pushgateway {
 		private Boolean enabled = false;
 
 		/**
-		 * Base URL for the Pushgateway.
+		 * Address (host:port) for the Pushgateway.
 		 */
-		private String baseUrl = "http://localhost:9091";
+		private String address = "localhost:9091";
+
+		/**
+		 * The scheme to use when pushing metrics.
+		 */
+		private Scheme scheme = Scheme.HTTP;
 
 		/**
 		 * Login user of the Prometheus Pushgateway.
@@ -118,6 +123,16 @@ public static class Pushgateway {
 		 */
 		private String password;
 
+		/**
+		 * The token to use for authentication with the Prometheus Pushgateway.
+		 */
+		private String token;
+
+		/**
+		 * The format to use when pushing metrics.
+		 */
+		private Format format = Format.PROTOBUF;
+
 		/**
 		 * Frequency with which to push metrics.
 		 */
@@ -146,12 +161,12 @@ public void setEnabled(Boolean enabled) {
 			this.enabled = enabled;
 		}
 
-		public String getBaseUrl() {
-			return this.baseUrl;
+		public String getAddress() {
+			return this.address;
 		}
 
-		public void setBaseUrl(String baseUrl) {
-			this.baseUrl = baseUrl;
+		public void setAddress(String address) {
+			this.address = address;
 		}
 
 		public String getUsername() {
@@ -202,6 +217,58 @@ public void setShutdownOperation(ShutdownOperation shutdownOperation) {
 			this.shutdownOperation = shutdownOperation;
 		}
 
+		public Scheme getScheme() {
+			return this.scheme;
+		}
+
+		public void setScheme(Scheme scheme) {
+			this.scheme = scheme;
+		}
+
+		public String getToken() {
+			return this.token;
+		}
+
+		public void setToken(String token) {
+			this.token = token;
+		}
+
+		public Format getFormat() {
+			return this.format;
+		}
+
+		public void setFormat(Format format) {
+			this.format = format;
+		}
+
+		public enum Format {
+
+			/**
+			 * Push metrics in text format.
+			 */
+			TEXT,
+
+			/**
+			 * Push metrics in protobuf format.
+			 */
+			PROTOBUF
+
+		}
+
+		public enum Scheme {
+
+			/**
+			 * Use HTTP to push metrics.
+			 */
+			HTTP,
+
+			/**
+			 * Use HTTPS to push metrics.
+			 */
+			HTTPS
+
+		}
+
 	}
 
 }

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json

@@ -2083,6 +2083,14 @@
       "type": "java.lang.Boolean",
       "description": "Whether auto-configuration of tracing is enabled to export OTLP traces."
     },
+    {
+      "name": "management.promethus.metrics.export.pushgateway.base-url",
+      "type": "java.lang.String",
+      "deprecation": {
+        "level": "error",
+        "replacement": "management.prometheus.metrics.export.pushgateway.address"
+      }
+    },
     {
       "name": "management.server.add-application-context-header",
       "type": "java.lang.Boolean",

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/PrometheusScrapeEndpointDocumentationTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2024 the original author or authors.
+ * Copyright 2012-2025 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,7 +21,7 @@
 import io.micrometer.core.instrument.Clock;
 import io.micrometer.core.instrument.binder.jvm.JvmMemoryMetrics;
 import io.micrometer.prometheusmetrics.PrometheusMeterRegistry;
-import io.prometheus.client.exporter.common.TextFormat;
+import io.prometheus.metrics.expositionformats.OpenMetricsTextFormatWriter;
 import io.prometheus.metrics.model.registry.PrometheusRegistry;
 import org.junit.jupiter.api.Test;
 
@@ -50,7 +50,7 @@ void prometheus() {
 
 	@Test
 	void prometheusOpenmetrics() {
-		assertThat(this.mvc.get().uri("/actuator/prometheus").accept(TextFormat.CONTENT_TYPE_OPENMETRICS_100))
+		assertThat(this.mvc.get().uri("/actuator/prometheus").accept(OpenMetricsTextFormatWriter.CONTENT_TYPE))
 			.satisfies((result) -> {
 				assertThat(result).hasStatusOk()
 					.headers()