POTEL 57 - Spring Boot 2 OTel samples (#3879)

* port Spring Boot 3 otel changes to Spring Boot 2

* Spring Boot 2 OTel sample

* add noagent spring boot 2 sample; fix spring boot 3 samples

* fix tests

* disable up to date checking for systemTests

* another e2e test run

* fix SentryAutoConfigurationTest

---------

Co-authored-by: Lukas Bloder <[email protected]>

Author: adinauer

.github/workflows/system-tests-backend.yml

@@ -24,6 +24,13 @@ jobs:
         agent-auto-init: [ "true" ]
         include:
           - sample: "sentry-samples-spring-boot"
+          - sample: "sentry-samples-spring-boot-opentelemetry-noagent"
+          - sample: "sentry-samples-spring-boot-opentelemetry"
+            agent: "1"
+            agent-auto-init: "true"
+          - sample: "sentry-samples-spring-boot-opentelemetry"
+            agent: "1"
+            agent-auto-init: "false"
           - sample: "sentry-samples-spring-boot-webflux-jakarta"
           - sample: "sentry-samples-spring-boot-webflux"
           - sample: "sentry-samples-spring-boot-jakarta-opentelemetry-noagent"

build.gradle.kts

@@ -60,6 +60,8 @@ apiValidation {
             "sentry-samples-spring",
             "sentry-samples-spring-jakarta",
             "sentry-samples-spring-boot",
+            "sentry-samples-spring-boot-opentelemetry",
+            "sentry-samples-spring-boot-opentelemetry-noagent",
             "sentry-samples-spring-boot-jakarta",
             "sentry-samples-spring-boot-jakarta-opentelemetry",
             "sentry-samples-spring-boot-jakarta-opentelemetry-noagent",

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

@@ -85,7 +85,8 @@ tasks.register<Test>("systemTest").configure {
     group = "verification"
     description = "Runs the System tests"
 
-//    maxParallelForks = Runtime.getRuntime().availableProcessors() / 2
+    outputs.upToDateWhen { false }
+
     maxParallelForks = 1
 
     // Cap JVM args per test

sentry-samples/sentry-samples-spring-boot-jakarta-opentelemetry-noagent/src/main/java/io/sentry/samples/spring/boot/jakarta/PersonController.java

@@ -1,7 +1,7 @@
 package io.sentry.samples.spring.boot.jakarta;
 
-import io.opentelemetry.api.OpenTelemetry;
 import io.opentelemetry.api.trace.Span;
+import io.opentelemetry.api.trace.Tracer;
 import io.opentelemetry.context.Scope;
 import io.opentelemetry.instrumentation.annotations.WithSpan;
 import io.sentry.ISpan;
@@ -20,22 +20,18 @@
 @RequestMapping("/person/")
 public class PersonController {
   private final PersonService personService;
-  private final OpenTelemetry openTelemetry;
+  private final Tracer tracer;
   private static final Logger LOGGER = LoggerFactory.getLogger(PersonController.class);
 
-  public PersonController(PersonService personService, OpenTelemetry openTelemetry) {
+  public PersonController(PersonService personService, Tracer tracer) {
     this.personService = personService;
-    this.openTelemetry = openTelemetry;
+    this.tracer = tracer;
   }
 
   @GetMapping("{id}")
   @WithSpan("personSpanThroughOtelAnnotation")
   Person person(@PathVariable Long id) {
-    Span span =
-        openTelemetry
-            .getTracer("tracerForSpringBootDemo")
-            .spanBuilder("spanCreatedThroughOtelApi")
-            .startSpan();
+    Span span = tracer.spanBuilder("spanCreatedThroughOtelApi").startSpan();
     try (final @NotNull Scope spanScope = span.makeCurrent()) {
       ISpan currentSpan = Sentry.getSpan();
       ISpan sentrySpan = currentSpan.startChild("spanCreatedThroughSentryApi");
@@ -52,11 +48,7 @@ Person person(@PathVariable Long id) {
 
   @PostMapping
   Person create(@RequestBody Person person) {
-    Span span =
-        openTelemetry
-            .getTracer("tracerForSpringBootDemo")
-            .spanBuilder("spanCreatedThroughOtelApi")
-            .startSpan();
+    Span span = tracer.spanBuilder("spanCreatedThroughOtelApi").startSpan();
     try (final @NotNull Scope spanScope = span.makeCurrent()) {
       ISpan sentrySpan = Sentry.getSpan().startChild("spanCreatedThroughSentryApi");
       try {

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

@@ -32,8 +32,3 @@ spring.graphql.websocket.path=/graphql
 spring.quartz.job-store-type=memory
 
 otel.propagators=tracecontext,baggage,sentry
-otel.resource.attributes.deployment.environment=dev
-otel.resource.attributes.service.name=cart
-otel.resource.attributes.service.namespace=shop
-
-logging.level.org.springframework: DEBUG

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

@@ -52,9 +52,7 @@ dependencies {
     implementation(projects.sentryLogback)
     implementation(projects.sentryGraphql22)
     implementation(projects.sentryQuartz)
-    implementation(Config.Libs.springBoot3StarterOpenTelemetry)
-    implementation(projects.sentryOpentelemetry.sentryOpentelemetryBootstrap)
-    implementation(projects.sentryOpentelemetry.sentryOpentelemetryAgentcustomization)
+    implementation(Config.Libs.OpenTelemetry.otelSdk)
 
     // database query tracing
     implementation(projects.sentryJdbc)
@@ -85,7 +83,8 @@ tasks.register<Test>("systemTest").configure {
     group = "verification"
     description = "Runs the System tests"
 
-//    maxParallelForks = Runtime.getRuntime().availableProcessors() / 2
+    outputs.upToDateWhen { false }
+
     maxParallelForks = 1
 
     // Cap JVM args per test

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

@@ -1,9 +1,8 @@
 package io.sentry.samples.spring.boot.jakarta;
 
-import io.opentelemetry.api.OpenTelemetry;
 import io.opentelemetry.api.trace.Span;
+import io.opentelemetry.api.trace.Tracer;
 import io.opentelemetry.context.Scope;
-import io.opentelemetry.instrumentation.annotations.WithSpan;
 import io.sentry.ISpan;
 import io.sentry.Sentry;
 import org.jetbrains.annotations.NotNull;
@@ -20,24 +19,17 @@
 @RequestMapping("/person/")
 public class PersonController {
   private final PersonService personService;
-  private final OpenTelemetry openTelemetry;
+  private final Tracer tracer;
   private static final Logger LOGGER = LoggerFactory.getLogger(PersonController.class);
 
-  public PersonController(PersonService personService, OpenTelemetry openTelemetry) {
+  public PersonController(PersonService personService, Tracer tracer) {
     this.personService = personService;
-    this.openTelemetry = openTelemetry;
+    this.tracer = tracer;
   }
 
   @GetMapping("{id}")
-  @WithSpan("personSpanThroughOtelAnnotation")
   Person person(@PathVariable Long id) {
-    ISpan annotationSpan = Sentry.getSpan();
-    System.out.println(annotationSpan);
-    Span span =
-        openTelemetry
-            .getTracer("tracerForSpringBootDemo")
-            .spanBuilder("spanCreatedThroughOtelApi")
-            .startSpan();
+    Span span = tracer.spanBuilder("spanCreatedThroughOtelApi").startSpan();
     try (final @NotNull Scope spanScope = span.makeCurrent()) {
       ISpan currentSpan = Sentry.getSpan();
       ISpan sentrySpan = currentSpan.startChild("spanCreatedThroughSentryApi");
@@ -54,11 +46,7 @@ Person person(@PathVariable Long id) {
 
   @PostMapping
   Person create(@RequestBody Person person) {
-    Span span =
-        openTelemetry
-            .getTracer("tracerForSpringBootDemo")
-            .spanBuilder("spanCreatedThroughOtelApi")
-            .startSpan();
+    Span span = tracer.spanBuilder("spanCreatedThroughOtelApi").startSpan();
     try (final @NotNull Scope spanScope = span.makeCurrent()) {
       ISpan sentrySpan = Sentry.getSpan().startChild("spanCreatedThroughSentryApi");
       try {

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

@@ -1,7 +1,7 @@
 package io.sentry.samples.spring.boot.jakarta;
 
-import io.opentelemetry.api.OpenTelemetry;
 import io.opentelemetry.api.trace.Span;
+import io.opentelemetry.api.trace.Tracer;
 import io.opentelemetry.context.Scope;
 import io.sentry.ISpan;
 import io.sentry.Sentry;
@@ -22,26 +22,19 @@ public class TodoController {
   private final RestTemplate restTemplate;
   private final WebClient webClient;
   private final RestClient restClient;
-  private final OpenTelemetry openTelemetry;
+  private final Tracer tracer;
 
   public TodoController(
-      RestTemplate restTemplate,
-      WebClient webClient,
-      RestClient restClient,
-      OpenTelemetry openTelemetry) {
+      RestTemplate restTemplate, WebClient webClient, RestClient restClient, Tracer tracer) {
     this.restTemplate = restTemplate;
     this.webClient = webClient;
     this.restClient = restClient;
-    this.openTelemetry = openTelemetry;
+    this.tracer = tracer;
   }
 
   @GetMapping("/todo/{id}")
   Todo todo(@PathVariable Long id) {
-    Span otelSpan =
-        openTelemetry
-            .getTracer("tracerForSpringBootDemo")
-            .spanBuilder("todoSpanOtelApi")
-            .startSpan();
+    Span otelSpan = tracer.spanBuilder("todoSpanOtelApi").startSpan();
     try (final @NotNull Scope spanScope = otelSpan.makeCurrent()) {
       ISpan sentrySpan = Sentry.getSpan().startChild("todoSpanSentryApi");
       try {
@@ -74,11 +67,7 @@ Todo todoWebClient(@PathVariable Long id) {
 
   @GetMapping("/todo-restclient/{id}")
   Todo todoRestClient(@PathVariable Long id) {
-    Span span =
-        openTelemetry
-            .getTracer("tracerForSpringBootDemo")
-            .spanBuilder("todoRestClientSpanOtelApi")
-            .startSpan();
+    Span span = tracer.spanBuilder("todoRestClientSpanOtelApi").startSpan();
     try (final @NotNull Scope spanScope = span.makeCurrent()) {
       ISpan sentrySpan = Sentry.getSpan().startChild("todoRestClientSpanSentryApi");
       try {

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

@@ -30,10 +30,3 @@ spring.datasource.password=
 spring.graphql.graphiql.enabled=true
 spring.graphql.websocket.path=/graphql
 spring.quartz.job-store-type=memory
-
-otel.propagators=tracecontext,baggage,sentry
-otel.resource.attributes.deployment.environment=dev
-otel.resource.attributes.service.name=cart
-otel.resource.attributes.service.namespace=shop
-
-logging.level.org.springframework: DEBUG

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

@@ -81,6 +81,8 @@ tasks.register<Test>("systemTest").configure {
     group = "verification"
     description = "Runs the System tests"
 
+    outputs.upToDateWhen { false }
+
     maxParallelForks = 1
 
     // Cap JVM args per test