okhttp auto config for spring boot 2 and 3 (#6139)

Author: lbloder

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

@@ -73,6 +73,10 @@ dependencies {
   // OpenFeature SDK
   implementation(libs.openfeature)
 
+  // okhttp client instrumentation
+  implementation(projects.sentryOkhttp)
+  implementation(libs.okhttp)
+
   // database query tracing
   implementation(projects.sentryJdbc)
   runtimeOnly(libs.hsqldb)

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

@@ -4,6 +4,7 @@
 
 import io.sentry.samples.spring.boot.jakarta.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-jakarta/src/main/java/io/sentry/samples/spring/boot/jakarta/TodoController.java

@@ -1,6 +1,12 @@
 package io.sentry.samples.spring.boot.jakarta;
 
+import com.fasterxml.jackson.databind.ObjectMapper;
 import io.sentry.reactor.SentryReactorUtils;
+import java.io.IOException;
+import java.io.UncheckedIOException;
+import okhttp3.OkHttpClient;
+import okhttp3.Request;
+import okhttp3.Response;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RestController;
@@ -16,11 +22,20 @@ 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 +69,15 @@ 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()) {
+      return objectMapper.readValue(response.body().byteStream(), Todo.class);
+    } catch (IOException e) {
+      throw new UncheckedIOException(e);
+    }
+  }
 }

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

@@ -37,6 +37,8 @@ spring.quartz.job-store-type=memory
 
 # Cache tracing
 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-jakarta/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",
+        )
+    }
+  }
 }

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

@@ -77,6 +77,10 @@ dependencies {
   implementation(projects.sentryQuartz)
   implementation(projects.sentryAsyncProfiler)
 
+  // okhttp client instrumentation
+  implementation(projects.sentryOkhttp)
+  implementation(libs.okhttp)
+
   // database query tracing
   implementation(projects.sentryJdbc)
   runtimeOnly(libs.hsqldb)

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

@@ -4,6 +4,7 @@
 
 import io.sentry.samples.spring.boot.quartz.SampleJob;
 import java.util.Collections;
+import okhttp3.OkHttpClient;
 import org.quartz.JobDetail;
 import org.quartz.SimpleTrigger;
 import org.springframework.boot.SpringApplication;
@@ -36,6 +37,12 @@ WebClient webClient(WebClient.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/src/main/java/io/sentry/samples/spring/boot/TodoController.java

@@ -1,5 +1,11 @@
 package io.sentry.samples.spring.boot;
 
+import com.fasterxml.jackson.databind.ObjectMapper;
+import java.io.IOException;
+import java.io.UncheckedIOException;
+import okhttp3.OkHttpClient;
+import okhttp3.Request;
+import okhttp3.Response;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RestController;
@@ -10,10 +16,18 @@
 public class TodoController {
   private final RestTemplate restTemplate;
   private final WebClient webClient;
+  private final OkHttpClient okHttpClient;
+  private final ObjectMapper objectMapper;
 
-  public TodoController(RestTemplate restTemplate, WebClient webClient) {
+  public TodoController(
+      RestTemplate restTemplate,
+      WebClient webClient,
+      OkHttpClient okHttpClient,
+      ObjectMapper objectMapper) {
     this.restTemplate = restTemplate;
     this.webClient = webClient;
+    this.okHttpClient = okHttpClient;
+    this.objectMapper = objectMapper;
   }
 
   @GetMapping("/todo/{id}")
@@ -31,4 +45,15 @@ Todo todoWebClient(@PathVariable Long id) {
         .bodyToMono(Todo.class)
         .block();
   }
+
+  @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()) {
+      return objectMapper.readValue(response.body().byteStream(), Todo.class);
+    } catch (IOException e) {
+      throw new UncheckedIOException(e);
+    }
+  }
 }

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

@@ -22,6 +22,8 @@ sentry.profile-lifecycle=TRACE
 
 # Cache tracing
 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/src/test/kotlin/io/sentry/systemtest/TodoSystemTest.kt

@@ -43,4 +43,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",
+        )
+    }
+  }
 }