Add NLog package and example configuration

Author: govert

Logging/Log4NetTraceListener.cs

@@ -3,6 +3,8 @@
 // https://code.google.com/p/cavity/source/browse/trunk/src/Cavity%20Diagnostics%20log4net/Class%20Libraries/Diagnostics.Log4Net/Diagnostics/Log4NetTraceListener.cs
 // Code License: MIT License (http://www.opensource.org/licenses/mit-license.php)
 
+// Source for similar implementation targeting NLog (included in the NLog assembly) is here: https://github.com/jkowalski/NLog/blob/master/src/NLog/NLogTraceListener.cs
+
 namespace Cavity.Diagnostics
 {
     using System;

Logging/Logging-AddIn.xll.config

@@ -4,29 +4,22 @@
   <!-- This .config file contains the various configuration examples.
   
        log4net
-  
+       NLog
   
   -->
 
   <!--  ============= Begin log4net ================  -->
 
+  <!--
   <configSections>
     <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net" />
   </configSections>
   <system.diagnostics>
     <sources>
-      <!-- By default the TraceSource is configured to source only Warning, Error and Fatal.
-              the configuration can override this by setting switchValue, or create a SourceSwitch. 
-              switchValue is a SourceLevel: Off, Critical, Error, Warning (default), Information, Verbose, All 
-           By default, LogDisplay is only shown if Errors are present.
-      -->
       <source name="ExcelDna.Integration" switchValue="Verbose">
         <listeners>
           <remove name="Default" />
-          <!--<clear/>-->
           <add name="LogDisplay" type="ExcelDna.Logging.LogDisplayTraceListener,ExcelDna.Integration">
-            <!-- EventTypeFilter takes a SourceLevel: Off, Critical, Error, Warning (default), Information, Verbose, All -->
-            <!-- We use the filter here to disable the LogDisplay -->
             <filter type="System.Diagnostics.EventTypeFilter" initializeData="Off"/>
           </add>
           <add name="Log4NetListener" type="Cavity.Diagnostics.Log4NetTraceListener,Logging" >
@@ -36,10 +29,6 @@
       </source>
     </sources>
   </system.diagnostics>
-  <appSettings>
-    <!-- Change this setting to "true" if you want to debug the log4net configuration -->
-    <add key="log4net.Internal.Debug" value="false"/>
-  </appSettings>
   <log4net>
     <appender name="DebugAppender" type="log4net.Appender.DebugAppender" >
       <layout type="log4net.Layout.PatternLayout">
@@ -51,7 +40,38 @@
       <appender-ref ref="DebugAppender" />
     </root>
   </log4net>
-
-  <!--  ============= End log4net ================  -->
+  -->
 
+  <!--  ============= End log4net ================  -->
+
+  <!--  ============= Begin NLog ================  -->
+
+  <configSections>
+    <section name="nlog" type="NLog.Config.ConfigSectionHandler, NLog"/>
+  </configSections>
+  <system.diagnostics>
+    <sources>
+      <source name="ExcelDna.Integration" switchValue="Verbose">
+        <listeners>
+          <remove name="Default" />
+          <add name="LogDisplay" type="ExcelDna.Logging.LogDisplayTraceListener,ExcelDna.Integration">
+            <filter type="System.Diagnostics.EventTypeFilter" initializeData="Off"/>
+          </add>
+          <add name="NLogListener" type="NLog.NLogTraceListener,NLog" >
+            <filter type="System.Diagnostics.EventTypeFilter" initializeData="All"/>
+          </add>
+        </listeners>
+      </source>
+    </sources>
+  </system.diagnostics>
+  <nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+    <targets>
+      <target name="debugger" xsi:type="Debugger" layout="NLOG: ${longdate}|${level:uppercase=true}|${logger}[${event-properties:EventID}]|${message}"/>
+    </targets>
+    <rules>
+      <logger name="*" minlevel="Warn" writeTo="debugger" />
+    </rules>
+  </nlog>
+
+  <!--  ============= End NLog ================  -->
 </configuration>

Logging/Logging.csproj

@@ -37,6 +37,9 @@
     <Reference Include="log4net">
       <HintPath>packages\log4net.2.0.3\lib\net40-full\log4net.dll</HintPath>
     </Reference>
+    <Reference Include="NLog">
+      <HintPath>packages\NLog.4.0.1\lib\net40\NLog.dll</HintPath>
+    </Reference>
     <Reference Include="System" />
     <Reference Include="System.Core" />
     <Reference Include="System.Xml.Linq" />

Logging/README.md

@@ -2,6 +2,10 @@ Excel-DNA Logging Samples
 =========================
 
 The Logging samples show different ways of configuring the Excel-DNA diagnostic logging.
+To examine each option, uncomment the corresponding part in the Logging-AddIn.xll.config file.
 
 ### log4net
-A Log4Net TraceListener is defined, which forwards trace events to Log4Net. 
+A Log4Net TraceListener is defined (in this example project), that forwards trace events to Log4Net.
+
+### NLog
+The NLog library includes an NLogTraceListener that can be configured to forward trace events to NLog.

Logging/TestLoggers.cs

@@ -3,9 +3,12 @@
 using System.Linq;
 using System.Text;
 using ExcelDna.Integration;
+
 using log4net;
 using log4net.Config;
 
+using NLog;
+
 [assembly: log4net.Config.XmlConfigurator()]
 namespace Logging
 {
@@ -20,12 +23,13 @@ public void AutoOpen()
             // Alternative is to call 
             // XmlConfigurator.Configure();
             // but for our example it would be too late.
-            ILog log = LogManager.GetLogger(typeof(TestLoggers));   // Typically 
+            ILog log = log4net.LogManager.GetLogger(typeof(TestLoggers));   // Typically 
             log.Info("Testing log4net Info message");
 
 
             // NLog
-
+            Logger logger = NLog.LogManager.GetLogger("TestLogger");
+            logger.Info("Testing NLog Info message");
         }
 
         public void AutoClose() { }

Logging/packages.config

@@ -3,4 +3,5 @@
   <package id="Excel-DNA" version="0.32.0" targetFramework="net40" />
   <package id="Excel-DNA.Lib" version="0.32.0" targetFramework="net40" />
   <package id="log4net" version="2.0.3" targetFramework="net40" />
+  <package id="NLog" version="4.0.1" targetFramework="net40" />
 </packages>