Added LogMessageGenerator overloads for exceptions

src/NLog/ILoggerExtensions.cs

@@ -0,0 +1,179 @@
+// 
+// Copyright (c) 2004-2016 Jaroslaw Kowalski <jaak@jkowalski.net>, Kim Christensen, Julian Verdurmen
+// 
+// All rights reserved.
+// 
+// Redistribution and use in source and binary forms, with or without 
+// modification, are permitted provided that the following conditions 
+// are met:
+// 
+// * Redistributions of source code must retain the above copyright notice, 
+//   this list of conditions and the following disclaimer. 
+// 
+// * Redistributions in binary form must reproduce the above copyright notice,
+//   this list of conditions and the following disclaimer in the documentation
+//   and/or other materials provided with the distribution. 
+// 
+// * Neither the name of Jaroslaw Kowalski nor the names of its 
+//   contributors may be used to endorse or promote products derived from this
+//   software without specific prior written permission. 
+// 
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
+// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
+// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
+// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
+// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
+// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
+// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
+// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 
+// THE POSSIBILITY OF SUCH DAMAGE.
+// 
+
+namespace NLog
+{
+    using System;
+
+    /// <summary>
+    /// Extensions for NLog <see cref="ILogger"/>.
+    /// </summary>
+    public static class ILoggerExtensions
+    {
+        /// <summary>
+        /// Writes the diagnostic message and exception at the specified level.
+        /// </summary>
+        /// <param name="logger">A logger implementation that will handle the message.</param>
+        /// <param name="level">The log level.</param>
+        /// <param name="exception">An exception to be logged.</param>
+        /// <param name="messageFunc">A function returning message to be written. Function is not evaluated if logging is not enabled.</param>
+        [CLSCompliant(false)]
+        public static void Log(this ILogger logger, LogLevel level, Exception exception, LogMessageGenerator messageFunc)
+        {
+            if (logger.IsEnabled(level))
+            {
+                logger.Log(level, exception, messageFunc(), null);
+            }
+        }
+
+        /// <summary>
+        /// Writes the diagnostic message and exception at the <c>Trace</c> level.
+        /// </summary>
+        /// <param name="logger">A logger implementation that will handle the message.</param>
+        /// <param name="exception">An exception to be logged.</param>
+        /// <param name="messageFunc">A function returning message to be written. Function is not evaluated if logging is not enabled.</param>
+        [CLSCompliant(false)]
+        public static void Trace(this ILogger logger, Exception exception, LogMessageGenerator messageFunc)
+        {
+            if (logger.IsTraceEnabled)
+            {
+                if (messageFunc == null)
+                {
+                    throw new ArgumentNullException("messageFunc");
+                }
+
+                logger.Trace(exception, messageFunc());
+            }
+        }
+
+        /// <summary>
+        /// Writes the diagnostic message and exception at the <c>Debug</c> level.
+        /// </summary>
+        /// <param name="logger">A logger implementation that will handle the message.</param>
+        /// <param name="exception">An exception to be logged.</param>
+        /// <param name="messageFunc">A function returning message to be written. Function is not evaluated if logging is not enabled.</param>
+        [CLSCompliant(false)]
+        public static void Debug(this ILogger logger, Exception exception, LogMessageGenerator messageFunc)
+        {
+            if (logger.IsDebugEnabled)
+            {
+                if (messageFunc == null)
+                {
+                    throw new ArgumentNullException("messageFunc");
+                }
+
+                logger.Debug(exception, messageFunc());
+            }
+        }
+
+        /// <summary>
+        /// Writes the diagnostic message and exception at the <c>Info</c> level.
+        /// </summary>
+        /// <param name="logger">A logger implementation that will handle the message.</param>
+        /// <param name="exception">An exception to be logged.</param>
+        /// <param name="messageFunc">A function returning message to be written. Function is not evaluated if logging is not enabled.</param>
+        [CLSCompliant(false)]
+        public static void Info(this ILogger logger, Exception exception, LogMessageGenerator messageFunc)
+        {
+            if (logger.IsInfoEnabled)
+            {
+                if (messageFunc == null)
+                {
+                    throw new ArgumentNullException("messageFunc");
+                }
+
+                logger.Info(exception, messageFunc());
+            }
+        }
+
+        /// <summary>
+        /// Writes the diagnostic message and exception at the <c>Warn</c> level.
+        /// </summary>
+        /// <param name="logger">A logger implementation that will handle the message.</param>
+        /// <param name="exception">An exception to be logged.</param>
+        /// <param name="messageFunc">A function returning message to be written. Function is not evaluated if logging is not enabled.</param>
+        [CLSCompliant(false)]
+        public static void Warn(this ILogger logger, Exception exception, LogMessageGenerator messageFunc)
+        {
+            if (logger.IsWarnEnabled)
+            {
+                if (messageFunc == null)
+                {
+                    throw new ArgumentNullException("messageFunc");
+                }
+
+                logger.Warn(exception, messageFunc());
+            }
+        }
+
+        /// <summary>
+        /// Writes the diagnostic message and exception at the <c>Error</c> level.
+        /// </summary>
+        /// <param name="logger">A logger implementation that will handle the message.</param>
+        /// <param name="exception">An exception to be logged.</param>
+        /// <param name="messageFunc">A function returning message to be written. Function is not evaluated if logging is not enabled.</param>
+        [CLSCompliant(false)]
+        public static void Error(this ILogger logger, Exception exception, LogMessageGenerator messageFunc)
+        {
+            if (logger.IsErrorEnabled)
+            {
+                if (messageFunc == null)
+                {
+                    throw new ArgumentNullException("messageFunc");
+                }
+
+                logger.Error(exception, messageFunc());
+            }
+        }
+
+        /// <summary>
+        /// Writes the diagnostic message and exception at the <c>Fatal</c> level.
+        /// </summary>
+        /// <param name="logger">A logger implementation that will handle the message.</param>
+        /// <param name="exception">An exception to be logged.</param>
+        /// <param name="messageFunc">A function returning message to be written. Function is not evaluated if logging is not enabled.</param>
+        [CLSCompliant(false)]
+        public static void Fatal(this ILogger logger, Exception exception, LogMessageGenerator messageFunc)
+        {
+            if (logger.IsFatalEnabled)
+            {
+                if (messageFunc == null)
+                {
+                    throw new ArgumentNullException("messageFunc");
+                }
+
+                logger.Fatal(exception, messageFunc());
+            }
+        }
+    }
+}

