From 7df8b59a7f54c6b5ac2e2d39d001bb7602354825 Mon Sep 17 00:00:00 2001 From: Johnny Lim Date: Tue, 18 Oct 2022 09:11:07 +0900 Subject: [PATCH] Polish "Reorganize HTTP Observation types" See gh-29334 --- ...efaultClientRequestObservationConvention.java | 4 ++-- ...efaultServerRequestObservationConvention.java | 10 +++++----- ...efaultServerRequestObservationConvention.java | 9 ++++----- ...efaultClientRequestObservationConvention.java | 16 ++++++++-------- 4 files changed, 19 insertions(+), 20 deletions(-) diff --git a/spring-web/src/main/java/org/springframework/http/client/observation/DefaultClientRequestObservationConvention.java b/spring-web/src/main/java/org/springframework/http/client/observation/DefaultClientRequestObservationConvention.java index 8c5b728dbc..762077d541 100644 --- a/spring-web/src/main/java/org/springframework/http/client/observation/DefaultClientRequestObservationConvention.java +++ b/spring-web/src/main/java/org/springframework/http/client/observation/DefaultClientRequestObservationConvention.java @@ -164,8 +164,8 @@ public class DefaultClientRequestObservationConvention implements ClientRequestO if (statusCode.is2xxSuccessful()) { return HTTP_OUTCOME_SUCCESS; } - else if (statusCode instanceof HttpStatus status){ - return KeyValue.of("outcome", status.series().name()); + else if (statusCode instanceof HttpStatus status) { + return KeyValue.of(ClientHttpObservationDocumentation.LowCardinalityKeyNames.OUTCOME, status.series().name()); } else { return HTTP_OUTCOME_UNKNOWN; diff --git a/spring-web/src/main/java/org/springframework/http/observation/DefaultServerRequestObservationConvention.java b/spring-web/src/main/java/org/springframework/http/observation/DefaultServerRequestObservationConvention.java index 38ce54a453..b8f1ca947c 100644 --- a/spring-web/src/main/java/org/springframework/http/observation/DefaultServerRequestObservationConvention.java +++ b/spring-web/src/main/java/org/springframework/http/observation/DefaultServerRequestObservationConvention.java @@ -86,7 +86,7 @@ public class DefaultServerRequestObservationConvention implements ServerRequestO @Override public KeyValues getHighCardinalityKeyValues(ServerRequestObservationContext context) { - return KeyValues.of(uriExpanded(context)); + return KeyValues.of(httpUrl(context)); } protected KeyValue method(ServerRequestObservationContext context) { @@ -104,7 +104,7 @@ public class DefaultServerRequestObservationConvention implements ServerRequestO if (pattern.isEmpty()) { return URI_ROOT; } - return KeyValue.of("uri", pattern); + return KeyValue.of(ServerHttpObservationDocumentation.LowCardinalityKeyNames.URI, pattern); } if (context.getResponse() != null) { HttpStatus status = HttpStatus.resolve(context.getResponse().getStatus()); @@ -139,7 +139,7 @@ public class DefaultServerRequestObservationConvention implements ServerRequestO return HTTP_OUTCOME_UNKNOWN; } - protected KeyValue uriExpanded(ServerRequestObservationContext context) { + protected KeyValue httpUrl(ServerRequestObservationContext context) { if (context.getCarrier() != null) { return KeyValue.of(ServerHttpObservationDocumentation.HighCardinalityKeyNames.HTTP_URL, context.getCarrier().getRequestURI()); } @@ -153,8 +153,8 @@ public class DefaultServerRequestObservationConvention implements ServerRequestO if (statusCode.is2xxSuccessful()) { return HTTP_OUTCOME_SUCCESS; } - else if (statusCode instanceof HttpStatus status){ - return KeyValue.of("outcome", status.series().name()); + else if (statusCode instanceof HttpStatus status) { + return KeyValue.of(ServerHttpObservationDocumentation.LowCardinalityKeyNames.OUTCOME, status.series().name()); } else { return HTTP_OUTCOME_UNKNOWN; diff --git a/spring-web/src/main/java/org/springframework/http/observation/reactive/DefaultServerRequestObservationConvention.java b/spring-web/src/main/java/org/springframework/http/observation/reactive/DefaultServerRequestObservationConvention.java index f7701ffee8..60400992c9 100644 --- a/spring-web/src/main/java/org/springframework/http/observation/reactive/DefaultServerRequestObservationConvention.java +++ b/spring-web/src/main/java/org/springframework/http/observation/reactive/DefaultServerRequestObservationConvention.java @@ -110,7 +110,7 @@ public class DefaultServerRequestObservationConvention implements ServerRequestO if (pattern.toString().isEmpty()) { return URI_ROOT; } - return KeyValue.of("uri", pattern.toString()); + return KeyValue.of(ServerHttpObservationDocumentation.LowCardinalityKeyNames.URI, pattern.toString()); } if (context.getResponse() != null) { HttpStatus status = HttpStatus.resolve(context.getResponse().getStatusCode().value()); @@ -149,8 +149,7 @@ public class DefaultServerRequestObservationConvention implements ServerRequestO protected KeyValue httpUrl(ServerRequestObservationContext context) { if (context.getCarrier() != null) { - String uriExpanded = context.getCarrier().getPath().toString(); - return KeyValue.of(ServerHttpObservationDocumentation.HighCardinalityKeyNames.HTTP_URL, uriExpanded); + return KeyValue.of(ServerHttpObservationDocumentation.HighCardinalityKeyNames.HTTP_URL, context.getCarrier().getPath().toString()); } return HTTP_URL_UNKNOWN; } @@ -161,8 +160,8 @@ public class DefaultServerRequestObservationConvention implements ServerRequestO if (statusCode.is2xxSuccessful()) { return HTTP_OUTCOME_SUCCESS; } - else if (statusCode instanceof HttpStatus status){ - return KeyValue.of("outcome", status.series().name()); + else if (statusCode instanceof HttpStatus status) { + return KeyValue.of(ServerHttpObservationDocumentation.LowCardinalityKeyNames.OUTCOME, status.series().name()); } else { return HTTP_OUTCOME_UNKNOWN; diff --git a/spring-webflux/src/main/java/org/springframework/web/reactive/function/client/DefaultClientRequestObservationConvention.java b/spring-webflux/src/main/java/org/springframework/web/reactive/function/client/DefaultClientRequestObservationConvention.java index 69c088e476..8c5ed618d4 100644 --- a/spring-webflux/src/main/java/org/springframework/web/reactive/function/client/DefaultClientRequestObservationConvention.java +++ b/spring-webflux/src/main/java/org/springframework/web/reactive/function/client/DefaultClientRequestObservationConvention.java @@ -40,19 +40,19 @@ public class DefaultClientRequestObservationConvention implements ClientRequestO private static final KeyValue METHOD_NONE = KeyValue.of(ClientHttpObservationDocumentation.LowCardinalityKeyNames.METHOD, "none"); - private static final KeyValue STATUS_IO_ERROR = KeyValue.of(org.springframework.http.client.observation.ClientHttpObservationDocumentation.LowCardinalityKeyNames.STATUS, "IO_ERROR"); + private static final KeyValue STATUS_IO_ERROR = KeyValue.of(ClientHttpObservationDocumentation.LowCardinalityKeyNames.STATUS, "IO_ERROR"); - private static final KeyValue STATUS_CLIENT_ERROR = KeyValue.of(org.springframework.http.client.observation.ClientHttpObservationDocumentation.LowCardinalityKeyNames.STATUS, "CLIENT_ERROR"); + private static final KeyValue STATUS_CLIENT_ERROR = KeyValue.of(ClientHttpObservationDocumentation.LowCardinalityKeyNames.STATUS, "CLIENT_ERROR"); - private static final KeyValue HTTP_OUTCOME_SUCCESS = KeyValue.of(org.springframework.http.client.observation.ClientHttpObservationDocumentation.LowCardinalityKeyNames.OUTCOME, "SUCCESS"); + private static final KeyValue HTTP_OUTCOME_SUCCESS = KeyValue.of(ClientHttpObservationDocumentation.LowCardinalityKeyNames.OUTCOME, "SUCCESS"); - private static final KeyValue HTTP_OUTCOME_UNKNOWN = KeyValue.of(org.springframework.http.client.observation.ClientHttpObservationDocumentation.LowCardinalityKeyNames.OUTCOME, "UNKNOWN"); + private static final KeyValue HTTP_OUTCOME_UNKNOWN = KeyValue.of(ClientHttpObservationDocumentation.LowCardinalityKeyNames.OUTCOME, "UNKNOWN"); private static final KeyValue EXCEPTION_NONE = KeyValue.of(ClientHttpObservationDocumentation.LowCardinalityKeyNames.EXCEPTION, "none"); - private static final KeyValue HTTP_URL_NONE = KeyValue.of(org.springframework.http.client.observation.ClientHttpObservationDocumentation.HighCardinalityKeyNames.HTTP_URL, "none"); + private static final KeyValue HTTP_URL_NONE = KeyValue.of(ClientHttpObservationDocumentation.HighCardinalityKeyNames.HTTP_URL, "none"); - private static final KeyValue CLIENT_NAME_NONE = KeyValue.of(org.springframework.http.client.observation.ClientHttpObservationDocumentation.HighCardinalityKeyNames.CLIENT_NAME, "none"); + private static final KeyValue CLIENT_NAME_NONE = KeyValue.of(ClientHttpObservationDocumentation.HighCardinalityKeyNames.CLIENT_NAME, "none"); private final String name; @@ -162,8 +162,8 @@ public class DefaultClientRequestObservationConvention implements ClientRequestO if (statusCode.is2xxSuccessful()) { return HTTP_OUTCOME_SUCCESS; } - else if (statusCode instanceof HttpStatus status){ - return KeyValue.of("outcome", status.series().name()); + else if (statusCode instanceof HttpStatus status) { + return KeyValue.of(ClientHttpObservationDocumentation.LowCardinalityKeyNames.OUTCOME, status.series().name()); } else { return HTTP_OUTCOME_UNKNOWN;