Logowanie za pomocą Azure SDK dla Java i Log4j

W tym artykule pokazano, jak skonfigurować usługę Log4j dla aplikacji korzystających z Azure SDK na potrzeby Java. Jak wspomniano w artykule Konfigurowanie rejestrowania w Azure SDK dla Java, wszystkie biblioteki klienckie Azure logują się za pośrednictwem protokołu SLF4J, dzięki czemu można używać struktur, takich jak Log4j 2, aby uprościć rozwiązywanie problemów.

Ten artykuł zawiera wskazówki dotyczące korzystania z wersji Log4J 2.x, ale Azure SDK dla Java obsługuje również bibliotekę Log4J 1.x. Aby włączyć rejestrowanie log4j, wykonaj następujące dwa kroki:

  1. Dołącz bibliotekę log4j jako zależność.
  2. Utwórz plik konfiguracji (log4j2.properties lub log4j2.xml) w katalogu projektu /src/main/resources .

Aby uzyskać więcej informacji na temat konfigurowania log4j, zobacz Welcome to Log4j 2 (Witamy w usłudze Log4j 2).

Dodaj zależność Maven

Aby dodać zależność narzędzia Maven, dołącz następujący kod XML do pliku pom.xml projektu. Zastąp numer wersji 2.16.0 najnowszym dostępnym numerem wersji widocznym na stronie powiązania Apache Log4j SLF4J .

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

Notatka

Ze względu na znaną lukę w zabezpieczeniach CVE-2021-44228 należy użyć usługi Log4j w wersji 2.16 lub nowszej.

Konfigurowanie usługi Log4j

Usługa Log4j można skonfigurować na dwa typowe sposoby: za pośrednictwem pliku właściwości zewnętrznych lub zewnętrznego pliku XML. W poniższych sekcjach opisano te podejścia.

Korzystanie z pliku właściwości

Umieść plik właściwości prostych o nazwie log4j2.properties w katalogu /src/main/resources projektu. Ten plik powinien mieć następującą formę:

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

Używanie pliku XML

Umieść plik XML o nazwie log4j2.xml w katalogu /src/main/resources projektu. Plik powinien być zgodny z tą strukturą:

<?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>

Następne kroki

W tym artykule opisano konfigurację usługi Log4j i sposób używania go do rejestrowania za pomocą zestawu Azure SDK dla języka Java. Ponieważ zestaw Azure SDK dla języka Java współpracuje ze wszystkimi strukturami rejestrowania SLF4J, rozważ przejrzenie podręcznika użytkownika SLF4J, aby uzyskać więcej szczegółów. Jeśli używasz usługi Log4j, istnieje również wiele wskazówek dotyczących konfiguracji w jej witrynie internetowej. Aby uzyskać więcej informacji, zobacz Welcome to Log4j 2!

Gdy opanujesz rejestrowanie, rozważ zapoznanie się z integracjami, które Azure oferuje dla frameworków takich jak Spring.

  • Last updated on