Add LoggingGenerator #51064
- Add LoggerMessageAttribute - ref/src
- Fix build on csproj - Make InternalsVisibleTo in test for DiagDescriptors asserts - Fix name typos in sln and cs file
- Loading branch information
commit 3ef20830d02f347035a57b23db77fa6d0e6ab350
There are no files selected for viewing
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
|
|
||
| using System.Runtime.CompilerServices; | ||
|
|
||
| [assembly: InternalsVisibleTo("Microsoft.Extensions.Logging.Generators.Tests, PublicKey=0024000004800000940000000602000000240000525341310004000001000100f33a29044fa9d740c9b3213a93e57c84b472c84e0b8a0e1ae48e67a9f8f6de9d5f7f3d52ac23e48ac51801f1dc950abe901da34d2a9e3baadb141a17c77ef3c565dd5ee5054b91cf63bb3c6ab83f72ab3aafe93d0fc3c2348b764fafb0b1c0733de51459aeab46580384bf9d74c4e28164b7cde247f891ba07891c9d872ad2bb")] | ||
maryamariyan marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -24,7 +24,7 @@ public enum ActivityTrackingOptions | |
| TraceState = 8, | ||
| TraceFlags = 16, | ||
| Tags = 32, | ||
| Baggage = 64, | ||
| } | ||
| public static partial class FilterLoggingBuilderExtensions | ||
| { | ||
|
|
@@ -85,6 +85,15 @@ public LoggerFilterRule(string providerName, string categoryName, Microsoft.Exte | |
| public string ProviderName { get { throw null; } } | ||
| public override string ToString() { throw null; } | ||
| } | ||
| [System.AttributeUsageAttribute(System.AttributeTargets.Method)] | ||
| public sealed partial class LoggerMessageAttribute : System.Attribute | ||
|
Member
There was a problem hiding this comment. I know this is still up in the air - but I assumed we weren't putting the attribute in the library's
Member
There was a problem hiding this comment. I think we need to file an issue on roslyn to help solve this. I think this generator is a great case study to drive such an issue. Especially given that in Preview4 the reference assembly will be in the ASP.NETCore shared framework but the generator will only be in the NuGet package.
Member
There was a problem hiding this comment.
A way to do this would be to provide an analyzer that validates if the corresponding partial-implementation part is there, and errors if it is not. If that's a requirement of this attribute, it should be responsible for delivering the analyzer that validates that piece IMO.
Contributor
Author
There was a problem hiding this comment. I was just about to reply with your message here @CyrusNajmabadi :) you beat me to it.
Member
There was a problem hiding this comment.
What if the analyzer isn't passed to the compiler? That's just the same problem. I don't think adding redundancy in another optional component is a solution. |
||
| { | ||
| public LoggerMessageAttribute() { } | ||
| public int EventId { get { throw null; } set { } } | ||
| public string? EventName { get { throw null; } set { } } | ||
| public Microsoft.Extensions.Logging.LogLevel Level { get { throw null; } set { } } | ||
| public string Message { get { throw null; } set { } } | ||
| } | ||
| public static partial class LoggingBuilderExtensions | ||
| { | ||
| public static Microsoft.Extensions.Logging.ILoggingBuilder AddProvider(this Microsoft.Extensions.Logging.ILoggingBuilder builder, Microsoft.Extensions.Logging.ILoggerProvider provider) { throw null; } | ||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
|
|
||
| using System; | ||
|
|
||
| namespace Microsoft.Extensions.Logging | ||
| { | ||
| /// <summary> | ||
| /// Provides information to guide the production of a strongly-typed logging method. | ||
| /// </summary> | ||
| [AttributeUsage(AttributeTargets.Method)] | ||
| public sealed class LoggerMessageAttribute : Attribute | ||
| { | ||
| #pragma warning disable SA1629 // Documentation text should end with a period | ||
| /// <summary> | ||
| /// Initializes a new instance of the <see cref="LoggerMessageAttribute"/> class | ||
| /// which is used to guide the production of a strongly-typed logging method. | ||
| /// </summary> | ||
| /// <remarks> | ||
maryamariyan marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| /// The method this attribute is applied to: | ||
| /// - Must be a partial method. | ||
| /// - Must return <c>void</c>. | ||
| /// - Must not be generic. | ||
| /// - Must have an <see cref="ILogger"/> as one of its parameters. | ||
| /// - Must have a <see cref="Microsoft.Extensions.Logging.LogLevel"/> as one of its parameters. | ||
| /// - None of the parameters can be generic. | ||
| /// </remarks> | ||
| /// <example> | ||
| /// static partial class Log | ||
| /// { | ||
| /// [LoggerMessage(EventId = 0, Message = "Could not open socket for {hostName}")] | ||
| /// static partial void CouldNotOpenSocket(ILogger logger, LogLevel level, string hostName); | ||
| /// } | ||
| /// </example> | ||
| public LoggerMessageAttribute() { } | ||
| #pragma warning restore SA1629 // Documentation text should end with a period | ||
|
|
||
| /// <summary> | ||
| /// Gets the logging event id for the logging method. | ||
| /// </summary> | ||
| public int EventId { get; set; } = -1; | ||
|
|
||
| /// <summary> | ||
| /// Gets or sets the logging event name for the logging method. | ||
| /// </summary> | ||
| /// <remarks> | ||
| /// This will equal the method name if not specified. | ||
| /// </remarks> | ||
| public string? EventName { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Gets the logging level for the logging method. | ||
| /// </summary> | ||
| public LogLevel Level { get; set; } = LogLevel.None; | ||
|
|
||
| /// <summary> | ||
| /// Gets the message text for the logging method. | ||
| /// </summary> | ||
| public string Message { get; set; } = ""; | ||
| } | ||
| } | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.