Adding Microsoft.Extensions.Telemetry.Abstractions README #4670
Conversation
ghost
assigned 
src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/README.md
Outdated
Show resolved
Hide resolved
src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/README.md
Outdated
Show resolved
Hide resolved
| It also adds the `LogProperties` attribute which can be applied to a an object parameter of a `LoggerMessage` method. It introspects the passed-in object and automatically adds tags for all its properties. This leads to more informative logs without the need for manual tagging of each property. | ||
|
|
||
| ```csharp | ||
| [LoggerMessage(1, LogLevel.Information, "Detected a new temperature: {temperature}")] |
There was a problem hiding this comment.
| [LoggerMessage(1, LogLevel.Information, "Detected a new temperature: {temperature}")] | |
| [LoggerMessage(1, LogLevel.Information, "Detected a new temperature: {Temperature}")] |
There was a problem hiding this comment.
This should match the parameter name, which is lower case.
There was a problem hiding this comment.
Examples in extensions
And the doc: https://learn.microsoft.com/en-us/dotnet/core/extensions/logger-message-generator#basic-usage
There was a problem hiding this comment.
Keep in mind that this is using a different generator which adds additional constraints and diagnostics (this is using Microsoft.Extensions.Telemetry.Abstractions logging generator)
I believe in the past I've seen warnings when parameter name doesn't exactly match the template, @geeknoid can you confirm?
There was a problem hiding this comment.
I checked back and it does seem like this is not case-sensitive as you suggested, which also seems to be called out explicitly https://learn.microsoft.com/en-us/dotnet/core/extensions/logger-message-generator#case-insensitive-template-name-support . Anyway, since it's not a convention that we should upper case those, I've left it lowercase for now (I also hope it helps describing that what should match is paramter name as opposed to the parameter type, since in my example both are the same).
There was a problem hiding this comment.
First letter can be either lowercased or uppercased, you can check Iliar's PR: #4584
src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/README.md
Outdated
Show resolved
Hide resolved
src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/README.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Sébastien Ros <sebastienros@gmail.com>
| Logging data can be enriched by adding custom log enrichers to the service collection. This can be done using specific implementations or generic types. | ||
|
|
||
| ```csharp | ||
| // Using a specific implementation |
There was a problem hiding this comment.
implementation -> instance?
| builder.Services.AddLogEnricher<AnotherLogEnricher>(); | ||
| ``` | ||
|
|
||
| Create custom log enrichers by implementing the `ILogEnricher` interface. |
There was a problem hiding this comment.
Worth mentioning IStaticLogEnricher too
There was a problem hiding this comment.
Adding Microsoft.Extensions.Telemetry.Abstractions README
Microsoft Reviewers: Open in CodeFlow