Feat/breadcrumb level from http status (#3771)

* set http breadcrumb level based on status code

* add changelog

---------

Co-authored-by: Alexander Dinauer <[email protected]>

Author: lbloder

CHANGELOG.md

@@ -39,6 +39,7 @@
   - Use `<meta-data android:name="io.sentry.force-init" android:value="true" />` to ensure Sentry Android auto init is not easily overwritten
 - Attach request body for `application/x-www-form-urlencoded` requests in Spring ([#3731](https://github.com/getsentry/sentry-java/pull/3731))
   - Previously request body was only attached for `application/json` requests
+- Set breadcrumb level based on http status ([#3771](https://github.com/getsentry/sentry-java/pull/3771))
 - Support `graphql-java` v22 via a new module `sentry-graphql-22` ([#3740](https://github.com/getsentry/sentry-java/pull/3740))
   - If you are using `graphql-java` v21 or earlier, you can use the `sentry-graphql` module
   - For `graphql-java` v22 and newer please use the `sentry-graphql-22` module

sentry/api/sentry.api

@@ -5969,6 +5969,8 @@ public final class io/sentry/util/HttpUtils {
 	public static fun filterOutSecurityCookies (Ljava/lang/String;Ljava/util/List;)Ljava/lang/String;
 	public static fun filterOutSecurityCookiesFromHeader (Ljava/util/Enumeration;Ljava/lang/String;Ljava/util/List;)Ljava/util/List;
 	public static fun filterOutSecurityCookiesFromHeader (Ljava/util/List;Ljava/lang/String;Ljava/util/List;)Ljava/util/List;
+	public static fun isHttpClientError (I)Z
+	public static fun isHttpServerError (I)Z
 	public static fun isSecurityCookie (Ljava/lang/String;Ljava/util/List;)Z
 }
 

sentry/src/main/java/io/sentry/Breadcrumb.java

@@ -1,6 +1,7 @@
 package io.sentry;
 
 import io.sentry.util.CollectionUtils;
+import io.sentry.util.HttpUtils;
 import io.sentry.util.Objects;
 import io.sentry.util.UrlUtils;
 import io.sentry.vendor.gson.stream.JsonToken;
@@ -189,6 +190,7 @@ public static Breadcrumb fromMap(
     final Breadcrumb breadcrumb = http(url, method);
     if (code != null) {
       breadcrumb.setData("status_code", code);
+      breadcrumb.setLevel(levelFromHttpStatusCode(code));
     }
     return breadcrumb;
   }
@@ -494,6 +496,16 @@ public static Breadcrumb fromMap(
     return userInteraction(subCategory, viewId, viewClass, null, additionalData);
   }
 
+  private static @Nullable SentryLevel levelFromHttpStatusCode(final @NotNull Integer code) {
+    if (HttpUtils.isHttpClientError(code)) {
+      return SentryLevel.WARNING;
+    } else if (HttpUtils.isHttpServerError(code)) {
+      return SentryLevel.ERROR;
+    } else {
+      return null;
+    }
+  }
+
   /** Breadcrumb ctor */
   public Breadcrumb() {
     this(DateUtils.getCurrentDateTime());

sentry/src/main/java/io/sentry/util/HttpUtils.java

@@ -2,6 +2,7 @@
 
 import static io.sentry.util.UrlUtils.SENSITIVE_DATA_SUBSTITUTE;
 
+import io.sentry.HttpStatusCodeRange;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;
@@ -42,6 +43,12 @@ public final class HttpUtils {
           "CSRFTOKEN",
           "XSRF-TOKEN");
 
+  private static final HttpStatusCodeRange CLIENT_ERROR_STATUS_CODES =
+      new HttpStatusCodeRange(400, 499);
+
+  private static final HttpStatusCodeRange SEVER_ERROR_STATUS_CODES =
+      new HttpStatusCodeRange(500, 599);
+
   public static boolean containsSensitiveHeader(final @NotNull String header) {
     return SENSITIVE_HEADERS.contains(header.toUpperCase(Locale.ROOT));
   }
@@ -130,4 +137,12 @@ public static boolean isSecurityCookie(
 
     return false;
   }
+
+  public static boolean isHttpClientError(final int statusCode) {
+    return CLIENT_ERROR_STATUS_CODES.isInRange(statusCode);
+  }
+
+  public static boolean isHttpServerError(final int statusCode) {
+    return SEVER_ERROR_STATUS_CODES.isInRange(statusCode);
+  }
 }

sentry/src/test/java/io/sentry/BreadcrumbTest.kt

@@ -131,6 +131,38 @@ class BreadcrumbTest {
         assertFalse(breadcrumb.data.containsKey("status_code"))
     }
 
+    @Test
+    fun `creates HTTP breadcrumb with WARNING level if status code is 4xx`() {
+        val breadcrumb = Breadcrumb.http("http://example.com", "POST", 417)
+        assertEquals("http://example.com", breadcrumb.data["url"])
+        assertEquals("POST", breadcrumb.data["method"])
+        assertEquals("http", breadcrumb.type)
+        assertEquals("http", breadcrumb.category)
+        assertEquals(SentryLevel.WARNING, breadcrumb.level)
+    }
+
+    @Test
+    fun `creates HTTP breadcrumb with error level if status code is 5xx`() {
+        val breadcrumb = Breadcrumb.http("http://example.com", "POST", 502)
+        assertEquals("http://example.com", breadcrumb.data["url"])
+        assertEquals("POST", breadcrumb.data["method"])
+        assertEquals("http", breadcrumb.type)
+        assertEquals("http", breadcrumb.category)
+        assertEquals(502, breadcrumb.data["status_code"])
+        assertEquals(SentryLevel.ERROR, breadcrumb.level)
+    }
+
+    @Test
+    fun `creates HTTP breadcrumb with null level if status code is not 5xx or 4xx`() {
+        val breadcrumb = Breadcrumb.http("http://example.com", "POST", 200)
+        assertEquals("http://example.com", breadcrumb.data["url"])
+        assertEquals("POST", breadcrumb.data["method"])
+        assertEquals("http", breadcrumb.type)
+        assertEquals("http", breadcrumb.category)
+        assertEquals(200, breadcrumb.data["status_code"])
+        assertEquals(null, breadcrumb.level)
+    }
+
     @Test
     fun `creates navigation breadcrumb`() {
         val breadcrumb = Breadcrumb.navigation("from", "to")