Aanmelden met de Azure SDK voor Java en Log4j

Artikel
10/23/2023

Dit artikel bevat een overzicht van het toevoegen van logboekregistratie met behulp van Log4j aan toepassingen die gebruikmaken van de Azure SDK voor Java. Zoals vermeld in Logboekregistratie configureren in de Azure SDK voor Java, registreren alle Azure-clientbibliotheken zich via SLF4J, zodat u logboekregistratieframeworks zoals log4j kunt gebruiken.

Dit artikel bevat richtlijnen voor het gebruik van de Log4J 2.x-releases, maar Log4J 1.x wordt evengoed ondersteund door de Azure SDK voor Java. Als u log4j-logboekregistratie wilt inschakelen, moet u twee dingen doen:

Neem de log4j-bibliotheek op als een afhankelijkheid,
Maak een configuratiebestand (log4j2.properties of log4j2.xml) onder de projectmap /src/main/resources.

Zie Welkom bij Log4j 2 voor meer informatie over het configureren van log4j.

De Maven-afhankelijkheid toevoegen

Als u de Maven-afhankelijkheid wilt toevoegen, neemt u de volgende XML op in het pom.xml-bestand van het project. Vervang het versienummer 2.16.0 door het meest recente versienummer dat wordt weergegeven op de pagina Apache Log4j SLF4J Binding.

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

Notitie

Vanwege bekend beveiligingsprobleem CVE-2021-44228 moet u Log4j versie 2.16 of hoger gebruiken

Log4j configureren

Er zijn twee algemene manieren om Log4j te configureren: via een bestand met externe eigenschappen of via een extern XML-bestand. Deze benaderingen worden hieronder beschreven.

Een eigenschapsbestand gebruiken

U kunt een bestand met platte eigenschappen met de naam log4j2.properties plaatsen in de map /src/main/resources van het project. Dit bestand moet het volgende formulier hebben:

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

Een XML-bestand gebruiken

U kunt een XML-bestand met de naam log4j2.xml in de map /src/main/resources van het project plaatsen. Dit bestand moet het volgende formulier hebben:

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

Volgende stappen

Dit artikel heeft betrekking op de configuratie van Log4j en hoe u de Azure SDK voor Java gebruikt voor logboekregistratie. Omdat de Azure SDK voor Java werkt met alle frameworks voor SLF4J-logboekregistratie, kunt u overwegen de gebruikershandleiding voor SLF4J te bekijken voor meer informatie. Als u Log4j gebruikt, is er ook een grote hoeveelheid configuratierichtlijnen op de website. Zie Welkom bij Log4j 2 voor meer informatie.

Nadat u logboekregistratie hebt beheerd, kunt u overwegen om te kijken naar de integraties die Azure biedt in frameworks zoals Spring en MicroProfile.

Delen via