Log4j - Википедия - Log4j

Apache Log4j
Apache Log4j Logo.png
Разработчики)Фонд программного обеспечения Apache
изначальный выпуск8 января 2001 г.; 19 лет назад (2001-01-08)[1]
Стабильный выпуск
2.14.0 / 6 ноября 2020 г.; 45 дней назад (2020-11-06)[2]
РепозиторийРепозиторий Log4j
Написано вЯва
Операционная системаКроссплатформенность
Типлогирование
ЛицензияЛицензия Apache 2.0
Интернет сайтпротоколирование.apache.org/ log4j/2.Икс/

Apache Log4j это Ява -основан протоколирование полезность. Первоначально он был написан Чеки Гюльджю и является частью Службы ведения журнала Apache проект Фонд программного обеспечения Apache. Log4j - один из нескольких Фреймворки ведения журналов Java.

Гюльджю с тех пор начал SLF4J и логбэк[3] projects, с намерением предложить преемника Log4j.

Команда Apache Log4j создала преемника Log4j 1 с номером версии 2.[4] Log4j 2 был разработан с упором на проблемы Log4j 1.2, 1.3, java.util.logging и Logback, а также устраняет проблемы, которые возникали в этих средах.[5] Кроме того, Log4j 2 предлагает архитектуру плагинов, которая делает его более расширяемым, чем его предшественник. Log4j 2 не имеет обратной совместимости с версиями 1.x,[6] хотя есть "переходник".

5 августа 2015 года Комитет по управлению проектами Apache Logging Services объявил[7] Срок службы Log4j 1 подошел к концу, и пользователям Log4j 1 рекомендуется перейти на Apache Log4j 2.

Apache Log4j 2

Apache Log4j 2 является преемником Log4j 1, выпущенного как Версия GA в июле 2014 года. Фреймворк был переписан с нуля и основан на существующих решениях для ведения журналов, включая Log4j 1 и java.util.logging. Основные отличия[8][9] из Log4j 1:

  • Повышенная надежность. Сообщения не теряются при перенастройке фреймворка, как в Log4j 1 или Logback
  • Расширяемость: Log4j 2 поддерживает систему плагинов, позволяющую пользователям определять и настраивать собственные компоненты.
  • Упрощенный синтаксис конфигурации
  • Поддержка xml, json, ямл и конфигурации свойств
  • Улучшенные фильтры
  • Поддержка поиска свойств для значений, определенных в файле конфигурации, системных свойствах, переменных среды, карте контекста потока и данных, представленных в событии.
  • Поддержка нескольких API: Log4j 2 может использоваться с приложениями, использующими API Log4j 2, Log4j 1.2, SLF4J, Commons Logging и java.util.logging (JUL).
  • Пользовательские уровни журнала
  • Поддержка лямбда-выражения в стиле Java 8 для "ленивого ведения журнала"
  • Маркеры
  • Поддержка определяемых пользователем объектов сообщений
  • «Без мусора или с минимальным объемом мусора» в обычных конфигурациях
  • Повышенная скорость

Одной из наиболее узнаваемых особенностей Log4j 2 является производительность «асинхронных регистраторов».[10] Log4j 2 использует LMAX Disruptor.[11] Библиотека снижает потребность в блокировке ядра и увеличивает производительность журналирования в 12 раз. Например, в той же среде Log4j 2 может записывать более 18 000 000 сообщений в секунду, тогда как другие платформы, такие как Logback и Log4j 1, просто записывают <2 000 000 сообщений. в секунду.

Уровни журнала Log4j

В следующей таблице определены встроенные уровни журналов и сообщения в Log4j в порядке убывания важности. В левом столбце приводится обозначение уровня журнала в Log4j, а в правом столбце приводится краткое описание каждого уровня журнала.

УровеньОписание
ВЫКЛЮЧЕННЫЙМаксимально возможный ранг и предназначен для отключения регистрации.
ФАТАЛЬНЫЙСерьезные ошибки, вызывающие преждевременное завершение работы. Ожидайте, что они будут немедленно видны на консоли состояния.
ОШИБКАДругие ошибки времени выполнения или неожиданные условия. Ожидайте, что они будут немедленно видны на консоли состояния.
ПРЕДУПРЕЖДАТЬИспользование устаревших API, плохое использование API, «почти» ошибки, другие ситуации выполнения, которые являются нежелательными или неожиданными, но не обязательно «неправильными». Ожидайте, что они будут немедленно видны на консоли состояния.
ИНФОРМАЦИЯИнтересные события во время выполнения (запуск / завершение работы). Ожидайте, что они сразу же будут видны на консоли, поэтому будьте осторожны и сведите к минимуму.
ОТЛАЖИВАТЬПодробная информация о потоке через систему. Ожидайте, что они будут записаны только в журналы. Вообще говоря, большинство строк, регистрируемых вашим приложением, следует записывать как DEBUG.
СЛЕДСамая подробная информация. Ожидайте, что они будут записаны только в журналы. Начиная с версии 1.2.12.[12]

