Merge pull request #3055 from microsoft/rajrang/aad

Entra Id - NLog update

Author: rajkumar-rangaraj

.publicApi/Microsoft.ApplicationInsights.NLogTarget.dll/Stable/PublicAPI.Unshipped.txt

@@ -1,8 +1,10 @@
 Microsoft.ApplicationInsights.NLogTarget.ApplicationInsightsTarget
 Microsoft.ApplicationInsights.NLogTarget.ApplicationInsightsTarget.ApplicationInsightsTarget() -> void
-Microsoft.ApplicationInsights.NLogTarget.ApplicationInsightsTarget.ContextProperties.get -> System.Collections.Generic.IList<Microsoft.ApplicationInsights.NLogTarget.TargetPropertyWithContext>
 Microsoft.ApplicationInsights.NLogTarget.ApplicationInsightsTarget.ConnectionString.get -> string
 Microsoft.ApplicationInsights.NLogTarget.ApplicationInsightsTarget.ConnectionString.set -> void
+Microsoft.ApplicationInsights.NLogTarget.ApplicationInsightsTarget.ContextProperties.get -> System.Collections.Generic.IList<Microsoft.ApplicationInsights.NLogTarget.TargetPropertyWithContext>
+Microsoft.ApplicationInsights.NLogTarget.ApplicationInsightsTarget.Credential.get -> Azure.Core.TokenCredential
+Microsoft.ApplicationInsights.NLogTarget.ApplicationInsightsTarget.Credential.set -> void
 Microsoft.ApplicationInsights.NLogTarget.TargetPropertyWithContext
 Microsoft.ApplicationInsights.NLogTarget.TargetPropertyWithContext.Layout.get -> NLog.Layouts.Layout
 Microsoft.ApplicationInsights.NLogTarget.TargetPropertyWithContext.Layout.set -> void

LOGGING/README.md

@@ -39,19 +39,26 @@ If your application does not have web.config then it can also be configured manu
 
 ### Azure Active Directory (AAD) Authentication
 
-To use AAD authentication with NLog, configure the TelemetryConfiguration before initializing NLog:
+To use AAD authentication with NLog, set the `Credential` property on the `ApplicationInsightsTarget`:
 
 ```csharp
-using Microsoft.ApplicationInsights.Extensibility;
+using Microsoft.ApplicationInsights.NLogTarget;
 using Azure.Identity;
 using NLog;
+using NLog.Config;
 
-// Configure Application Insights with AAD authentication BEFORE NLog initialization
-var telemetryConfig = TelemetryConfiguration.CreateDefault();
-telemetryConfig.ConnectionString = "InstrumentationKey=YOUR_IKEY;IngestionEndpoint=https://ingestion-endpoint.applicationinsights.azure.com/";
-telemetryConfig.SetAzureTokenCredential(new DefaultAzureCredential());
+// Configure NLog programmatically with AAD
+var config = new LoggingConfiguration();
+var aiTarget = new ApplicationInsightsTarget
+{
+    Name = "aiTarget",
+    ConnectionString = "InstrumentationKey=YOUR_IKEY;IngestionEndpoint=https://ingestion-endpoint.applicationinsights.azure.com/",
+    Credential = new DefaultAzureCredential()  // Set AAD credential
+};
+config.AddTarget(aiTarget);
+config.AddRule(LogLevel.Trace, LogLevel.Fatal, aiTarget);
+LogManager.Configuration = config;
 
-// Now initialize NLog - it will use the configured TelemetryConfiguration
 var logger = LogManager.GetCurrentClassLogger();
 logger.Info("Using AAD authentication");
 ```

LOGGING/src/NLogTarget/ApplicationInsightsTarget.cs

@@ -10,13 +10,16 @@ namespace Microsoft.ApplicationInsights.NLogTarget
     using System;
     using System.Collections.Generic;
     using System.Globalization;
+    using Azure.Core;
     using Microsoft.ApplicationInsights.Channel;
     using Microsoft.ApplicationInsights.DataContracts;
     using Microsoft.ApplicationInsights.Extensibility;
     using NLog;
     using NLog.Common;
     using NLog.Config;
     using NLog.Targets;
+    using OpenTelemetry;
+    using OpenTelemetry.Resources;
 
     /// <summary>
     /// NLog Target that routes all logging output to the Application Insights logging framework.
@@ -41,6 +44,13 @@ public ApplicationInsightsTarget()
             this.OptimizeBufferReuse = true;
         }
 
+        /// <summary>
+        /// Gets or sets the Azure Active Directory (AAD) TokenCredential for authentication.
+        /// When set, this credential will be used to authenticate with Azure Monitor.
+        /// </summary>
+        [CLSCompliant(false)]
+        public TokenCredential Credential { get; set; }
+
         /// <summary>
         /// Gets or sets the Application Insights connection string for your application. 
         /// </summary>
