Вход [закрытых] лучших практик

Я должен присоединиться к хору, рекомендующему log4net, в моем случае, прибывающем из гибкости платформы (настольный .NET / Компактная Платформа, 32/64-bit) точка зрения.

Однако обертывание его в частной марке API главный антишаблон . log4net.ILogger дубликат .NET эти палата общин, Регистрирующаяся обертка , API уже, таким образом связываясь уже минимизирован для Вас, и так как это - также библиотека Apache, это не обычно даже беспокойство, потому что Вы не бросаете управления: разветвите его, если Вы должны.

Большинство библиотек-оболочек дома, которые я видел также, фиксирует один или несколько из унылого перечня отказов:

42. Используя глобальный одноэлементный регистратор (или эквивалентно статическая точка входа), который теряет высокое разрешение рекомендуемого шаблон регистратора в классе ни для какого другого усиления селективности.
43. Отказ выставить дополнительное Exception аргумент , ведя к многочисленным проблемам:
    • Это вырабатывает политику входа исключения, еще более трудную поддержать, таким образом, ничто последовательно не делается за исключениями.
    • Даже с последовательной политикой, форматируя исключение далеко в строку теряет данные преждевременно. Я записал пользовательское ILayout декоратор, который выполняет подробную развертку на исключении для определения цепочки событий.
44. Отказ выставить эти IsLevelEnabled свойства , который отбрасывает способность пропустить форматирование код, когда области или уровни входа выключены.

Я не квалифицирован для комментария входа для .NET, так как мой хлеб с маслом является Java, но у нас была миграция в нашем входе за прошлые 8 лет, можно найти полезную аналогию с вопросом.

Мы запустили с регистратора Singleton, который использовался каждым потоком в JVM и установил регистрирующийся уровень для всего процесса. Это привело к огромным журналам, если мы должны были отладить даже очень определенную часть системы, таким образом, урок номер один должен сегментировать Ваш вход.

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

Мы пользуемся библиотекой входа свободного городского населения Apache перенесенный Log4J.

Hope это помогает!

* Редактирование *

После того, чтобы читать сообщение Jeffrey Hantin ниже, я понял, что должен был отметить то, чем на самом деле стала наша внутренняя обертка входа. Это - теперь по существу фабрика и строго используется для получения рабочего регистратора с помощью корректного файла свойств (который по причинам прежней версии не был перемещен в положение по умолчанию). Так как можно указать регистрирующийся конфигурационный файл на командной строке теперь, я подозреваю, что это станет еще более минимизированным и если бы Вы запускаете новое приложение, я определенно согласился бы с его оператором, что Вы не должны даже потрудиться переносить регистратор.

, Какие платформы Вы используете?

Мы используем соединение регистрирующегося блока приложений и пользовательского помощника входа, который работает вокруг битов платформы .NET. LAB настроен для вывода довольно обширных файлов журнала включенные отдельные общие файлы трассировки для сервисной записи/выхода метода и определенные ошибочные файлы для неожиданных проблем. Конфигурация включает дату/время, поток, pId и т.д. для помощи отладки, а также полной детали исключения и стека (в случае непредвиденной исключительной ситуации).

пользовательский помощник входа использует Трассировку. Корреляция и особенно удобна в контексте входа в систему WF. Например, у нас есть конечный автомат, который вызывает серию последовательных рабочих процессов. В каждом из них вызывают операции, мы регистрируем запуск (использующий StartLogicalOperation), и затем в конце мы останавливаемся, логическая операция с gereric возвращают обработчик событий.

Это оказалось полезным несколько раз при попытке отладить отказы в сложных бизнес-последовательностях, поскольку это позволяет нам определять вещи как то, Если/Еще выборы при разветвлении и т.д. более быстро на основе выполнения действия упорядочивают.

, Какие выводы журнала Вы используете?

Мы используем текстовые файлы и XML-файлы. Текстовые файлы настроены через блок приложений, но у нас есть выводы XML также от нашего сервиса WF. Это позволяет нам получить события во время выполнения (персистентность и т.д.), а также универсальные бизнес-исключения типа. Текстовые файлы прокручивают журналы, которые прокручиваются днем и размер (я полагаю, что общий размер 1 МБ является динамической точкой).

, Что инструменты Вам используют для просмотра журналов?

Мы используем Блокнот и Сервисное Средство просмотра трассировки WCF, в зависимости от которой выходной группы мы смотрим на. Сервисное Средство просмотра трассировки WCF действительно действительно удобно, если Вы имеете свою выходную установку правильно и можете сделать чтение вывода намного более простым. Тем не менее, если я знаю примерно, где ошибка так или иначе - просто чтение хорошо аннотируемого текстового файла хорошо также.

журналы отправляются в единственный каталог, который затем разделяется на поддиректоров на основе исходного сервиса. Корневой каталог выставляется через веб-сайт, который имеет, это - доступ, которым управляет группа пользователей поддержки. Это позволяет нам смотреть на производственные журналы, не имея необходимость вставлять запросы и проходить долгие процессы бюрократизма для производственных данных.

Мы используем Log4Net на работе как регистрирующийся поставщик с одноэлементной оберткой для экземпляра журнала (хотя одиночный элемент рассматривается, подвергая сомнению, являются ли они хорошей идеей или не).

Мы выбрали его по следующим причинам:

• Простая конфигурация / реконфигурирование на различных средах
• Большое количество предварительно созданного appenders
• Одному из CMS, который мы используем уже, создали его в
• Хорошее количество уровней журнала и конфигураций вокруг них

