Merge pull request #1548 from NLog/EventLog-1542

Bugfix: Can't update EventLog's Source property
NLog · Jul 23, 2016 · ba06724 · ba06724
2 parents ee98bf2 + 8b5590d
commit ba06724
Show file tree

Hide file tree

Showing 2 changed files with 57 additions and 1 deletion.
diff --git a/src/NLog/Targets/EventLogTarget.cs b/src/NLog/Targets/EventLogTarget.cs
@@ -349,7 +349,15 @@ internal string GetFixedSource()
         /// <returns></returns>
         private EventLog GetEventLog(LogEventInfo logEvent)
         {
-            return eventLogInstance ?? (eventLogInstance = new EventLog(this.Log, this.MachineName, this.Source.Render(logEvent)));
+            var renderedSource = this.Source?.Render(logEvent);
+            var isCacheUpToDate = eventLogInstance != null && renderedSource == eventLogInstance.Source &&
+                                   eventLogInstance.Log == this.Log && eventLogInstance.MachineName == this.MachineName;
+
+            if (!isCacheUpToDate)
+            {
+                eventLogInstance = new EventLog(this.Log, this.MachineName, renderedSource);
+            }
+            return eventLogInstance;
         }
 
         /// <summary>

diff --git a/tests/NLog.UnitTests/Targets/EventLogTargetTests.cs b/tests/NLog.UnitTests/Targets/EventLogTargetTests.cs
@@ -376,6 +376,44 @@ public void WriteEventLogEntryLargerThanMaxMessageLengthWithOverflowDiscard_TheM
             Assert.False(wasWritten);
         }
 
+
+        [Fact]
+        public void WriteEventLogEntryWithDynamicSource()
+        {
+            const int maxMessageLength = 10;
+            string expectedMessage = string.Join("", Enumerable.Repeat("a", maxMessageLength));
+
+            var target = CreateEventLogTarget(null, "NLog.UnitTests" + Guid.NewGuid().ToString("N"), EventLogTargetOverflowAction.Split, maxMessageLength);
+            target.Layout = new SimpleLayout("${message}");
+            target.Source = new SimpleLayout("${event-properties:item=DynamicSource}");
+            SimpleConfigurator.ConfigureForTargetLogging(target, LogLevel.Trace);
+
+            var logger = LogManager.GetLogger("WriteEventLogEntry");
+
+            var sourceName = "NLog.UnitTests" + Guid.NewGuid().ToString("N");
+            var logEvent = CreateLogEventWithDynamicSource(expectedMessage, LogLevel.Trace, "DynamicSource", sourceName);           
+
+            logger.Log(logEvent);
+
+            var eventLog = new EventLog(target.Log);
+            var entries = GetEventRecords(eventLog.Log).ToList();
+
+            entries = entries.Where(a => a.ProviderName == sourceName).ToList();
+            Assert.Equal(1, entries.Count);
+            AssertWrittenMessage(entries, expectedMessage);
+
+            sourceName = "NLog.UnitTests" + Guid.NewGuid().ToString("N");
+            expectedMessage = string.Join("", Enumerable.Repeat("b", maxMessageLength));
+
+            logEvent = CreateLogEventWithDynamicSource(expectedMessage, LogLevel.Trace, "DynamicSource", sourceName);
+            logger.Log(logEvent);
+
+            entries = GetEventRecords(eventLog.Log).ToList();
+            entries = entries.Where(a => a.ProviderName == sourceName).ToList();
+            Assert.Equal(1, entries.Count);
+            AssertWrittenMessage(entries, expectedMessage);
+        }
+
         private static IEnumerable<EventRecord> Write(LogLevel logLevel, EventLogEntryType expectedEventLogEntryType, string logMessage, Layout entryType = null, EventLogTargetOverflowAction overflowAction = EventLogTargetOverflowAction.Truncate, int maxMessageLength = 16384)
         {
             var target = CreateEventLogTarget(entryType, "NLog.UnitTests" + Guid.NewGuid().ToString("N"), overflowAction, maxMessageLength);
@@ -433,6 +471,16 @@ private static EventLogTarget CreateEventLogTarget(Layout entryType, string sour
             return target;
         }
 
+        private LogEventInfo CreateLogEventWithDynamicSource(string message, LogLevel level, string propertyKey, string proertyValue)
+        {
+            var logEvent = new LogEventInfo();
+            logEvent.Message = message;
+            logEvent.Level = level;
+            logEvent.Properties[propertyKey] = proertyValue;
+
+            return logEvent;
+        }
+
         private static IEnumerable<EventRecord> GetEventRecords(string logName)
         {
             var query = new EventLogQuery(logName, PathType.LogName) { ReverseDirection = true };