Repository navigation
docs: simplify and update OpenTelemetry guide - #302
Draft
zhongkechen wants to merge 3 commits into
Draft
zhongkechen wants to merge 3 commits into
zhongkechen wants to merge 3 commits into
Conversation
zhongkechen
had a problem deploying
to
ai-pr-review
October 28, 2026 21:51 — with
GitHub Actions
Error
zhongkechen
had a problem deploying
to
ai-pr-review
October 28, 2026 22:03 — with
GitHub Actions
Error
zhongkechen
requested a deployment
to
ai-pr-review
October 28, 2026 22:08 — with
GitHub Actions
Waiting
This branch is waiting to be deployed
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
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.
The OpenTelemetry guide still registers plugin instances that the current SDK 3.x APIs reject, recommends Python's unimplemented W3C extractor, and describes outdated sampling behavior. Update the guide and all six handler examples to the supported factories, including Java's public
handleRequestoverride.Remove the stale experimental/non-production warning: the JavaScript 3.0 release removes the plugin interface's experimental/beta labels, and the Python OTel package metadata declares Production/Stable.
Consolidate repeated deployment templates and trace explanations into shared setup and a view comparison. Correct fallback-root export, sampling differences, log correlation, and failure/replay guidance; document TypeScript's flush budget. The page is about 36% shorter by word count.
Python #865 and #869 are explicitly marked as pending, with the behavior before and after their fixes. This documentation can merge independently because it does not present those changes as released.
Implementation checked against JavaScript
b92df515, Python4625d01b, Java64339d4f, and shared conformance requirementsb0340ba. The two Python fix revisions were352a137fand626c1756. Also reviewed the open Python OTel conformance and lifecycle test PRs; this guide makes no new deployed-service qualification claims.Validation:
mdformat --check docs/andcodespell docs/passed; final edited page rechecked.git diff --checkpassed. No cloud deployment or conformance suite execution.The browser policy blocked local-file visual preview; generated HTML was inspected programmatically instead.