fix(docs): correct stale flush() docstrings to reflect drain-only semantics (HYBIM-966) - #217
Merged
Merged
Conversation
etserend
marked this pull request as draft
August 7, 2026 19:19
etserend
marked this pull request as ready for review
August 20, 2026 23:24
…s automatically (HYBIM-966)
etserend
force-pushed
the
fix/HYBIM-966-flush-docstrings
branch
from
August 20, 2026 23:52
00a2499 to
62efd38
Compare
fercor-cisco
approved these changes
Aug 22, 2026
Collaborator
|
I created this follow-up ticket: https://splunk.atlassian.net/browse/SAO-16166 |
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
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.
Background
PR #155 (
8e244a0) changedflush()/async_flush()to drain-only — they no longer conclude open spans or upload traces. Docstrings and example code still described the old upload-and-finalize behavior.Changes in this PR
src/splunk_ao/utils/singleton.py—SplunkAOLoggerSingleton.flush()andflush_all()docstrings: "Flush (upload and clear)" → drain-only semanticssrc/splunk_ao/decorator.py—SplunkAODecorator.flush_all()docstring: "Upload all captured traces" → drain-only, with explicit note that it does not conclude open spanslogger.flush()calls and updated comments that implied upload-and-send behavior