Skip to content

Commit 841e24d

Browse files
mhalbrittermhalbritter
committed
Add auto-configuration for Micrometer 2.0.0 Observation API
- Adds a ObservationRegistry bean - Add support for ObservationRegistryCustomizers - Enables timer creation for observations if micrometer-core is on the classpath - Registers ObservationPredicate, GlobalTagsProvider and ObservationHandler on the MeterRegistry - Applies grouping to the ObservationHandlers: MeterObservationHandler are added to a FirstMatchingCompositeObservationHandler - If micrometer-tracing is on the classpath, the TracingObservationHandler are added to a FirstMatchingCompositeObservationHandler See spring-projectsgh-29666
1 parent 47eb630 commit 841e24d

File tree

17 files changed

+1171
-3
lines changed

17 files changed

+1171
-3
lines changed

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,9 @@ dependencies {
4747
optional("com.zaxxer:HikariCP")
4848
optional("io.dropwizard.metrics:metrics-jmx")
4949
optional("io.lettuce:lettuce-core")
50+
optional("io.micrometer:micrometer-observation")
5051
optional("io.micrometer:micrometer-core")
52+
optional("io.micrometer:micrometer-tracing-api")
5153
optional("io.micrometer:micrometer-binders")
5254
optional("io.micrometer:micrometer-registry-appoptics")
5355
optional("io.micrometer:micrometer-registry-atlas") {

‎spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/observation/HandlersObservationRegistryCustomizer.java

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
/*
2+
* Copyright 2012-2022 the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package org.springframework.boot.actuate.autoconfigure.observation;
18+
19+
import java.util.ArrayList;
20+
import java.util.List;
21+
import java.util.Map;
22+
import java.util.TreeMap;
23+
24+
import io.micrometer.observation.ObservationHandler;
25+
import io.micrometer.observation.ObservationHandler.FirstMatchingCompositeObservationHandler;
26+
import io.micrometer.observation.ObservationRegistry;
27+
28+
/**
29+
* Installs {@link ObservationHandler} into an {@link ObservationRegistry}.
30+
*
31+
* Uses an {@link ObservationHandlerGrouping} strategy to group the handlers. All handlers
32+
* which belong to a group are added with their group members into a
33+
* {@link FirstMatchingCompositeObservationHandler}. All handlers without a group are
34+
* added directly to the {@link ObservationRegistry}. The group numbers are ordered
35+
* ascending, meaning lower numbers are added first to the {@link ObservationRegistry}.
36+
*
37+
* @author Moritz Halbritter
38+
*/
39+
class HandlersObservationRegistryCustomizer implements ObservationRegistryCustomizer<ObservationRegistry> {
40+
41+
private final List<ObservationHandler<?>> observationHandlers;
42+
43+
private final ObservationHandlerGrouping observationHandlerGrouping;
44+
45+
HandlersObservationRegistryCustomizer(List<ObservationHandler<?>> observationHandlers,
46+
ObservationHandlerGrouping observationHandlerGrouping) {
47+
this.observationHandlers = observationHandlers;
48+
this.observationHandlerGrouping = observationHandlerGrouping;
49+
}
50+
51+
@Override
52+
public void customize(ObservationRegistry registry) {
53+
Map<Integer, List<ObservationHandler<?>>> groupedHandlers = new TreeMap<>();
54+
for (ObservationHandler<?> observationHandler : this.observationHandlers) {
55+
Integer group = this.observationHandlerGrouping.getGroup(observationHandler);
56+
if (group == null) {
57+
registry.observationConfig().observationHandler(observationHandler);
58+
}
59+
else {
60+
groupedHandlers.computeIfAbsent(group, (ignored) -> new ArrayList<>()).add(observationHandler);
61+
}
62+
}
63+
for (List<ObservationHandler<?>> handlers : groupedHandlers.values()) {
64+
registry.observationConfig()
65+
.observationHandler(new FirstMatchingCompositeObservationHandler(castToRawType(handlers)));
66+
}
67+
}
68+
69+
@SuppressWarnings({ "unchecked", "rawtypes" })
70+
private List<ObservationHandler> castToRawType(List<ObservationHandler<?>> handlers) {
71+
// See https://github.com/micrometer-metrics/micrometer/issues/3064
72+
return (List) handlers;
73+
}
74+
75+
}

‎spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/observation/NoTracingObservationHandlerGrouping.java

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
/*
2+
* Copyright 2012-2022 the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package org.springframework.boot.actuate.autoconfigure.observation;
18+
19+
import io.micrometer.core.instrument.observation.MeterObservationHandler;
20+
import io.micrometer.observation.ObservationHandler;
21+
22+
/**
23+
* {@link ObservationHandlerGrouping} used by {@link ObservationAutoConfiguration} if
24+
* micrometer-tracing is not on the classpath.
25+
*
26+
* @author Moritz Halbritter
27+
*/
28+
class NoTracingObservationHandlerGrouping implements ObservationHandlerGrouping {
29+
30+
private static final int METER_OBSERVATION_HANDLER_GROUP = 1;
31+
32+
@Override
33+
public Integer getGroup(ObservationHandler<?> observationHandler) {
34+
if (observationHandler instanceof MeterObservationHandler) {
35+
return METER_OBSERVATION_HANDLER_GROUP;
36+
}
37+
return null;
38+
}
39+
40+
}

‎spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/observation/ObservationAutoConfiguration.java

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
/*
2+
* Copyright 2012-2022 the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package org.springframework.boot.actuate.autoconfigure.observation;
18+
19+
import java.util.List;
20+
21+
import io.micrometer.core.instrument.MeterRegistry;
22+
import io.micrometer.observation.Observation.GlobalTagsProvider;
23+
import io.micrometer.observation.ObservationHandler;
24+
import io.micrometer.observation.ObservationPredicate;
25+
import io.micrometer.observation.ObservationRegistry;
26+
import io.micrometer.tracing.handler.TracingObservationHandler;
27+
28+
import org.springframework.beans.factory.ObjectProvider;
29+
import org.springframework.boot.actuate.autoconfigure.metrics.CompositeMeterRegistryAutoConfiguration;
30+
import org.springframework.boot.autoconfigure.AutoConfiguration;
31+
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
32+
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
33+
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
34+
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
35+
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingClass;
36+
import org.springframework.context.annotation.Bean;
37+
import org.springframework.context.annotation.Configuration;
38+
39+
/**
40+
* {@link EnableAutoConfiguration Auto-configuration} for the Micrometer Observation API.
41+
*
42+
* @author Moritz Halbritter
43+
* @since 3.0.0
44+
*/
45+
@AutoConfiguration(after = CompositeMeterRegistryAutoConfiguration.class)
46+
@ConditionalOnClass(ObservationRegistry.class)
47+
public class ObservationAutoConfiguration {
48+
49+
@Bean
50+
static ObservationRegistryPostProcessor observationRegistryPostProcessor(
51+
ObjectProvider<ObservationRegistryCustomizer<?>> observationRegistryCustomizers,
52+
ObjectProvider<ObservationPredicate> observationPredicates,
53+
ObjectProvider<GlobalTagsProvider<?>> tagProviders) {
54+
return new ObservationRegistryPostProcessor(observationRegistryCustomizers, observationPredicates,
55+
tagProviders);
56+
}
57+
58+
@Bean
59+
@ConditionalOnMissingBean
60+
ObservationRegistry observationRegistry() {
61+
return ObservationRegistry.create();
62+
}
63+
64+
@Bean
65+
@ConditionalOnMissingBean
66+
HandlersObservationRegistryCustomizer handlersObservationRegistryCustomizer(
67+
List<ObservationHandler<?>> observationHandlers, ObservationHandlerGrouping observationHandlerGrouping) {
68+
return new HandlersObservationRegistryCustomizer(observationHandlers, observationHandlerGrouping);
69+
}
70+
71+
@Configuration(proxyBeanMethods = false)
72+
@ConditionalOnBean(MeterRegistry.class)
73+
static class MetricsConfiguration {
74+
75+
@Bean
76+
TimerObservationHandlerObservationRegistryCustomizer enableTimerObservationHandler(
77+
MeterRegistry meterRegistry) {
78+
return new TimerObservationHandlerObservationRegistryCustomizer(meterRegistry);
79+
}
80+
81+
}
82+
83+
@Configuration(proxyBeanMethods = false)
84+
@ConditionalOnMissingClass("io.micrometer.tracing.handler.TracingObservationHandler")
85+
static class NoTracingConfiguration {
86+
87+
@Bean
88+
ObservationHandlerGrouping noTracingObservationHandlerGrouping() {
89+
return new NoTracingObservationHandlerGrouping();
90+
}
91+
92+
}
93+
94+
@Configuration(proxyBeanMethods = false)
95+
@ConditionalOnClass(TracingObservationHandler.class)
96+
static class TracingConfiguration {
97+
98+
@Bean
99+
ObservationHandlerGrouping tracingObservationHandlerGrouping() {
100+
return new TracingObservationHandlerGrouping();
101+
}
102+
103+
}
104+
105+
}

‎spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/observation/ObservationHandlerGrouping.java

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
/*
2+
* Copyright 2012-2022 the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package org.springframework.boot.actuate.autoconfigure.observation;
18+
19+
import io.micrometer.observation.ObservationHandler;
20+
21+
/**
22+
* Strategy to get the group for an {@link ObservationHandler}.
23+
*
24+
* @author Moritz Halbritter
25+
* @since 3.0.0
26+
*/
27+
public interface ObservationHandlerGrouping {
28+
29+
/**
30+
* Returns the group number of the given {@code observationHandler}. If {@code null}
31+
* is returned, the {@link ObservationHandler} doesn't belong to any group.
32+
* @param observationHandler the observation handler to get the group for
33+
* @return group number or {@code null} if the handler doesn't belong to any group
34+
*/
35+
Integer getGroup(ObservationHandler<?> observationHandler);
36+
37+
}

‎spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/observation/ObservationRegistryConfigurer.java

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
/*
2+
* Copyright 2012-2022 the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package org.springframework.boot.actuate.autoconfigure.observation;
18+
19+
import java.util.List;
20+
21+
import io.micrometer.observation.Observation.GlobalTagsProvider;
22+
import io.micrometer.observation.ObservationPredicate;
23+
import io.micrometer.observation.ObservationRegistry;
24+
25+
import org.springframework.beans.factory.ObjectProvider;
26+
import org.springframework.boot.util.LambdaSafe;
27+
28+
/**
29+
* Configurer to apply {@link ObservationRegistryCustomizer customizers} to
30+
* {@link ObservationRegistry observation registries}. Installs
31+
* {@link ObservationPredicate observation predicates} and {@link GlobalTagsProvider
32+
* global tag providers} into the {@link ObservationRegistry}.
33+
*
34+
* @author Moritz Halbritter
35+
*/
36+
class ObservationRegistryConfigurer {
37+
38+
private final ObjectProvider<ObservationRegistryCustomizer<?>> customizers;
39+
40+
private final ObjectProvider<ObservationPredicate> observationPredicates;
41+
42+
private final ObjectProvider<GlobalTagsProvider<?>> tagProviders;
43+
44+
ObservationRegistryConfigurer(ObjectProvider<ObservationRegistryCustomizer<?>> customizers,
45+
ObjectProvider<ObservationPredicate> observationPredicates,
46+
ObjectProvider<GlobalTagsProvider<?>> tagProviders) {
47+
this.customizers = customizers;
48+
this.observationPredicates = observationPredicates;
49+
this.tagProviders = tagProviders;
50+
}
51+
52+
void configure(ObservationRegistry registry) {
53+
registerObservationPredicates(registry);
54+
registerGlobalTagsProvider(registry);
55+
customize(registry);
56+
}
57+
58+
private void registerObservationPredicates(ObservationRegistry registry) {
59+
this.observationPredicates.orderedStream().forEach(
60+
(observationPredicate) -> registry.observationConfig().observationPredicate(observationPredicate));
61+
}
62+
63+
private void registerGlobalTagsProvider(ObservationRegistry registry) {
64+
this.tagProviders.orderedStream()
65+
.forEach((tagProvider) -> registry.observationConfig().tagsProvider(tagProvider));
66+
}
67+
68+
@SuppressWarnings("unchecked")
69+
private void customize(ObservationRegistry registry) {
70+
LambdaSafe.callbacks(ObservationRegistryCustomizer.class, asOrderedList(this.customizers), registry)
71+
.withLogger(ObservationRegistryConfigurer.class).invoke((customizer) -> customizer.customize(registry));
72+
}
73+
74+
private <T> List<T> asOrderedList(ObjectProvider<T> provider) {
75+
return provider.orderedStream().toList();
76+
}
77+
78+
}

‎spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/observation/ObservationRegistryCustomizer.java

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
/*
2+
* Copyright 2012-2022 the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package org.springframework.boot.actuate.autoconfigure.observation;
18+
19+
import io.micrometer.observation.ObservationRegistry;
20+
21+
/**
22+
* Callback interface that can be used to customize auto-configured
23+
* {@link ObservationRegistry ObservationRegistries}.
24+
*
25+
* @param <T> the registry type to customize
26+
* @author Moritz Halbritter
27+
* @since 3.0.0
28+
*/
29+
@FunctionalInterface
30+
public interface ObservationRegistryCustomizer<T extends ObservationRegistry> {
31+
32+
/**
33+
* Customize the given {@code registry}.
34+
* @param registry the registry to customize
35+
*/
36+
void customize(T registry);
37+
38+
}

0 commit comments

Comments
 (0)