Изменение уровня логирования в Log4j2 программным путем

Быстрый ответ

Для непосредственной установки уровня логирования в Log4j2 используйте метод Configurator.setAllLevels:

import org.apache.logging.log4j.core.config.Configurator;
import org.apache.logging.log4j.Level;
import org.apache.logging.log4j.LogManager;

Configurator.setAllLevels(LogManager.getRootLogger().getName(), Level.DEBUG);

Эта операция задаёт DEBUG уровень для корневого логгера, но вы свободны в выборе любого другого уровня Log4j2, такого как TRACE, INFO, WARN, ERROR, FATAL или OFF, в соответствии с потребностями.

Пошаговое руководство по управлению уровнями логирования

Итак, мы переходим к подробному изучению и освоению гибкого управления уровнями логирования, чтобы Log4j2 исполняло все наши задумки.

Выбор подходящего уровня логирования

// Точечное переключение уровней логирования
Configurator.setLevel("com.example.Foo", Level.DEBUG); // Для конкретного пакета
Configurator.setRootLevel(Level.INFO); // Для всех логгеров

Выбирайте уровень логирования заботливо, чтобы достичь оптимального баланса между производительностью и детализацией информации. Level.DEBUG хорош для отладки, а Level.INFO – идеальный выбор для ситуаций, когда вам нужен обзорный контроль системы.

Подробнее об этом расскажет наш спикер на видео

Изменение уровня конкретного логгера

Бывают моменты, когда важно акцентировать внимание на сегменте приложения:

LoggerContext ctx = (LoggerContext) LogManager.getContext(false);
Configuration config = ctx.getConfiguration();
LoggerConfig loggerConfig = config.getLoggerConfig(LogManager.ROOT_LOGGER_NAME);
loggerConfig.setLevel(Level.WARN);
ctx.updateLoggers();  // Подтверждаем изменения, будто бы нажимаем "Применить".

Такая микронастройка позволяет управлять логированием с высокой точностью.

Создание конфигураций для логгеров

Если логгеру требуется индивидуальная конфигурация, воспользуйтесь следующим подходом:

LoggerConfig newLoggerConfig = new LoggerConfig("com.example.MyClass", Level.DEBUG, true);
config.addLogger("com.example.MyClass", newLoggerConfig);
ctx.updateLoggers();

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

Модульное тестирование и отладка

Применяйте изменения уровней логирования для формирования проверок в тестах:

// Тестируйте и убедитесь, что логгеры работают корректно.
assertThat(LogManager.getLogger("com.example.MyClass").getLevel(), is(Level.DEBUG));

Модульные тесты помогут убедиться, записывают ли логгеры те события, на которые они настроены.

Взаимодействие настроек через код и конфигурационного файла

Не забывайте об log4j2.xml, который может переопределить ваши программные настройки:

// Приоритет у файла конфигурации.
Configurator.initialize(null, "path/to/log4j2-config.xml");

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

Визуализация

Представьте уровень логирования различными цветами, отмечающими события ваших логов:

До:
🟥🟦🟩🟨 [INFO Level]

// Добавляем больше деталей в логи
config.getLoggerConfig("com.example").setLevel(Level.DEBUG);

После:
🟥🟦🟩🟨🟧🟪🟫 [DEBUG Level]

Увеличение детализации в логах – это как добавление новых цветовых оттенков в вашу картину.

Лучшие практики и распространённые ошибки

Используйте возможности LoggerContext

Для полноценной работы с логированием важно понимать принципы работы LoggerContext и его взаимосвязь с конфигурациями и экземплярами логгеров:

// Подключаемся к контексту логгера.
LoggerContext context = (LoggerContext) LogManager.getContext(false);

Сделайте Configurator своим инструментом

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

Понимание иерархии логгеров

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

// Следим за иерархией, чтобы правильно установить уровень логирования.
config.getLoggerConfig("com.example").setLevel(Level.WARN);

Соответствие версиям Log4j2

Всегда уточняйте информацию о совместимости методов Configurator с вашей версией Log4j2, чтобы избежать неожиданных результатов.

Полезные материалы

1. Log4j — Конфигурация Log4j 2 – Официальная документация по программной настройке Log4j2.
2. Программное изменение уровня логирования в Log4j2 – Stack Overflow – Практические рекомендации и примеры использования от сообщества разработчиков.
3. (doc) очистка после #305 от pzygielo · Pull Request #310 · apache/logging-log4j2 · GitHub — Обсуждения и изменения в исходном коде Log4j2 на GitHub.
4. Log4j – Часто задаваемые вопросы — Ответы на распространенные вопросы по Log4j2.
5. Java Logging API – Учебник — Обзор принципов и практики использования Log4j2.