Refactor java SDK and configuration #4966
Conversation
|
Corresponding PR with supporting code snippets: open-telemetry/opentelemetry-java-examples#455 |
| the SDK. For an exhaustive set of the available configuration APIs, consult the | ||
| code. | ||
|
|
||
| ## Zero-code SDK autoconfigure |
There was a problem hiding this comment.
the term zero-code already has a meaning: https://opentelemetry.io/docs/concepts/instrumentation/zero-code/
maybe "declarative"?
There was a problem hiding this comment.
I'm trying to rebrand file configuration as "declarative configuration" here: open-telemetry/opentelemetry-specification#4128
Since SDK autoconfigure combines environment variable / system property configuration AND declarative configuration in one module, calling it "declarative configuration" is probably not a great name.
Maybe just "SDK autoconfigure"? Also open to other ideas..
|
Thanks for the reviews @theletterf, @zeitlinger! |
|
Finally, I found some time to take a look, but I see already that @theletterf , @jaydeluca and @zeitlinger are providing reviews and great feedback! Awesome work, looking forward to see this land. |
chalin
force-pushed
the
refactor-java-configuration
branch
from
fe84b47
to
a53743d
Compare
|
@svrnm any items I need to followup on that I'm missing? |
there seems to be a merge conflict, beyond that I would hope for some more reviews from Docs & Java (@theletterf needs to verify the changes requested) |
…y.io into refactor-java-configuration
Not sure what happened here |
Yeah I don't know either. I can recreate it locally but can't figure out the cause. |
|
let me take a look |
|
this seems to be an issue related to the localizations effort. I can not explain why, but since there is a chinese translation of the Java index page, this is failing. If you update that file the issue goes away: diff --git a/content/zh/docs/languages/java/_index.md b/content/zh/docs/languages/java/_index.md
index e6c54318..fa112b3e 100644
--- a/content/zh/docs/languages/java/_index.md
+++ b/content/zh/docs/languages/java/_index.md
@@ -9,6 +9,7 @@ cascade:
instrumentation: 2.7.0
otel: 1.41.0
semconv: 1.26.0
+ contrib: 1.38.0I think as a workaround we can do that, but we might need to revisit how we store those versions |
Signed-off-by: svrnm <neumanns@cisco.com>
|
Made it work again, using the changes as suggested above. @open-telemetry/java-approvers @open-telemetry/docs-approvers PTAL! Would be great to ship this if there are no more major objections :-) |
…y.io into refactor-java-configuration
| otel: 1.42.1 | ||
| contrib: 1.38.0 | ||
| semconv: 1.27.0 |
There was a problem hiding this comment.
@open-telemetry/docs-maintainers - a reminder that an en PR shouldn't be updating non-en pages.
This is the first PR in what will be a multi-step reworking of the Java docs, as discussed in #4853 and the related doc.
Disclaimer: Refactoring docs iteratively is difficult because its hard to know where to stop. Docs develop organically over time and end with lots of interlinking and little warnings which get in the way of refactoring. For this PR, the scope I targeted was the "SDK", but this leaked into "SDK configuration" because the two are so tightly connected. It also leaked into the "Instrumentation" page which often talks about the SDK through conflated responsibilities. It also leaked into the standalone "Resources", "Exporters", and "Samplers" pages since these are SDK concepts.
What does this PR do?
There is lot of content in this PR, but the principles are simple and scalable. The quantity of content reflects the essential complexity of the project, and is required in order for completeness. I recommend reviewing by looking at the rendered website.
I have future PRs planned for:
cc @open-telemetry/java-approvers, @open-telemetry/java-instrumentation-approvers
Preview: https://deploy-preview-4966--opentelemetry.netlify.app/docs/languages/java/