Polish "Reorganize HTTP Observation types"

izeye · izeye · commit 7df8b59a7f54 · 2022-10-18T09:11:07.000+09:00
See gh-29334
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
@@ -164,8 +164,8 @@ static KeyValue forStatus(HttpStatusCode statusCode) {
 			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
@@ -86,7 +86,7 @@ public KeyValues getLowCardinalityKeyValues(ServerRequestObservationContext cont
 
 	@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 @@ protected KeyValue uri(ServerRequestObservationContext context) {
 				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 @@ protected KeyValue outcome(ServerRequestObservationContext context) {
 		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 @@ static KeyValue forStatus(HttpStatusCode statusCode) {
 			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
@@ -110,7 +110,7 @@ protected KeyValue uri(ServerRequestObservationContext context) {
 				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 @@ protected KeyValue outcome(ServerRequestObservationContext context) {
 
 	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 @@ static KeyValue forStatus(HttpStatusCode statusCode) {
 			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
@@ -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 @@ static KeyValue forStatus(HttpStatusCode statusCode) {
 			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;

Original file line number	Diff line number	Diff line change
`@@ -164,8 +164,8 @@ static KeyValue forStatus(HttpStatusCode statusCode) {`
`164`	`164`	`if (statusCode.is2xxSuccessful()) {`
`165`	`165`	`return HTTP_OUTCOME_SUCCESS;`
`166`	`166`	`}`
`167`		`- else if (statusCode instanceof HttpStatus status){`
`168`		`- return KeyValue.of("outcome", status.series().name());`
	`167`	`+ else if (statusCode instanceof HttpStatus status) {`
	`168`	`+ return KeyValue.of(ClientHttpObservationDocumentation.LowCardinalityKeyNames.OUTCOME, status.series().name());`
`169`	`169`	`}`
`170`	`170`	`else {`
`171`	`171`	`return HTTP_OUTCOME_UNKNOWN;`
Original file line number	Diff line number	Diff line change
`@@ -86,7 +86,7 @@ public KeyValues getLowCardinalityKeyValues(ServerRequestObservationContext cont`
`86`	`86`
`87`	`87`	`@Override`
`88`	`88`	`public KeyValues getHighCardinalityKeyValues(ServerRequestObservationContext context) {`
`89`		`- return KeyValues.of(uriExpanded(context));`
	`89`	`+ return KeyValues.of(httpUrl(context));`
`90`	`90`	`}`
`91`	`91`
`92`	`92`	`protected KeyValue method(ServerRequestObservationContext context) {`
`@@ -104,7 +104,7 @@ protected KeyValue uri(ServerRequestObservationContext context) {`
`104`	`104`	`if (pattern.isEmpty()) {`
`105`	`105`	`return URI_ROOT;`
`106`	`106`	`}`
`107`		`- return KeyValue.of("uri", pattern);`
	`107`	`+ return KeyValue.of(ServerHttpObservationDocumentation.LowCardinalityKeyNames.URI, pattern);`
`108`	`108`	`}`
`109`	`109`	`if (context.getResponse() != null) {`
`110`	`110`	`HttpStatus status = HttpStatus.resolve(context.getResponse().getStatus());`
`@@ -139,7 +139,7 @@ protected KeyValue outcome(ServerRequestObservationContext context) {`
`139`	`139`	`return HTTP_OUTCOME_UNKNOWN;`
`140`	`140`	`}`
`141`	`141`
`142`		`- protected KeyValue uriExpanded(ServerRequestObservationContext context) {`
	`142`	`+ protected KeyValue httpUrl(ServerRequestObservationContext context) {`
`143`	`143`	`if (context.getCarrier() != null) {`
`144`	`144`	`return KeyValue.of(ServerHttpObservationDocumentation.HighCardinalityKeyNames.HTTP_URL, context.getCarrier().getRequestURI());`
`145`	`145`	`}`
`@@ -153,8 +153,8 @@ static KeyValue forStatus(HttpStatusCode statusCode) {`
`153`	`153`	`if (statusCode.is2xxSuccessful()) {`
`154`	`154`	`return HTTP_OUTCOME_SUCCESS;`
`155`	`155`	`}`
`156`		`- else if (statusCode instanceof HttpStatus status){`
`157`		`- return KeyValue.of("outcome", status.series().name());`
	`156`	`+ else if (statusCode instanceof HttpStatus status) {`
	`157`	`+ return KeyValue.of(ServerHttpObservationDocumentation.LowCardinalityKeyNames.OUTCOME, status.series().name());`
`158`	`158`	`}`
`159`	`159`	`else {`
`160`	`160`	`return HTTP_OUTCOME_UNKNOWN;`
Original file line number	Diff line number	Diff line change
`@@ -110,7 +110,7 @@ protected KeyValue uri(ServerRequestObservationContext context) {`
`110`	`110`	`if (pattern.toString().isEmpty()) {`
`111`	`111`	`return URI_ROOT;`
`112`	`112`	`}`
`113`		`- return KeyValue.of("uri", pattern.toString());`
	`113`	`+ return KeyValue.of(ServerHttpObservationDocumentation.LowCardinalityKeyNames.URI, pattern.toString());`
`114`	`114`	`}`
`115`	`115`	`if (context.getResponse() != null) {`
`116`	`116`	`HttpStatus status = HttpStatus.resolve(context.getResponse().getStatusCode().value());`
`@@ -149,8 +149,7 @@ protected KeyValue outcome(ServerRequestObservationContext context) {`
`149`	`149`
`150`	`150`	`protected KeyValue httpUrl(ServerRequestObservationContext context) {`
`151`	`151`	`if (context.getCarrier() != null) {`
`152`		`- String uriExpanded = context.getCarrier().getPath().toString();`
`153`		`- return KeyValue.of(ServerHttpObservationDocumentation.HighCardinalityKeyNames.HTTP_URL, uriExpanded);`
	`152`	`+ return KeyValue.of(ServerHttpObservationDocumentation.HighCardinalityKeyNames.HTTP_URL, context.getCarrier().getPath().toString());`
`154`	`153`	`}`
`155`	`154`	`return HTTP_URL_UNKNOWN;`
`156`	`155`	`}`
`@@ -161,8 +160,8 @@ static KeyValue forStatus(HttpStatusCode statusCode) {`
`161`	`160`	`if (statusCode.is2xxSuccessful()) {`
`162`	`161`	`return HTTP_OUTCOME_SUCCESS;`
`163`	`162`	`}`
`164`		`- else if (statusCode instanceof HttpStatus status){`
`165`		`- return KeyValue.of("outcome", status.series().name());`
	`163`	`+ else if (statusCode instanceof HttpStatus status) {`
	`164`	`+ return KeyValue.of(ServerHttpObservationDocumentation.LowCardinalityKeyNames.OUTCOME, status.series().name());`
`166`	`165`	`}`
`167`	`166`	`else {`
`168`	`167`	`return HTTP_OUTCOME_UNKNOWN;`