Encapsulate logging #6543
Merged
Encapsulate logging #6543
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mateuszrzeszutek
force-pushed
the
encapsulate-logging
branch
from
00b2fa7
to
fdb68c1
Compare
trask
approved these changes
Sep 8, 2022
Comment on lines
-17
to
-18
| // Prevents conflict with other SLF4J instances. Important for premain. | ||
| relocate("org.slf4j", "io.opentelemetry.javaagent.slf4j") |
| @@ -92,12 +92,12 @@ class JavaagentTestArgumentsProvider( | |||
| "-Dotel.metrics.exporter=otlp", | |||
| // suppress repeated logging of "No metric data to export - skipping export." | |||
| // since PeriodicMetricReader is configured with a short interval | |||
| "-Dio.opentelemetry.javaagent.slf4j.simpleLogger.log.io.opentelemetry.sdk.metrics.export.PeriodicMetricReader=INFO", | |||
| "-Dio.opentelemetry.javaagent.logging.simple.slf4j.simpleLogger.log.io.opentelemetry.sdk.metrics.export.PeriodicMetricReader=INFO", | |||
javaagent-tooling/src/main/java/io/opentelemetry/javaagent/tooling/AgentStarterImpl.java
Outdated
Show resolved
Hide resolved
|
|
||
| // org.slf4j package name in the constants will be shaded too |
Comment on lines
+42
to
+43
| // trigger loading the provider from the agent CL | ||
| LoggerFactory.getILoggerFactory(); |
There was a problem hiding this comment.
do we still need to trigger loading?
There was a problem hiding this comment.
Yes, probably - the first usage of any slf4j API method causes it to load the actual implementation using SPI; and since it uses the context CL, it might not find the actual implementation. It's safer to just pre-load it here.
...ogging-simple/src/main/java/io/opentelemetry/javaagent/logging/simple/Slf4jSimpleLogger.java
Outdated
Show resolved
Hide resolved
Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>
laurit
reviewed
Sep 9, 2022
| mergeServiceFiles() | ||
|
|
||
| // Prevents configuration naming conflict with other SLF4J instances | ||
| relocate("org.slf4j", "io.opentelemetry.javaagent.logging.simple.slf4j") |
There was a problem hiding this comment.
it might be better to continue using io.opentelemetry.javaagent.slf4j as there are people who are using stuff like -Dio.opentelemetry.javaagent.slf4j.simpleLogger.defaultLogLevel=off and -Dio.opentelemetry.javaagent.slf4j.simpleLogger.logFile=...
There was a problem hiding this comment.
Hm, you're right. I dislike the fact that we're exposing the javaagent internals this way, but since we don't have a better logging story I suppose it is a necessity for now. I'll revert to the previous package name.
LironKS
pushed a commit
to helios/opentelemetry-java-instrumentation
that referenced
this pull request
Oct 23, 2022
* Encapsulate actual logging implementation better * Apply suggestions from code review Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com> * code review comments * revert to the old slf4j package name * spotless Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>
LironKS
pushed a commit
to helios/opentelemetry-java-instrumentation
that referenced
this pull request
Oct 31, 2022
* Encapsulate actual logging implementation better * Apply suggestions from code review Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com> * code review comments * revert to the old slf4j package name * spotless Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>
LironKS
pushed a commit
to helios/opentelemetry-java-instrumentation
that referenced
this pull request
Dec 4, 2022
* Encapsulate actual logging implementation better * Apply suggestions from code review Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com> * code review comments * revert to the old slf4j package name * spotless Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Depends on #6499
This PR introduces a new
javaagent-internal-logging-simplemodule that encapsulates the logging implementation completely (well, almost, except for a couple of tests). Slf4j is removed from bootstrap dependencies, shading relocation lists, and from the agent's "public" (as in, publicly accessible) space.