Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update log4j instrumentation docs #4915

Merged
merged 9 commits into from
Jan 5, 2022
Merged

Update log4j instrumentation docs #4915

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
02db90a
Update log4j instrumentation docs for 1.10.0 release
trask Dec 16, 2021
2656939
Merge remote-tracking branch 'upstream/main' into update-log4j-librar…
trask Dec 17, 2021
0fd1e72
More log4j doc changes for 0.10.0
trask Dec 17, 2021
2140821
Merge remote-tracking branch 'upstream/main' into update-log4j-librar…
trask Dec 18, 2021
9d860eb
Updates for #4937
trask Dec 18, 2021
76565eb
Fix log4j documentation
jack-berg Jan 3, 2022
8cbacd4
Update instrumentation/log4j/log4j-2.16/library/README.md
trask Jan 3, 2022
c0fac23
Merge pull request #36 from jack-berg/update-log4j2-docs
trask Jan 3, 2022
5dcc00b
Merge remote-tracking branch 'upstream/main' into update-log4j-librar…
trask Jan 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/standalone-library-instrumentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ that can be used if you prefer that over using the Java agent:
* [Guava](../instrumentation/guava-10.0/library)
* [JDBC](../instrumentation/jdbc/library)
* [Lettuce](../instrumentation/lettuce/lettuce-5.1/library)
* [Log4j](../instrumentation/log4j/log4j-2.13.2/library)
* [Log4j](../instrumentation/log4j/log4j-2.16/library)
* [Logback](../instrumentation/logback-1.0/library)
* [MongoDB Driver](../instrumentation/mongo/mongo-3.1/library)
* [OkHttp](../instrumentation/okhttp/okhttp-3.0/library)
Expand Down
12 changes: 3 additions & 9 deletions instrumentation/log4j/log4j-2.13.2/library-autoconfigure/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ To use it, add the module to your application's runtime classpath.
<dependencies>
<dependency>
<groupId>io.opentelemetry.instrumentation</groupId>
<artifactId>opentelemetry-log4j-2.13.2</artifactId>
<version>0.17.0-alpha</version>
<artifactId>opentelemetry-log4j-2.16</artifactId>
<version>1.10.0-alpha</version>
<scope>runtime</scope>
</dependency>
</dependencies>
Expand All @@ -22,7 +22,7 @@ To use it, add the module to your application's runtime classpath.

```kotlin
dependencies {
runtimeOnly("io.opentelemetry.instrumentation:opentelemetry-log4j-2.13.2:0.17.0-alpha")
runtimeOnly("io.opentelemetry.instrumentation:opentelemetry-log4j-2.16:1.10.0-alpha")
}
```

Expand All @@ -32,12 +32,6 @@ dependencies {
trace ID and span ID from an active span into
Log4j's [context data](https://logging.apache.org/log4j/2.x/manual/thread-context.html).

**Note**: Depending on your application, you may run into
a [critical bug](https://issues.apache.org/jira/browse/LOG4J2-2838)
with Log4j 2.13.2. If log messages show a `NullPointerException` when adding this instrumentation,
please update to 2.13.3 or higher. The only change between 2.13.2 and 2.13.3 is the fix to this
issue.

Log4j will automatically pick up the integration when you include this module. The following keys
will be added to the context when a log statement is made when a span is active:

Expand Down