Пользовательские уровни журнала

Log4j 2 позволяет пользователям определять свои собственные уровни ведения журнала.[13] Инструмент генератора исходного кода предназначен для создания регистраторов, которые поддерживают настраиваемые уровни журнала, идентичные уровням встроенного журнала. Пользовательские уровни журнала могут дополнять или заменять встроенные уровни журнала.

Конфигурация Log4j

Log4j можно настроить[14] через файл конфигурации или через код Java. Файлы конфигурации можно записывать в XML, JSON, YAML, или же файл свойств формат. В конфигурации вы можете определить три основных компонента: регистраторы, приложения и макеты. Настройка ведения журнала через файл имеет то преимущество, что его можно включить или выключить, не изменяя приложение, использующее Log4j. Например, приложению можно разрешить запуск с выходом из системы, пока не возникнет проблема, а затем снова включить ведение журнала, просто изменив файл конфигурации.

Лесорубы[15] называются адресатами сообщений журнала. Это имена, известные приложению Java. Каждый регистратор независимо настраивается относительно того, какой уровень ведения журнала (FATAL, ERROR и т. Д.) Он в настоящее время регистрирует. В ранних версиях Log4j они назывались категорией и приоритетом, но теперь они называются регистратором и уровнем соответственно. Регистратор может отправлять сообщения журнала нескольким приложениям.

Фактические результаты выполняются Приложения.[16] Доступно множество приложений с описательными именами, например FileAppender, RollingFileAppender, ConsoleAppender, SocketAppender, SyslogAppender и SMTPAppender. Log4j 2 добавил приложения, которые пишут в Apache Flume, то Java Persistence API, Апач Кафка, NoSQL базы данных, Файлы с отображением памяти, Файлы произвольного доступа[17] и ZeroMQ конечные точки. К любому регистратору можно подключить несколько приложений, поэтому можно записывать одну и ту же информацию на несколько выходов; например в файл локально и в разъем слушатель на другом компьютере.

Использование приложений Макеты[18] для форматирования записей журнала. Популярным способом форматирования файлов журнала по одной строке за раз является PatternLayout, который использует строку шаблона, очень похожую на C / C ++ функция printf. Существуют также средства форматирования HTMLLayout и XMLLayout для использования, когда HTML или форматы XML более удобны соответственно. Log4j 2 добавил макеты для CSV, Расширенный формат журнала Graylog (GELF),[19] JSON, YAML и RFC-5424.[20]

В Log4j 2, Фильтры[21] могут быть определены в элементах конфигурации, чтобы дать более точный контроль над тем, какие записи журнала должны обрабатываться какими регистраторами и приложениями. В дополнение к фильтрации по уровню журнала и сопоставлению регулярных выражений в строке сообщения, Log4j 2 добавил пакетные фильтры, временные фильтры, фильтрацию по другим атрибутам событий журнала, таким как маркеры или карта контекста потока и JSR 223 скриптовые фильтры.

Чтобы отладить некорректную конфигурацию:

  • В конфигурациях Log4j 2 установите положение дел атрибут TRACE для отправки выходных данных внутренней регистрации состояния на стандартный выход. Чтобы включить ведение журнала состояния до того, как конфигурация будет найдена, используйте свойство Java VM -Dorg.apache.logging.log4j.simplelog.StatusLogger.level = трассировка.
  • В Log4j 1 используйте свойство Java VM -Dlog4j.debug.

Чтобы узнать, откуда был загружен файл конфигурации log4j2.xml, из inspect getClass (). getResource ("/ log4j2.xml").

Существует также неявная «ненастроенная» или «по умолчанию» конфигурация Log4j, конфигурация Java-приложения с инструментами Log4j, в которой отсутствует какая-либо конфигурация Log4j. Это выводит на стандартный вывод предупреждение о том, что программа не настроена, и URL-адрес веб-сайта Log4j, на котором можно найти подробную информацию о предупреждении и конфигурации. Помимо вывода этого предупреждения ненастроенное приложение Log4j будет печатать только записи журнала ERROR или FATAL в стандартном формате.

