Add outcome tag to web mvc servlet and reactive metrics. Fixes gh-13801.

Author: Michael McFadyen

spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/web/reactive/server/DefaultWebFluxTagsProvider.java

@@ -35,7 +35,8 @@ public class DefaultWebFluxTagsProvider implements WebFluxTagsProvider {
 	public Iterable<Tag> httpRequestTags(ServerWebExchange exchange,
 			Throwable exception) {
 		return Arrays.asList(WebFluxTags.method(exchange), WebFluxTags.uri(exchange),
-				WebFluxTags.exception(exception), WebFluxTags.status(exchange));
+				WebFluxTags.exception(exception), WebFluxTags.status(exchange),
+				WebFluxTags.outcome(exchange));
 	}
 
 }

spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/web/reactive/server/WebFluxTags.java

@@ -30,6 +30,7 @@
  *
  * @author Jon Schneider
  * @author Andy Wilkinson
+ * @author Michael McFadyen
  * @since 2.0.0
  */
 public final class WebFluxTags {
@@ -44,6 +45,8 @@ public final class WebFluxTags {
 
 	private static final Tag EXCEPTION_NONE = Tag.of("exception", "None");
 
+	private static final Tag OUTCOME_UNKNOWN = Tag.of("outcome", "UNKNOWN");
+
 	private WebFluxTags() {
 	}
 
@@ -60,7 +63,7 @@ public static Tag method(ServerWebExchange exchange) {
 	}
 
 	/**
-	 * Creates a {@code method} tag based on the response status of the given
+	 * Creates a {@code status} tag based on the response status of the given
 	 * {@code exchange}.
 	 * @param exchange the exchange
 	 * @return the "status" tag derived from the response status
@@ -117,4 +120,31 @@ public static Tag exception(Throwable exception) {
 		return EXCEPTION_NONE;
 	}
 
+	/**
+	 * Creates a {@code outcome} tag based on the response status of the given
+	 * {@code exchange}.
+	 * @param exchange the exchange
+	 * @return the "outcome" tag derived from the response status
+	 */
+	public static Tag outcome(ServerWebExchange exchange) {
+		if (exchange != null && exchange.getResponse().getStatusCode() != null) {
+			HttpStatus status = exchange.getResponse().getStatusCode();
+			String outcome;
+			if (status.is1xxInformational() || status.is2xxSuccessful()
+					|| status.is3xxRedirection()) {
+				outcome = "SUCCESS";
+			}
+			else if (status.is4xxClientError()) {
+				outcome = "CLIENT_ERROR";
+			}
+			else {
+				outcome = "SERVER_ERROR";
+			}
+			return Tag.of("outcome", outcome);
+		}
+		else {
+			return OUTCOME_UNKNOWN;
+		}
+	}
+
 }

spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/web/servlet/DefaultWebMvcTagsProvider.java

@@ -34,7 +34,8 @@ public class DefaultWebMvcTagsProvider implements WebMvcTagsProvider {
 	public Iterable<Tag> getTags(HttpServletRequest request, HttpServletResponse response,
 			Object handler, Throwable exception) {
 		return Tags.of(WebMvcTags.method(request), WebMvcTags.uri(request, response),
-				WebMvcTags.exception(exception), WebMvcTags.status(response));
+				WebMvcTags.exception(exception), WebMvcTags.status(response),
+				WebMvcTags.outcome(response));
 	}
 
 	@Override

spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/web/servlet/WebMvcTags.java

@@ -32,6 +32,7 @@
  * @author Jon Schneider
  * @author Andy Wilkinson
  * @author Brian Clozel
+ * @author Michael McFadyen
  * @since 2.0.0
  */
 public final class WebMvcTags {
@@ -48,6 +49,8 @@ public final class WebMvcTags {
 
 	private static final Tag STATUS_UNKNOWN = Tag.of("status", "UNKNOWN");
 
+	private static final Tag OUTCOME_UNKNOWN = Tag.of("outcome", "UNKNOWN");
+
 	private static final Tag METHOD_UNKNOWN = Tag.of("method", "UNKNOWN");
 
 	private WebMvcTags() {
@@ -64,7 +67,7 @@ public static Tag method(HttpServletRequest request) {
 	}
 
 	/**
-	 * Creates a {@code method} tag based on the status of the given {@code response}.
+	 * Creates a {@code status} tag based on the status of the given {@code response}.
 	 * @param response the HTTP response
 	 * @return the status tag derived from the status of the response
 	 */
@@ -142,4 +145,29 @@ public static Tag exception(Throwable exception) {
 		return EXCEPTION_NONE;
 	}
 
+	/**
+	 * Creates a {@code outcome} tag based on the status of the given {@code response}.
+	 * @param response the HTTP response
+	 * @return the outcome tag derived from the status of the response
+	 */
+	public static Tag outcome(HttpServletResponse response) {
+		if (response != null) {
+			int status = response.getStatus();
+			String outcome;
+			if (status < 400) {
+				outcome = "SUCCESS";
+			}
+			else if (status < 500) {
+				outcome = "CLIENT_ERROR";
+			}
+			else {
+				outcome = "SERVER_ERROR";
+			}
+			return Tag.of("outcome", outcome);
+		}
+		else {
+			return OUTCOME_UNKNOWN;
+		}
+	}
+
 }

spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/endpoint/web/servlet/WebMvcTagsTests.java

@@ -31,6 +31,7 @@
  *
  * @author Andy Wilkinson
  * @author Brian Clozel
+ * @author Michael McFadyen
  */
 public class WebMvcTagsTests {
 
@@ -91,4 +92,31 @@ public void uriTagIsUnknownWhenRequestIsNull() {
 		assertThat(tag.getValue()).isEqualTo("UNKNOWN");
 	}
 
+	@Test
+	public void outcomeTagIsUnknownWhenResponseIsNull() {
+		Tag tag = WebMvcTags.outcome(null);
+		assertThat(tag.getValue()).isEqualTo("UNKNOWN");
+	}
+
+	@Test
+	public void outcomeTagIsSuccessWhenResponseIs2XX() {
+		this.response.setStatus(200);
+		Tag tag = WebMvcTags.outcome(this.response);
+		assertThat(tag.getValue()).isEqualTo("SUCCESS");
+	}
+
+	@Test
+	public void outcomeTagIsClientErrorWhenResponseIs4XX() {
+		this.response.setStatus(400);
+		Tag tag = WebMvcTags.outcome(this.response);
+		assertThat(tag.getValue()).isEqualTo("CLIENT_ERROR");
+	}
+
+	@Test
+	public void outcomeTagIsServerErrorWhenResponseIs5XX() {
+		this.response.setStatus(500);
+		Tag tag = WebMvcTags.outcome(this.response);
+		assertThat(tag.getValue()).isEqualTo("SERVER_ERROR");
+	}
+
 }

spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/metrics/web/reactive/server/WebFluxTagsTests.java

@@ -36,6 +36,7 @@
  * Tests for {@link WebFluxTags}.
  *
  * @author Brian Clozel
+ * @author Michael McFadyen
  */
 public class WebFluxTagsTests {
 
@@ -94,4 +95,38 @@ public void methodTagToleratesNonStandardHttpMethods() {
 		assertThat(tag.getValue()).isEqualTo("CUSTOM");
 	}
 
+	@Test
+	public void outcomeTagIsUnknownWhenResponseIsNull() {
+		Tag tag = WebFluxTags.outcome(null);
+		assertThat(tag.getValue()).isEqualTo("UNKNOWN");
+	}
+
+	@Test
+	public void outcomeTagIsUnknownWhenResponseStatusIsNull() {
+		this.exchange.getResponse().setStatusCode(null);
+		Tag tag = WebFluxTags.outcome(this.exchange);
+		assertThat(tag.getValue()).isEqualTo("UNKNOWN");
+	}
+
+	@Test
+	public void outcomeTagIsSuccessWhenResponseIs2XX() {
+		this.exchange.getResponse().setStatusCode(HttpStatus.OK);
+		Tag tag = WebFluxTags.outcome(this.exchange);
+		assertThat(tag.getValue()).isEqualTo("SUCCESS");
+	}
+
+	@Test
+	public void outcomeTagIsClientErrorWhenResponseIs4XX() {
+		this.exchange.getResponse().setStatusCode(HttpStatus.BAD_REQUEST);
+		Tag tag = WebFluxTags.outcome(this.exchange);
+		assertThat(tag.getValue()).isEqualTo("CLIENT_ERROR");
+	}
+
+	@Test
+	public void outcomeTagIsServerErrorWhenResponseIs5XX() {
+		this.exchange.getResponse().setStatusCode(HttpStatus.BAD_GATEWAY);
+		Tag tag = WebFluxTags.outcome(this.exchange);
+		assertThat(tag.getValue()).isEqualTo("SERVER_ERROR");
+	}
+
 }