Add log buffering docs #46232
Open
Add log buffering docs #46232
+939
−0
Conversation
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
evgenyfedorov2
force-pushed
the
users/evgenyfedorov2/log_buffering_doc
branch
5 times, most recently
from
1ad5e4b to
b8fb0b7
Compare
evgenyfedorov2
force-pushed
the
users/evgenyfedorov2/log_buffering_doc
branch
from
b8fb0b7 to
5cbf2fc
Compare
Rageking8
reviewed
May 18, 2025
| - Buffers logs from categories starting with `PerRequestLogBufferingFileBased.` with level <xref:Microsoft.Extensions.Logging.LogLevel.Information?displayProperty=nameWithType> and below. | ||
| - Sets an auto-flush duration of 5 seconds after manual flushing. | ||
|
|
||
| To register the log buffering with the configuration, consider the following code:: |
There was a problem hiding this comment.
Suggested change
| To register the log buffering with the configuration, consider the following code:: | |
| To register the log buffering with the configuration, consider the following code: |
| > [!NOTE] | ||
| > Log buffering is available in .NET 9 and later versions. | ||
|
|
||
| Log buffering works with all logging providers. If a logging provider you use does not implement the <xref:Microsoft.Extensions.Logging.Abstractions.IBufferedLogger> interface, log buffering will be calling log methods directly on every single buffered log record when flushing the buffer. |
There was a problem hiding this comment.
Suggested change
| Log buffering works with all logging providers. If a logging provider you use does not implement the <xref:Microsoft.Extensions.Logging.Abstractions.IBufferedLogger> interface, log buffering will be calling log methods directly on every single buffered log record when flushing the buffer. | |
| Log buffering works with all logging providers. If a logging provider you use does not implement the <xref:Microsoft.Extensions.Logging.Abstractions.IBufferedLogger> interface, log buffering will call log methods directly on every single buffered log record when flushing the buffer. |
|
|
||
| - If the buffer is full, the oldest logs will be dropped and never emitted. | ||
| - If you want to emit the buffered logs, you can call `Flush()` on the `GlobalLogBuffer` or `PerRequestLogBuffer` class. | ||
| - If you never flush buffers, the buffered logs will eventually be dropped as application runs, so it effectively behaves like those logs are disabled. |
There was a problem hiding this comment.
Suggested change
| - If you never flush buffers, the buffered logs will eventually be dropped as application runs, so it effectively behaves like those logs are disabled. | |
| - If you never flush the buffers, the buffered logs will eventually be dropped as the application runs, so it effectively behaves like those logs are disabled. |
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
Fixes #46231
Internal previews