Пример для Log4j 2

<?xml version="1.0" encoding="UTF-8"?><Конфигурация статус ="след" monitorInterval ="60">  <Properties>    <Свойство имя ="имя файла">цель / test.log</Property>  </Properties>   <Appenders>    <Консоль имя ="STDOUT">       шаблон ="% d% p% c {1.} [% t]% m% n"/>    </Console>    <Файл имя ="файл" fileName ="$ {имя файла}">      <PatternLayout>        <pattern>% d% p% c {1.} [% t]% m% n</pattern>      </PatternLayout>    </File>  </Appenders>   <Loggers>     <!--          регистраторы, имя которых начинается с 'org.springframework', будут регистрировать только сообщения уровня "информация" или выше;         если вы извлекаете регистраторы, используя имя класса (например, Logger.getLogger (AClass.class))         и если AClass является частью пакета org.springframework, он будет принадлежать к этой категории    -->    <Регистратор имя ="org.springframework" уровень ="Информация" аддитивность ="ложный" />    <!--        Пример фильтра: для регистраторов, имя которых начинается с com.mycompany.myproduct,        записи журнала уровня «отладка» или выше, данные ThreadContextMap которых содержат        пара "ключ-значение" "test = 123", также отправьте эти записи журнала в приложение "STDOUT".    -->    <Регистратор имя ="com.mycompany.myproduct" уровень ="отлаживать" аддитивность ="истинный">      <ThreadContextMapFilter>         ключ ="тест" значение ="123"/>      </ThreadContextMapFilter>       ref ="STDOUT"/>    </Logger>     <!--        По умолчанию все сообщения журнала уровня «трассировка» или выше будут регистрироваться.        Сообщения журнала отправляются в приложение "файл" и         сообщения журнала уровня «ошибка» и выше будут отправлены в приложение «STDOUT».    -->    <Корень уровень ="след">       ref ="файл"/>       ref ="STDOUT" уровень ="ошибка"/>    </Root>  </Loggers> </Configuration>

Пример для Log4j 1.2

<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE log4j:configuration PUBLIC "-//LOGGER" "http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/xml/doc-files/log4j.dtd"><log4j:configuration>    <!--          приложение - это место назначения вывода, такое как консоль или файл;         имена добавлений выбраны произвольно.    -->     имя ="стандартный вывод" class ="org.apache.log4j.ConsoleAppender">         class ="org.apache.log4j.PatternLayout">            <параметр имя ="ConversionPattern"                значение ="% d {АБСОЛЮТНЫЙ}% 5p% c {1}:% L -% m% n" />        </layout>    </appender>     <!--          регистраторы категории 'org.springframework' будут регистрировать только сообщения уровня "информация" или выше;         если вы извлекаете регистраторы, используя имя класса (например, Logger.getLogger (AClass.class))         и если AClass является частью пакета org.springframework, он будет принадлежать к этой категории    -->    <регистратор имя ="org.springframework">        <уровень значение ="Информация"/>    </logger>    <!--          все весеннее было установлено на "информацию", но для класса          PropertyEditorRegistrySupport мы хотим вести журнал "отладки"     -->    <регистратор имя ="org.springframework.beans.PropertyEditorRegistrySupport">        <уровень значение ="отлаживать"/>    </logger>     <регистратор имя ="org.acegisecurity">        <уровень значение ="Информация"/>    </logger>            <root>        <!--             все сообщения журнала уровня "отладка" или выше будут регистрироваться, если не указано иное             все сообщения журнала будут записываться в приложение "stdout", если не указано иное         -->        <уровень значение ="отлаживать" />         ref ="стандартный вывод" />    </root></log4j:configuration>

ТТКС

TTCC - это формат сообщения, используемый log4j.[22] TTCC - это аббревиатура от Компонент категории временной нити. Он использует следующий шаблон:

 % r [% t]% -5p% c% x -% m% n

Где

МнемоническийОписание
%рИспользуется для вывода количества миллисекунд, прошедших от построения макета до создания события регистрации.
% tИспользуется для вывода имени потока, который сгенерировал событие регистрации.
%пИспользуется для вывода приоритета события регистрации.
% cИспользуется для вывода категории события регистрации.
%ИксИспользуется для вывода NDC (вложенного диагностического контекста), связанного с потоком, который сгенерировал событие регистрации.[23]
% X {ключ}Используется для вывода MDC (сопоставленного диагностического контекста), связанного с потоком, который сгенерировал событие регистрации для указанного ключа.[24]
% mИспользуется для вывода предоставленного приложением сообщения, связанного с событием регистрации.
% nИспользуется для вывода специфичной для платформы новая линия персонаж или персонажи.

