chore(otel): document otel api limitations #6915
Closed
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.
Resolves: #6882
What does this PR do?
Updates OpenTelemetry documentation to clearly warn users that dd-trace-js and their application must use the same instance of
@opentelemetry/apiand@opentelemetry/api-logsmodules.Motivation
Users installing different versions of
@opentelemetry/api(e.g., v1.9.0) can end up with multiple copies in node_modules, causing module duplication. This breaks OpenTelemetry's singleton pattern, resulting in spans becoming no-ops with all-zero trace IDs and opentelemetry logs not being submitted.This documentation update serves as an alternative to converting these packages to peer dependencies. It makes users aware of the requirement to use the same module instance as dd-trace-js.
Additional Notes