@@ -122,10 +132,23 @@ protected override void InitializeTarget()
 
             this.telemetryConfiguration = new TelemetryConfiguration();
             this.telemetryConfiguration.ConnectionString = connectionString;
+            
+            // Configure OpenTelemetry resource with distro name
+            this.telemetryConfiguration.ConfigureOpenTelemetryBuilder(builder =>
+            {
+                builder.ConfigureResource(r => r.AddAttributes(new[] 
+                { 
+                    new System.Collections.Generic.KeyValuePair<string, object>("telemetry.distro.name", "Microsoft.ApplicationInsights.NLogTarget"),
+                }));
+            });
+
+            // Set AAD credential if provided
+            if (this.Credential != null)
+            {
+                this.telemetryConfiguration.SetAzureTokenCredential(this.Credential);
+            }
+            
             this.telemetryClient = new TelemetryClient(this.telemetryConfiguration);
-
-            // TODO: Uncomment once SdkVersionUtils is available.
-            // this.telemetryClient.Context.GetInternalContext().SdkVersion = SdkVersionUtils.GetSdkVersion("nlog:");
         }
 
         /// <summary>

LOGGING/test/NLogTarget.Tests/NLogTargetTests.cs

@@ -94,6 +94,20 @@ public void ExceptionsDoNotEscapeNLog()
             logger.Trace("Hello World");
         }
 
+        [Trait("Category", "NLogTarget")]
+        [Fact]
+        public void CredentialPropertyCanBeSetAndRetrieved()
+        {
+            var mockCredential = new MockTokenCredential();
+            var target = new ApplicationInsightsTarget
+            {
+                ConnectionString = DefaultConnectionString,
+                Credential = mockCredential
+            };
+
+            Assert.Same(mockCredential, target.Credential);
+        }
+
         [Fact]
         [Trait("Category", "NLogTarget")]
         public async Task TracesAreCapturedByExporter()
@@ -580,4 +594,18 @@ private static string NormalizeConnectionString(string value)
             return (SeverityLevel)severity.Value;
         }
     }
+
+    // Mock TokenCredential for testing
+    internal class MockTokenCredential : Azure.Core.TokenCredential
+    {
+        public override Azure.Core.AccessToken GetToken(Azure.Core.TokenRequestContext requestContext, CancellationToken cancellationToken)
+        {
+            return new Azure.Core.AccessToken("mock_token", DateTimeOffset.UtcNow.AddHours(1));
+        }
+
+        public override ValueTask<Azure.Core.AccessToken> GetTokenAsync(Azure.Core.TokenRequestContext requestContext, CancellationToken cancellationToken)
+        {
+            return new ValueTask<Azure.Core.AccessToken>(GetToken(requestContext, cancellationToken));
+        }
+    }
 }

examples/NLogConsoleApp/Program.cs

@@ -1,21 +1,36 @@
 using NLog;
-// Uncomment these for Azure Active Directory (AAD) authentication
-// using Microsoft.ApplicationInsights.Extensibility;
-// using Azure.Identity;
 
 Console.WriteLine("NLog Console App - Application Insights Example");
 Console.WriteLine("================================================\n");
 
 NLog.Common.InternalLogger.LogToConsole = true;
 NLog.Common.InternalLogger.LogLevel = NLog.LogLevel.Warn;
 
+/*
 // Optional: Configure Azure Active Directory (AAD) authentication
-// This must be done BEFORE LogManager.GetCurrentClassLogger() is called
 // Requires: Install-Package Azure.Identity
-/*
-var telemetryConfig = TelemetryConfiguration.CreateDefault();
-telemetryConfig.ConnectionString = "InstrumentationKey=YOUR_IKEY;IngestionEndpoint=https://ingestion-endpoint.applicationinsights.azure.com/";
-telemetryConfig.SetAzureTokenCredential(new DefaultAzureCredential());
+
+var config = new LoggingConfiguration();
+
+// Add console target so you can see the output
+var consoleTarget = new NLog.Targets.ConsoleTarget("console")
+{
+    Layout = "${longdate}|${level:uppercase=true}|${logger}|${message} ${exception:format=tostring}"
+};
+config.AddTarget(consoleTarget);
+config.AddRule(LogLevel.Trace, LogLevel.Fatal, consoleTarget);
+
+// Add AI target with AAD
+var aiTarget = new ApplicationInsightsTarget
+{
+    Name = "aiTarget",
+    ConnectionString = "InstrumentationKey=YOUR_IKEY;IngestionEndpoint=https://ingestion-endpoint.applicationinsights.azure.com/",
+    Credential = new DefaultAzureCredential()
+};
+config.AddTarget("aiTarget", aiTarget);
+config.AddRule(LogLevel.Info, LogLevel.Fatal, aiTarget);
+
+LogManager.Configuration = config;
 */
 
 // Get NLog logger - the ApplicationInsightsTarget will handle telemetry