Hello, NLog

Логирование - неотъемлемая часть любого проекта. Не секрет, что каждый из нас, хотя бы раз написал свою собственную систему логирования. А задумывались насколько она у Вас гибкая? Начиная новый проект, вы снова пишите новую систему логирования? До сих пор используете Console.WriteLine(...) в качестве ведения лога? Вывод один, используйте готовый logging framework, например: log4net, NLog, Logging Application Block от Microsoft и другие. Преимущества готовых logging framework-ов от самодельных:

1. Гибкая настройка лога.
2. Широкие возможности.
3. Наличие конфигурационных xml-файлов с xsd-схемами.
4. Готовое стабильное решение (экономия времени на отладке).
5. Наличие документации (форумов, блогов).

У каждого из них есть свои плюсы и минусы. В статье мы познакомимся с одном из них - NLog.

На вой взгляд, NLog кажется более простым в конфигурировании(log4net) и менее требователен к ресурсам(Logging Application Block) при том, что он выполняет те же задачи, поэтому именно ему я и отдаю предпочтение. Начать работу с NLog действительно очень просто, ведь для этого от Вас требуется только понимание основных принципов NLog, а именно в правильном конфигурировании двух основных частей: targets и rules и в выборе оптимального уровня логирования.

Рассмотрим подробнее, каждое сообщение имеет уровень логирования(log level), в лог заноситься только то сообщение, уровень логирования которого ниже указанного в правиле логирования. NLog поддерживает следующие уровни:

• Trace - детальное логирование (все сообщения)
• Debug - отладочное логирование, менее детально чем Trace
• Info - логирование информационных сообщений
• Warn - логирование сообщений о предупреждениях
• Error - логирование сообщений об ошибках
• Fatal - логирование сообщений о критических ошибках(только критические сообщения)
• Off - логирование сообщений не производиться

Например, выбрав уровень Error, в лог попадут сообщения типа Error и Fatal, остальные же проигнорируются. Выбрав уровень логирования необходимо задать правило логирования (logger), которое задается в блоке rules, другими словами, задать КАК будет осуществляться логирование: указав источник (name) сообщений(например класс, набор классов из пространства имен и прочие), уровень логирования (level), ссылку КУДА мы будем делать вывод (target). Описание КУДА осуществлять вывод производиться в блоке targets, в котором задается: вид логирования(type)(в файл, на консоль, почту, в базу и другие), формат сообщения(layout) (с указанием даты, уровня, имени источника и прочего).

Рассмотрим простой пример, допустим, нам надо осуществлять логирование следующим образом: сообщения уровня Debug выводить на консоль, а сообщения уровня Trace (все сообщения) выводить в файл. При этом, в лог должно записываться: время сообщения (а в случае записи в файл еще текущую дату), уровень сообщения и само сообщение.

Для того чтобы начать работу с NLog необходимо скачать с сайта последний дистрибутив и установить его на жесткий диск. После чего, можно приступать к созданию нового проекта NLogExample, в котором надо добавить ссылку на библиотеку NLog.dll. Как и любая система, NLog нуждается в настройке, для этого добавим в проект файл конфигурации NLog.config, задав файлу опцию "Copy to Output Directory" (это нужно для того, чтобы файл NLog.config при спорке проекта автоматически перемещался в выходную директорию):

<?xml version="1.0" encoding="utf-8" ?>

 

<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"

      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

 

    <targets>

        <target name="console" xsi:type="Console" layout="${date:format=HH\:mm\:ss}|${level}|${message}" />

        <target name="file"  xsi:type="File" fileName="${basedir}/nlog.txt" layout="${date}|${level}|${message}" />

    </targets>

 

    <rules>

        <logger name="*" minlevel="Debug" writeTo="console" />

        <logger name="*" minlevel="Trace" writeTo="file" />

    </rules>

 

</nlog>

Наш логгер настроен, и мы можем начать его использовать, для этого необходимо получить на него ссылку, это делается следующим образом:

Logger logger = LogManager.GetCurrentClassLogger();

Полученный нами экземпляр логгера содержит все необходимые методы (Trace, Debug, Info, Warn, Error, Fatal, и другие) для записи сообщения в лог. Каждый такой метод задает уровень логирования для сообщения. Поэтому если мы хотим записать в лог сообщение типа Info, мы должны использовать одноименный метод:

using System;

using NLog;

namespace NLogExample

{

    class Program

    {       

        private static Logger logger = LogManager.GetCurrentClassLogger();

 

        static void Main(string[] args)

        {

            logger.Trace("logger.Trace");           

            logger.Debug("logger.Debug");

            logger.Info("logger.Info");

            logger.Warn("logger.Warn");

            logger.Error("logger.Error");

            logger.Fatal("logger.Fatal");

        }

    }

}

В итоге, если запустить приложение, на консоли мы увидим сообщения Debug, Info, Warn, Error, Fatal, а в файле(расположенного в том же каталоге где и сборка) еще и Trace сообщения.

UPD: Смотрим логи. NLogViewer
UPD: Настройка логов на примере NLog