Add okhttp autoconfiguration for spring boot (#5797)

Author: lbloder

CHANGELOG.md

@@ -7,6 +7,7 @@
 - Deprecate `sendDefaultPii` in favor of `dataCollection` ahead of its removal in 9.0 ([#6158](https://github.com/getsentry/sentry-java/pull/6158))
 - Make the tombstone merge time threshold configurable via `SentryAndroidOptions.setTombstoneMergeTimeThresholdMillis` and the `io.sentry.tombstone.merge-time-threshold-millis` manifest option ([#6154](https://github.com/getsentry/sentry-java/pull/6154))
 - Add `sentry-apollo-5` integration for Apollo Kotlin 5, providing HTTP tracing and failed GraphQL request reporting ([#6074](https://github.com/getsentry/sentry-java/pull/6074))
+- Add OkHttp autoconfiguration for Spring Boot ([#5797](https://github.com/getsentry/sentry-java/pull/5797))
 
 ### Fixes
 

sentry-okhttp/src/main/java/io/sentry/okhttp/SentryOkHttpEvent.kt

@@ -6,6 +6,7 @@ import io.sentry.IScopes
 import io.sentry.ISpan
 import io.sentry.SentryDate
 import io.sentry.SpanDataConvention
+import io.sentry.SpanOptions
 import io.sentry.TypeCheckHint
 import io.sentry.transport.CurrentDateProvider
 import io.sentry.util.Platform
@@ -40,8 +41,8 @@ internal class SentryOkHttpEvent(private val scopes: IScopes, private val reques
 
     // We start the call span that will contain all the others
     val parentSpan = if (Platform.isAndroid()) scopes.transaction else scopes.span
-    callSpan = parentSpan?.startChild("http.client")
-    callSpan?.spanContext?.origin = TRACE_ORIGIN
+    callSpan =
+      parentSpan?.startChild("http.client", null, SpanOptions().apply { origin = TRACE_ORIGIN })
 
     breadcrumb =
       Breadcrumb().apply {

sentry-okhttp/src/main/java/io/sentry/okhttp/SentryOkHttpInterceptor.kt

@@ -12,6 +12,7 @@ import io.sentry.SentryIntegrationPackageStorage
 import io.sentry.SentryOptions.DEFAULT_PROPAGATION_TARGETS
 import io.sentry.SentryReplayOptions
 import io.sentry.SpanDataConvention
+import io.sentry.SpanOptions
 import io.sentry.SpanStatus
 import io.sentry.TypeCheckHint.OKHTTP_REQUEST
 import io.sentry.TypeCheckHint.OKHTTP_RESPONSE
@@ -96,13 +97,16 @@ public open class SentryOkHttpInterceptor(
       // read the span from the bound scope
       okHttpEvent = null
       val parentSpan = if (Platform.isAndroid()) scopes.transaction else scopes.span
-      span = parentSpan?.startChild("http.client", "$method $url")
+      span =
+        parentSpan?.startChild(
+          "http.client",
+          "$method $url",
+          SpanOptions().apply { origin = TRACE_ORIGIN },
+        )
     }
 
     val startTimestamp = CurrentDateProvider.getInstance().currentTimeMillis
 
-    span?.spanContext?.origin = TRACE_ORIGIN
-
     urlDetails.applyToSpan(span)
 
     val isFromEventListener = okHttpEvent != null

sentry-okhttp/src/test/java/io/sentry/okhttp/SentryOkHttpEventTest.kt

@@ -100,13 +100,21 @@ class SentryOkHttpEventTest {
     val callSpan = sut.callSpan
     assertNotNull(callSpan)
     assertEquals("http.client", callSpan.operation)
+    assertEquals("auto.http.okhttp", callSpan.spanContext.origin)
     assertEquals("${fixture.mockRequest.method} ${fixture.mockRequest.url}", callSpan.description)
     assertEquals(fixture.mockRequest.url.toString(), callSpan.getData("url"))
     assertEquals(fixture.mockRequest.url.host, callSpan.getData("host"))
     assertEquals(fixture.mockRequest.url.encodedPath, callSpan.getData("path"))
     assertEquals(fixture.mockRequest.method, callSpan.getData(SpanDataConvention.HTTP_METHOD_KEY))
   }
 
+  @Test
+  fun `when span origin is ignored, call span is a no-op`() {
+    fixture.scopes.options.setIgnoredSpanOrigins(listOf("auto.http.okhttp"))
+    val sut = fixture.getSut()
+    assertTrue(sut.callSpan!!.isNoOp)
+  }
+
   @Test
   fun `when call span is null, breadcrumb is created anyway`() {
     val sut = fixture.getSut(currentSpan = null)

sentry-okhttp/src/test/java/io/sentry/okhttp/SentryOkHttpInterceptorTest.kt

@@ -294,6 +294,15 @@ class SentryOkHttpInterceptorTest {
     assertTrue(httpClientSpan.isFinished)
   }
 
+  @Test
+  fun `does not create a span when span origin is ignored`() {
+    val sut = fixture.getSut { options ->
+      options.setIgnoredSpanOrigins(listOf("auto.http.okhttp"))
+    }
+    sut.newCall(getRequest()).execute()
+    assertEquals(0, fixture.sentryTracer.children.size)
+  }
+
   @Test
   fun `maps http status code to SpanStatus`() {
     val sut = fixture.getSut(httpStatusCode = 400)

sentry-samples/sentry-samples-spring-boot-4/build.gradle.kts

@@ -64,6 +64,10 @@ dependencies {
   implementation(libs.springboot4.starter.kafka)
   implementation(projects.sentryKafka)
 
+  // okhttp client instrumentation
+  implementation(projects.sentryOkhttp)
+  implementation(libs.okhttp)
+
   // database query tracing
   implementation(projects.sentryJdbc)
   runtimeOnly(libs.hsqldb)

sentry-samples/sentry-samples-spring-boot-4/src/main/java/io/sentry/samples/spring/boot4/SentryDemoApplication.java

@@ -4,6 +4,7 @@
 
 import io.sentry.samples.spring.boot4.quartz.SampleJob;
 import java.util.Collections;
+import okhttp3.OkHttpClient;
 import org.quartz.JobDetail;
 import org.quartz.SimpleTrigger;
 import org.springframework.boot.SpringApplication;
@@ -42,6 +43,12 @@ RestClient restClient(RestClient.Builder builder) {
     return builder.build();
   }
 
+  @Bean
+  OkHttpClient okHttpClient() {
+    // automatically instrumented by Sentry via sentry.clients.ok-http-enabled=true
+    return new OkHttpClient.Builder().build();
+  }
+
   @Bean
   public JobDetailFactoryBean jobDetail() {
     JobDetailFactoryBean jobDetailFactory = new JobDetailFactoryBean();

sentry-samples/sentry-samples-spring-boot-4/src/main/java/io/sentry/samples/spring/boot4/TodoController.java

@@ -1,6 +1,12 @@
 package io.sentry.samples.spring.boot4;
 
 import io.sentry.reactor.SentryReactorUtils;
+import java.io.IOException;
+import java.io.UncheckedIOException;
+import okhttp3.OkHttpClient;
+import okhttp3.Request;
+import okhttp3.Response;
+import okhttp3.ResponseBody;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RestController;
@@ -10,17 +16,27 @@
 import reactor.core.publisher.Hooks;
 import reactor.core.publisher.Mono;
 import reactor.core.scheduler.Schedulers;
+import tools.jackson.databind.ObjectMapper;
 
 @RestController
 public class TodoController {
   private final RestTemplate restTemplate;
   private final WebClient webClient;
   private final RestClient restClient;
+  private final OkHttpClient okHttpClient;
+  private final ObjectMapper objectMapper;
 
-  public TodoController(RestTemplate restTemplate, WebClient webClient, RestClient restClient) {
+  public TodoController(
+      RestTemplate restTemplate,
+      WebClient webClient,
+      RestClient restClient,
+      OkHttpClient okHttpClient,
+      ObjectMapper objectMapper) {
     this.restTemplate = restTemplate;
     this.webClient = webClient;
     this.restClient = restClient;
+    this.okHttpClient = okHttpClient;
+    this.objectMapper = objectMapper;
   }
 
   @GetMapping("/todo/{id}")
@@ -54,4 +70,19 @@ Todo todoRestClient(@PathVariable Long id) {
         .retrieve()
         .body(Todo.class);
   }
+
+  @GetMapping("/todo-okhttp/{id}")
+  Todo todoOkHttp(@PathVariable Long id) {
+    final Request request =
+        new Request.Builder().url("https://jsonplaceholder.typicode.com/todos/" + id).build();
+    try (Response response = okHttpClient.newCall(request).execute()) {
+      final ResponseBody body = response.body();
+      if (body == null) {
+        throw new IllegalStateException("Response body was null");
+      }
+      return objectMapper.readValue(body.byteStream(), Todo.class);
+    } catch (IOException e) {
+      throw new UncheckedIOException(e);
+    }
+  }
 }

sentry-samples/sentry-samples-spring-boot-4/src/main/resources/application.properties

@@ -21,6 +21,8 @@ sentry.profile-session-sample-rate=1.0
 sentry.profiling-traces-dir-path=tmp/sentry/profiling-traces
 sentry.profile-lifecycle=TRACE
 sentry.enable-cache-tracing=true
+# Automatically instrument Spring-managed OkHttpClient beans
+sentry.clients.ok-http-enabled=true
 spring.cache.cache-names=todos
 spring.cache.caffeine.spec=maximumSize=500,expireAfterAccess=600s
 

sentry-samples/sentry-samples-spring-boot-4/src/test/kotlin/io/sentry/systemtest/TodoSystemTest.kt

@@ -58,4 +58,20 @@ class TodoSystemTest {
       )
     }
   }
+
+  @Test
+  fun `get todo okhttp works`() {
+    val restClient = testHelper.restClient
+    restClient.getTodoOkHttp(1L)
+    assertEquals(200, restClient.lastKnownStatusCode)
+
+    testHelper.ensureTransactionReceived { transaction, envelopeHeader ->
+      transaction.transaction == "GET /todo-okhttp/{id}" &&
+        testHelper.doesTransactionContainSpanWithOpAndDescription(
+          transaction,
+          "http.client",
+          "GET https://jsonplaceholder.typicode.com/todos/1",
+        )
+    }
+  }
 }