src/NLog/NLog.Xamarin.Android.csproj

@@ -125,6 +125,7 @@
     <Compile Include="ILogger.cs" />
     <Compile Include="ILoggerBase.cs" />
     <Compile Include="ILoggerBase-V1.cs" />
+    <Compile Include="ILoggerExtensions.cs" />
     <Compile Include="ILogger-V1.cs" />
     <Compile Include="Internal\AppendBuilderCreator.cs" />
     <Compile Include="Internal\ArrayHelper.cs" />

src/NLog/NLog.Xamarin.iOS.csproj

@@ -122,6 +122,7 @@
     <Compile Include="ILogger.cs" />
     <Compile Include="ILoggerBase.cs" />
     <Compile Include="ILoggerBase-V1.cs" />
+    <Compile Include="ILoggerExtensions.cs" />
     <Compile Include="ILogger-V1.cs" />
     <Compile Include="Internal\AppendBuilderCreator.cs" />
     <Compile Include="Internal\ArrayHelper.cs" />

src/NLog/NLog.doc.csproj

@@ -135,6 +135,7 @@
     <Compile Include="ILogger.cs" />
     <Compile Include="ILoggerBase.cs" />
     <Compile Include="ILoggerBase-V1.cs" />
+    <Compile Include="ILoggerExtensions.cs" />
     <Compile Include="ILogger-V1.cs" />
     <Compile Include="Internal\AppendBuilderCreator.cs" />
     <Compile Include="Internal\ArrayHelper.cs" />

src/NLog/NLog.mono.csproj

@@ -141,6 +141,7 @@
     <Compile Include="ILogger.cs" />
     <Compile Include="ILoggerBase.cs" />
     <Compile Include="ILoggerBase-V1.cs" />
+    <Compile Include="ILoggerExtensions.cs" />
     <Compile Include="ILogger-V1.cs" />
     <Compile Include="Internal\AppendBuilderCreator.cs" />
     <Compile Include="Internal\ArrayHelper.cs" />

src/NLog/NLog.netfx35.csproj

@@ -135,6 +135,7 @@
     <Compile Include="ILogger.cs" />
     <Compile Include="ILoggerBase.cs" />
     <Compile Include="ILoggerBase-V1.cs" />
+    <Compile Include="ILoggerExtensions.cs" />
     <Compile Include="ILogger-V1.cs" />
     <Compile Include="Internal\AppendBuilderCreator.cs" />
     <Compile Include="Internal\ArrayHelper.cs" />

src/NLog/NLog.netfx40.csproj

