-
Notifications
You must be signed in to change notification settings - Fork 40.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Auto-configure ObservationRegistry on ScheduledTaskRegistrar
The TaskSchedulingAutoConfiguration.taskScheduler auto-configuration now no longer backs off on SchedulingConfigurer beans. Closes gh-36119
- Loading branch information
1 parent
90a38b6
commit 54e99d6
Showing
5 changed files
with
130 additions
and
14 deletions.
There are no files selected for viewing
63 changes: 63 additions & 0 deletions
63
...k/boot/actuate/autoconfigure/scheduling/ScheduledTasksObservabilityAutoConfiguration.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
/* | ||
* Copyright 2012-2023 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.boot.actuate.autoconfigure.scheduling; | ||
|
||
import io.micrometer.observation.ObservationRegistry; | ||
|
||
import org.springframework.boot.actuate.autoconfigure.observation.ObservationAutoConfiguration; | ||
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.context.annotation.Bean; | ||
import org.springframework.scheduling.annotation.SchedulingConfigurer; | ||
import org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler; | ||
import org.springframework.scheduling.config.ScheduledTaskRegistrar; | ||
|
||
/** | ||
* {@link EnableAutoConfiguration Auto-configuration} to enable observability for | ||
* scheduled tasks. | ||
* | ||
* @author Moritz Halbritter | ||
* @since 3.2.0 | ||
*/ | ||
@AutoConfiguration(after = ObservationAutoConfiguration.class) | ||
@ConditionalOnBean(ObservationRegistry.class) | ||
@ConditionalOnClass(ThreadPoolTaskScheduler.class) | ||
public class ScheduledTasksObservabilityAutoConfiguration { | ||
|
||
@Bean | ||
ObservabilitySchedulingConfigurer observabilitySchedulingConfigurer(ObservationRegistry observationRegistry) { | ||
return new ObservabilitySchedulingConfigurer(observationRegistry); | ||
} | ||
|
||
static final class ObservabilitySchedulingConfigurer implements SchedulingConfigurer { | ||
|
||
private final ObservationRegistry observationRegistry; | ||
|
||
ObservabilitySchedulingConfigurer(ObservationRegistry observationRegistry) { | ||
this.observationRegistry = observationRegistry; | ||
} | ||
|
||
@Override | ||
public void configureTasks(ScheduledTaskRegistrar taskRegistrar) { | ||
taskRegistrar.setObservationRegistry(this.observationRegistry); | ||
} | ||
|
||
} | ||
|
||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
64 changes: 64 additions & 0 deletions
64
...t/actuate/autoconfigure/scheduling/ScheduledTasksObservabilityAutoConfigurationTests.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
/* | ||
* Copyright 2012-2023 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.boot.actuate.autoconfigure.scheduling; | ||
|
||
import java.util.List; | ||
|
||
import io.micrometer.observation.ObservationRegistry; | ||
import org.junit.jupiter.api.Test; | ||
|
||
import org.springframework.boot.actuate.autoconfigure.observation.ObservationAutoConfiguration; | ||
import org.springframework.boot.actuate.autoconfigure.scheduling.ScheduledTasksObservabilityAutoConfiguration.ObservabilitySchedulingConfigurer; | ||
import org.springframework.boot.autoconfigure.AutoConfiguration; | ||
import org.springframework.boot.autoconfigure.AutoConfigurations; | ||
import org.springframework.boot.context.annotation.ImportCandidates; | ||
import org.springframework.boot.test.context.runner.ApplicationContextRunner; | ||
import org.springframework.scheduling.config.ScheduledTaskRegistrar; | ||
|
||
import static org.assertj.core.api.Assertions.assertThat; | ||
|
||
/** | ||
* Tests for {@link ScheduledTasksObservabilityAutoConfiguration}. | ||
* | ||
* @author Moritz Halbritter | ||
*/ | ||
class ScheduledTasksObservabilityAutoConfigurationTests { | ||
|
||
private final ApplicationContextRunner runner = new ApplicationContextRunner().withConfiguration(AutoConfigurations | ||
.of(ObservationAutoConfiguration.class, ScheduledTasksObservabilityAutoConfiguration.class)); | ||
|
||
@Test | ||
void shouldProvideObservabilitySchedulingConfigurer() { | ||
this.runner.run((context) -> assertThat(context).hasSingleBean(ObservabilitySchedulingConfigurer.class)); | ||
} | ||
|
||
@Test | ||
void observabilitySchedulingConfigurerShouldConfigureObservationRegistry() { | ||
ObservationRegistry observationRegistry = ObservationRegistry.create(); | ||
ObservabilitySchedulingConfigurer configurer = new ObservabilitySchedulingConfigurer(observationRegistry); | ||
ScheduledTaskRegistrar registrar = new ScheduledTaskRegistrar(); | ||
configurer.configureTasks(registrar); | ||
assertThat(registrar.getObservationRegistry()).isEqualTo(observationRegistry); | ||
} | ||
|
||
@Test | ||
void isRegisteredInAutoConfigurationsFile() { | ||
List<String> configurations = ImportCandidates.load(AutoConfiguration.class, null).getCandidates(); | ||
assertThat(configurations).contains(ScheduledTasksObservabilityAutoConfiguration.class.getName()); | ||
} | ||
|
||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters