Reorganize HTTP Observation types

Closes gh-29334

Author: bclozel

spring-web/src/main/java/org/springframework/http/client/observation/ClientHttpObservationDocumentation.java

@@ -25,8 +25,9 @@
 
 
 /**
- * Documented {@link io.micrometer.common.KeyValue KeyValues} for {@link ClientHttpRequestFactory HTTP client observations}.
+ * Documented {@link io.micrometer.common.KeyValue KeyValues} for {@link ClientHttpRequestFactory HTTP client} observations.
  * <p>This class is used by automated tools to document KeyValues attached to the HTTP client observations.
+ *
  * @author Brian Clozel
  * @since 6.0
  */
@@ -38,7 +39,7 @@ public enum ClientHttpObservationDocumentation implements ObservationDocumentati
 	HTTP_REQUEST {
 		@Override
 		public Class<? extends ObservationConvention<? extends Observation.Context>> getDefaultConvention() {
-			return DefaultClientHttpObservationConvention.class;
+			return DefaultClientRequestObservationConvention.class;
 		}
 
 		@Override

spring-web/src/main/java/org/springframework/http/client/observation/ClientHttpObservationContext.java renamed to spring-web/src/main/java/org/springframework/http/client/observation/ClientRequestObservationContext.java

@@ -19,19 +19,18 @@
 import io.micrometer.observation.transport.RequestReplySenderContext;
 
 import org.springframework.http.client.ClientHttpRequest;
-import org.springframework.http.client.ClientHttpRequestFactory;
 import org.springframework.http.client.ClientHttpResponse;
 import org.springframework.lang.Nullable;
 
 /**
  * Context that holds information for metadata collection
- * during the {@link ClientHttpRequestFactory client HTTP} observations.
+ * during the {@link ClientHttpObservationDocumentation#HTTP_REQUEST client HTTP exchanges} observations.
  * <p>This context also extends {@link RequestReplySenderContext} for propagating tracing
  * information with the HTTP client exchange.
  * @author Brian Clozel
  * @since 6.0
  */
-public class ClientHttpObservationContext extends RequestReplySenderContext<ClientHttpRequest, ClientHttpResponse> {
+public class ClientRequestObservationContext extends RequestReplySenderContext<ClientHttpRequest, ClientHttpResponse> {
 
 	@Nullable
 	private String uriTemplate;
@@ -40,8 +39,8 @@ public class ClientHttpObservationContext extends RequestReplySenderContext<Clie
 	 * Create an observation context for {@link ClientHttpRequest} observations.
 	 * @param request the HTTP client request
 	 */
-	public ClientHttpObservationContext(ClientHttpRequest request) {
-		super(ClientHttpObservationContext::setRequestHeader);
+	public ClientRequestObservationContext(ClientHttpRequest request) {
+		super(ClientRequestObservationContext::setRequestHeader);
 		this.setCarrier(request);
 	}
 

spring-web/src/main/java/org/springframework/http/client/observation/ClientHttpObservationConvention.java renamed to spring-web/src/main/java/org/springframework/http/client/observation/ClientRequestObservationConvention.java

@@ -20,15 +20,17 @@
 import io.micrometer.observation.ObservationConvention;
 
 /**
- * Interface for an {@link ObservationConvention} related to RestTemplate HTTP exchanges.
+ * Interface for an {@link ObservationConvention} for
+ * {@link ClientHttpObservationDocumentation#HTTP_REQUEST client HTTP exchanges}.
+ *
  * @author Brian Clozel
  * @since 6.0
  */
-public interface ClientHttpObservationConvention extends ObservationConvention<ClientHttpObservationContext> {
+public interface ClientRequestObservationConvention extends ObservationConvention<ClientRequestObservationContext> {
 
 	@Override
 	default boolean supportsContext(Observation.Context context) {
-		return context instanceof ClientHttpObservationContext;
+		return context instanceof ClientRequestObservationContext;
 	}
 
 }

spring-web/src/main/java/org/springframework/http/client/observation/DefaultClientHttpObservationConvention.java renamed to spring-web/src/main/java/org/springframework/http/client/observation/DefaultClientRequestObservationConvention.java

@@ -21,18 +21,19 @@
 import io.micrometer.common.KeyValue;
 import io.micrometer.common.KeyValues;
 
+import org.springframework.http.HttpStatus;
+import org.springframework.http.HttpStatusCode;
 import org.springframework.http.client.ClientHttpResponse;
-import org.springframework.http.observation.HttpOutcome;
 import org.springframework.util.StringUtils;
 
 /**
- * Default implementation for a {@link ClientHttpObservationConvention},
- * extracting information from the {@link ClientHttpObservationContext}.
+ * Default implementation for a {@link ClientRequestObservationConvention},
+ * extracting information from the {@link ClientRequestObservationContext}.
  *
  * @author Brian Clozel
  * @since 6.0
  */
-public class DefaultClientHttpObservationConvention implements ClientHttpObservationConvention {
+public class DefaultClientRequestObservationConvention implements ClientRequestObservationConvention {
 
 	private static final String DEFAULT_NAME = "http.client.requests";
 
@@ -44,26 +45,31 @@ public class DefaultClientHttpObservationConvention implements ClientHttpObserva
 
 	private static final KeyValue STATUS_CLIENT_ERROR = KeyValue.of(ClientHttpObservationDocumentation.LowCardinalityKeyNames.STATUS, "CLIENT_ERROR");
 
+	private static final KeyValue HTTP_OUTCOME_SUCCESS = KeyValue.of(ClientHttpObservationDocumentation.LowCardinalityKeyNames.OUTCOME, "SUCCESS");
+
+	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(ClientHttpObservationDocumentation.HighCardinalityKeyNames.HTTP_URL, "none");
 
 	private static final KeyValue CLIENT_NAME_NONE = KeyValue.of(ClientHttpObservationDocumentation.HighCardinalityKeyNames.CLIENT_NAME, "none");
 
+
 	private final String name;
 
 	/**
 	 * Create a convention with the default name {@code "http.client.requests"}.
 	 */
-	public DefaultClientHttpObservationConvention() {
+	public DefaultClientRequestObservationConvention() {
 		this(DEFAULT_NAME);
 	}
 
 	/**
 	 * Create a convention with a custom name.
 	 * @param name the observation name
 	 */
-	public DefaultClientHttpObservationConvention(String name) {
+	public DefaultClientRequestObservationConvention(String name) {
 		this.name = name;
 	}
 
@@ -73,23 +79,23 @@ public String getName() {
 	}
 
 	@Override
-	public String getContextualName(ClientHttpObservationContext context) {
+	public String getContextualName(ClientRequestObservationContext context) {
 		return "http " + context.getCarrier().getMethod().name().toLowerCase();
 	}
 
 	@Override
-	public KeyValues getLowCardinalityKeyValues(ClientHttpObservationContext context) {
+	public KeyValues getLowCardinalityKeyValues(ClientRequestObservationContext context) {
 		return KeyValues.of(uri(context), method(context), status(context), exception(context), outcome(context));
 	}
 
-	protected KeyValue uri(ClientHttpObservationContext context) {
+	protected KeyValue uri(ClientRequestObservationContext context) {
 		if (context.getUriTemplate() != null) {
 			return KeyValue.of(ClientHttpObservationDocumentation.LowCardinalityKeyNames.URI, context.getUriTemplate());
 		}
 		return URI_NONE;
 	}
 
-	protected KeyValue method(ClientHttpObservationContext context) {
+	protected KeyValue method(ClientRequestObservationContext context) {
 		if (context.getCarrier() != null) {
 			return KeyValue.of(ClientHttpObservationDocumentation.LowCardinalityKeyNames.METHOD, context.getCarrier().getMethod().name());
 		}
@@ -98,7 +104,7 @@ protected KeyValue method(ClientHttpObservationContext context) {
 		}
 	}
 
-	protected KeyValue status(ClientHttpObservationContext context) {
+	protected KeyValue status(ClientRequestObservationContext context) {
 		ClientHttpResponse response = context.getResponse();
 		if (response == null) {
 			return STATUS_CLIENT_ERROR;
@@ -111,7 +117,7 @@ protected KeyValue status(ClientHttpObservationContext context) {
 		}
 	}
 
-	protected KeyValue exception(ClientHttpObservationContext context) {
+	protected KeyValue exception(ClientRequestObservationContext context) {
 		Throwable error = context.getError();
 		if (error != null) {
 			String simpleName = error.getClass().getSimpleName();
@@ -121,36 +127,51 @@ protected KeyValue exception(ClientHttpObservationContext context) {
 		return EXCEPTION_NONE;
 	}
 
-	protected static KeyValue outcome(ClientHttpObservationContext context) {
+	protected static KeyValue outcome(ClientRequestObservationContext context) {
 		if (context.getResponse() != null) {
 			try {
-				HttpOutcome httpOutcome = HttpOutcome.forStatus(context.getResponse().getStatusCode());
-				return httpOutcome.asKeyValue();
+				return HttpOutcome.forStatus(context.getResponse().getStatusCode());
 			}
 			catch (IOException ex) {
 				// Continue
 			}
 		}
-		return HttpOutcome.UNKNOWN.asKeyValue();
+		return HTTP_OUTCOME_UNKNOWN;
 	}
 
 	@Override
-	public KeyValues getHighCardinalityKeyValues(ClientHttpObservationContext context) {
+	public KeyValues getHighCardinalityKeyValues(ClientRequestObservationContext context) {
 		return KeyValues.of(requestUri(context), clientName(context));
 	}
 
-	protected KeyValue requestUri(ClientHttpObservationContext context) {
+	protected KeyValue requestUri(ClientRequestObservationContext context) {
 		if (context.getCarrier() != null) {
 			return KeyValue.of(ClientHttpObservationDocumentation.HighCardinalityKeyNames.HTTP_URL, context.getCarrier().getURI().toASCIIString());
 		}
 		return HTTP_URL_NONE;
 	}
 
-	protected KeyValue clientName(ClientHttpObservationContext context) {
+	protected KeyValue clientName(ClientRequestObservationContext context) {
 		if (context.getCarrier() != null && context.getCarrier().getURI().getHost() != null) {
 			return KeyValue.of(ClientHttpObservationDocumentation.HighCardinalityKeyNames.CLIENT_NAME, context.getCarrier().getURI().getHost());
 		}
 		return CLIENT_NAME_NONE;
 	}
 
+	static class HttpOutcome {
+
+		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 {
+				return HTTP_OUTCOME_UNKNOWN;
+			}
+		}
+
+	}
+
 }