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

Attaches error to Observation (#2743)

Browse Source 
without this change when there is no response and the observation closing web exception handler stops the observation we've forgotten to attach an error to it
with this change we're attaching the error
This commit is contained in:
Marcin Grzejszczak
2022-10-04 23:09:47 +02:00
committed by GitHub
parent f2192b0770
commit db35e58264
6 changed files with 23 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
spring-cloud-gateway-server/src/main/java/org/springframework/cloud/gateway/filter/headers/observation/DefaultGatewayObservationConvention.java
View File

@@ -50,8 +50,9 @@ public class DefaultGatewayObservationConvention implements GatewayObservationCo
return keyValues;
}
Route route = context.getServerWebExchange().getAttribute(ServerWebExchangeUtils.GATEWAY_ROUTE_ATTR);
keyValues = keyValues.and(ROUTE_URI.withValue(route.getUri().toString()),
METHOD.withValue(context.getRequest().getMethod().name()))
keyValues = keyValues
.and(ROUTE_URI.withValue(route.getUri().toString()),
METHOD.withValue(context.getRequest().getMethod().name()))
.and(ROUTE_ID.withValue(route.getId()));
ServerHttpResponse response = context.getResponse();
if (response != null && response.getStatusCode() != null) {

1
spring-cloud-gateway-server/src/main/java/org/springframework/cloud/gateway/filter/headers/observation/GatewayContext.java
View File

@@ -53,4 +53,5 @@ public class GatewayContext extends RequestReplySenderContext<HttpHeaders, Serve
public ServerWebExchange getServerWebExchange() {
return serverWebExchange;
}
}

1
spring-cloud-gateway-server/src/main/java/org/springframework/cloud/gateway/filter/headers/observation/ObservationClosingWebExceptionHandler.java
View File

@@ -41,6 +41,7 @@ public class ObservationClosingWebExceptionHandler implements WebExceptionHandle
Observation observation = exchange.getAttribute(ObservedRequestHttpHeadersFilter.CHILD_OBSERVATION);
if (observation != null) {
log.debug(() -> "Observation was not previously stopped, will stop it.");
observation.error(ex);
observation.stop();
}
}

11
spring-cloud-gateway-server/src/test/java/org/springframework/cloud/gateway/filter/headers/observation/B3BraveObservedHttpHeadersFilterTests.java
View File

@@ -104,12 +104,11 @@ class B3BraveObservedHttpHeadersFilterTests {
assertThat(headers.get("b3").get(0)).matches("^" + context.traceId() + "-(.*)-1-" + context.spanId() + "$");
List<FinishedSpan> finishedSpans = testSpanHandler.spans().stream().map(BraveFinishedSpan::new)
.collect(Collectors.toList());
SpansAssert.then(finishedSpans).hasASpanWithName("HTTP GET", spanAssert -> spanAssert
.hasTag("spring.cloud.gateway.route.id", "foo")
.hasTag("http.method", "GET")
.hasTag("http.status_code", "200")
.hasTag("spring.cloud.gateway.route.uri", "http://localhost:8080/")
.hasTag("http.uri", "http://localhost:8080/get"));
SpansAssert.then(finishedSpans).hasASpanWithName("HTTP GET",
spanAssert -> spanAssert.hasTag("spring.cloud.gateway.route.id", "foo").hasTag("http.method", "GET")
.hasTag("http.status_code", "200")
.hasTag("spring.cloud.gateway.route.uri", "http://localhost:8080/")
.hasTag("http.uri", "http://localhost:8080/get"));
});
}

4
spring-cloud-gateway-server/src/test/java/org/springframework/cloud/gateway/filter/headers/observation/ObservationClosingWebExceptionHandlerTests.java
View File

@@ -52,8 +52,10 @@ class ObservationClosingWebExceptionHandlerTests {
void shouldStopTheObservationIfItWasNotStoppedPreviouslyAndThereWasAnError() {
Observation observation = Mockito.mock(Observation.class);
exchange.getAttributes().put(ObservedRequestHttpHeadersFilter.CHILD_OBSERVATION, observation);
RuntimeException runtimeException = new RuntimeException();
assertThatNoException().isThrownBy(() -> handler.handle(exchange, new RuntimeException()));
assertThatNoException().isThrownBy(() -> handler.handle(exchange, runtimeException));
Mockito.verify(observation).error(runtimeException);
Mockito.verify(observation).stop();
}

21
spring-cloud-gateway-server/src/test/java/org/springframework/cloud/gateway/filter/headers/observation/ObservedHttpHeadersFilterTests.java
View File

@@ -84,17 +84,16 @@ public class ObservedHttpHeadersFilterTests extends SampleTestRunner {
.containsEntry("X-B3-TraceId", Collections.singletonList(context.traceId()))
.doesNotContainEntry("X-B3-SpanId", Collections.singletonList(context.spanId()))
.containsKey("X-B3-SpanId");
SpansAssert.then(bb.getFinishedSpans()).hasASpanWithName("HTTP GET", spanAssert -> spanAssert
.hasTag("http.method", "GET").hasTag("http.status_code", "200")
.hasTag("http.uri", "http://localhost:8080/get")
.hasTag("spring.cloud.gateway.route.uri", "http://localhost:8080/")
.hasTag("spring.cloud.gateway.route.id", "foo"));
MeterRegistryAssert.then(meterRegistry)
.hasTimerWithNameAndTags("http.client.requests",
Tags.of("spring.cloud.gateway.route.id", "foo", "error", "none", "http.method", "GET", "http.status_code", "200", "spring.cloud.gateway.route.uri",
"http://localhost:8080/"))
.hasMeterWithNameAndTags("http.client.requests.active",
Tags.of("spring.cloud.gateway.route.id", "foo", "http.method", "GET", "spring.cloud.gateway.route.uri", "http://localhost:8080/"));
SpansAssert.then(bb.getFinishedSpans()).hasASpanWithName("HTTP GET",
spanAssert -> spanAssert.hasTag("http.method", "GET").hasTag("http.status_code", "200")
.hasTag("http.uri", "http://localhost:8080/get")
.hasTag("spring.cloud.gateway.route.uri", "http://localhost:8080/")
.hasTag("spring.cloud.gateway.route.id", "foo"));
MeterRegistryAssert.then(meterRegistry).hasTimerWithNameAndTags("http.client.requests",
Tags.of("spring.cloud.gateway.route.id", "foo", "error", "none", "http.method", "GET",
"http.status_code", "200", "spring.cloud.gateway.route.uri", "http://localhost:8080/"))
.hasMeterWithNameAndTags("http.client.requests.active", Tags.of("spring.cloud.gateway.route.id",
"foo", "http.method", "GET", "spring.cloud.gateway.route.uri", "http://localhost:8080/"));
};
}