-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
docs(java): Document OpenTelemetry BOM alignment #18647
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
adinauer
wants to merge
1
commit into
master
Choose a base branch
from
docs/java-otel-bom
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+166
−1
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
25 changes: 25 additions & 0 deletions
25
docs/platforms/java/common/opentelemetry/troubleshooting/index.mdx
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| --- | ||
| title: Troubleshooting | ||
| sdk: sentry.java.opentelemetry-agentless | ||
| description: "Troubleshoot Java OpenTelemetry problems." | ||
| sidebar_order: 400 | ||
| --- | ||
|
|
||
| ## OpenTelemetry Dependency Version Mismatches | ||
|
|
||
| OpenTelemetry integrations use several artifacts that must stay on compatible versions. If another BOM or dependency-management plugin changes some OpenTelemetry versions but not others, your application can start with a mixed OpenTelemetry classpath. | ||
|
|
||
| This is common in Spring Boot applications because Spring Boot dependency management can manage OpenTelemetry core artifacts while your application, Sentry, or another library brings in OpenTelemetry instrumentation artifacts. Version mismatches often appear as startup or request-time classloading errors, such as `ClassNotFoundException`, `NoClassDefFoundError`, `NoSuchMethodError`, or `NoSuchFieldError`. | ||
|
|
||
| ### Fix Dependency Alignment | ||
|
|
||
| If you use Sentry's OpenTelemetry agentless or OTLP integrations and another BOM manages OpenTelemetry versions, manually import Sentry's OpenTelemetry BOM. The BOM aligns Sentry's OpenTelemetry modules with the OpenTelemetry core, instrumentation, and incubator artifacts Sentry tests against. | ||
|
|
||
| Use the dependency alignment instructions for your integration: | ||
|
|
||
| - <PlatformLink to="/opentelemetry/setup/agentless/#opentelemetry-dependency-alignment"> | ||
| Agentless dependency alignment | ||
| </PlatformLink> | ||
| - <PlatformLink to="/opentelemetry/setup/otlp/#opentelemetry-dependency-alignment"> | ||
| OTLP dependency alignment | ||
| </PlatformLink> |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should gradle and maven be tabs like for the java view or do we want to have them split due to the additional info outside of snippet?