Repository navigation
Optionally preserve logging scopes in buffered log records - #7807
Closed
evgenyfedorov2 wants to merge 1 commit into
Closed
evgenyfedorov2 wants to merge 1 commit into
evgenyfedorov2 wants to merge 1 commit into
Conversation
Collaborator
🎉 Good job! The coverage increased 🎉
Full code coverage report: https://dev.azure.com/dnceng-public/public/_build/results?buildId=1624548&view=codecoverage-tab |
Collaborator
🎉 Good job! The coverage increased 🎉
Full code coverage report: https://dev.azure.com/dnceng-public/public/_build/results?buildId=1625111&view=codecoverage-tab |
Collaborator
🎉 Good job! The coverage increased 🎉
Full code coverage report: https://dev.azure.com/dnceng-public/public/_build/results?buildId=1626028&view=codecoverage-tab |
Collaborator
🎉 Good job! The coverage increased 🎉
Full code coverage report: https://dev.azure.com/dnceng-public/public/_build/results?buildId=1626139&view=codecoverage-tab |
Collaborator
🎉 Good job! The coverage increased 🎉
Full code coverage report: https://dev.azure.com/dnceng-public/public/_build/results?buildId=1626234&view=codecoverage-tab |
Adds the experimental GlobalLogBufferingOptions.IncludeScopes and PerRequestLogBufferingOptions.IncludeScopes
options (EXTEXP0003). When an option is enabled, the buffer adds the name/value pairs of the logging scopes
that are active when a log record is buffered to the record's attributes. IBufferedLogger implementations
get them in BufferedLogRecord.Attributes, and other loggers get them in the state passed to ILogger.Log.
- Only scopes that implement IEnumerable<KeyValuePair<string, object?>> are added, without their
"{OriginalFormat}" pairs. The log record's own "{OriginalFormat}" stays the last attribute.
- Scope values are converted to strings and count toward the size limits.
- The buffers get the IExternalScopeProvider through constructor injection. AddGlobalBuffer registers one
with TryAddSingleton, and ExtendedLoggerFactory uses it too, so the factory and the buffers share it.
- Both options bind from configuration, and the delegate overload of AddPerIncomingRequestBuffer copies
IncludeScopes to the global buffer options.
Fixes #7781
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
evgenyfedorov2
force-pushed
the
evgenyfedorov2-buffered-logging-scopes
branch
from
October 7, 2026 12:18
808400a to
6d8e6a9
Compare
Collaborator
🎉 Good job! The coverage increased 🎉
Full code coverage report: https://dev.azure.com/dnceng-public/public/_build/results?buildId=1626352&view=codecoverage-tab |
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
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.
Log buffering drops
ILogger.BeginScopedata today: buffered records are emitted without the scopes that were active when they were logged. This was raised in the #5635 review. This PR adds an opt-in way to keep that data by adding the scopes' name/value pairs to the attributes of buffered records.New API (experimental, EXTEXP0003)
GlobalLogBufferingOptions.IncludeScopesPerRequestLogBufferingOptions.IncludeScopesBoth default to
falseand bind from configuration. The buffers read them each time they buffer a record, so options reloads take effect. The name matchesOpenTelemetryLoggerOptions.IncludeScopesandConsoleFormatterOptions.IncludeScopes, which are also opt-in. I avoidedCaptureScopesbecauseLoggerFilterOptions.CaptureScopesis the factory-wide switch and defaults totrue. The delegate overload ofAddPerIncomingRequestBuffercopies the value to the global fallback buffer, the same way it already copiesRules.How it works
IncludeScopesis on,GlobalBufferandIncomingRequestLogBufferread the current scopes, includingActivityTrackingOptionsscopes, and add each scope's name/value pairs to the record's attributes.{OriginalFormat}, which stays the last attribute.ExtendedLoggerguarantees that since [Telemetry, Logging] Emit {OriginalFormat} as the last property of the log record #6111, and OpenTelemetry up to 1.15.0 only looks for the message template in the last attribute.IEnumerable<KeyValuePair<string, object?>>are added, without their{OriginalFormat}pairs. Other scopes, such as strings andDictionary<string, string>instances, are skipped. Console's JSON formatter and OpenTelemetry also treat only such scopes as name/value pairs.IBufferedLoggerimplementations get the pairs inBufferedLogRecord.Attributes. Other loggers get them in the state passed toILogger.Log.IExternalScopeProviderthey get through constructor injection.AddGlobalBufferregisters one withTryAddSingleton, andExtendedLoggerFactoryalready uses anIExternalScopeProviderfrom DI when there is one, so the factory and the buffers share it.Worth a careful look
BeginScopealways records into it, even whenIncludeScopesis off.ISupportExternalScope, this costs 256 bytes perBeginScope(measured on net10.0). The Console and OpenTelemetry providers implement it, so in typical apps the factory records scopes anyway.IExternalScopeProviderthat an app registers itself, or decide at startup, which needs a DI registration that returns null. Autofac throws on that.Testing
New tests cover:
{OriginalFormat}, with string scopes,Dictionary<string, string>scopes and the scopes'{OriginalFormat}pairs skipped{OriginalFormat}The config-binding tests and the per-request delegate overload tests are extended.
The full
Microsoft.Extensions.Telemetry.TestsandMicrosoft.AspNetCore.Diagnostics.Middleware.Testssuites pass on net8.0, net9.0, and net10.0.The learn.microsoft.com log buffering limitations page will need a follow-up in dotnet/docs.
Fixes: #7781
Microsoft Reviewers: Open in CodeFlow