feat(spring-boot-jakarta): [Queue Instrumentation 5] Add Kafka queue auto-configuration

CHANGELOG.md

@@ -4,8 +4,7 @@
 
 ### Features
 
-- Add Kafka consumer instrumentation for Spring Boot 3 ([#5255](https://github.com/getsentry/sentry-java/pull/5255))
-- Add Kafka producer instrumentation for Spring Boot 3 ([#5254](https://github.com/getsentry/sentry-java/pull/5254))
+- Add Kafka queue tracing for Spring Boot 3 ([#5254](https://github.com/getsentry/sentry-java/pull/5254)), ([#5255](https://github.com/getsentry/sentry-java/pull/5255)), ([#5256](https://github.com/getsentry/sentry-java/pull/5256))
 - Add `enableQueueTracing` option and messaging span data conventions ([#5250](https://github.com/getsentry/sentry-java/pull/5250))
 - Prevent cross-organization trace continuation ([#5136](https://github.com/getsentry/sentry-java/pull/5136))
   - By default, the SDK now extracts the organization ID from the DSN (e.g. `o123.ingest.sentry.io`) and compares it with the `sentry-org_id` value in incoming baggage headers. When the two differ, the SDK starts a fresh trace instead of continuing the foreign one. This guards against accidentally linking traces across organizations.

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

@@ -40,6 +40,7 @@ dependencies {
   compileOnly(projects.sentryGraphql)
   compileOnly(projects.sentryGraphql22)
   compileOnly(projects.sentryQuartz)
+  compileOnly(libs.spring.kafka3)
   compileOnly(Config.Libs.springWeb)
   compileOnly(Config.Libs.springWebflux)
   compileOnly(libs.context.propagation)
@@ -90,6 +91,7 @@ dependencies {
   testImplementation(libs.springboot3.starter)
   testImplementation(libs.springboot3.starter.aop)
   testImplementation(libs.springboot3.starter.graphql)
+  testImplementation(libs.spring.kafka3)
   testImplementation(libs.springboot3.starter.quartz)
   testImplementation(libs.springboot3.starter.security)
   testImplementation(libs.springboot3.starter.test)

sentry-spring-boot-jakarta/src/main/java/io/sentry/spring/boot/jakarta/SentryAutoConfiguration.java

@@ -31,6 +31,8 @@
 import io.sentry.spring.jakarta.checkin.SentryQuartzConfiguration;
 import io.sentry.spring.jakarta.exception.SentryCaptureExceptionParameterPointcutConfiguration;
 import io.sentry.spring.jakarta.exception.SentryExceptionParameterAdviceConfiguration;
+import io.sentry.spring.jakarta.kafka.SentryKafkaConsumerBeanPostProcessor;
+import io.sentry.spring.jakarta.kafka.SentryKafkaProducerBeanPostProcessor;
 import io.sentry.spring.jakarta.opentelemetry.SentryOpenTelemetryAgentWithoutAutoInitConfiguration;
 import io.sentry.spring.jakarta.opentelemetry.SentryOpenTelemetryNoAgentConfiguration;
 import io.sentry.spring.jakarta.tracing.CombinedTransactionNameProvider;
@@ -75,6 +77,7 @@
 import org.springframework.core.annotation.Order;
 import org.springframework.core.env.Environment;
 import org.springframework.graphql.execution.DataFetcherExceptionResolverAdapter;
+import org.springframework.kafka.core.KafkaTemplate;
 import org.springframework.scheduling.quartz.SchedulerFactoryBean;
 import org.springframework.security.core.context.SecurityContextHolder;
 import org.springframework.web.client.RestClient;
@@ -246,6 +249,26 @@ static class SentryCacheConfiguration {
       }
     }
 
+    @Configuration(proxyBeanMethods = false)
+    @ConditionalOnClass(KafkaTemplate.class)
+    @ConditionalOnProperty(name = "sentry.enable-queue-tracing", havingValue = "true")
+    @Open
+    static class SentryKafkaQueueConfiguration {
+
+      @Bean
+      public static @NotNull SentryKafkaProducerBeanPostProcessor
+          sentryKafkaProducerBeanPostProcessor() {
+        SentryIntegrationPackageStorage.getInstance().addIntegration("SpringKafka");
+        return new SentryKafkaProducerBeanPostProcessor();
+      }
+
+      @Bean
+      public static @NotNull SentryKafkaConsumerBeanPostProcessor
+          sentryKafkaConsumerBeanPostProcessor() {
+        return new SentryKafkaConsumerBeanPostProcessor();
+      }
+    }
+
     @Configuration(proxyBeanMethods = false)
     @ConditionalOnClass(ProceedingJoinPoint.class)
     @ConditionalOnProperty(

sentry-spring-boot-jakarta/src/test/kotlin/io/sentry/spring/boot/jakarta/SentryKafkaAutoConfigurationTest.kt

@@ -0,0 +1,50 @@
+package io.sentry.spring.boot.jakarta
+
+import io.sentry.spring.jakarta.kafka.SentryKafkaConsumerBeanPostProcessor
+import io.sentry.spring.jakarta.kafka.SentryKafkaProducerBeanPostProcessor
+import kotlin.test.Test
+import org.assertj.core.api.Assertions.assertThat
+import org.springframework.boot.autoconfigure.AutoConfigurations
+import org.springframework.boot.test.context.runner.ApplicationContextRunner
+
+class SentryKafkaAutoConfigurationTest {
+
+  private val contextRunner =
+    ApplicationContextRunner()
+      .withConfiguration(AutoConfigurations.of(SentryAutoConfiguration::class.java))
+      .withPropertyValues(
+        "sentry.dsn=http://key@localhost/proj",
+        "sentry.traces-sample-rate=1.0",
+        "sentry.shutdownTimeoutMillis=0",
+        "sentry.sessionFlushTimeoutMillis=0",
+        "sentry.flushTimeoutMillis=0",
+        "sentry.readTimeoutMillis=50",
+        "sentry.connectionTimeoutMillis=50",
+        "sentry.send-modules=false",
+        "sentry.debug=false",
+      )
+
+  @Test
+  fun `registers Kafka BPPs when queue tracing is enabled`() {
+    contextRunner.withPropertyValues("sentry.enable-queue-tracing=true").run { context ->
+      assertThat(context).hasSingleBean(SentryKafkaProducerBeanPostProcessor::class.java)
+      assertThat(context).hasSingleBean(SentryKafkaConsumerBeanPostProcessor::class.java)
+    }
+  }
+
+  @Test
+  fun `does not register Kafka BPPs when queue tracing is disabled`() {
+    contextRunner.run { context ->
+      assertThat(context).doesNotHaveBean(SentryKafkaProducerBeanPostProcessor::class.java)
+      assertThat(context).doesNotHaveBean(SentryKafkaConsumerBeanPostProcessor::class.java)
+    }
+  }
+
+  @Test
+  fun `does not register Kafka BPPs when queue tracing is explicitly false`() {
+    contextRunner.withPropertyValues("sentry.enable-queue-tracing=false").run { context ->
+      assertThat(context).doesNotHaveBean(SentryKafkaProducerBeanPostProcessor::class.java)
+      assertThat(context).doesNotHaveBean(SentryKafkaConsumerBeanPostProcessor::class.java)
+    }
+  }
+}