Skip to content

Commit

Permalink
chore: update readme to outline properly the example
Browse files Browse the repository at this point in the history
  • Loading branch information
smoke committed Oct 17, 2024
1 parent 8daa9fe commit da88e35
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions javaagent-log-appender/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# OpenTelemetry Log Appender Example
# OpenTelemetry Log Appender built-in OpenTelemetry Java Agent Example

This example demonstrates an application configured to use the OpenTelemetry Log
Appenders to bridge logs into the OpenTelemetry Log SDK, and export
Appenders built-in OpenTelemetry Java Agent to bridge logs into the OpenTelemetry Log SDK, and export
via [OTLP](https://opentelemetry.io/docs/reference/specification/protocol/otlp/).

Details about the example:
Expand All @@ -12,10 +12,10 @@ Details about the example:
* The application is configured with a variety of log solutions:
* Log4j API [configured](./src/main/resources/log4j2.xml) to print logs to the
console and
the [OpenTelemetry Log4J Appender](https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/instrumentation/log4j/log4j-appender-2.17/library/README.md).
the [OpenTelemetry Log4J Appender](https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/instrumentation/log4j/log4j-appender-2.17/javaagent/README.md).
* SLF4J API [configured with Logback](./src/main/resources/logback.xml) to
print logs to the console and
the [OpenTelemetry Logback Appender](https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/instrumentation/logback/logback-appender-1.0/library/README.md).
the [OpenTelemetry Logback Appender](https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/instrumentation/logback/logback-appender-1.0/javaagent/README.md).
* [JUL to SLF4J](./build.gradle.kts), which bridges JUL logs to the SLF4J API, and
ultimately to Logback.
* Demonstrates how trace context is propagated to logs when recorded within a
Expand Down

0 comments on commit da88e35

Please sign in to comment.