nlog 1.0.0.505-mswin32

data/docs/examples/web/GetLogger.cs

@@ -0,0 +1,11 @@
+using System;
+using System.Globalization;
+
+using NLog;
+
+class MyClass {
+    static Logger logger = LogManager.GetLogger("MyClass");
+
+    // other class members go here
+
+}

data/docs/examples/web/MyFirstFilter.cs

@@ -0,0 +1,35 @@
+using System;
+using System.Text;
+
+using NLog;
+
+namespace MyNamespace
+{
+    [Filter("hourRange")]
+    public sealed class HourRangeFilter: Filter
+    {
+        private int _fromHour = 0;
+        private int _toHour = -1;
+        
+        public int FromHour
+        {
+            get { return _fromHour; }
+            set { _fromHour = value; }
+            
+        }
+        public int ToHour
+        {
+            get { return _toHour; }
+            set { _toHour = value; }
+            
+        }
+
+        protected override FilterResult Check(LogEventInfo ev)
+        {
+            if (ev.TimeStamp.Hour >= FromHour && ev.TimeStamp.Hour <= ToHour)
+                return Result;
+            else
+                return FilterResult.Neutral;
+        }
+    }
+}

data/docs/examples/web/MyFirstLayoutRenderer.cs

@@ -0,0 +1,41 @@
+using System;
+using System.Text;
+
+using NLog;
+
+namespace MyNamespace
+{
+    [LayoutRenderer("hour")]
+    public sealed class HourLayoutRenderer: LayoutRenderer
+    {
+        private bool _showMinutes = false;
+        
+        // this is an example of a configurable parameter
+        public bool ShowMinutes
+        {
+            get { return _showMinutes; }
+            set { _showMinutes = value; }
+            
+        }
+        protected override int GetEstimatedBufferSize(LogEventInfo ev)
+        {
+            // since hour is expressed by 2 digits we need at most 2-character
+            // buffer for it
+            return 2;
+        }
+
+        protected override void Append(StringBuilder builder, LogEventInfo ev)
+        {
+            // get current hour or minute, convert it to string, apply padding
+            // and append to the specified StringBuilder
+            if (ShowMinutes)
+            {
+                builder.Append(ApplyPadding(DateTime.Now.Minute.ToString()));
+            }
+            else
+            {
+                builder.Append(ApplyPadding(DateTime.Now.Hour.ToString()));
+            }
+        }
+    }
+}

data/docs/examples/web/MyFirstTarget.cs

@@ -0,0 +1,28 @@
+using NLog;
+
+namespace MyNamespace
+{
+    [Target("MyFirst")]
+    public sealed class MyFirstTarget: TargetWithLayout
+    {
+        private string _host = "localhost";
+
+        public string Host
+        {
+            get { return _host; }
+            set { _host = value; }
+        }
+
+        protected override void Write(LogEventInfo logEvent)
+        {
+            string logMessage = CompiledLayout.GetFormattedMessage(logEvent);
+
+            SendTheMessageToRemoteHost(this.Host, logMessage);
+        }
+
+        private void SendTheMessageToRemoteHost(string host, string message)
+        {
+            // TODO - write me
+        }
+    }
+}

data/docs/examples/web/NLogC.cpp

@@ -0,0 +1,26 @@
+
+// 
+// ANSI functions
+// 
+int NLog_ConfigureFromFileA(const char *fileName);
+void NLog_LogA(NLogLevel level, const char *loggerName, const char *logMessage, ...); 
+void NLog_TraceA(const char *loggerName, const char *logMessage, ...); 
+void NLog_DebugA(const char *loggerName, const char *logMessage, ...); 
+void NLog_InfoA(const char *loggerName, const char *logMessage, ...); 
+void NLog_WarnA(const char *loggerName, const char *logMessage, ...); 
+void NLog_ErrorA(const char *loggerName, const char *logMessage, ...); 
+void NLog_FatalA(const char *loggerName, const char *logMessage, ...); 
+void NLog_LogVA(NLogLevel level, const char *loggerName, const char *logMessage, va_list args);
+
+// 
+// Unicode functions
+// 
+int NLog_ConfigureFromFileW(const wchar_t *fileName);
+void NLog_LogW(NLogLevel level, const wchar_t *loggerName, const wchar_t *logMessage, ...); 
+void NLog_TraceW(const wchar_t *loggerName, const wchar_t *logMessage, ...); 
+void NLog_DebugW(const wchar_t *loggerName, const wchar_t *logMessage, ...); 
+void NLog_InfoW(const wchar_t *loggerName, const wchar_t *logMessage, ...); 
+void NLog_WarnW(const wchar_t *loggerName, const wchar_t *logMessage, ...); 
+void NLog_ErrorW(const wchar_t *loggerName, const wchar_t *logMessage, ...); 
+void NLog_FatalW(const wchar_t *loggerName, const wchar_t *logMessage, ...); 
+void NLog_LogVW(NLogLevel level, const wchar_t *loggerName, const wchar_t *logMessage, va_list args);

