Add event name in Middlewares (#6467)

Author: Kahbazi

src/Middleware/CORS/src/Internal/CORSLoggerExtensions.cs

@@ -1,4 +1,4 @@
-// Copyright (c) .NET Foundation. All rights reserved.
+// Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
 using System;
@@ -25,47 +25,47 @@ static CORSLoggerExtensions()
         {
             _isPreflightRequest = LoggerMessage.Define(
                 LogLevel.Debug,
-                1,
+                new EventId(1, "IsPreflightRequest"),
                 "The request is a preflight request.");
 
             _requestHasOriginHeader = LoggerMessage.Define<string>(
                 LogLevel.Debug,
-                2,
+                new EventId(2, "RequestHasOriginHeader"),
                 "The request has an origin header: '{origin}'.");
 
             _requestDoesNotHaveOriginHeader = LoggerMessage.Define(
                 LogLevel.Debug,
-                3,
+                new EventId(3, "RequestDoesNotHaveOriginHeader"),
                 "The request does not have an origin header.");
 
             _policySuccess = LoggerMessage.Define(
                 LogLevel.Information,
-                4,
+                new EventId(4, "PolicySuccess"),
                 "CORS policy execution successful.");
 
             _policyFailure = LoggerMessage.Define(
                 LogLevel.Information,
-                5,
+                new EventId(5, "PolicyFailure"),
                 "CORS policy execution failed.");
 
             _originNotAllowed = LoggerMessage.Define<string>(
                 LogLevel.Information,
-                6,
+                new EventId(6, "OriginNotAllowed"),
                 "Request origin {origin} does not have permission to access the resource.");
 
             _accessControlMethodNotAllowed = LoggerMessage.Define<string>(
                 LogLevel.Information,
-                7,
+                new EventId(7, "AccessControlMethodNotAllowed"),
                 "Request method {accessControlRequestMethod} not allowed in CORS policy.");
 
             _requestHeaderNotAllowed = LoggerMessage.Define<string>(
                 LogLevel.Information,
-                8,
+                new EventId(8, "RequestHeaderNotAllowed"),
                 "Request header '{requestHeader}' not allowed in CORS policy.");
 
             _failedToSetCorsHeaders = LoggerMessage.Define(
                 LogLevel.Warning,
-                9,
+                new EventId(9, "FailedToSetCorsHeaders"),
                 "Failed to apply CORS Response headers.");
 
             _noCorsPolicyFound = LoggerMessage.Define(
@@ -75,12 +75,12 @@ static CORSLoggerExtensions()
 
             _insecureConfiguration = LoggerMessage.Define(
                 LogLevel.Warning,
-                new EventId(11, "CorsInsecureConfiguration"),
+                new EventId(11, "InsecureConfiguration"),
                 "The CORS protocol does not allow specifying a wildcard (any) origin and credentials at the same time. Configure the policy by listing individual origins if credentials needs to be supported.");
 
             _isNotPreflightRequest = LoggerMessage.Define(
                 LogLevel.Debug,
-                new EventId(12, "OptionsRequestWithoutAccessControlRequestMethodHeader"),
+                new EventId(12, "IsNotPreflightRequest"),
                 "This request uses the HTTP OPTIONS method but does not have an Access-Control-Request-Method header. This request will not be treated as a CORS preflight request.");
         }
 

src/Middleware/HttpsPolicy/src/internal/HstsLoggingExtensions.cs

@@ -14,9 +14,20 @@ internal static class HstsLoggingExtensions
 
         static HstsLoggingExtensions()
         {
-            _notSecure = LoggerMessage.Define(LogLevel.Debug, 1, "The request is insecure. Skipping HSTS header.");
-            _excludedHost = LoggerMessage.Define<string>(LogLevel.Debug, 2, "The host '{host}' is excluded. Skipping HSTS header.");
-            _addingHstsHeader = LoggerMessage.Define(LogLevel.Trace, 3, "Adding HSTS header to response.");
+            _notSecure = LoggerMessage.Define(
+                LogLevel.Debug,
+                new EventId(1, "NotSecure"),
+                "The request is insecure. Skipping HSTS header.");
+
+            _excludedHost = LoggerMessage.Define<string>(
+                LogLevel.Debug,
+                new EventId(2, "ExcludedHost"),
+                "The host '{host}' is excluded. Skipping HSTS header.");
+
+            _addingHstsHeader = LoggerMessage.Define(
+                LogLevel.Trace,
+                new EventId(3, "AddingHstsHeader"),
+                "Adding HSTS header to response.");
         }
 
         public static void SkippingInsecure(this ILogger logger)

src/Middleware/HttpsPolicy/src/internal/HttpsLoggingExtensions.cs

@@ -1,4 +1,4 @@
-// Copyright (c) .NET Foundation. All rights reserved.
+// Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
 using System;
@@ -16,13 +16,31 @@ internal static class HttpsLoggingExtensions
 
         static HttpsLoggingExtensions()
         {
-            _redirectingToHttps = LoggerMessage.Define<string>(LogLevel.Debug, 1, "Redirecting to '{redirect}'.");
-            _portLoadedFromConfig = LoggerMessage.Define<int>(LogLevel.Debug, 2, "Https port '{port}' loaded from configuration.");
-            _failedToDeterminePort = LoggerMessage.Define(LogLevel.Warning, 3, "Failed to determine the https port for redirect.");
-            _failedMultiplePorts = LoggerMessage.Define(LogLevel.Warning, 4,
+            _redirectingToHttps = LoggerMessage.Define<string>(
+                LogLevel.Debug,
+                new EventId(1, "RedirectingToHttps"),
+                "Redirecting to '{redirect}'.");
+
+            _portLoadedFromConfig = LoggerMessage.Define<int>(
+                LogLevel.Debug,
+                new EventId(2, "PortLoadedFromConfig"),
+                "Https port '{port}' loaded from configuration.");
+
+            _failedToDeterminePort = LoggerMessage.Define(
+                LogLevel.Warning,
+                new EventId(3, "FailedToDeterminePort"),
+                "Failed to determine the https port for redirect.");
+
+            _failedMultiplePorts = LoggerMessage.Define(
+                LogLevel.Warning,
+                new EventId(4, "FailedMultiplePorts"),
                 "Cannot determine the https port from IServerAddressesFeature, multiple values were found. " +
                 "Please set the desired port explicitly on HttpsRedirectionOptions.HttpsPort.");
-            _portFromServer = LoggerMessage.Define<int>(LogLevel.Debug, 5, "Https port '{httpsPort}' discovered from server endpoints.");
+
+            _portFromServer = LoggerMessage.Define<int>(
+                LogLevel.Debug,
+                new EventId(5, "PortFromServer"),
+                "Https port '{httpsPort}' discovered from server endpoints.");
         }
 
         public static void RedirectingToHttps(this ILogger logger, string redirect)

src/Middleware/Localization/src/Internal/RequestCultureProviderLoggerExtensions.cs

@@ -1,4 +1,4 @@
-// Copyright (c) .NET Foundation. All rights reserved.
+// Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
 using System;
@@ -17,11 +17,11 @@ static RequestCultureProviderLoggerExtensions()
         {
             _unsupportedCulture = LoggerMessage.Define<string, IList<StringSegment>>(
                 LogLevel.Warning,
-                1,
+                 new EventId (1, "UnsupportedCulture"),
                 "{requestCultureProvider} returned the following unsupported cultures '{cultures}'.");
             _unsupportedUICulture = LoggerMessage.Define<string, IList<StringSegment>>(
                 LogLevel.Warning,
-                2,
+                 new EventId(2, "UnsupportedUICulture"),
                 "{requestCultureProvider} returned the following unsupported UI Cultures '{uiCultures}'.");
         }