Настройка логов на примере NLog

Хочу поделиться с Вами своим best practices по настройке логирования на примере NLog. Логи, это первая вещь, которую приходится настраивать при создании нового проекта, причем обычно для каждого нового проекта настройки логирования выглядят, как шаблонное решение, поэтому разумно выделить единый общий шаблон и использовать его в своих проектах. В данной статье рассмотрим мое простое шаблонное решение, которое я успешно применяю во многих своих проектах. Основная идея которую я отразил в шаблоне, это ведение не одного общего лога, а нескольких, каждый из которых лишь отличается уровнем подробности логирования и назначением, это 2 основных и 2 вспомогательных лога.

Пишем обертку для Stopwatch

Во время работы приложения, в качестве мониторинга времени выполнения метода или доступа к свойству используется класс Stopwatch из System.Diagnostics. Работает Stopwatch очень просто, он замеряет время прошедшее между вызовами Start* и Stop* методами. Приведу простой пример:

// Наш секундомер.

Stopwatch timer = new Stopwatch();           

timer.Start(); // Запустим секундомер

try

{

    Thread.Sleep(1234); // долгая операция

}

finally

{

    timer.Stop(); // Остановим секундомер

    // Показания секундомера:

    TimeSpan elapsed = timer.Elapsed;

    Console.WriteLine("Время выполнения {0}", elapsed);

}

В данном примере видны все неудобства использования Stopwatch, это необходимость явно создавать объект Stopwatch, это явный запуск и остановка секундомера, при этом, если возможны исключения, то нужно добавить и обработку исключений.

Смотрим логи. NLogViewer

Однажды, я написал статью, в которой рассказал про то, как быстро начать работать с системой логирования NLog. Да, все это хорошо, мы умеем вести лог файл, но что с ним делать? Этот, правильный на мой взгляд, вопрос мне задавали мои читатели. И я решил рассказать о NLogViewer - системе анализа лог файла, созданным NLog. Вообще, лог файл не зависит от системы логирования, поэтому существует множество различных систем просмотра(анализа) лог файлов. В этой статье я расскажу о NLogViewer, и о том, как сделать связку NLog+NLogViewer.

Hello, NLog

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

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

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