Example of Log Appenders when using OpenTelemetry JavaAgent #503

smoke · 2024-10-10T09:19:49Z

No description provided.

smoke · 2024-10-11T07:58:22Z

Such example was useful for me to explore how the log appending works when using JavaAgent and how to properly configure them.
I was under the impression logger xml files can be used to configure them accordingly, but this is not the case.

My final goal was to achieve ability to control from properties and env vars the Logs Sending and Level.
There is my PoC implementation smoke#1 that allows usage of these env vars or system properties defined in log4j2.xml:

LOG_LEVEL env var or logLevel property - controls the log4j2 Root (and inherited) loggers
level
OTEL_X_LOG_SENDING_DISABLED env var or otel.x.log_sending.disabled property - set to "true" to fully disable the
OpenTelemetryAppender
OTEL_X_LOG_SENDING_LEVEL env var or otel.x.log_sending.level property - defaults to "all", set to relevant log4j2 Level
(off, fatal, error, warn, info, debug, trace, all) to additionally filter what goes to Otel Collector

jeanbisutti

Thank you for this PR.

I have added comments.

This documentation link could perhaps be added: https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/instrumentation/logback/logback-appender-1.0/javaagent/README.md

jeanbisutti · 2024-10-14T10:39:22Z

javaagent-log-appender/README.md

