Skip to content

Start building against Micrometer 1.10.0-M5 and Micrometer Tracing 1.0.0-M8 snapshots #32048

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -17,26 +17,27 @@
package org.springframework.boot.actuate.autoconfigure.observation;

import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.core.instrument.observation.TimerObservationHandler;
import io.micrometer.core.instrument.observation.DefaultMeterObservationHandler;
import io.micrometer.observation.ObservationRegistry;

/**
* Registers the {@link TimerObservationHandler} with an {@link ObservationRegistry}.
* Registers the {@link DefaultMeterObservationHandler} with an
* {@link ObservationRegistry}.
*
* @author Moritz Halbritter
*/
class TimerObservationHandlerObservationRegistryCustomizer
class DefaultMeterObservationHandlerObservationRegistryCustomizer
implements ObservationRegistryCustomizer<ObservationRegistry> {

private final MeterRegistry meterRegistry;

TimerObservationHandlerObservationRegistryCustomizer(MeterRegistry meterRegistry) {
DefaultMeterObservationHandlerObservationRegistryCustomizer(MeterRegistry meterRegistry) {
this.meterRegistry = meterRegistry;
}

@Override
public void customize(ObservationRegistry registry) {
registry.observationConfig().observationHandler(new TimerObservationHandler(this.meterRegistry));
registry.observationConfig().observationHandler(new DefaultMeterObservationHandler(this.meterRegistry));
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
package org.springframework.boot.actuate.autoconfigure.observation;

import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.observation.Observation.GlobalKeyValuesProvider;
import io.micrometer.observation.Observation.GlobalObservationConvention;
import io.micrometer.observation.ObservationHandler;
import io.micrometer.observation.ObservationPredicate;
import io.micrometer.observation.ObservationRegistry;
Expand Down Expand Up @@ -48,11 +48,11 @@ public class ObservationAutoConfiguration {
static ObservationRegistryPostProcessor observationRegistryPostProcessor(
ObjectProvider<ObservationRegistryCustomizer<?>> observationRegistryCustomizers,
ObjectProvider<ObservationPredicate> observationPredicates,
ObjectProvider<GlobalKeyValuesProvider<?>> keyValuesProviders,
ObjectProvider<GlobalObservationConvention<?>> observationConventions,
ObjectProvider<ObservationHandler<?>> observationHandlers,
ObjectProvider<ObservationHandlerGrouping> observationHandlerGrouping) {
return new ObservationRegistryPostProcessor(observationRegistryCustomizers, observationPredicates,
keyValuesProviders, observationHandlers, observationHandlerGrouping);
observationConventions, observationHandlers, observationHandlerGrouping);
}

@Bean
Expand All @@ -66,9 +66,9 @@ ObservationRegistry observationRegistry() {
static class MetricsConfiguration {

@Bean
TimerObservationHandlerObservationRegistryCustomizer enableTimerObservationHandler(
DefaultMeterObservationHandlerObservationRegistryCustomizer enableDefaultMeterObservationHandler(
MeterRegistry meterRegistry) {
return new TimerObservationHandlerObservationRegistryCustomizer(meterRegistry);
return new DefaultMeterObservationHandlerObservationRegistryCustomizer(meterRegistry);
}

}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

import java.util.List;

import io.micrometer.observation.Observation.GlobalKeyValuesProvider;
import io.micrometer.observation.Observation.GlobalObservationConvention;
import io.micrometer.observation.ObservationHandler;
import io.micrometer.observation.ObservationPredicate;
import io.micrometer.observation.ObservationRegistry;
Expand All @@ -29,10 +29,10 @@
/**
* Configurer to apply {@link ObservationRegistryCustomizer customizers} to
* {@link ObservationRegistry observation registries}. Installs
* {@link ObservationPredicate observation predicates} and {@link GlobalKeyValuesProvider
* global key values providers} into the {@link ObservationRegistry}. Also uses a
* {@link ObservationHandlerGrouping} to group handlers, which are then added to the
* {@link ObservationRegistry}.
* {@link ObservationPredicate observation predicates} and
* {@link GlobalObservationConvention global observation conventions} into the
* {@link ObservationRegistry}. Also uses a {@link ObservationHandlerGrouping} to group
* handlers, which are then added to the {@link ObservationRegistry}.
*
* @author Moritz Halbritter
*/
Expand All @@ -42,27 +42,27 @@ class ObservationRegistryConfigurer {

private final ObjectProvider<ObservationPredicate> observationPredicates;

private final ObjectProvider<GlobalKeyValuesProvider<?>> keyValuesProviders;
private final ObjectProvider<GlobalObservationConvention<?>> observationConventions;

private final ObjectProvider<ObservationHandler<?>> observationHandlers;

private final ObjectProvider<ObservationHandlerGrouping> observationHandlerGrouping;

ObservationRegistryConfigurer(ObjectProvider<ObservationRegistryCustomizer<?>> customizers,
ObjectProvider<ObservationPredicate> observationPredicates,
ObjectProvider<GlobalKeyValuesProvider<?>> keyValuesProviders,
ObjectProvider<GlobalObservationConvention<?>> observationConventions,
ObjectProvider<ObservationHandler<?>> observationHandlers,
ObjectProvider<ObservationHandlerGrouping> observationHandlerGrouping) {
this.customizers = customizers;
this.observationPredicates = observationPredicates;
this.keyValuesProviders = keyValuesProviders;
this.observationConventions = observationConventions;
this.observationHandlers = observationHandlers;
this.observationHandlerGrouping = observationHandlerGrouping;
}

void configure(ObservationRegistry registry) {
registerObservationPredicates(registry);
registerGlobalKeyValuesProviders(registry);
registerGlobalObservationConventions(registry);
registerHandlers(registry);
customize(registry);
}
Expand All @@ -77,9 +77,9 @@ private void registerObservationPredicates(ObservationRegistry registry) {
(observationPredicate) -> registry.observationConfig().observationPredicate(observationPredicate));
}

private void registerGlobalKeyValuesProviders(ObservationRegistry registry) {
this.keyValuesProviders.orderedStream()
.forEach((keyValuesProvider) -> registry.observationConfig().keyValuesProvider(keyValuesProvider));
private void registerGlobalObservationConventions(ObservationRegistry registry) {
this.observationConventions.orderedStream()
.forEach((convention) -> registry.observationConfig().observationConvention(convention));
}

@SuppressWarnings("unchecked")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

package org.springframework.boot.actuate.autoconfigure.observation;

import io.micrometer.observation.Observation.GlobalKeyValuesProvider;
import io.micrometer.observation.Observation.GlobalObservationConvention;
import io.micrometer.observation.ObservationHandler;
import io.micrometer.observation.ObservationPredicate;
import io.micrometer.observation.ObservationRegistry;
Expand All @@ -38,7 +38,7 @@ class ObservationRegistryPostProcessor implements BeanPostProcessor {

private final ObjectProvider<ObservationPredicate> observationPredicates;

private final ObjectProvider<GlobalKeyValuesProvider<?>> keyValuesProviders;
private final ObjectProvider<GlobalObservationConvention<?>> observationConventions;

private final ObjectProvider<ObservationHandler<?>> observationHandlers;

Expand All @@ -48,12 +48,12 @@ class ObservationRegistryPostProcessor implements BeanPostProcessor {

ObservationRegistryPostProcessor(ObjectProvider<ObservationRegistryCustomizer<?>> observationRegistryCustomizers,
ObjectProvider<ObservationPredicate> observationPredicates,
ObjectProvider<GlobalKeyValuesProvider<?>> keyValuesProviders,
ObjectProvider<GlobalObservationConvention<?>> observationConventions,
ObjectProvider<ObservationHandler<?>> observationHandlers,
ObjectProvider<ObservationHandlerGrouping> observationHandlerGrouping) {
this.observationRegistryCustomizers = observationRegistryCustomizers;
this.observationPredicates = observationPredicates;
this.keyValuesProviders = keyValuesProviders;
this.observationConventions = observationConventions;
this.observationHandlers = observationHandlers;
this.observationHandlerGrouping = observationHandlerGrouping;
}
Expand All @@ -69,7 +69,7 @@ public Object postProcessAfterInitialization(Object bean, String beanName) throw
private ObservationRegistryConfigurer getConfigurer() {
if (this.configurer == null) {
this.configurer = new ObservationRegistryConfigurer(this.observationRegistryCustomizers,
this.observationPredicates, this.keyValuesProviders, this.observationHandlers,
this.observationPredicates, this.observationConventions, this.observationHandlers,
this.observationHandlerGrouping);
}
return this.configurer;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,9 @@

import io.micrometer.tracing.Tracer;
import io.micrometer.tracing.handler.DefaultTracingObservationHandler;
import io.micrometer.tracing.handler.HttpClientTracingObservationHandler;
import io.micrometer.tracing.handler.HttpServerTracingObservationHandler;
import io.micrometer.tracing.http.HttpClientHandler;
import io.micrometer.tracing.http.HttpServerHandler;
import io.micrometer.tracing.handler.PropagatingReceiverTracingObservationHandler;
import io.micrometer.tracing.handler.PropagatingSenderTracingObservationHandler;
import io.micrometer.tracing.propagation.Propagator;

import org.springframework.boot.autoconfigure.AutoConfiguration;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
Expand Down Expand Up @@ -50,15 +49,15 @@ public class MicrometerTracingAutoConfiguration {

/**
* {@code @Order} value of
* {@link #httpServerTracingObservationHandler(Tracer, HttpServerHandler)}.
* {@link #propagatingReceiverTracingObservationHandler(Tracer, Propagator)}.
*/
public static final int HTTP_SERVER_TRACING_OBSERVATION_HANDLER_ORDER = 1000;
public static final int RECEIVER_TRACING_OBSERVATION_HANDLER_ORDER = 1000;

/**
* {@code @Order} value of
* {@link #httpClientTracingObservationHandler(Tracer, HttpClientHandler)}.
* {@link #propagatingSenderTracingObservationHandler(Tracer, Propagator)}.
*/
public static final int HTTP_CLIENT_TRACING_OBSERVATION_HANDLER_ORDER = 2000;
public static final int SENDER_TRACING_OBSERVATION_HANDLER_ORDER = 2000;

@Bean
@ConditionalOnMissingBean
Expand All @@ -70,20 +69,20 @@ public DefaultTracingObservationHandler defaultTracingObservationHandler(Tracer

@Bean
@ConditionalOnMissingBean
@ConditionalOnBean({ Tracer.class, HttpServerHandler.class })
@Order(HTTP_SERVER_TRACING_OBSERVATION_HANDLER_ORDER)
public HttpServerTracingObservationHandler httpServerTracingObservationHandler(Tracer tracer,
HttpServerHandler httpServerHandler) {
return new HttpServerTracingObservationHandler(tracer, httpServerHandler);
@ConditionalOnBean({ Tracer.class, Propagator.class })
@Order(RECEIVER_TRACING_OBSERVATION_HANDLER_ORDER)
public PropagatingReceiverTracingObservationHandler<?> propagatingReceiverTracingObservationHandler(Tracer tracer,
Propagator propagator) {
return new PropagatingReceiverTracingObservationHandler<>(tracer, propagator);
}

@Bean
@ConditionalOnMissingBean
@ConditionalOnBean({ Tracer.class, HttpClientHandler.class })
@Order(HTTP_CLIENT_TRACING_OBSERVATION_HANDLER_ORDER)
public HttpClientTracingObservationHandler httpClientTracingObservationHandler(Tracer tracer,
HttpClientHandler httpClientHandler) {
return new HttpClientTracingObservationHandler(tracer, httpClientHandler);
@ConditionalOnBean({ Tracer.class, Propagator.class })
@Order(SENDER_TRACING_OBSERVATION_HANDLER_ORDER)
public PropagatingSenderTracingObservationHandler<?> propagatingSenderTracingObservationHandler(Tracer tracer,
Propagator propagator) {
return new PropagatingSenderTracingObservationHandler<>(tracer, propagator);
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,16 @@
import static org.assertj.core.api.Assertions.assertThat;

/**
* Tests for {@link TimerObservationHandlerObservationRegistryCustomizer}.
* Tests for {@link DefaultMeterObservationHandlerObservationRegistryCustomizer}.
*
* @author Moritz Halbritter
*/
class TimerObservationHandlerObservationRegistryCustomizerTests {
class DefaultMeterObservationHandlerObservationRegistryCustomizerTests {

@Test
void customizeInstallsTimerObservationHandler() {
void customizeInstallsDefaultMeterObservationHandler() {
MeterRegistry meterRegistry = new SimpleMeterRegistry();
TimerObservationHandlerObservationRegistryCustomizer sut = new TimerObservationHandlerObservationRegistryCustomizer(
DefaultMeterObservationHandlerObservationRegistryCustomizer sut = new DefaultMeterObservationHandlerObservationRegistryCustomizer(
meterRegistry);
ObservationRegistry observationRegistry = ObservationRegistry.create();
sut.customize(observationRegistry);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
import io.micrometer.core.instrument.search.MeterNotFoundException;
import io.micrometer.observation.Observation;
import io.micrometer.observation.Observation.Context;
import io.micrometer.observation.Observation.GlobalKeyValuesProvider;
import io.micrometer.observation.Observation.GlobalObservationConvention;
import io.micrometer.observation.ObservationHandler;
import io.micrometer.observation.ObservationHandler.AllMatchingCompositeObservationHandler;
import io.micrometer.observation.ObservationHandler.FirstMatchingCompositeObservationHandler;
Expand Down Expand Up @@ -65,22 +65,22 @@ class ObservationAutoConfigurationTests {
.with(MetricsRun.simple()).withConfiguration(AutoConfigurations.of(ObservationAutoConfiguration.class));

@Test
void autoConfiguresTimerObservationHandler() {
void autoConfiguresDefaultMeterObservationHandler() {
this.contextRunner.run((context) -> {
ObservationRegistry observationRegistry = context.getBean(ObservationRegistry.class);
Observation.start("test-observation", observationRegistry).stop();
// When a TimerObservationHandler is registered, every stopped Observation
// leads to a timer
// When a DefaultMeterObservationHandler is registered, every stopped
// Observation leads to a timer
MeterRegistry meterRegistry = context.getBean(MeterRegistry.class);
assertThat(meterRegistry.get("test-observation").timer().count()).isEqualTo(1);
});
}

@Test
void allowsTimerObservationHandlerToBeDisabled() {
void allowsDefaultMeterObservationHandlerToBeDisabled() {
this.contextRunner.withClassLoader(new FilteredClassLoader(MeterRegistry.class))
.run((context) -> assertThat(context)
.doesNotHaveBean(TimerObservationHandlerObservationRegistryCustomizer.class));
.doesNotHaveBean(DefaultMeterObservationHandlerObservationRegistryCustomizer.class));
}

@Test
Expand Down Expand Up @@ -177,8 +177,8 @@ ObservationPredicate customPredicate() {
static class GlobalKeyValuesProviders {

@Bean
Observation.GlobalKeyValuesProvider<?> customKeyValuesProvider() {
return new GlobalKeyValuesProvider<>() {
GlobalObservationConvention<?> customConvention() {
return new GlobalObservationConvention<>() {
@Override
public boolean supportsContext(Context context) {
return true;
Expand Down
Loading