Document OTel metrics lifecycle methods - #39515
Draft
bm1549 wants to merge 3 commits into
Draft
Conversation
Contributor
Preview links (active after the
|
mabdinur
force-pushed
the
brian.marks/otel-metrics-lifecycle
branch
from
September 1, 2026 22:08
c0b50bc to
8e58cc5
Compare
mabdinur
approved these changes
Sep 2, 2026
mabdinur
left a comment
Contributor
There was a problem hiding this comment.
Reviewed for consistency with the SDK lifecycle APIs. CI is green.
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.
What does this PR do? What is the motivation?
Documents how short-lived Python, Java, and Node.js processes flush pending OTel custom metrics before exit.
The page clarifies that ForceFlush and Shutdown are Metrics SDK lifecycle operations, not Metrics API methods. It shows the official Python SDK surface and the equivalent Datadog extensions for Java and Node.js. It also documents language-specific completion, error, timeout, and export-pipeline behavior.
Merge readiness
The companion Java, Node.js, and system-tests PRs must land before this documentation is merged.
For Datadog employees:
<name>/<description>convention./reviewbefore requesting Documentation team review.AI assistance
Used Codex to review the SDK contracts, update the examples, and run documentation checks.
Additional notes
Vale reports no errors or findings on changed lines. Existing warnings are on unchanged content.
Companion PRs: system-tests #7606, Java #12317, and Node.js #10023.