, я должен упомянуть, это говорит с точки зрения разработки ASP.NET

, я вижу некоторые достоинства в использовании Трассировки, которая находится в платформе.NET, но я не полностью продаюсь на нем, главным образом потому что компоненты, с которыми я работаю, действительно не делают никаких вызовов Трассировки. Единственная вещь, которую я часто использую, который делает, System.Net.Mail от того, что я могу сказать.

, Таким образом, у нас есть библиотека, которая переносит log4net и в рамках нашего кода, который мы просто должны наполнить как это:

Logger.Instance.Warn("Something to warn about");
Logger.Instance.Fatal("Something went bad!", new Exception());

try {
  var i = int.Parse("Hello World");
} catch(FormatException, ex) {
  Logger.Instance.Error(ex);
}

В рамках методов мы делаем проверку, чтобы видеть, включен ли регистрирующийся уровень, таким образом, у Вас нет избыточных вызовов к log4net API (поэтому, если Отладка не включена, операторы отладки проигнорированы), но когда я получу некоторое время, я буду обновлять его для представления их так, чтобы можно было сделать проверки сами. Это предотвратит оценки, предпринимаемые, когда они не были должны, например:

Logger.Instance.Debug(string.Format("Something to debug at {0}", DateTime.Now);

Это станет:

if(Logger.DebugEnabled) Logger.Instance.Debug(string.Format("Something to debug at {0}", DateTime.Now);

(Экономят немного времени выполнения)

По умолчанию мы регистрируемся в двух местах:

1. Файловая система веб-сайта (в неподаваемом расширении файла)
2. электронная почта, посылающая за Ошибкой & Фатальный

Файлы сделаны как прокрутка каждого дня или 10 МБ (IIRC). Мы не используем EventLog, поскольку он может потребовать повышения уровня защиты, чем мы часто хотим дать сайт.

я нахожу, что Блокнот работает просто великолепно для чтения журналов.

Как авторы инструмента, мы, конечно, используем SmartInspect для входа и трассировки приложений.NET. Мы обычно используем протокол именованного канала для живого входа и (зашифровали) двоичные файлы журнала для журналов конечного пользователя. Мы используем Консоль SmartInspect в качестве средства просмотра и контролирующего инструмента.

существует на самом деле довольно много платформ журналирования и инструментов для.NET там. Существует обзор и сравнение различных инструментов на DotNetLogging.com .

Мы используем log4net на наших веб-приложениях.

Это - способность настроить вход во времени выполнения путем изменения конфигурационного XML-файла, очень удобно, когда приложение неправильно функционирует во времени выполнения, и необходимо видеть больше информации.

Это также позволяет Вам быть нацеленными на определенные классы или атрибуты для входа под. Это очень удобно, когда у Вас есть идея, где ошибка происходит. Классическим примером является NHibernate, где Вы хотите видеть просто SQL, идущий в базу данных.

Редактирование:

Мы пишем все события в базу данных и систему Трассировки. Журнал событий мы используем для ошибок или исключений. Мы регистрируем большинство событий к базе данных так, чтобы мы могли создать пользовательские отчеты и позволить пользователям просмотреть журнал, если они хотят исправиться из приложения.

Я не часто разрабатываю в asp.net, однако когда дело доходит до регистраторов, я думаю, что много лучших практик универсально. Вот некоторые мои случайные мысли о входе этого, я учился за эти годы:

Платформы

• Использование платформа абстракции регистратора - как slf4j (или самокрутка), так, чтобы Вы отделили реализацию регистратора от своего API. Я видел, что много платформ регистратора приходят и уходят, и Вы - более обеспеченная способность принять новую без большого количества стычки.
• Попытка найти платформу, которая поддерживает множество выходных форматов.
• Попытка найти платформу, которая поддерживает плагины / пользовательские фильтры.
• Использование платформа, которая может быть настроена внешними файлами, так, чтобы Ваши клиенты / потребители могли настроить вывод журнала легко так, чтобы это могло быть считано коммерческими приложениями для управления журналом легко.
• убедиться не пойти за борт на пользовательских уровнях входа, иначе Вы не можете перемещаться в различные платформы журналирования.

Вывод Регистратора

• Старается избегать журналов стиля XML/RSS для входа, который мог встретиться с катастрофическими отказами. Это важно, потому что, если выключатель питания отключен без Вашего регистратора, пишущий закрытие </xxx> тег, Ваш журнал повреждается.
• потоки Журнала. Иначе может быть очень трудно отследить поток Вашей программы.
• , Если необходимо интернационализировать журналы, можно хотеть иметь разработчика, только входят в систему английский язык (или предпочтительный язык).
• Иногда наличие опции вставить регистрирующиеся операторы в SQL-запросы может быть спасителем в отладке ситуаций. Такой как:

    -- Invoking Class: com.foocorp.foopackage.FooClass:9021
    SELECT * FROM foo;

• Вы хотите вход уровня класса. Вы обычно не хотите статические экземпляры регистраторов также - это не стоит микрооптимизации.
• отмечание и категоризация зарегистрированных исключений иногда полезны, потому что не все исключения создаются равные. Так зная подмножество важных исключений голова времени полезна, если у Вас есть монитор журнала, который должен отправить уведомления на критические состояния.
• фильтры Дублирования сохранят Ваше зрение и жесткий диск. Вы действительно хотите видеть, что тот же регистрирует оператор, повторенный 10^10000000 времена? Не был бы это быть лучше только получить сообщение как: This is my logging statement - Repeated 100 times

Также см. этот мой вопрос .