@@ -135,6 +135,7 @@
     <Compile Include="ILogger.cs" />
     <Compile Include="ILoggerBase.cs" />
     <Compile Include="ILoggerBase-V1.cs" />
+    <Compile Include="ILoggerExtensions.cs" />
     <Compile Include="ILogger-V1.cs" />
     <Compile Include="Internal\AppendBuilderCreator.cs" />
     <Compile Include="Internal\ArrayHelper.cs" />

src/NLog/NLog.netfx45.csproj

@@ -140,6 +140,7 @@
     <Compile Include="ILogger.cs" />
     <Compile Include="ILoggerBase.cs" />
     <Compile Include="ILoggerBase-V1.cs" />
+    <Compile Include="ILoggerExtensions.cs" />
     <Compile Include="ILogger-V1.cs" />
     <Compile Include="Internal\AppendBuilderCreator.cs" />
     <Compile Include="Internal\ArrayHelper.cs" />

src/NLog/NLog.sl4.csproj

@@ -142,6 +142,7 @@
     <Compile Include="ILogger.cs" />
     <Compile Include="ILoggerBase.cs" />
     <Compile Include="ILoggerBase-V1.cs" />
+    <Compile Include="ILoggerExtensions.cs" />
     <Compile Include="ILogger-V1.cs" />
     <Compile Include="Internal\AppendBuilderCreator.cs" />
     <Compile Include="Internal\ArrayHelper.cs" />

src/NLog/NLog.sl5.csproj

@@ -139,6 +139,7 @@
     <Compile Include="ILogger.cs" />
     <Compile Include="ILoggerBase.cs" />
     <Compile Include="ILoggerBase-V1.cs" />
+    <Compile Include="ILoggerExtensions.cs" />
     <Compile Include="ILogger-V1.cs" />
     <Compile Include="Internal\AppendBuilderCreator.cs" />
     <Compile Include="Internal\ArrayHelper.cs" />

src/NLog/NLog.wp7.csproj

@@ -138,6 +138,7 @@
     <Compile Include="ILogger.cs" />
     <Compile Include="ILoggerBase.cs" />
     <Compile Include="ILoggerBase-V1.cs" />
+    <Compile Include="ILoggerExtensions.cs" />
     <Compile Include="ILogger-V1.cs" />
     <Compile Include="Internal\AppendBuilderCreator.cs" />
     <Compile Include="Internal\ArrayHelper.cs" />

src/NLog/NLog.wp71.csproj

@@ -138,6 +138,7 @@
     <Compile Include="ILogger.cs" />
     <Compile Include="ILoggerBase.cs" />
     <Compile Include="ILoggerBase-V1.cs" />
+    <Compile Include="ILoggerExtensions.cs" />
     <Compile Include="ILogger-V1.cs" />
     <Compile Include="Internal\AppendBuilderCreator.cs" />
     <Compile Include="Internal\ArrayHelper.cs" />

src/NLog/NLog.wp8.csproj

@@ -163,6 +163,7 @@
     <Compile Include="ILogger.cs" />
     <Compile Include="ILoggerBase.cs" />
     <Compile Include="ILoggerBase-V1.cs" />
+    <Compile Include="ILoggerExtensions.cs" />
     <Compile Include="ILogger-V1.cs" />
     <Compile Include="Internal\AppendBuilderCreator.cs" />
     <Compile Include="Internal\ArrayHelper.cs" />

tests/NLog.UnitTests/LayoutRenderers/ExceptionTests.cs

@@ -295,7 +295,10 @@ public void ExceptionUsingLogMethodTest()
             string exceptionMessage = "Test exception";
             Exception ex = GetExceptionWithStackTrace(exceptionMessage);
             logger.Log(LogLevel.Error, ex, "msg");
-            AssertDebugLastMessage("debug1", "ERROR*Test exception*" + typeof(InvalidOperationException).Name);
+            AssertDebugLastMessage("debug1", "ERROR*msg*Test exception*" + typeof(InvalidOperationException).Name);
+
+            logger.Log(LogLevel.Error, ex, () => "msg func");
+            AssertDebugLastMessage("debug1", "ERROR*msg func*Test exception*" + typeof(InvalidOperationException).Name);
         }
 
         [Fact]
@@ -305,7 +308,10 @@ public void ExceptionUsingTraceMethodTest()
             string exceptionMessage = "Test exception";
             Exception ex = GetExceptionWithStackTrace(exceptionMessage);
             logger.Trace(ex, "msg");
