add okhttp to spring boot sample, add e2e test

Author: lbloder

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,11 @@
 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 org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RestController;
@@ -10,17 +15,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 +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-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",
+        )
+    }
+  }
 }

sentry-system-test-support/src/main/kotlin/io/sentry/systemtest/util/RestTestClient.kt

@@ -50,6 +50,12 @@ class RestTestClient(private val backendBaseUrl: String) : LoggingInsecureRestCl
     return callTyped(request, true)
   }
 
+  fun getTodoOkHttp(id: Long): Todo? {
+    val request = Request.Builder().url("$backendBaseUrl/todo-okhttp/$id")
+
+    return callTyped(request, true)
+  }
+
   fun getCachedTodo(id: Long): Todo? {
     val request = Request.Builder().url("$backendBaseUrl/cache/$id")