Логирование с помощью Azure SDK для Java и Log4j

В этой статье показано, как настроить Log4j для приложений, использующих Azure SDK для Java. Как упоминалось в разделе "Настройка ведения журнала в Azure SDK для Java", все клиентские библиотеки Azure регистрируются через SLF4J, поэтому можно использовать платформы, такие как Log4j 2, для упрощения устранения неполадок.

В этой статье приведены рекомендации по использованию выпусков Log4J 2.x, но Azure SDK для Java также поддерживает Log4J 1.x. Чтобы включить ведение журнала log4j, выполните следующие два шага:

  1. Включите библиотеку log4j в качестве зависимости.
  2. Создайте файл конфигурации (log4j2.properties или log4j2.xml) в каталоге проекта /src/main/resources .

Дополнительные сведения о настройке log4j см. в статье "Добро пожаловать в Log4j 2".

Добавьте зависимость Maven

Чтобы добавить зависимость Maven, добавьте следующий XML-код в файл pom.xml проекта. Замените номер версии 2.16.0 номером последней версии, показанным на странице привязки Apache Log4j SLF4J.

<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-slf4j-impl</artifactId>
    <version>2.16.0</version>
</dependency>

Заметка

Из-за известной уязвимости CVE-2021-44228 обязательно используйте Log4j версии 2.16 или более поздней.

Настройка Log4j

Log4j можно настроить двумя распространёнными способами: через внешний файл свойств или через внешний XML-файл. В следующих разделах описаны эти подходы.

Использование файла свойств

Поместите файл неструктурированных свойств с именем log4j2.properties в каталог /src/main/resources проекта. Этот файл должен иметь следующую форму:

appender.console.type = Console
appender.console.name = STDOUT
appender.console.layout.type = PatternLayout
appender.console.layout.pattern = %d %5p [%t] %c{3} - %m%n

logger.app.name = com.azure.core
logger.app.level = ERROR

rootLogger.level = info
rootLogger.appenderRefs = stdout
rootLogger.appenderRef.stdout.ref = STDOUT

Использование XML-файла

Поместите XML-файл с именемlog4j2.xml в каталог /src/main/resources проекта. Файл должен соответствовать этой структуре:

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="INFO">
    <Appenders>
        <Console name="console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d %5p [%t] %c{3} - %m%n" />
        </Console>
    </Appenders>
    <Loggers>
        <Logger name="com.azure.core" level="error" additivity="true">
            <appender-ref ref="console" />
        </Logger>
        <Root level="info" additivity="false">
            <appender-ref ref="console" />
        </Root>
     </Loggers>
</Configuration>

Дальнейшие действия

В этой статье описана конфигурация Log4j и способ использования пакета SDK Azure для Java для ведения журнала. Так как пакет SDK Azure для Java работает со всеми платформами ведения журнала SLF4J, рассмотрите возможность просмотра руководства пользователя SLF4J для получения дополнительных сведений. Если вы используете Log4j, на веб-сайте также есть огромное количество рекомендаций по настройке. Дополнительные сведения см. в разделе Добро пожаловать в Log4j 2!

Освоив журналирование, рассмотрите интеграции Azure с такими фреймворками, как Spring.

  • Last updated on