Пример вывода
467 [main] INFO org.apache.log4j.examples.Sort - Выход из основного метода.

Порты

  • log4c - Порт для C. Log4C является C-основанным протоколирование библиотека, выпущенная SourceForge под LGPL лицензия. Для различных Unix операционные системы autoconf и автопроизводитель файлы предоставляются. На Windows а Makefile предоставляется для использования с MSVC. Разработчики могут также выбрать использование своей собственной системы make для компиляции исходного кода, в зависимости от своих инженерных требований к сборке. Экземпляр log4c библиотеку можно настроить тремя способами: используя переменные среды, программно или через XML конфигурационный файл. log4c имеет дополнения для файлов, потоков и файлов с отображением памяти. (Без адаптера Socket.) Последняя версия - 1.2.4, выпущенная в 2013 году, и проект больше не развивается.[25]
  • log4js - Порт для JavaScript. Log4js доступен по лицензии Фонд программного обеспечения Apache. Особенностью Log4js является возможность удаленно регистрировать события браузера на сервере. С помощью Аякс возможна отправка событий журнала в нескольких форматах (XML, JSON, простой ASCII и т. д.) на сервер для оценки там. Следующие дополнения реализованы для log4js: AjaxAppender, ConsoleAppender, FileAppender, JSConsoleAppender, MetatagAppender и WindowsEventsAppender. Предоставляются следующие классы макета: BasicLayout, HtmlLayout, JSONLayout и XMLLayout. Последняя версия - 1.1, выпущенная в 2008 году.[26]
  • log4javascript - Еще один порт для JavaScript. log4javascript - это среда ведения журналов JavaScript, основанная на log4j. Последняя версия - 1.4.9, выпущенная в мае 2014 года.[27]
  • JSNLog - Порт для JavaScript. Автоматически помещает сообщения из регистраторов JavaScript в журналы на стороне сервера с помощью серверного компонента .NET, который взаимодействует с Log4Net, NLog, Elmah или Common.Logging. Это обеспечивает интегрированный журнал событий на стороне клиента и сервера. Идентификаторы запросов коррелируют события, связанные с конкретным пользователем. Конфигурация осуществляется через файл web.config на стороне сервера. Поддерживает ведение журнала исключений, включая трассировку стека. В июле 2014 года была последняя версия 2.7.1, и обновления производились регулярно.[28]
  • Apache Log4net - Порт на Microsoft .NET Framework. Первоначальная работа была выполнена Neoworks и был подарен Фонд программного обеспечения Apache в феврале 2004 года. Фреймворк похож на исходный log4j, но использует новые возможности среды выполнения .NET. Предоставляет вложенный диагностический контекст (NDC) и сопоставленный диагностический контекст (MDC). Последняя версия - 2.0.8, выпущенная в 2017 году.[29][30]
  • log4perl - А Perl порт популярного пакета журналирования log4j. Последняя версия - 1.49, выпущенная в феврале 2017 года.[31]
  • Apache log4php - «Универсальная система ведения журнала для PHP. Первоначально он был портированием Apache log4j на PHP, но теперь он включает в себя различные специфические особенности PHP ».[32]
  • PL-SQL-Logging-Утилита является адаптацией log4j в PL / SQL.[33]
  • Log4db2 - это утилита ведения журнала для DB2 for LUW, которая использует инструкции SQL с кодом SQL PL.[34]
  • Apache Log4cxx - Платформа ведения журналов для C ++ по образцу Apache log4j, который использует Портативная среда выполнения Apache для большей части кода, зависящего от платформы, и его следует использовать на любой платформе, поддерживаемой APR. В настоящее время он находится в стадии инкубации, последняя версия - 0.10.0, выпущенная в 2008 году.[35]
  • Log4r - Комплексная и гибкая библиотека журналов, написанная на Ruby для использования в программах Ruby. Он был вдохновлен и предоставляет многие возможности проекта Apache Log4j.[36]

Смотрите также