+```shell
+export \
+OTEL_SERVICE_NAME=log4j-example \
+OTEL_EXPORTER_OTLP_PROTOCOL=grpc \


The Java agent uses http/protobuf by default. Perhaps this example could use the default protocol as the Java agent example is doing, and a new example could be created to illustrate the gprc usage.

http/protobuf is also the recommended default in the spec. Would prefer to use that over grpc.

This is addressed in the follow-up changes.

jeanbisutti · 2024-10-14T10:45:39Z

javaagent-log-appender/README.md

+* 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 application does not use the OpenTelemetry Log4j Appender library but the Java agent out-of-the-box instrumentation for Log4j.

jeanbisutti · 2024-10-14T10:46:15Z

javaagent-log-appender/README.md

+    the [OpenTelemetry Log4J Appender](https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/instrumentation/log4j/log4j-appender-2.17/library/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 application does not use the OpenTelemetry Logback Appender library but the Java agent out-of-the-box instrumentation for Logback.

… metrics

…operties JavaAgent instrumentation of Log Appenders does not respect logger configs like `log4j2.xml` or `logback.xml` as it uses direct patching of loggers to do the same and no appenders set in the loggers.

refs open-telemetry#503 (comment)

refs open-telemetry#503 (comment) refs open-telemetry#503 (comment)

smoke · 2024-10-17T11:01:51Z

@jeanbisutti Thanks for your review! I have made changes to address your remarks, please re-review.

jeanbisutti · 2024-10-18T09:25:35Z

javaagent-log-appender/build.gradle.kts

+    mainClass = "io.opentelemetry.example.logappender.Application"
+}
+
+


Suggested change

jeanbisutti · 2024-10-18T09:28:35Z

javaagent-log-appender/README.md

+* 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/javaagent/README.md).


I don't follow what it means.
Is it needed?

Yes, it is needed, I have clarified it further.

jeanbisutti · 2024-10-18T09:28:45Z

javaagent-log-appender/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/javaagent/README.md).


I don't follow what it means.
Is it needed?

Yes, it is needed, I have clarified it further.

jeanbisutti · 2024-10-18T09:36:31Z

javaagent-log-appender/otel-config.yaml

+receivers:
+  otlp:
+    protocols:
+      grpc:


Lines 4 and 5 don't seem necessary

They are needed as I opted to provide optional support for grpc protocol https://github.com/open-telemetry/opentelemetry-java-examples/pull/503/files#diff-1b2f929f45fbea4950cb70b3a03c0c515e5821085c60c298d741be2822967f9eR53-R56

refs https://github.com/open-telemetry/opentelemetry-java-examples/pull/503/files#r1806183086

refs https://github.com/open-telemetry/opentelemetry-java-examples/pull/503/files#r1806187111 refs https://github.com/open-telemetry/opentelemetry-java-examples/pull/503/files#r1806187339

jeanbisutti · 2024-10-18T13:57:55Z

javaagent-log-appender/README.md

+  * Log4j API [configured](./src/main/resources/log4j2.xml) to print logs to the
+    console and
+    the OpenTelemetry Java Agent brings built-in
+    [OpenTelemetry Log4J Appender](https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/instrumentation/log4j/log4j-appender-2.17/javaagent/README.md).


It's not really a built-in appender:https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/3c32c6a8ff00443d2099afd75e054f530b1e84a7/instrumentation/log4j/log4j-appender-2.17/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/log4j/appender/v2_17/Log4jAppenderInstrumentation.java#L33

I would say the "Java agent out-of-the-box instrumentation for Log4j"

jeanbisutti · 2024-10-18T13:59:15Z

javaagent-log-appender/README.md

+  * SLF4J API [configured with Logback](./src/main/resources/logback.xml) to
+    print logs to the console and
+    the OpenTelemetry Java Agent brings built-in
+    [OpenTelemetry Logback Appender](https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/instrumentation/logback/logback-appender-1.0/javaagent/README.md).


It's not a built-in appender: https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/3c32c6a8ff00443d2099afd75e054f530b1e84a7/instrumentation/logback/logback-appender-1.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/logback/appender/v1_0/LogbackInstrumentation.java#L29

I would say the "Java agent out-of-the-box instrumentation for Logback"

smoke requested review from a team as code owners October 10, 2024 09:19

smoke marked this pull request as draft October 10, 2024 14:37

smoke marked this pull request as ready for review October 11, 2024 07:57

smoke force-pushed the example/javaagent-log4j2-appender branch from ec6b8fa to b4beac8 Compare October 11, 2024 07:59

jeanbisutti reviewed Oct 14, 2024

View reviewed changes

smoke added 6 commits October 17, 2024 13:59

feat(javaagent-log-appender): otel collector pipelines for traces and…

cbe87ab

… metrics

feat(javaagent-log-appender): switch to javaagent

8d834aa

feat(javaagent-log-appender): split javaagent-log-appender package

55a3557

feat(javaagent-log-appender): transfer appender settings to system pr…

0997ec5

…operties JavaAgent instrumentation of Log Appenders does not respect logger configs like `log4j2.xml` or `logback.xml` as it uses direct patching of loggers to do the same and no appenders set in the loggers.

chore: support and use the default http/protobuf protocol

8daa9fe

refs open-telemetry#503 (comment)

chore: update readme to outline properly the example

da88e35

refs open-telemetry#503 (comment) refs open-telemetry#503 (comment)

smoke force-pushed the example/javaagent-log4j2-appender branch from b4beac8 to da88e35 Compare October 17, 2024 10:59

smoke requested a review from jeanbisutti October 17, 2024 11:00

jeanbisutti reviewed Oct 18, 2024

View reviewed changes

smoke added 2 commits October 18, 2024 15:18

chore: remove empty line

cfe4157

refs https://github.com/open-telemetry/opentelemetry-java-examples/pull/503/files#r1806183086

chore: update readme to clarify appenders

ff05f0d

refs https://github.com/open-telemetry/opentelemetry-java-examples/pull/503/files#r1806187111 refs https://github.com/open-telemetry/opentelemetry-java-examples/pull/503/files#r1806187339

smoke requested a review from jeanbisutti October 18, 2024 12:22

jeanbisutti reviewed Oct 18, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Example of Log Appenders when using OpenTelemetry JavaAgent #503

Example of Log Appenders when using OpenTelemetry JavaAgent #503

smoke commented Oct 10, 2024

smoke commented Oct 11, 2024 •

edited

Loading

jeanbisutti left a comment

jeanbisutti Oct 14, 2024

breedx-splk Oct 21, 2024

smoke Oct 22, 2024

jeanbisutti Oct 14, 2024

jeanbisutti Oct 14, 2024

smoke commented Oct 17, 2024 •

edited

Loading

jeanbisutti Oct 18, 2024

jeanbisutti Oct 18, 2024

smoke Oct 18, 2024

jeanbisutti Oct 18, 2024

smoke Oct 18, 2024

jeanbisutti Oct 18, 2024

smoke Oct 18, 2024

jeanbisutti Oct 18, 2024

jeanbisutti Oct 18, 2024

		mainClass = "io.opentelemetry.example.logappender.Application"
		}

Example of Log Appenders when using OpenTelemetry JavaAgent #503

Are you sure you want to change the base?

Example of Log Appenders when using OpenTelemetry JavaAgent #503

Conversation

smoke commented Oct 10, 2024

smoke commented Oct 11, 2024 • edited Loading

jeanbisutti left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

smoke commented Oct 17, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

smoke commented Oct 11, 2024 •

edited

Loading

smoke commented Oct 17, 2024 •

edited

Loading