data/docs/examples/web/NLogCdef.cpp

@@ -0,0 +1,28 @@
+//
+// TCHAR macros
+// 
+#ifdef UNICODE
+
+#define NLog_Log NLog_LogW
+#define NLog_LogV NLog_LogVW
+#define NLog_Trace NLog_TraceW
+#define NLog_Debug NLog_DebugW
+#define NLog_Info NLog_InfoW
+#define NLog_Warn NLog_WarnW
+#define NLog_Error NLog_ErrorW
+#define NLog_Fatal NLog_FatalW
+#define NLog_ConfigureFromFile NLog_ConfigureFromFileW
+
+#else
+
+#define NLog_Log NLog_LogA
+#define NLog_LogV NLog_LogVA
+#define NLog_Trace NLog_TraceA
+#define NLog_Debug NLog_DebugA
+#define NLog_Info NLog_InfoA
+#define NLog_Warn NLog_WarnA
+#define NLog_Error NLog_ErrorA
+#define NLog_Fatal NLog_FatalA
+#define NLog_ConfigureFromFile NLog_ConfigureFromFileA
+
+#endif

data/docs/examples/web/Performance.cs

@@ -0,0 +1,16 @@
+using NLog;
+
+class MyClass {
+    // storing logger reference in a static variable is clean and fast
+    static Logger logger = LogManager.GetLogger("MyClass");
+
+    static void Main()
+    {
+        logger.Debug("This is a debugging message");
+
+        // it is not recommended to get the logger and store it in a local variable
+        Logger logger2 = LogManager.GetLogger("MyClass");
+        logger2.Debug("This is a debugging message");
+    }
+}
+

data/docs/examples/web/app.config

@@ -0,0 +1,10 @@
+<configuration>
+  <configSections>
+    <section name="nlog" type="NLog.Config.ConfigSectionHandler, NLog" />
+    <!-- other configSections go here -->
+  </configSections>
+  <nlog>
+    <!-- configuration parameters go here -->
+  </nlog>
+</configuration>
+

data/docs/examples/web/article1.cs

@@ -0,0 +1,21 @@
+using NLog;
+
+namespace Firma.Komponent
+{
+    public class Klasa {
+        private static Logger logger = LogManager.GetLogger("Firma.Komponent.Klasa");
+        // private static Logger logger = LogManager.GetCurrentClassLogger();
+
+        static void Main()
+        {
+            logger.Info("Informacja");
+            logger.Warn("Ostrze�enie {0}", "testowe");
+            logger.Error("B��d");
+            logger.Fatal("B��d krytyczny");
+            // formatowanie w stylu Console.WriteLine()
+            logger.Debug("Wynik {0} {1}", 1 + 2, "zzz");
+            // formatowanie z u�yciem IFormatProvider
+            logger.Debug(CultureInfo.InvariantCulture, "Bie��ca data {0}", DateTime.Now);
+        }
+    }
+}

data/docs/examples/web/article2.cs

