70 lines
2.3 KiB
Markdown
70 lines
2.3 KiB
Markdown
# Appender Instrumentation for Log4j2 version 2.17 and higher
|
|
|
|
This module provides a Log4j2 [appender](https://logging.apache.org/log4j/2.x/manual/appenders.html)
|
|
which forwards Log4j2 log events to the
|
|
[OpenTelemetry Log SDK](https://github.com/open-telemetry/opentelemetry-java/tree/main/sdk/logs).
|
|
|
|
## Quickstart
|
|
|
|
### Add these dependencies to your project
|
|
|
|
Replace `OPENTELEMETRY_VERSION` with the [latest
|
|
release](https://search.maven.org/search?q=g:io.opentelemetry.instrumentation%20AND%20a:opentelemetry-log4j-appender-2.17).
|
|
|
|
For Maven, add to your `pom.xml` dependencies:
|
|
|
|
```xml
|
|
<dependencies>
|
|
<dependency>
|
|
<groupId>io.opentelemetry.instrumentation</groupId>
|
|
<artifactId>opentelemetry-log4j-appender-2.17</artifactId>
|
|
<version>OPENTELEMETRY_VERSION</version>
|
|
<scope>runtime</scope>
|
|
</dependency>
|
|
</dependencies>
|
|
```
|
|
|
|
For Gradle, add to your dependencies:
|
|
|
|
```groovy
|
|
runtimeOnly("io.opentelemetry.instrumentation:opentelemetry-log4j-appender-2.17:OPENTELEMETRY_VERSION")
|
|
```
|
|
|
|
### Usage
|
|
|
|
The following demonstrates how you might configure the appender in your `log4j.xml` configuration:
|
|
|
|
```xml
|
|
<?xml version="1.0" encoding="UTF-8"?>
|
|
<Configuration status="WARN" packages="io.opentelemetry.instrumentation.log4j.appender.v2_17">
|
|
<Appenders>
|
|
<Console name="Console" target="SYSTEM_OUT">
|
|
<PatternLayout
|
|
pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} trace_id: %X{trace_id} span_id: %X{span_id} trace_flags: %X{trace_flags} - %msg%n"/>
|
|
</Console>
|
|
<OpenTelemetry name="OpenTelemetryAppender"/>
|
|
</Appenders>
|
|
<Loggers>
|
|
<Root>
|
|
<AppenderRef ref="OpenTelemetryAppender" level="All"/>
|
|
<AppenderRef ref="Console" level="All"/>
|
|
</Root>
|
|
</Loggers>
|
|
</Configuration>
|
|
```
|
|
|
|
Next, configure `GlobalLoggerProvider` with an `SdkLoggerProvider` in your application.
|
|
|
|
```
|
|
SdkLoggerProvider sdkLoggerProvider =
|
|
SdkLoggerProvider.builder()
|
|
.setResource(Resource.create(...))
|
|
.addLogProcessor(...)
|
|
.build();
|
|
GlobalLoggerProvider.set(sdkLoggerProvider);
|
|
```
|
|
|
|
In this example Log4j2 log events will be sent to both the console appender and
|
|
the `OpenTelemetryAppender`, which will drop the logs until `GlobalLoggerProvider.set(..)` is
|
|
called. Once initialized, logs will be emitted to a `Logger` obtained from the `SdkLoggerProvider`.
|