Update Micrometer's Prometheus sample to Java client version 1.x

References:
- https://github.com/micrometer-metrics/micrometer/wiki/1.13-Migration-Guide#prometheus-java-client-0x-to-1x-upgrade
- https://docs.micrometer.io/micrometer/reference/implementations/prometheus.html

Resolves #4689

Author: fmbenhassine

pom.xml

@@ -131,7 +131,7 @@
 		<!-- samples dependencies -->
 		<spring-rabbit.version>${spring-amqp.version}</spring-rabbit.version>
 		<quartz.version>2.5.0</quartz.version>
-		<prometheus_pushgateway.version>0.16.0</prometheus_pushgateway.version>
+		<prometheus-metrics-exporter-pushgateway>1.4.1</prometheus-metrics-exporter-pushgateway>
 		<groovy.version>3.0.22</groovy.version> <!-- change to org.apache.groovy:groovy + update to latest -->
 
 		<!-- documentation dependencies -->

spring-batch-samples/README.md

@@ -594,7 +594,7 @@ This should start the required monitoring stack:
 * Prometheus push gateway on port `9091`
 * Grafana on port `3000`
 
-Once started, you need to [configure Prometheus as data source in Grafana](https://grafana.com/docs/features/datasources/prometheus/)
+Once started, you need to [configure Prometheus as data source in Grafana](https://grafana.com/docs/grafana/latest/datasources/prometheus/configure/)
 and import the ready-to-use dashboard in `spring-batch-samples/src/main/resources/org/springframework/batch/samples/metrics/spring-batch-dashboard.json`.
 
 Finally, run the `org.springframework.batch.samples.metrics.BatchMetricsApplication`

spring-batch-samples/pom.xml

@@ -52,11 +52,9 @@
 			<artifactId>spring-context-support</artifactId>
 			<version>${spring-framework.version}</version>
 		</dependency>
-		<!-- temporary usage of deprecated dependency until pushgateway
-		 is supported in prometheus Java client 1.x -->
 		<dependency>
 			<groupId>io.micrometer</groupId>
-			<artifactId>micrometer-registry-prometheus-simpleclient</artifactId>
+			<artifactId>micrometer-registry-prometheus</artifactId>
 			<version>${micrometer.version}</version>
 		</dependency>
 		<dependency>
@@ -204,10 +202,10 @@
 			<artifactId>mongodb-driver-sync</artifactId>
 			<version>${mongodb-driver.version}</version>
 		</dependency>
-		<dependency>
-			<groupId>io.prometheus</groupId>
-			<artifactId>simpleclient_pushgateway</artifactId>
-			<version>${prometheus_pushgateway.version}</version>
+        <dependency>
+            <groupId>io.prometheus</groupId>
+            <artifactId>prometheus-metrics-exporter-pushgateway</artifactId>
+			<version>${prometheus-metrics-exporter-pushgateway}</version>
 		</dependency>
 		<dependency>
 			<groupId>com.fasterxml.jackson.core</groupId>

spring-batch-samples/src/main/java/org/springframework/batch/samples/metrics/BatchMetricsApplication.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022-2023 the original author or authors.
+ * Copyright 2022-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.
@@ -31,7 +31,7 @@
 @EnableJdbcJobRepository
 @Import({ Job1Configuration.class, Job2Configuration.class, JobScheduler.class, PrometheusConfiguration.class,
 		DataSourceConfiguration.class })
-@PropertySource("metrics-sample.properties")
+@PropertySource("classpath:org/springframework/batch/samples/metrics/metrics-sample.properties")
 public class BatchMetricsApplication {
 
 	public static void main(String[] args) {

spring-batch-samples/src/main/java/org/springframework/batch/samples/metrics/JobScheduler.java

@@ -1,5 +1,24 @@
+/*
+ * Copyright 2022-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.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 package org.springframework.batch.samples.metrics;
 
+import io.prometheus.metrics.exporter.pushgateway.PushGateway;
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+
 import org.springframework.batch.core.job.Job;
 import org.springframework.batch.core.job.parameters.JobParameters;
 import org.springframework.batch.core.job.parameters.JobParametersBuilder;
@@ -11,17 +30,22 @@
 @Component
 public class JobScheduler {
 
+	private static final Log LOGGER = LogFactory.getLog(JobScheduler.class);
+
 	private final Job job1;
 
 	private final Job job2;
 
 	private final JobOperator jobOperator;
 
+	private final PushGateway pushGateway;
+
 	@Autowired
-	public JobScheduler(Job job1, Job job2, JobOperator jobOperator) {
+	public JobScheduler(Job job1, Job job2, JobOperator jobOperator, PushGateway pushGateway) {
 		this.job1 = job1;
 		this.job2 = job2;
 		this.jobOperator = jobOperator;
+		this.pushGateway = pushGateway;
 	}
 
 	@Scheduled(cron = "*/10 * * * * *")
@@ -40,4 +64,14 @@ public void launchJob2() throws Exception {
 		jobOperator.start(job2, jobParameters);
 	}
 
+	@Scheduled(fixedRateString = "${prometheus.push.rate}")
+	public void pushMetrics() {
+		try {
+			pushGateway.pushAdd();
+		}
+		catch (Throwable ex) {
+			LOGGER.error("Unable to push metrics to Prometheus Push Gateway", ex);
+		}
+	}
+
 }

spring-batch-samples/src/main/java/org/springframework/batch/samples/metrics/PrometheusConfiguration.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2021-2023 the original author or authors.
+ * Copyright 2021-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.
@@ -15,27 +15,21 @@
  */
 package org.springframework.batch.samples.metrics;
 
-import java.util.HashMap;
-import java.util.Map;
-import jakarta.annotation.PostConstruct;
-
-import io.micrometer.core.instrument.Metrics;
-import io.micrometer.prometheus.PrometheusConfig;
-import io.micrometer.prometheus.PrometheusMeterRegistry;
-import io.prometheus.client.CollectorRegistry;
-import io.prometheus.client.exporter.PushGateway;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
+import io.micrometer.core.instrument.Clock;
+import io.micrometer.core.instrument.observation.DefaultMeterObservationHandler;
+import io.micrometer.observation.ObservationRegistry;
+import io.micrometer.prometheusmetrics.PrometheusConfig;
+import io.micrometer.prometheusmetrics.PrometheusMeterRegistry;
+import io.prometheus.metrics.exporter.pushgateway.PushGateway;
+import io.prometheus.metrics.model.registry.PrometheusRegistry;
 
 import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
-import org.springframework.scheduling.annotation.Scheduled;
 
 @Configuration
 public class PrometheusConfiguration {
 
-	private static final Logger LOGGER = LoggerFactory.getLogger(PrometheusConfiguration.class);
-
 	@Value("${prometheus.job.name}")
 	private String prometheusJobName;
 
@@ -45,29 +39,30 @@ public class PrometheusConfiguration {
 	@Value("${prometheus.pushgateway.url}")
 	private String prometheusPushGatewayUrl;
 
-	private final Map<String, String> groupingKey = new HashMap<>();
-
-	private PushGateway pushGateway;
+	@Bean
+	public PrometheusRegistry prometheusRegistry() {
+		return new PrometheusRegistry();
+	}
 
-	private CollectorRegistry collectorRegistry;
+	@Bean
+	public PrometheusMeterRegistry meterRegistry(PrometheusRegistry prometheusRegistry) {
+		return new PrometheusMeterRegistry(PrometheusConfig.DEFAULT, prometheusRegistry, Clock.SYSTEM);
+	}
 
-	@PostConstruct
-	public void init() {
-		pushGateway = new PushGateway(prometheusPushGatewayUrl);
-		groupingKey.put(prometheusGroupingKey, prometheusJobName);
-		PrometheusMeterRegistry prometheusMeterRegistry = new PrometheusMeterRegistry(PrometheusConfig.DEFAULT);
-		collectorRegistry = prometheusMeterRegistry.getPrometheusRegistry();
-		Metrics.globalRegistry.add(prometheusMeterRegistry);
+	@Bean
+	public PushGateway pushGateway(PrometheusRegistry prometheusRegistry) {
+		return PushGateway.builder()
+			.address(prometheusPushGatewayUrl)
+			.groupingKey(prometheusGroupingKey, prometheusJobName)
+			.registry(prometheusRegistry)
+			.build();
 	}
 
-	@Scheduled(fixedRateString = "${prometheus.push.rate}")
-	public void pushMetrics() {
-		try {
-			pushGateway.pushAdd(collectorRegistry, prometheusJobName, groupingKey);
-		}
-		catch (Throwable ex) {
-			LOGGER.error("Unable to push metrics to Prometheus Push Gateway", ex);
-		}
+	@Bean
+	public ObservationRegistry observationRegistry(PrometheusMeterRegistry meterRegistry) {
+		ObservationRegistry observationRegistry = ObservationRegistry.create();
+		observationRegistry.observationConfig().observationHandler(new DefaultMeterObservationHandler(meterRegistry));
+		return observationRegistry;
 	}
 
 }

spring-batch-samples/src/main/resources/org/springframework/batch/samples/metrics/docker-compose.yml

@@ -2,21 +2,21 @@ version: '3.3'
 services:
 
   prometheus:
-    image: prom/prometheus:v2.7.2
+    image: prom/prometheus:v3.6.0
     container_name: 'prometheus'
     ports:
       - '9090:9090'
     volumes:
       - ./prometheus.yml:/etc/prometheus/prometheus.yml
 
   pushgateway:
-    image: prom/pushgateway:v0.6.0
+    image: prom/pushgateway:v1.11.1
     container_name: 'pushgateway'
     ports:
       - '9091:9091'
 
   grafana:
-    image: grafana/grafana:6.0.2
+    image: grafana/grafana:12.3.0-17900959199-ubuntu
     container_name: 'grafana'
     ports:
       - '3000:3000'