#2714

.publicApi/Microsoft.ApplicationInsights.NLogTarget.dll/net452/PublicAPI.Shipped.txt

@@ -3,6 +3,8 @@ Microsoft.ApplicationInsights.NLogTarget.ApplicationInsightsTarget.ApplicationIn
 Microsoft.ApplicationInsights.NLogTarget.ApplicationInsightsTarget.ContextProperties.get -> System.Collections.Generic.IList<Microsoft.ApplicationInsights.NLogTarget.TargetPropertyWithContext>
 Microsoft.ApplicationInsights.NLogTarget.ApplicationInsightsTarget.InstrumentationKey.get -> string
 Microsoft.ApplicationInsights.NLogTarget.ApplicationInsightsTarget.InstrumentationKey.set -> void
+Microsoft.ApplicationInsights.NLogTarget.ApplicationInsightsTarget.ConnectionString.get -> string
+Microsoft.ApplicationInsights.NLogTarget.ApplicationInsightsTarget.ConnectionString.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

@@ -37,7 +37,27 @@ Application Insights NLog Target nuget package adds ApplicationInsights target i
 
 If your application does not have web.config then it can also be configured manually.
 
- * **Configure ApplicationInsightsTarget using NLog.config** :
+ * **Configure ApplicationInsightsTarget with ConnectionString using NLog.config** :
+ConnectionString is the preferred approach to write logs into Application Insights. If the NLog Application Insights target has connectionString in the config file then TelemetryClient will use it, otherwise it will use the instrumentationKey.
+
+```xml
+<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+    <extensions>
+		<add assembly="Microsoft.ApplicationInsights.NLogTarget" />
+    </extensions>
+	<targets>
+		<target xsi:type="ApplicationInsightsTarget" name="aiTarget">
+			<connectionString>Your_ApplicationInsights_ConnectionString</connectionString>	<!-- Only required if not using ApplicationInsights.config -->
+			<contextproperty name="threadid" layout="${threadid}" />	<!-- Can be repeated with more context -->
+		</target>
+	</targets>
+	<rules>
+		<logger name="*" minlevel="Trace" writeTo="aiTarget" />
+	</rules>
+</nlog>
+```
+
+ * **Configure ApplicationInsightsTarget with InstrumentationKey using NLog.config** :
 
 ```xml
 <nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
@@ -70,6 +90,11 @@ For more information see:
 
 
 ```csharp
+// You need this only if you did not define ConnectionString or InstrumentationKey in ApplicationInsights.config (Or in the NLog.config)
+TelemetryConfiguration.Active.ConnectionString = "Your_ApplicationInsights_ConnectionString";
+
+or 
+
 // You need this only if you did not define InstrumentationKey in ApplicationInsights.config (Or in the NLog.config)
 TelemetryConfiguration.Active.InstrumentationKey = "Your_Resource_Key";
 
@@ -85,6 +110,9 @@ If you configure NLog programmatically with the [NLog Config API](https://github
 var config = new LoggingConfiguration();
 
 ApplicationInsightsTarget target = new ApplicationInsightsTarget();
+// You need this only if you did not define Application Insights ConnectionString in ApplicationInsights.config or want to use different connectionstring
+target.ConnectionString = "Your_ApplicationInsights_ConnectionString";
+or
 // You need this only if you did not define InstrumentationKey in ApplicationInsights.config or want to use different instrumentation key
 target.InstrumentationKey = "Your_Resource_Key";
 

LOGGING/src/NLogTarget/ApplicationInsightsTarget.cs

@@ -13,6 +13,7 @@
 
     using Microsoft.ApplicationInsights.Channel;
     using Microsoft.ApplicationInsights.DataContracts;
+    using Microsoft.ApplicationInsights.Extensibility;
     using Microsoft.ApplicationInsights.Extensibility.Implementation;
     using Microsoft.ApplicationInsights.Implementation;
 
@@ -31,6 +32,7 @@
         private TelemetryClient telemetryClient;
         private DateTime lastLogEventTime;
         private NLog.Layouts.Layout instrumentationKeyLayout = string.Empty;
+        private NLog.Layouts.Layout connectionStringLayout = string.Empty;
 
         /// <summary>
         /// Initializers a new instance of ApplicationInsightsTarget type.
@@ -50,6 +52,15 @@
             set => this.instrumentationKeyLayout = value ?? string.Empty;
         }
 
+        /// <summary>
+        /// Gets or sets the Application Insights connectionstring for your application.
+        /// </summary>
+        public string ConnectionString
+        {
+            get => (this.connectionStringLayout as NLog.Layouts.SimpleLayout)?.Text ?? null;
+            set => this.connectionStringLayout = value ?? string.Empty;
+        }
+
         /// <summary>
         /// Gets the array of custom attributes to be passed into the logevent context.
         /// </summary>
