docs(java): Add Kafka queue tracing docs#17503
Merged
Conversation
Document Spring Boot and raw Kafka queue tracing for the Java SDK. Add setup guidance for sentry-kafka, document the enableQueueTracing option, and link the manual queues docs to the new integration page. Co-Authored-By: Claude <noreply@anthropic.com>
Clarify that Spring Boot Kafka auto-instrumentation is disabled\nwhen using Sentry OpenTelemetry integrations, and note that\nraw SentryKafkaConsumerTracing.withTracing() is not auto-\nsuppressed under OpenTelemetry.\n\nThis keeps the Kafka docs aligned with current SDK behavior\nand avoids overpromising OpenTelemetry fallback behavior.\n\nCo-Authored-By: Claude <noreply@anthropic.com>
Clarify that Spring Kafka producer spans depend on an active\ntransaction instead of implying every send creates one.\n\nThis keeps the setup section aligned with current SDK behavior\nand makes the initial guidance more precise.\n\nCo-Authored-By: Claude <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Document that Spring Kafka retry count data requires the delivery attempt header and compatible retry handling. Include DefaultErrorHandler as an example without requiring apps to replace existing handlers. Co-Authored-By: Claude <noreply@anthropic.com>
lbloder
reviewed
May 5, 2026
coolguyzone
reviewed
May 5, 2026
coolguyzone
reviewed
May 5, 2026
| libraryDependencies += "io.sentry" % "sentry-kafka" % "{{@inject packages.version('sentry.java.kafka', '8.37.0') }}" | ||
| ``` | ||
|
|
||
| For other dependency managers, check out the [central Maven repository](https://search.maven.org/artifact/io.sentry/sentry-kafka). |
Contributor
There was a problem hiding this comment.
@adinauer This links is 404ing for me, does it require authentication?
Member
Author
There was a problem hiding this comment.
We haven't released it yet, it'll be there once we include sentry-kafka in a release of Java SDK.
coolguyzone
approved these changes
May 5, 2026
Contributor
coolguyzone
left a comment
coolguyzone
left a comment
There was a problem hiding this comment.
Looks good! Please address the 404 I commented on before merge.
Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io>
Add Kotlin variants for Kafka retry-count setup and consumer tracing examples. Update custom queue instrumentation docs with Kotlin examples and clarify Kafka queue instrumentation wording. Co-Authored-By: Claude <noreply@anthropic.com>
Limit the Spring Kafka auto-instrumentation claim to record-based listeners and document that batch listeners are not supported yet. Co-Authored-By: Claude <noreply@anthropic.com>
Mark queue tracing as available since Java SDK 8.41.0 and update Kafka dependency examples to use the first supported release. Co-Authored-By: Claude <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add Kafka queue tracing docs for the Java SDK
This adds a dedicated Kafka integration page for Java, covers both the
Spring Boot and raw
kafka-clientspaths, and links the generic queuesdocs to the new page.
I kept this as a dedicated integration page instead of expanding the
generic queues page so the Kafka-specific setup, caveats, and examples
stay in one reviewable place.
This branch is written against the Java SDK PR collection branch
feat/queue-instrumentationingetsentry/sentry-java(
getsentry/sentry-java#5249). The docs also call out the current SDKcaveats around Spring producer spans and Sentry OpenTelemetry
integrations so the behavior matches that collection branch.