Include EventId in telemetry properties

CHANGELOG.md

@@ -4,6 +4,7 @@
 - Updated Javascript Snippet with latest from [Github/ApplicationInsights-JS](https://github.com/Microsoft/ApplicationInsights-JS)
 - [Make all built-in TelemetryInitializers public to allow easy removal from DI Container.](https://github.com/Microsoft/ApplicationInsights-aspnetcore/issues/351)
 - [Enforced limits of values read from incoming http requests to prevent security vulnerability](https://github.com/Microsoft/ApplicationInsights-aspnetcore/pull/608)
+- [ApplicationInsightsLogger adds EventId into telemetry properties. It is off by default for compatibility. It can be switched on by configuring ApplicationInsightsLoggerOptions.](https://github.com/Microsoft/ApplicationInsights-aspnetcore/issues/569)
 
 ## Version 2.2.1
 - Updated Web/Base SDK version dependency to 2.5.1 which addresses a bug.

src/Microsoft.ApplicationInsights.AspNetCore/Logging/Implementation/ApplicationInsightsLogger.cs

@@ -17,16 +17,18 @@ internal class ApplicationInsightsLogger : ILogger
         private readonly string categoryName;
         private readonly TelemetryClient telemetryClient;
         private readonly Func<string, LogLevel, bool> filter;
+        private readonly ApplicationInsightsLoggerOptions options;
         private readonly string sdkVersion;
 
         /// <summary>
         /// Creates a new instance of <see cref="ApplicationInsightsLogger"/>
         /// </summary>
-        public ApplicationInsightsLogger(string name, TelemetryClient telemetryClient, Func<string, LogLevel, bool> filter)
+        public ApplicationInsightsLogger(string name, TelemetryClient telemetryClient, Func<string, LogLevel, bool> filter, ApplicationInsightsLoggerOptions options)
         {
             this.categoryName = name;
             this.telemetryClient = telemetryClient;
             this.filter = filter;
+            this.options = options;
             this.sdkVersion = SdkVersionUtils.VersionPrefix + SdkVersionUtils.GetAssemblyVersion();
         }
 
@@ -51,7 +53,7 @@ public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Except
                 if (exception == null)
                 {
                     var traceTelemetry = new TraceTelemetry(formatter(state, exception), this.GetSeverityLevel(logLevel));
-                    PopulateTelemetry(traceTelemetry, stateDictionary);
+                    PopulateTelemetry(traceTelemetry, stateDictionary, eventId);
                     this.telemetryClient.TrackTrace(traceTelemetry);
                 }
                 else
@@ -60,16 +62,30 @@ public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Except
                     exceptionTelemetry.Message = formatter(state, exception);
                     exceptionTelemetry.SeverityLevel = this.GetSeverityLevel(logLevel);
                     exceptionTelemetry.Context.Properties["Exception"] = exception.ToString();
-                    PopulateTelemetry(exceptionTelemetry, stateDictionary);
+                    PopulateTelemetry(exceptionTelemetry, stateDictionary, eventId);
                     this.telemetryClient.TrackException(exceptionTelemetry);
                 }
             }
         }
 
-        private void PopulateTelemetry(ITelemetry telemetry, IReadOnlyList<KeyValuePair<string, object>> stateDictionary)
+        private void PopulateTelemetry(ITelemetry telemetry, IReadOnlyList<KeyValuePair<string, object>> stateDictionary, EventId eventId)
         {
             IDictionary<string, string> dict = telemetry.Context.Properties;
             dict["CategoryName"] = this.categoryName;
+
+            if (this.options?.IncludeEventId ?? false)
+            {
+                if (eventId.Id != 0)
+                {
+                    dict["EventId"] = eventId.Id.ToString(System.Globalization.CultureInfo.InvariantCulture);
+                }
+
+                if (!string.IsNullOrEmpty(eventId.Name))
+                {
+                    dict["EventName"] = eventId.Name;
+                }
+            }
+
             if (stateDictionary != null)
             {
                 foreach (KeyValuePair<string, object> item in stateDictionary)

src/Microsoft.ApplicationInsights.AspNetCore/Logging/Implementation/ApplicationInsightsLoggerFactoryExtensions.cs

@@ -4,6 +4,7 @@
     using ApplicationInsights;
     using ApplicationInsights.AspNetCore.Logging;
     using Microsoft.Extensions.DependencyInjection;
+    using Microsoft.Extensions.Options;
 
     /// <summary>
     /// Extension methods for <see cref="ILoggerFactory"/> that allow adding Application Insights logger.
@@ -64,6 +65,12 @@ public static ILoggerFactory AddApplicationInsights(
         {
             var client = serviceProvider.GetService<TelemetryClient>();
             var debugLoggerControl = serviceProvider.GetService<ApplicationInsightsLoggerEvents>();
+            var options = serviceProvider.GetService<IOptions<ApplicationInsightsLoggerOptions>>();
+
+            if (options == null)
+            {
+                options = Options.Create(new ApplicationInsightsLoggerOptions());
+            }
 
             if (debugLoggerControl != null)
             {
@@ -75,7 +82,7 @@ public static ILoggerFactory AddApplicationInsights(
                 }
             }
 
-            factory.AddProvider(new ApplicationInsightsLoggerProvider(client, filter));
+            factory.AddProvider(new ApplicationInsightsLoggerProvider(client, filter, options));
             return factory;
         }
     }

src/Microsoft.ApplicationInsights.AspNetCore/Logging/Implementation/ApplicationInsightsLoggerOptions.cs

@@ -0,0 +1,13 @@
+namespace Microsoft.ApplicationInsights.AspNetCore.Logging
+{
+    /// <summary>
+    /// Options for configuration of <see cref="ApplicationInsightsLogger"/>.
+    /// </summary>
+    public class ApplicationInsightsLoggerOptions
+    {
+        /// <summary>
+        /// Gets or sets value indicating, whether EventId and EventName properties should be included in telemetry.
+        /// </summary>
+        public bool IncludeEventId { get; set; }
+    }
+}

src/Microsoft.ApplicationInsights.AspNetCore/Logging/Implementation/ApplicationInsightsLoggerProvider.cs

@@ -2,6 +2,7 @@
 {
     using System;
     using Microsoft.Extensions.Logging;
+    using Microsoft.Extensions.Options;
 
     /// <summary>
     /// <see cref="ILoggerProvider"/> implementation that creates returns instances of <see cref="ApplicationInsightsLogger"/>
@@ -11,20 +12,22 @@ internal class ApplicationInsightsLoggerProvider : ILoggerProvider
     {
         private readonly TelemetryClient telemetryClient;
         private readonly Func<string, LogLevel, bool> filter;
+        private readonly ApplicationInsightsLoggerOptions options;
 
         /// <summary>
         /// Initializes a new instance of the <see cref="ApplicationInsightsLoggerProvider"/> class.
         /// </summary>
-        public ApplicationInsightsLoggerProvider(TelemetryClient telemetryClient, Func<string, LogLevel, bool> filter)
+        public ApplicationInsightsLoggerProvider(TelemetryClient telemetryClient, Func<string, LogLevel, bool> filter, IOptions<ApplicationInsightsLoggerOptions> options)
         {
             this.telemetryClient = telemetryClient;
             this.filter = filter;
+            this.options = options.Value;
         }
 
         /// <inheritdoc />
         public ILogger CreateLogger(string categoryName)
         {
-            return new ApplicationInsightsLogger(categoryName, this.telemetryClient, filter);
+            return new ApplicationInsightsLogger(categoryName, this.telemetryClient, filter, options);
         }
 
         /// <inheritdoc />