Fix log4j2 appender docs #4985
Fix log4j2 appender docs #4985
Conversation
jack-berg
requested review from
anuraaga,
iNikem,
jkwatson,
laurit,
mateuszrzeszutek,
pavolloffay,
trask and
tylerbenson
as code owners
|
|
||
| ```xml | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <Configuration status="WARN" packages="io.opentelemetry.instrumentation.log4j.appender.v2_16"> |
There was a problem hiding this comment.
@open-telemetry/java-instrumentation-maintainers this is terrible package name, it will confuse the hell out of our users.
There was a problem hiding this comment.
I added this to Special Topics meeting agenda for tomorrow
| </Configuration> | ||
| ``` | ||
|
|
||
| Next, associate the `OpenTelemetryAppender` with a `SdkLogEmitterProvider` in your application: |
There was a problem hiding this comment.
I don't see any OpenTelemetryAppender in the example below. Maybe I don't know anything about log4j appenders, but I am confused here :)
There was a problem hiding this comment.
OpenTelemetryAppender is the name given to the appender configured in the xml snippet above.
There was a problem hiding this comment.
Yes, but this name is not present in the code. So how exactly do I "associate the OpenTelemetryAppender configured via log4j2.xml with a SdkLogEmitterProvider"? What if I use another name in log4j.xml, do I need to change my code somehow?
|
|
||
| To use it, add the module to your application's runtime classpath. | ||
|
|
||
| Replace `OPENTELEMETRY_VERSION` with the latest | ||
| stable [release](https://search.maven.org/search?q=g:io.opentelemetry). |
There was a problem hiding this comment.
| stable [release](https://search.maven.org/search?q=g:io.opentelemetry). | |
| stable [release](https://search.maven.org/search?q=g:io.opentelemetry.instrumentation). |
| To use it, add the following modules to your application's classpath. | ||
|
|
||
| Replace `OPENTELEMETRY_VERSION` with the latest | ||
| stable [release](https://search.maven.org/search?q=g:io.opentelemetry). |
There was a problem hiding this comment.
| stable [release](https://search.maven.org/search?q=g:io.opentelemetry). | |
| stable [release](https://search.maven.org/search?q=g:io.opentelemetry.instrumentation). |
|
hey @jack-berg, can you send a PR to #4915 instead? or check that your changes cover everything in that PR and I will close #4915. thx! |
Fixes the out of date docs for the
io.opentelemetry.instrumentation:opentelemetry-log4j-context-data-2.16-autoconfiguremodule, and adds docs for theio.opentelemetry.instrumentation:opentelemetry-log4j-appender-2.16module.