Add IFlushableLogSink interface and LogManager.FlushAsync#13
Merged
Add IFlushableLogSink interface and LogManager.FlushAsync#13
Conversation
Introduce a flush primitive for buffered sinks that drains queued entries without tearing down the logging pipeline. Co-Authored-By: Claude Opus 4.6 <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
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
IFlushableLogSinkopt-in interface for sinks that support mid-stream flushingBufferedLogSinkLogManager.FlushAsync(TimeSpan?)to flush all flushable sinksReason for Change
There was no way to force-flush buffered sinks without shutting down. After a critical error, an application may need to ensure all buffered log entries are written to disk/network before attempting recovery — without tearing down the logging pipeline.
Impact
BufferedLogSink(and its subclassesFileSink,StreamSink) now implementIFlushableLogSinkConsoleSink,DebugSink,RecordingSink) are unaffected — they don't implement the interface and are simply skipped during flushLogManager.FlushAsync()iterates all sinks, callingFlushAsynconly onIFlushableLogSinkimplementationsMigration Steps
None required — this is purely additive. Existing code continues to work unchanged.
Performance Considerations
CreateFlushSentinelusesArray.Empty<byte>()to avoid allocation for the unused buffer fieldTaskCreationOptions.RunContinuationsAsynchronouslyprevents inline continuation on the drain loop threadIsFlushSentinelcheck is a single null reference checkSecurity Considerations
None.
Breaking Changes
BufferedEntryrecord struct gains an optionalFlushCompletionparameter (defaultnull) — source-compatible for existing derived sinks