@@ -0,0 +1,33 @@
+using NLog;
+
+namespace Firma.Komponent
+{
+    public class Klasa {
+        private static Logger logger = LogManager.GetLogger("Firma.Komponent.Klasa");
+        // private static Logger logger = LogManager.GetCurrentClassLogger();
+
+        static void Main()
+        {
+            logger.Info("Informacja");
+            logger.Warn("Ostrze�enie {0}", "testowe");
+            logger.Error("B��d");
+            logger.Fatal("B��d krytyczny");
+
+            // w przypadku du�ej liczby parametr�w warto sprawdzi�
+            // czy komunikat ma szans� by� gdziekolwiek zapisany
+            if (logger.IsDebugEnabled) {
+                int x = 3;
+                int y = 5;
+                
+                logger.Debug("x={0}, y={1}", x, y);
+            }
+
+            // formatowanie w stylu Console.WriteLine()
+            logger.Debug("Wynik {0} {1}", 1 + 2, "zzz");
+
+            // formatowanie z u�yciem IFormatProvider
+            logger.Debug(CultureInfo.InvariantCulture, 
+                    "Bie��ca data {0}", DateTime.Now);
+        }
+    }
+}

data/docs/examples/web/article3.nlog

@@ -0,0 +1,9 @@
+<nlog>
+    <targets>
+        <target name="konsola" type="Console" layout="${longdate} ${message}" />
+    </targets>
+
+    <rules>
+        <logger name="*" minlevel="Debug" writeTo="konsola" />
+    </rules>
+</nlog>

data/docs/examples/web/article4.nlog

@@ -0,0 +1,9 @@
+<nlog>
+    <targets>
+        <target name="codziennyPlik" type="File" layout="${longdate} ${message}" filename="${shortdate}.log" />
+    </targets>
+
+    <rules>
+        <logger name="*" minlevel="Debug" writeTo="codziennyPlik" />
+    </rules>
+</nlog>

data/docs/examples/web/article5.nlog

@@ -0,0 +1,24 @@
+<nlog>
+    <targets>
+        <target name="codziennyPlik" type="File" layout="${longdate} ${message}" filename="${shortdate}.log" />
+        <target name="konsola" type="Console" />
+        <target name="bledy" type="File" filename="errors.log" />
+        <target name="bazaDanych" type="Database">
+            <dbprovider>mssql</dbprovider>
+            <dbhost>.</dbhost> 
+            <dbdatabase>NLogDatabase</dbdatabase>
+            <dbusername>nloguser</dbusername>
+            <dbpassword>nlogpassword</dbpassword>
+
+            <commandText>
+                insert into LogTable(time_stamp,level,logger,message) 
+                       values(@time_stamp, @level, @logger, @message);
+            </commandText>
+
+            <parameter name="@time_stamp" layout="${date}" />
+            <parameter name="@level" layout="${level}" />
+            <parameter name="@logger" layout="${logger}" />
+            <parameter name="@message" layout="${message}" />
+        </target>
+    </targets>
+</nlog>

data/docs/examples/web/article6.nlog

@@ -0,0 +1,7 @@
+<rules>
+    <logger name="FooBar*" minlevel="Trace" writeTo="" final="true" />
+    <logger name="*" levels="Warn,Error" writeTo="bledy,bazaDanych" />
+    <logger name="Gizmo*" minlevel="Info" writeTo="bazaDanych" />
+    <logger name="*" minlevel="Info" writeTo="codziennyPlik" />
+    <logger name="*" minlevel="Trace" writeTo="konsola" />
+</rules>

data/docs/examples/web/benchmark_log4net.cs

@@ -0,0 +1,30 @@
+#if LOG4NET
+    ILog logger = LogManager.GetLogger("somelogger");
+#else
+    Logger logger = LogManager.GetLogger("somelogger");
+#endif
+
+// Case 1. No formatting:
+logger.Debug("This is a message without formatting.");
+
+// Case 2. One format parameter
+#if LOG4NET
+    logger.Debug(String.Format("This is a message with {0} format parameter", 1));
+#else
+    logger.Debug("This is a message with {0} format parameter", 1);
+#endif
+
+// Case 3. Two format parameters
+#if LOG4NET
+    logger.Debug(String.Format("This is a message with {0}{1} parameters", 2, "o"));
+#else
+    logger.Debug("This is a message with {0}{1} parameters", 2, "o");
+#endif
+    
+// Case 4. Three format parameters
+#if LOG4NET
+    logger.Debug(String.Format("This is a message with {0}{1}{2} parameters", "thr", 3, 3));
+#else
+    logger.Debug("This is a message with {0}{1}{2} parameters", "thr", 3, 3);
+#endif
+