@@ -118,10 +129,24 @@
             this.telemetryClient = new TelemetryClient();
 #pragma warning restore CS0618 // Type or member is obsolete
 
-            string instrumentationKey = this.instrumentationKeyLayout.Render(LogEventInfo.CreateNullEvent());
-            if (!string.IsNullOrWhiteSpace(instrumentationKey))
+            string connectionString = this.connectionStringLayout.Render(LogEventInfo.CreateNullEvent());
+
+            // Check if nlog application insights target has connectionstring in config file then
+            // configure telemetryclient with the connectionstring otherwise using instrumentationkey.
+            if (!string.IsNullOrWhiteSpace(connectionString))
             {
-                this.telemetryClient.Context.InstrumentationKey = instrumentationKey;
+                var configuration = TelemetryConfiguration.CreateDefault();
+                configuration.ConnectionString = connectionString;
+
+                this.telemetryClient.TelemetryConfiguration.ConnectionString = connectionString;
+            }
+            else
+            {
+                string instrumentationKey = this.instrumentationKeyLayout.Render(LogEventInfo.CreateNullEvent());
+                if (!string.IsNullOrWhiteSpace(instrumentationKey))
+                {
+                    this.telemetryClient.Context.InstrumentationKey = instrumentationKey;
+                }
             }
 
             this.telemetryClient.Context.GetInternalContext().SdkVersion = SdkVersionUtils.GetSdkVersion("nlog:");

LOGGING/test/NLogTarget.Tests/NLogTargetTests.cs

@@ -226,11 +226,11 @@ public void TraceHasCustomProperties()
 
             var telemetry = (TraceTelemetry)this.adapterHelper.Channel.SentItems.FirstOrDefault();
             Assert.IsNotNull(telemetry, "Didn't get the log event from the channel");
-            Assert.AreEqual("Value", telemetry.Properties["Name"]); 
+            Assert.AreEqual("Value", telemetry.Properties["Name"]);
         }
 
 
-    [TestMethod]
+        [TestMethod]
         [TestCategory("NLogTarget")]
         public void GlobalDiagnosticContextPropertiesAreAddedToProperties()
         {
@@ -260,8 +260,8 @@ public void GlobalDiagnosticContextPropertiesSupplementEventProperties()
             aiLogger.Log(eventInfo);
 
             var telemetry = (TraceTelemetry)this.adapterHelper.Channel.SentItems.FirstOrDefault();
-            Assert.AreEqual("global_value", telemetry.Properties["global_prop"]); 
-            Assert.AreEqual("Value", telemetry.Properties["Name"]); 
+            Assert.AreEqual("global_value", telemetry.Properties["global_prop"]);
+            Assert.AreEqual("Value", telemetry.Properties["Name"]);
         }
 
         [TestMethod]
@@ -280,10 +280,10 @@ public void EventPropertyKeyNameIsAppendedWith_1_IfSameAsGlobalDiagnosticContext
             aiLogger.Log(eventInfo);
 
             var telemetry = (TraceTelemetry)this.adapterHelper.Channel.SentItems.FirstOrDefault();
-            Assert.IsTrue(telemetry.Properties.ContainsKey("Name")); 
-            Assert.AreEqual("Global Value", telemetry.Properties["Name"]); 
-            Assert.IsTrue(telemetry.Properties.ContainsKey("Name_1"), "Key name altered"); 
-            Assert.AreEqual("Value", telemetry.Properties["Name_1"]); 
+            Assert.IsTrue(telemetry.Properties.ContainsKey("Name"));
+            Assert.AreEqual("Global Value", telemetry.Properties["Name"]);
+            Assert.IsTrue(telemetry.Properties.ContainsKey("Name_1"), "Key name altered");
+            Assert.AreEqual("Value", telemetry.Properties["Name_1"]);
         }
 
         [TestMethod]
@@ -459,6 +459,62 @@ public void NLogTargetFlushesTelemetryClient()
             Assert.AreEqual("Flush called", flushException.Message);
         }
 
