Target reports when disabled because failed to initialize

snakefoot · snakefoot · commit f674080e1f0d · 2025-02-01T14:35:37.000+01:00
diff --git a/src/NLog/Targets/Target.cs b/src/NLog/Targets/Target.cs
@@ -403,6 +403,15 @@ public void WriteAsyncLogEvents(IList<AsyncLogEventInfo> logEvents)
         /// </summary>
         protected virtual void WriteFailedNotInitialized(AsyncLogEventInfo logEvent, Exception initializeException)
         {
+            if (!_scannedForLayouts)
+            {
+                _scannedForLayouts = true;
+                InternalLogger.Error(_initializeException, "{0}: Disabled because NLog Target failed to initialize.", this);
+            }
+            else
+            {
+                InternalLogger.Debug("{0}: Disabled because NLog Target failed to initialize. {1} {2}", this, _initializeException?.GetType(), _initializeException?.Message);
+            }
             var initializeFailedException = new NLogRuntimeException($"Target {this} failed to initialize.", initializeException);
             logEvent.Continuation(initializeFailedException);
         }
@@ -421,6 +430,8 @@ internal void Initialize(LoggingConfiguration configuration)
                 {
                     try
                     {
+                        _scannedForLayouts = false;
+
                         PropertyHelper.CheckRequiredParameters(ConfigurationItemFactory.Default, this);
 
                         InitializeTarget();
@@ -436,13 +447,15 @@ internal void Initialize(LoggingConfiguration configuration)
                     {
                         // Target is now in disabled state, and cannot be used for writing LogEvents
                         _initializeException = exception;
+                        _scannedForLayouts = false;
                         if (ExceptionMustBeRethrown(exception))
                             throw;
                     }
                     catch (Exception exception)
                     {
                         // Target is now in disabled state, and cannot be used for writing LogEvents
                         _initializeException = exception;
+                        _scannedForLayouts = false;
                         if (ExceptionMustBeRethrown(exception))
                             throw;
 
diff --git a/tests/NLog.UnitTests/Targets/TargetWithContextTest.cs b/tests/NLog.UnitTests/Targets/TargetWithContextTest.cs
@@ -127,7 +127,7 @@ public void TargetWithContextAsyncTest()
         private static bool WaitForLastMessage(CustomTargetWithContext target)
         {
             System.Threading.Thread.Sleep(1);
-            for (int i = 0; i < 1000; ++i)
+            for (int i = 0; i < 5000; ++i)
             {
                 if (target.LastMessage != null)
                     return true;
@@ -328,7 +328,7 @@ public void TargetWithContextJsonTest()
             logger.Error("log message");
             var target = logFactory.Configuration.AllTargets.OfType<CustomTargetWithContext>().FirstOrDefault();
             System.Threading.Thread.Sleep(1);
-            for (int i = 0; i < 1000; ++i)
+            for (int i = 0; i < 5000; ++i)
             {
                 if (target.LastMessage != null)
                     break;

Original file line number	Diff line number	Diff line change
`@@ -403,6 +403,15 @@ public void WriteAsyncLogEvents(IList<AsyncLogEventInfo> logEvents)`
`403`	`403`	`/// </summary>`
`404`	`404`	`protected virtual void WriteFailedNotInitialized(AsyncLogEventInfo logEvent, Exception initializeException)`
`405`	`405`	`{`
	`406`	`+ if (!_scannedForLayouts)`
	`407`	`+ {`
	`408`	`+ _scannedForLayouts = true;`
	`409`	`+ InternalLogger.Error(_initializeException, "{0}: Disabled because NLog Target failed to initialize.", this);`
	`410`	`+ }`
	`411`	`+ else`
	`412`	`+ {`
	`413`	`+ InternalLogger.Debug("{0}: Disabled because NLog Target failed to initialize. {1} {2}", this, _initializeException?.GetType(), _initializeException?.Message);`
	`414`	`+ }`
`406`	`415`	`var initializeFailedException = new NLogRuntimeException($"Target {this} failed to initialize.", initializeException);`
`407`	`416`	`logEvent.Continuation(initializeFailedException);`
`408`	`417`	`}`
`@@ -421,6 +430,8 @@ internal void Initialize(LoggingConfiguration configuration)`
`421`	`430`	`{`
`422`	`431`	`try`
`423`	`432`	`{`
	`433`	`+ _scannedForLayouts = false;`
	`434`	`+`
`424`	`435`	`PropertyHelper.CheckRequiredParameters(ConfigurationItemFactory.Default, this);`
`425`	`436`
`426`	`437`	`InitializeTarget();`
`@@ -436,13 +447,15 @@ internal void Initialize(LoggingConfiguration configuration)`
`436`	`447`	`{`
`437`	`448`	`// Target is now in disabled state, and cannot be used for writing LogEvents`
`438`	`449`	`_initializeException = exception;`
	`450`	`+ _scannedForLayouts = false;`
`439`	`451`	`if (ExceptionMustBeRethrown(exception))`
`440`	`452`	`throw;`
`441`	`453`	`}`
`442`	`454`	`catch (Exception exception)`
`443`	`455`	`{`
`444`	`456`	`// Target is now in disabled state, and cannot be used for writing LogEvents`
`445`	`457`	`_initializeException = exception;`
	`458`	`+ _scannedForLayouts = false;`
`446`	`459`	`if (ExceptionMustBeRethrown(exception))`
`447`	`460`	`throw;`
`448`	`461`
Original file line number	Diff line number	Diff line change
`@@ -127,7 +127,7 @@ public void TargetWithContextAsyncTest()`
`127`	`127`	`private static bool WaitForLastMessage(CustomTargetWithContext target)`
`128`	`128`	`{`
`129`	`129`	`System.Threading.Thread.Sleep(1);`
`130`		`- for (int i = 0; i < 1000; ++i)`
	`130`	`+ for (int i = 0; i < 5000; ++i)`
`131`	`131`	`{`
`132`	`132`	`if (target.LastMessage != null)`
`133`	`133`	`return true;`
`@@ -328,7 +328,7 @@ public void TargetWithContextJsonTest()`
`328`	`328`	`logger.Error("log message");`
`329`	`329`	`var target = logFactory.Configuration.AllTargets.OfType<CustomTargetWithContext>().FirstOrDefault();`
`330`	`330`	`System.Threading.Thread.Sleep(1);`
`331`		`- for (int i = 0; i < 1000; ++i)`
	`331`	`+ for (int i = 0; i < 5000; ++i)`
`332`	`332`	`{`
`333`	`333`	`if (target.LastMessage != null)`
`334`	`334`	`break;`