fix(docs): correct stale flush() docstrings to reflect drain-only semantics (HYBIM-966) - #217
Draft
etserend wants to merge 3 commits into
Draft
fix(docs): correct stale flush() docstrings to reflect drain-only semantics (HYBIM-966)#217etserend wants to merge 3 commits into
etserend wants to merge 3 commits into
Conversation
…antics (HYBIM-966) flush() and async_flush() no longer upload traces — they only drain the OTLP export queue since PR #155. Update singleton.py and decorator.py docstrings to match the actual behavior. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
etserend
marked this pull request as draft
August 7, 2026 19:19
…M-966) flush() no longer uploads traces — it only drains the OTLP export queue. Also note it does not conclude open spans, matching the CHANGELOG entry from PR #155. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
…s (HYBIM-966) Replace stale "send the trace to Splunk AO" / "uploads traces" inline comments with "drain the OTLP export queue" across chatbot examples, redaction example, and migration-tool before/after examples. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
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
1 participant
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.
Summary
SplunkAOLoggerSingleton.flush()docstring: "Flush (upload and clear)" → "Drain the OTLP export queue for"SplunkAOLoggerSingleton.flush_all()one-liner: same fixSplunkAODecorator.flush_all()docstring: "Upload all captured traces" → drain-only semantics, with explicit note that it does not conclude spansRoot cause: PR #155 (
8e244a0) changedflush()/async_flush()to returnNoneand only drain the OTLP export queue. The docstrings still described the old upload-and-finalize behavior.Companion change:
agent-observability-docshand-authored snippets and guide prose updated in a separate commit (3 files:basic-logging.mdx,flush-logger-gl.mdx,manual-span-creation.mdx).Test plan
decorator.mdxandsingleton.mdxwill reflect correct semantics on next docs publish🤖 Generated with Claude Code