Repository navigation
docs: finalize 3.0 migration release guidance - #818
Open
zhongkechen wants to merge 12 commits into
Open
zhongkechen wants to merge 12 commits into
zhongkechen wants to merge 12 commits into
Conversation
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
Contributor
Codex AI reviewNo actionable findings. The prior stability-contract concern is resolved in the base revision. This documentation-only review was static; runtime and cloud migration paths were not exercised. Reviewed commit |
This branch was successfully 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.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
Issue Link, if available
Release preparation follow-up to #813 for the draft v3.0.0 release. Incorporates the migration implications of #817, #820, and #821.
Description
The migration guide still describes the factory release as
3.0.0-SNAPSHOTand omits changes consumers need for the proposed 3.0.0 artifacts. Document coordinated Core, Testing, and OTel versions, a Maven dependency example, provider/layer rebuilding, and the concrete factory-method compatibility check. Java's OTel artifact uses 3.0.0; Python and JavaScript version their OTel packages separately.Document the release decision that the Telemetry Exporter becomes a stable public API in 3.0.0, with migration guidance for consumers of earlier preview builds. Its migration section covers the factory return type, registration recompilation, Lambda JSON log envelope, fixed-width millisecond UTC timestamps, invocation-scoped
emittedAtordering, and optional error causes. The OTel section explains Java-agent sampler verification, chained-invoke propagation and fallback, and deterministic propagation during replay/retry.Organize the guide around dependency upgrades, registration changes, resource ownership, lifecycle behavior, and validation. Preserve existing API examples and the documented limits for stale directly registered providers and non-cooperative cleanup. Expand the affected-code searches and validation steps for the merged tracing and exporter changes.
The guide continues to describe a proposed release. The draft release notes link to this guide's updated revision. Before publication, align the exporter's source annotations and README with the stable 3.0.0 API decision; this documentation PR does not change those files.
Demo/Screenshots
Not applicable; the Markdown guide is included in the diff and its rendered headings and links were checked locally.
Checklist
Testing
Unit Tests
No runtime unit tests added or run for this documentation-only change. Verified the documented behavior against current SDK source and the OTel/exporter references. The repository-wide Java 17 offline Spotless check passed.
Integration Tests
No runtime behavior changed. Rendered the Markdown and checked all 14 links, including local targets and anchors. Parsed the Maven example as XML and verified its coordinated 3.0.0 dependencies. Hidden-character and
git diff --checkchecks passed.Examples
All 17 fenced blocks are retained. Existing Java, XML, and diagnostic examples are unchanged by the release-alignment update; affected-code searches now include tracing configuration and telemetry consumers. Publication is still required before consumers can resolve the proposed release coordinates.