Skip to content

Commit 579364c

Browse files
committed
Polish "Auto-configure observation for Spring-Batch"
See gh-34305
1 parent 5ad29db commit 579364c

File tree

6 files changed

+25
-10
lines changed

6 files changed

+25
-10
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
plugins {
2-
id "java-library"
2+
id "java-library"
33
id "org.asciidoctor.jvm.convert"
44
id "org.springframework.boot.auto-configuration"
55
id "org.springframework.boot.conventions"
66
id "org.springframework.boot.deployed"
7-
id "org.springframework.boot.optional-dependencies"
7+
id "org.springframework.boot.optional-dependencies"
88
}
99

1010
description = "Spring Boot Actuator AutoConfigure"

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/observation/batch/BatchObservationAutoConfiguration.java

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2022 the original author or authors.
2+
* Copyright 2012-2023 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -28,21 +28,20 @@
2828
import org.springframework.context.annotation.Bean;
2929

3030
/**
31-
* {@link EnableAutoConfiguration Auto-configuration} for instrumentation of Spring Batch.
32-
* Jobs
31+
* {@link EnableAutoConfiguration Auto-configuration} for instrumentation of Spring Batch
32+
* Jobs.
3333
*
3434
* @author Mark Bonnekessel
35-
* @since 3.0.3
35+
* @since 3.0.6
3636
*/
3737
@AutoConfiguration(after = ObservationAutoConfiguration.class)
3838
@ConditionalOnBean(ObservationRegistry.class)
3939
@ConditionalOnClass({ ObservationRegistry.class, BatchObservabilityBeanPostProcessor.class })
40-
@SuppressWarnings("removal")
4140
public class BatchObservationAutoConfiguration {
4241

4342
@ConditionalOnMissingBean
4443
@Bean
45-
public BatchObservabilityBeanPostProcessor batchObservabilityBeanPostProcessor() {
44+
public static BatchObservabilityBeanPostProcessor batchObservabilityBeanPostProcessor() {
4645
return new BatchObservabilityBeanPostProcessor();
4746
}
4847

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/observation/batch/package-info.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2022 the original author or authors.
2+
* Copyright 2012-2023 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -15,6 +15,6 @@
1515
*/
1616

1717
/**
18-
* Auto-configuration for Spring Batcn observations.
18+
* Auto-configuration for Spring Batch observations.
1919
*/
2020
package org.springframework.boot.actuate.autoconfigure.observation.batch;

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ org.springframework.boot.actuate.autoconfigure.metrics.export.simple.SimpleMetri
6868
org.springframework.boot.actuate.autoconfigure.metrics.export.stackdriver.StackdriverMetricsExportAutoConfiguration
6969
org.springframework.boot.actuate.autoconfigure.metrics.export.statsd.StatsdMetricsExportAutoConfiguration
7070
org.springframework.boot.actuate.autoconfigure.metrics.export.wavefront.WavefrontMetricsExportAutoConfiguration
71+
org.springframework.boot.actuate.autoconfigure.observation.batch.BatchObservationAutoConfiguration
7172
org.springframework.boot.actuate.autoconfigure.observation.graphql.GraphQlObservationAutoConfiguration
7273
org.springframework.boot.actuate.autoconfigure.metrics.integration.IntegrationMetricsAutoConfiguration
7374
org.springframework.boot.actuate.autoconfigure.metrics.jdbc.DataSourcePoolMetricsAutoConfiguration

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/observation/batch/BatchObservationAutoConfigurationTests.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,11 @@
2525

2626
import static org.assertj.core.api.Assertions.assertThat;
2727

28+
/**
29+
* Tests for {@link BatchObservationAutoConfiguration}.
30+
*
31+
* @author Mark Bonnekessel
32+
*/
2833
class BatchObservationAutoConfigurationTests {
2934

3035
private final ApplicationContextRunner contextRunner = new ApplicationContextRunner()

spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/metrics.adoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -858,12 +858,22 @@ NOTE: Only caches that are configured on startup are bound to the registry.
858858
For caches not defined in the cache’s configuration, such as caches created on the fly or programmatically after the startup phase, an explicit registration is required.
859859
A `CacheMetricsRegistrar` bean is made available to make that process easier.
860860

861+
862+
863+
[[actuator.metrics.supported.spring-batch]]
864+
==== Spring Batch Metrics
865+
866+
See the {spring-batch-docs}monitoring-and-metrics.html[Spring Batch reference documentation].
867+
868+
869+
861870
[[actuator.metrics.supported.spring-graphql]]
862871
==== Spring GraphQL Metrics
863872

864873
See the {spring-graphql-docs}[Spring GraphQL reference documentation].
865874

866875

876+
867877
[[actuator.metrics.supported.jdbc]]
868878
==== DataSource Metrics
869879
Auto-configuration enables the instrumentation of all available `DataSource` objects with metrics prefixed with `jdbc.connections`.

0 commit comments

Comments
 (0)