Added notes about Log Scope usage to README #182
Merged
Conversation
This file contains 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
The ability to pass any `IEnumerable<KeyValuePair<string, object>>` to `ILogger.BeginScope` is an _extremely_ useful feature, but unfortunately it doesn't seem to be officially documented anywhere. I only discovered it while digging through this repo's source code! I assume this repo is the correct location for this information, as it only applies when one is using both Serilog and the _Microsoft.Extensions.Logging_ library, but I could see where it might be better off in the Serilog wiki. Looking forward to your feedback!
sungam3r
reviewed
Nov 9, 2020
sungam3r
reviewed
Nov 9, 2020
| A far better alternative is to use the `BeginScope<TState>(TState state)` method. If you provide any `IEnumerable<KeyValuePair<string, object>>` to this method, then we will output the key/value pairs as structured properties _without_ the `Scope` property, as in this example: | ||
|
|
||
| ```cs | ||
| var scopeProps = new Dictionary<string, object> { |
There was a problem hiding this comment.
Did you try
var scopeProps = new { TransactionId = 12345, ResponseJson = jsonString };?
There was a problem hiding this comment.
Ooh no I did not, good idea. Unfortunately, looks like anonymous types still generate a Scope property:
... Scope=["{ TransactionId = 12345, ResponseJson = "{\"Key1\":\"Value1\", \"Key2\":\"Value2\"}" }"]
|
@sungam3r So is there any interest in merging this PR or nah? |
|
Looks good 👍 |
Merged
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.
The ability to pass any
IEnumerable<KeyValuePair<string, object>>toILogger.BeginScopeis an extremely useful feature, but unfortunately it doesn't seem to be officially documented anywhere. I only discovered it while digging through this repo's source code! I assume this repo is the correct location for this information, as it only applies when one is using both Serilog and the Microsoft.Extensions.Logging library, but I could see where it might be better off in the Serilog wiki. Looking forward to your feedback!