SpringCloud/spring-cloud-commons
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Sets parentObservation on circuitbreaker Observation (#1159)

Browse Source
This commit is contained in:
Marcin Grzejszczak
2022-10-24 17:02:50 +02:00
committed by GitHub
parent ceab8dc08f
commit 6a03d2b201
4 changed files with 32 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
spring-cloud-commons/src/main/java/org/springframework/cloud/client/circuitbreaker/observation/CircuitBreakerObservationDocumentation.java
View File

@@ -42,11 +42,10 @@ enum CircuitBreakerObservationDocumentation implements ObservationDocumentation
return "spring.cloud.circuitbreaker";
}
// TODO: Move this to convention with the next micrometer release
// @Override
// public String getContextualName() {
// return "circuit-breaker";
// }
@Override
public String getContextualName() {
return "circuit-breaker";
}
},
/**
@@ -69,11 +68,10 @@ enum CircuitBreakerObservationDocumentation implements ObservationDocumentation
return "spring.cloud.circuitbreaker";
}
// TODO: Move this to convention with the next micrometer release
// @Override
// public String getContextualName() {
// return "circuit-breaker fallback";
// }
@Override
public String getContextualName() {
return "circuit-breaker fallback";
}
};
public enum LowCardinalityTags implements KeyName {

8
spring-cloud-commons/src/main/java/org/springframework/cloud/client/circuitbreaker/observation/ObservedFunction.java
View File

@@ -33,13 +33,13 @@ class ObservedFunction<T> implements Function<Throwable, T> {
private final Observation observation;
// TODO: Move out contextual name with the next micrometer release
ObservedFunction(CircuitBreakerObservationConvention customConvention, CircuitBreakerObservationContext context,
String conextualName, ObservationRegistry observationRegistry, Function<Throwable, T> toRun) {
this.delegate = toRun;
this.observation = CircuitBreakerObservationDocumentation.CIRCUIT_BREAKER_SUPPLIER_OBSERVATION.observation(
customConvention, DefaultCircuitBreakerObservationConvention.INSTANCE, () -> context,
observationRegistry);
this.observation = CircuitBreakerObservationDocumentation.CIRCUIT_BREAKER_SUPPLIER_OBSERVATION
.observation(customConvention, DefaultCircuitBreakerObservationConvention.INSTANCE, () -> context,
observationRegistry)
.parentObservation(observationRegistry.getCurrentObservation());
this.observation.contextualName(conextualName);
}

8
spring-cloud-commons/src/main/java/org/springframework/cloud/client/circuitbreaker/observation/ObservedSupplier.java
View File

@@ -33,13 +33,13 @@ class ObservedSupplier<T> implements Supplier<T> {
private final Observation observation;
// TODO: Move out contextual name with the next micrometer release
ObservedSupplier(CircuitBreakerObservationConvention customConvention, CircuitBreakerObservationContext context,
String contextualName, ObservationRegistry observationRegistry, Supplier<T> toRun) {
this.delegate = toRun;
this.observation = CircuitBreakerObservationDocumentation.CIRCUIT_BREAKER_SUPPLIER_OBSERVATION.observation(
customConvention, DefaultCircuitBreakerObservationConvention.INSTANCE, () -> context,
observationRegistry);
this.observation = CircuitBreakerObservationDocumentation.CIRCUIT_BREAKER_SUPPLIER_OBSERVATION
.observation(customConvention, DefaultCircuitBreakerObservationConvention.INSTANCE, () -> context,
observationRegistry)
.parentObservation(observationRegistry.getCurrentObservation());
this.observation.contextualName(contextualName);
}

53
spring-cloud-commons/src/test/java/org/springframework/cloud/client/circuitbreaker/observation/ObservedCircuitBreakerTests.java
View File

@@ -16,19 +16,14 @@
package org.springframework.cloud.client.circuitbreaker.observation;
import java.util.ArrayList;
import java.util.List;
import java.util.function.Function;
import java.util.function.Supplier;
import io.micrometer.common.KeyValues;
import io.micrometer.observation.Observation;
import io.micrometer.observation.ObservationHandler;
import io.micrometer.observation.ObservationRegistry;
import io.micrometer.observation.tck.ObservationContextAssert;
import io.micrometer.observation.tck.TestObservationRegistry;
import io.micrometer.observation.tck.TestObservationRegistryAssert;
import org.assertj.core.api.BDDAssertions;
import org.junit.jupiter.api.Test;
import org.springframework.cloud.client.circuitbreaker.CircuitBreaker;
@@ -89,9 +84,7 @@ class ObservedCircuitBreakerTests {
@Test
void should_wrap_circuit_breaker_with_fallback_in_observation() {
ObservationRegistry registry = ObservationRegistry.create();
MyHandler myHandler = new MyHandler();
registry.observationConfig().observationHandler(myHandler);
TestObservationRegistry registry = TestObservationRegistry.create();
CircuitBreaker delegate = new CircuitBreaker() {
@Override
public <T> T run(Supplier<T> toRun, Function<Throwable, T> fallback) {
@@ -105,39 +98,25 @@ class ObservedCircuitBreakerTests {
};
ObservedCircuitBreaker circuitBreaker = new ObservedCircuitBreaker(delegate, registry);
String result = circuitBreaker.run(() -> {
Observation parent = Observation.createNotStarted("parent", registry);
String result = parent.observe(() -> circuitBreaker.run(() -> {
throw new IllegalStateException("BOOM!");
}, throwable -> "goodbye");
}, throwable -> "goodbye"));
then(result).isEqualTo("goodbye");
List<Observation.Context> contexts = myHandler.contexts;
// TODO: Convert to usage of test registry assert with the next micrometer release
BDDAssertions.then(contexts).hasSize(2);
BDDAssertions.then(contexts.get(0))
.satisfies(context -> ObservationContextAssert.then(context)
.hasNameEqualTo("spring.cloud.circuitbreaker").hasContextualNameEqualTo("circuit-breaker")
.hasLowCardinalityKeyValue("spring.cloud.circuitbreaker.type", "supplier"));
BDDAssertions.then(contexts.get(1)).satisfies(context -> ObservationContextAssert.then(context)
.hasNameEqualTo("spring.cloud.circuitbreaker").hasContextualNameEqualTo("circuit-breaker fallback")
.hasLowCardinalityKeyValue("spring.cloud.circuitbreaker.type", "function"));
}
// TODO: Convert to usage of test registry assert with the next micrometer release
static class MyHandler implements ObservationHandler<Observation.Context> {
List<Observation.Context> contexts = new ArrayList<>();
@Override
public void onStop(Observation.Context context) {
this.contexts.add(context);
}
@Override
public boolean supportsContext(Observation.Context context) {
return true;
}
TestObservationRegistryAssert.then(registry).hasNumberOfObservationsEqualTo(3)
.hasHandledContextsThatSatisfy(contexts -> {
ObservationContextAssert.then(contexts.get(0)).hasNameEqualTo("parent");
ObservationContextAssert.then(contexts.get(1)).hasNameEqualTo("spring.cloud.circuitbreaker")
.hasContextualNameEqualTo("circuit-breaker")
.hasLowCardinalityKeyValue("spring.cloud.circuitbreaker.type", "supplier")
.hasParentObservationEqualTo(parent);
ObservationContextAssert.then(contexts.get(2)).hasNameEqualTo("spring.cloud.circuitbreaker")
.hasContextualNameEqualTo("circuit-breaker fallback")
.hasLowCardinalityKeyValue("spring.cloud.circuitbreaker.type", "function")
.hasParentObservationEqualTo(parent);
});
}
}