Skip to content

Commit e685fd4

Browse files
committed
docs(samples): [Queue Instrumentation 30] Document OTel Kafka suppression fixture
The OTel Jakarta sample Kafka configs intentionally set `sentry.enable-queue-tracing=true` so the coexistence system test (`KafkaOtelCoexistenceSystemTest`, added in PR #5324) can assert that Sentry's Spring Kafka auto-config (`SentryKafkaQueueConfiguration`) stays suppressed even when the customer explicitly opts in. Add a comment to each `application-kafka.properties` explaining the deliberate choice and link it to the test, so the property does not read as a copy/paste trap for customers. Also extend the test KDoc to call out the fixture. #skip-changelog
1 parent 4a48e54 commit e685fd4

4 files changed

Lines changed: 10 additions & 0 deletions

File tree

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
# Kafka — activate with: --spring.profiles.active=kafka
2+
3+
# Deliberate fixture for KafkaOtelCoexistenceSystemTest: must stay suppressed in OTel mode.
24
sentry.enable-queue-tracing=true
35

46
spring.kafka.bootstrap-servers=localhost:9092

sentry-samples/sentry-samples-spring-boot-jakarta-opentelemetry-noagent/src/test/kotlin/io/sentry/systemtest/KafkaOtelCoexistenceSystemTest.kt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@ import org.junit.Before
1616
* `queue.process` spans/transactions are *not* emitted. Any Kafka telemetry in OTel mode must come
1717
* from the OTel Kafka instrumentation, not from the Sentry Kafka integration.
1818
*
19+
* The sample sets `sentry.enable-queue-tracing=true` on purpose: suppression must win even when the
20+
* customer explicitly opts in.
21+
*
1922
* Requires:
2023
* - The sample app running with `--spring.profiles.active=kafka`
2124
* - A Kafka broker at localhost:9092

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
# Kafka — activate with: --spring.profiles.active=kafka
2+
3+
# Deliberate fixture for KafkaOtelCoexistenceSystemTest: must stay suppressed in OTel mode.
24
sentry.enable-queue-tracing=true
35

46
spring.kafka.bootstrap-servers=localhost:9092

sentry-samples/sentry-samples-spring-boot-jakarta-opentelemetry/src/test/kotlin/io/sentry/systemtest/KafkaOtelCoexistenceSystemTest.kt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@ import org.junit.Before
1616
* `queue.process` spans/transactions are *not* emitted. Any Kafka telemetry in OTel mode must come
1717
* from the OTel Kafka instrumentation, not from the Sentry Kafka integration.
1818
*
19+
* The sample sets `sentry.enable-queue-tracing=true` on purpose: suppression must win even when the
20+
* customer explicitly opts in.
21+
*
1922
* Requires:
2023
* - The sample app running with `--spring.profiles.active=kafka`
2124
* - A Kafka broker at localhost:9092

0 commit comments

Comments
 (0)