+        [TestMethod]
+        [TestCategory("NLogTarget")]
+        public void NLogInfoIsSentAsInformationTraceItemWithAIConnectionString()
+        {
+            var aiLogger = this.CreateTargetWithGivenConnectionString("Your_ApplicationInsights_ConnectionString");
+            aiLogger.Info("Info message");
+
+            var telemetry = (TraceTelemetry)this.adapterHelper.Channel.SentItems.First();
+            Assert.AreEqual($"Info message", telemetry.Message);
+        }
+
+        [TestMethod]
+        [TestCategory("NLogTarget")]
+        public void NLogTraceIsSentAsVerboseTraceItemWithAIConnectionString()
+        {
+            var aiLogger = this.CreateTargetWithGivenConnectionString("Your_ApplicationInsights_ConnectionString");
+            aiLogger.Trace("Trace message");
+
+            var telemetry = (TraceTelemetry)this.adapterHelper.Channel.SentItems.FirstOrDefault();
+            Assert.AreEqual("Trace message", telemetry.Message);
+        }
+
+        [TestMethod]
+        [TestCategory("NLogTarget")]
+        public void NLogDebugIsSentAsVerboseTraceItemWithAIConnectionString()
+        {
+            var aiLogger = this.CreateTargetWithGivenConnectionString("Your_ApplicationInsights_ConnectionString");
+            aiLogger.Debug("Debug Message");
+
+            var telemetry = (TraceTelemetry)this.adapterHelper.Channel.SentItems.FirstOrDefault();
+            Assert.AreEqual("Debug Message", telemetry.Message);
+        }
+
+        [TestMethod]
+        [TestCategory("NLogTarget")]
+        public void NLogWarnIsSentAsWarningTraceItemWithAIConnectionString()
+        {
+            var aiLogger = this.CreateTargetWithGivenConnectionString("Your_ApplicationInsights_ConnectionString");
+
+            aiLogger.Warn("Warn message");
+
+            var telemetry = (TraceTelemetry)this.adapterHelper.Channel.SentItems.FirstOrDefault();
+            Assert.AreEqual("Warn message", telemetry.Message);
+        }
+
+        [TestMethod]
+        [TestCategory("NLogTarget")]
+        public void NLogErrorIsSentAsVerboseTraceItemWithAIConnectionString()
+        {
+            var aiLogger = this.CreateTargetWithGivenConnectionString("Your_ApplicationInsights_ConnectionString");
+            aiLogger.Error("Error Message");
+
+            var telemetry = (TraceTelemetry)this.adapterHelper.Channel.SentItems.FirstOrDefault();
+            Assert.AreEqual("Error Message", telemetry.Message);
+        }
+
         private void VerifyMessagesInMockChannel(Logger aiLogger, string instrumentationKey)
         {
             aiLogger.Trace("Sample trace message");
@@ -504,5 +560,38 @@ private Logger CreateTargetWithGivenInstrumentationKey(
 
             return aiLogger;
         }
+
+        private Logger CreateTargetWithGivenConnectionString(
+            string connectionString = "Your_ApplicationInsights_ConnectionString",
+            Action<Logger> loggerAction = null)
+        {
+            // Mock channel to validate that our appender is trying to send logs
+#pragma warning disable CS0618 // Type or member is obsolete
+            TelemetryConfiguration.Active.TelemetryChannel = this.adapterHelper.Channel;
+#pragma warning restore CS0618 // Type or member is obsolete
+
+            ApplicationInsightsTarget target = new ApplicationInsightsTarget
+            {
+                ConnectionString = connectionString
+            };
+
+            LoggingRule rule = new LoggingRule("*", LogLevel.Trace, target);
+            LoggingConfiguration config = new LoggingConfiguration();
+            config.AddTarget("AITarget", target);
+            config.LoggingRules.Add(rule);
+
+            LogManager.Configuration = config;
+            Logger aiLogger = LogManager.GetLogger("AITarget");
+
+            if (loggerAction != null)
+            {
+                loggerAction(aiLogger);
+                target.Dispose();
+                return null;
+            }
+
+            return aiLogger;
+        }
+
     }
 }

LOGGING/test/Shared/AdapterHelper.cs

@@ -19,6 +19,8 @@ public class AdapterHelper : IDisposable
     {
         public string InstrumentationKey { get; }
 
+        public string ConnectionString { get; }
+
 #if NET452 || NET46
         private static readonly string ApplicationInsightsConfigFilePath =
             Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "ApplicationInsights.config");
@@ -27,16 +29,19 @@ public class AdapterHelper : IDisposable
             Path.Combine(Path.GetDirectoryName(typeof(AdapterHelper).GetTypeInfo().Assembly.Location), "ApplicationInsights.config");
 #endif
 
-        public AdapterHelper(string instrumentationKey = "F8474271-D231-45B6-8DD4-D344C309AE69")
+        public AdapterHelper(string instrumentationKey = "F8474271-D231-45B6-8DD4-D344C309AE69", 
+            string connectionString= "Your_ApplicationInsights_ConnectionString")
         {
             this.InstrumentationKey = instrumentationKey;
+            this.ConnectionString = connectionString;
 
             string configuration = string.Format(InvariantCulture,
                                     @"<?xml version=""1.0"" encoding=""utf-8"" ?>
                                      <ApplicationInsights xmlns=""http://schemas.microsoft.com/ApplicationInsights/2013/Settings"">
                                         <InstrumentationKey>{0}</InstrumentationKey>
+                                        <ConnectionString>{1}</ConnectionString>
                                      </ApplicationInsights>",
-                                     instrumentationKey);
+                                     instrumentationKey, connectionString);
 
             File.WriteAllText(ApplicationInsightsConfigFilePath, configuration);
             this.Channel = new CustomTelemetryChannel();