data/docs/examples/web/benchmark_nlog.cs

@@ -0,0 +1,29 @@
+Logger logger = LogManager.GetLogger("somelogger");
+
+// Case 1. No formatting
+logger.Debug("This is a message without formatting.");
+
+// Case 2. One format parameter
+logger.Debug("This is a message with {0} format parameter", 1);
+
+// Case 3. Two format parameters
+logger.Debug("This is a message with {0}{1} parameters", 2, "o");
+
+// Case 4. Three format parameters
+logger.Debug("This is a message with {0}{1}{2} parameters", "thr", 3, 3);
+
+// Case 1a. No formatting, using a guard.
+if (logger.IsDebugEnabled)
+    logger.Debug("This is a message without formatting.");
+
+// Case 2a. One format parameter, using a guard.
+if (logger.IsDebugEnabled)
+    logger.Debug("This is a message with {0} format parameter", 1);
+
+// Case 3a. Two format parameters, using a guard.
+if (logger.IsDebugEnabled)
+    logger.Debug("This is a message with {0}{1} parameters", 2, "o");
+
+// Case 4a. Three format parameters, using a guard.
+if (logger.IsDebugEnabled)
+    logger.Debug("This is a message with {0}{1}{2} parameters", "thr", 3, 3);

data/docs/examples/web/config1.nlog

@@ -0,0 +1,4 @@
+<nlog>
+    <!-- configuration parameters go here -->
+</nlog>
+

data/docs/examples/web/config10.nlog

@@ -0,0 +1,18 @@
+<?xml version="1.0" ?>
+<nlog>
+    <extensions>
+        <add assembly="MyAssembly" />
+    </extensions>
+
+    <targets>
+        <target name="console" type="Console" />
+    </targets>
+
+    <rules>
+        <logger name="*" minLevel="Info" appendTo="console">
+            <filters>
+                <hourRange fromHour="10" toHour="12" action="Ignore" />
+            </filters>
+        </logger>
+    </rules>
+</nlog>

data/docs/examples/web/config11.nlog

@@ -0,0 +1,14 @@
+<?xml version="1.0" ?>
+<nlog>
+    <targets>
+        <target name="file" type="File" filename="${basedir}/logs/logfile.txt"
+            layout="${longdate} ${level:uppercase=true} ${logger} ${aspnet-session:variable=UserName} ${threadid} ${callsite} ${message}" />
+        <target name="trace" type="ASPNetTrace" 
+            layout="${level:uppercase=true} ${callsite} ${message}" />
+    </targets>
+
+    <rules>
+        <logger name="*" minLevel="Info" appendTo="trace" />
+        <logger name="*" minLevel="Debug" appendTo="file" />
+    </rules>
+</nlog>

data/docs/examples/web/config12.nlog

@@ -0,0 +1,4 @@
+<?xml version="1.0" ?>
+<nlog autoReload="true">
+    <!-- config goes here -->
+</nlog>

data/docs/examples/web/config2.nlog

@@ -0,0 +1,3 @@
+<nlog>
+    <include file="${machinename}.config.log" />
+</nlog>

data/docs/examples/web/config3.nlog

@@ -0,0 +1,24 @@
+<?xml version="1.0" ?>
+<nlog>
+    <targets>
+        <target name="console" type="Console" />
+        <target name="file1" type="File" filename="file1.log" />
+        <target name="file2" type="File" filename="file2.log" />
+        <target name="file3" type="File" filename="file3.log" />
+    </targets>
+
+    <rules>
+        <!-- SQL messages to file3.log but nowhere else-->
+        <logger name="*SQL*" appendTo="file3" final="true" />
+
+        <!-- Info and Error messages go to the console and file1.log -->
+        <logger levels="Info,Error" appendTo="console,file1" />
+
+        <!-- log all Debug messages to file1.log -->
+        <logger name="*" level="Debug" appendTo="file1" />
+
+        <!-- log error and fatal messages to file2.log -->
+        <logger name="*" minlevel="Error" appendTo="file2" />
+    </rules>
+</nlog>
+