Рекомендации

  1. ^ «История выпусков Apache Log4j 1.2». apache.org. Фонд программного обеспечения Apache. Получено 2014-09-02.
  2. ^ «Log4j - Изменения - Apache Log4j 2». apache.org. Фонд программного обеспечения Apache. Получено 21 апреля 2017.
  3. ^ "Возвращение домой". Logback.qos.ch. Получено 2014-07-24.
  4. ^ «Руководство по Log4j 2 - Apache Log4j 2». Logging.apache.org. 2014-07-12. Получено 2014-07-24.
  5. ^ "Главная | Ральф Гоерс | Ведение журнала с помощью Log4j 2". Ральф Гоерс.
  6. ^ «Руководство по Log4j 2 - Apache Log4j 2: Новости». Logging.apache.org. 2014-07-12. Получено 2014-07-24.
  7. ^ «Проект Apache ™ Logging Services ™ объявляет об окончании срока службы Log4j ™ 1; рекомендует выполнить обновление до Log4j 2». blogs.apache.org. 2015-08-05. Получено 2016-07-03.
  8. ^ "Новый log4j 2.0". Grobmeier.de. 2012-12-05. Получено 2014-07-24.
  9. ^ «Log4j - Обзор - Apache Log4j 2». logging.apache.org. 2016-06-05. Получено 2016-07-03.
  10. ^ «Асинхронные регистраторы Log4j 2 для ведения журнала с малой задержкой - Apache Log4j 2». Logging.apache.org. 2014-07-12. Получено 2014-07-24.
  11. ^ «Дисраптор от LMAX-Exchange». Lmax-exchange.github.io. Получено 2014-07-24.
  12. ^ «Уровень (API Apache Log4j 1.2.17)». Logging.apache.org. 2012-06-09. Получено 2014-07-24.
  13. ^ «Пользовательские уровни журнала». Logging.apache.org. 2014-07-12. Получено 2016-07-16.
  14. ^ «Конфигурация». Logging.apache.org. 2016-07-05. Получено 2016-07-16.
  15. ^ "Архитектура". Logging.apache.org. 2016-07-05. Получено 2016-07-16.
  16. ^ "Приложения". Logging.apache.org. 2016-07-05. Получено 2016-07-16.
  17. ^ "RandomAccessFile". docs.oracle.com. 2011-07-28. Получено 2016-07-16.
  18. ^ «Макеты». Logging.apache.org. 2016-07-05. Получено 2016-07-16.
  19. ^ «ГЕЛФ». docs.graylog.org. 2016-06-08. Получено 2016-07-16.
  20. ^ «RFC 5424 - протокол системного журнала». tools.ietf.org. 2009-03-01. Получено 2016-07-16.
  21. ^ «Фильтры». Logging.apache.org. 2016-07-05. Получено 2016-07-16.
  22. ^ "TTCCLayout (API Apache Log4j 1.2.17)". Logging.apache.org. 2012-06-09. Получено 2014-07-24.
  23. ^ «Класс НДЦ». Архивировано из оригинал на 2007-08-20. Получено 2014-07-24.
  24. ^ "MDC (API Apache Log4j 1.2.17)". Logging.apache.org. 2012-06-09. Получено 2014-07-24.
  25. ^ "Logging Framework для C | Загрузки бесплатного программного обеспечения для системного администрирования". Sourceforge.net. Получено 2014-07-24.
  26. ^ "Log4js". Log4js. Получено 2017-03-29.
  27. ^ "среда ведения журналов JavaScript". log4javascript. Получено 2014-07-24.
  28. ^ «Запись ошибок JavaScript в журнал на стороне сервера». JSNLog. Получено 2014-07-24.
  29. ^ "Apache log4net: Главная". Logging.apache.org. 2015-12-05. Получено 2016-04-08.
  30. ^ «Релиз 2.0.8 принят · apache / logging-log4net @ cd20f62». GitHub.
  31. ^ "log4perl - log4j для Perl". Mschilli.github.com. Получено 2014-07-24.
  32. ^ «Службы регистрации Apache». Apache.org. Получено 2015-03-11.
  33. ^ "tmuth / Logger-A-PL-SQL-Logging-Utility - GitHub". Github.com. Получено 2014-07-24.
  34. ^ "Log4db2 от angoca". Angoca.github.io. Получено 2014-07-24.
  35. ^ "log4cxx - Изменения". logging.apache.org.
  36. ^ "Руководство по Log4r". log4r.rubyforge.org. Архивировано из оригинал на 2012-12-25. Получено 2017-04-13.

дальнейшее чтение

  • Гюльджю, Цеки (февраль 2010 г.), Полное руководство по Log4j (2-е изд.), QOS.ch, стр. 204, г. ISBN  978-2-9700369-0-6
  • Гупта, Самудра (22 июня 2005 г.), Pro Apache Log4j (2-е изд.), Apress, п. 224, г. ISBN  978-1-59059-499-5

внешняя ссылка