Accedere con Azure SDK per Java e Log4j

Articolo
10/23/2023

Questo articolo offre una panoramica di come aggiungere la registrazione usando Log4j alle applicazioni che usano Azure SDK per Java. Come indicato in Configurare la registrazione in Azure SDK per Java, tutte le librerie client di Azure accedono tramite SLF4J, in modo da poter usare framework di registrazione come log4j.

Questo articolo fornisce indicazioni sull'uso delle versioni di Log4J 2.x, ma Log4J 1.x è ugualmente supportato da Azure SDK per Java. Per abilitare la registrazione log4j, è necessario eseguire due operazioni:

Includere la libreria log4j come dipendenza,
Creare un file di configurazione (log4j2.properties o log4j2.xml) nella directory del progetto /src/main/resources.

Per altre informazioni relative alla configurazione di log4j, vedere Benvenuti in Log4j 2.

Aggiungere la dipendenza Maven

Per aggiungere la dipendenza Maven, includere il codice XML seguente nel file pom.xml del progetto. Sostituire il numero di versione 2.16.0 con il numero di versione rilasciato più recente visualizzato nella pagina Di associazione Apache Log4j SLF4J.

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

Nota

A causa della vulnerabilità nota CVE-2021-44228, assicurarsi di usare Log4j versione 2.16 o successiva

Configurazione di Log4j

Esistono due modi comuni per configurare Log4j: tramite un file di proprietà esterno o tramite un file XML esterno. Questi approcci sono descritti di seguito.

Uso di un file di proprietà

È possibile inserire un file di proprietà flat denominato log4j2.properties nella directory /src/main/resources del progetto. Questo file deve avere il formato seguente:

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

Uso di un file XML

È possibile inserire un file XML denominato log4j2.xml nella directory /src/main/resources del progetto. Questo file deve avere il formato seguente:

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

Passaggi successivi

Questo articolo ha illustrato la configurazione di Log4j e come usare Azure SDK per Java per la registrazione. Poiché Azure SDK per Java funziona con tutti i framework di registrazione SLF4J, è consigliabile esaminare il manuale dell'utente SLF4J per altri dettagli. Se si usa Log4j, sono disponibili anche numerose linee guida per la configurazione nel sito Web. Per altre informazioni, vedere Benvenuti in Log4j 2!

Dopo aver eseguito la registrazione, è consigliabile esaminare le integrazioni offerte da Azure in framework come Spring e MicroProfile.

Condividi tramite