Update the agent-config docs. #2551
Merged
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
This provides more direct linking to the auto-instrumentation docs that people might need.
jkwatson
requested review from
anuraaga,
iNikem,
mateuszrzeszutek,
pavolloffay,
trask and
tylerbenson
as code owners
breedx-splk
approved these changes
Mar 10, 2021
docs/agent-config.md
Outdated
| Here are some quick links into those docs for the configuration options for specific portions of the SDK & agent: | ||
|
|
||
| * [Exporters](#exporters) | ||
| + [OTLP exporter (both span and metric exporters)](https://github.com/open-telemetry/opentelemetry-java/tree/v1.0.0/sdk-extensions/autoconfigure/README.md#otlp-exporter-both-span-and-metric-exporters) |
There was a problem hiding this comment.
Hmmm...I'm not convinced that linking to the specific version (instead of main branch) is a good idea. Can you convince me?
There was a problem hiding this comment.
I have no idea...it's what was linked to in this document, so I stuck with it.
There was a problem hiding this comment.
updated to point at main
added 2 commits
March 10, 2021 14:19
trask
reviewed
Mar 11, 2021
docs/agent-config.md
Outdated
Comment on lines
47
to
62
| ## Customizing the OpenTelemetry SDK | ||
|
|
||
| *Customizing the SDK is highly advanced behavior and is still in the prototyping phase. It may change drastically or be removed completely. Use | ||
| with caution* | ||
|
|
||
| The OpenTelemetry SDK exposes SPI [hooks](https://github.com/open-telemetry/opentelemetry-java/tree/main/sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/spi) | ||
| for customizing its behavior, such as the `Resource` attached to spans or the `Sampler`. | ||
|
|
||
| Because the automatic instrumentation runs in a different classpath than the instrumented application, it is not possible for customization in the application to take advantage of this customization. In order to provide such customization, you can provide the path to a JAR file, including an SPI implementation using the system property `otel.initializer.jar`. Note that this JAR needs to shade the OpenTelemetry API in the same way as the agent does. The simplest way to do this is to use the same shading configuration as the agent from [here](https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/cfade733b899a2f02cfec7033c6a1efd7c54fd8b/java-agent/java-agent.gradle#L39). In addition, you must specify the `io.opentelemetry.javaagent.shaded.io.opentelemetry.api.trace.spi.TraceProvider` to the name of the class that implements the SPI. |
There was a problem hiding this comment.
I think this section is still relevant (though maybe too advanced for main agent config page, and scheduled to change a bit in #2442)
There was a problem hiding this comment.
yeah, I missed this line. I think we should remove it from this page, since it's not relevant for normal end-users and will probably confuse most people who are the target audience.
docs/agent-config.md
Outdated
| Here are some quick links into those docs for the configuration options for specific portions of the SDK & agent: | ||
|
|
||
| * [Exporters](#exporters) | ||
| + [OTLP exporter (both span and metric exporters)](https://github.com/open-telemetry/opentelemetry-java/tree/v1.0.0/sdk-extensions/autoconfigure/README.md#otlp-exporter-both-span-and-metric-exporters) |
…el-java repo docs
mateuszrzeszutek
approved these changes
Mar 11, 2021
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.
This provides more direct linking to the auto-instrumentation docs that people might need.
Mainly, it reduces by one the number of links that a user might have to click to get to what they need.