-            AssertDebugLastMessage("debug1", "TRACE*Test exception*" + typeof(InvalidOperationException).Name);
+            AssertDebugLastMessage("debug1", "TRACE*msg*Test exception*" + typeof(InvalidOperationException).Name);
+
+            logger.Trace(ex, () => "msg func");
+            AssertDebugLastMessage("debug1", "TRACE*msg func*Test exception*" + typeof(InvalidOperationException).Name);
         }
 
         [Fact]
@@ -315,7 +321,10 @@ public void ExceptionUsingDebugMethodTest()
             string exceptionMessage = "Test exception";
             Exception ex = GetExceptionWithStackTrace(exceptionMessage);
             logger.Debug(ex, "msg");
-            AssertDebugLastMessage("debug1", "DEBUG*Test exception*" + typeof(InvalidOperationException).Name);
+            AssertDebugLastMessage("debug1", "DEBUG*msg*Test exception*" + typeof(InvalidOperationException).Name);
+
+            logger.Debug(ex, () => "msg func");
+            AssertDebugLastMessage("debug1", "DEBUG*msg func*Test exception*" + typeof(InvalidOperationException).Name);
         }
 
         [Fact]
@@ -325,7 +334,10 @@ public void ExceptionUsingInfoMethodTest()
             string exceptionMessage = "Test exception";
             Exception ex = GetExceptionWithStackTrace(exceptionMessage);
             logger.Info(ex, "msg");
-            AssertDebugLastMessage("debug1", "INFO*Test exception*" + typeof(InvalidOperationException).Name);
+            AssertDebugLastMessage("debug1", "INFO*msg*Test exception*" + typeof(InvalidOperationException).Name);
+
+            logger.Info(ex, () => "msg func");
+            AssertDebugLastMessage("debug1", "INFO*msg func*Test exception*" + typeof(InvalidOperationException).Name);
         }
 
         [Fact]
@@ -335,7 +347,10 @@ public void ExceptionUsingWarnMethodTest()
             string exceptionMessage = "Test exception";
             Exception ex = GetExceptionWithStackTrace(exceptionMessage);
             logger.Warn(ex, "msg");
-            AssertDebugLastMessage("debug1", "WARN*Test exception*" + typeof(InvalidOperationException).Name);
+            AssertDebugLastMessage("debug1", "WARN*msg*Test exception*" + typeof(InvalidOperationException).Name);
+
+            logger.Warn(ex, () => "msg func");
+            AssertDebugLastMessage("debug1", "WARN*msg func*Test exception*" + typeof(InvalidOperationException).Name);
         }
 
         [Fact]
@@ -345,7 +360,10 @@ public void ExceptionUsingErrorMethodTest()
             string exceptionMessage = "Test exception";
             Exception ex = GetExceptionWithStackTrace(exceptionMessage);
             logger.Error(ex, "msg");
-            AssertDebugLastMessage("debug1", "ERROR*Test exception*" + typeof(InvalidOperationException).Name);
+            AssertDebugLastMessage("debug1", "ERROR*msg*Test exception*" + typeof(InvalidOperationException).Name);
+
+            logger.Error(ex, () => "msg func");
+            AssertDebugLastMessage("debug1", "ERROR*msg func*Test exception*" + typeof(InvalidOperationException).Name);
         }
 
         [Fact]
@@ -355,7 +373,10 @@ public void ExceptionUsingFatalMethodTest()
             string exceptionMessage = "Test exception";
             Exception ex = GetExceptionWithStackTrace(exceptionMessage);
             logger.Fatal(ex, "msg");
-            AssertDebugLastMessage("debug1", "FATAL*Test exception*" + typeof(InvalidOperationException).Name);
+            AssertDebugLastMessage("debug1", "FATAL*msg*Test exception*" + typeof(InvalidOperationException).Name);
+
+            logger.Fatal(ex, () => "msg func");
+            AssertDebugLastMessage("debug1", "FATAL*msg func*Test exception*" + typeof(InvalidOperationException).Name);
         }
 
         [Fact]
@@ -527,7 +548,7 @@ private void SetConfigurationForExceptionUsingRootMethodTests()
             LogManager.Configuration = CreateConfigurationFromString(@"
             <nlog>
                 <targets>
-                    <target name='debug1' type='Debug' layout='${level:uppercase=true}*${exception:format=message,shorttype:separator=*}' />
+                    <target name='debug1' type='Debug' layout='${level:uppercase=true}*${message}*${exception:format=message,shorttype:separator=*}' />
                 </targets>
                 <rules>
                     <logger minlevel='Trace' writeTo='debug1' />