diff --git a/README.md b/README.md index 9de93acfe745..de340608d79a 100644 --- a/README.md +++ b/README.md @@ -81,7 +81,7 @@ configured to send data to at `http://localhost:4317`. Configuration parameters are passed as Java system properties (`-D` flags) or -as environment variables. See [the configuration documentation][config] +as environment variables. See [the configuration documentation][config-agent] for the full list of configuration items. For example: ``` @@ -93,11 +93,14 @@ java -javaagent:path/to/opentelemetry-javaagent.jar \ ## Configuring the Agent -The agent is [highly configurable][config]! Many aspects of the agent's behavior can be +The agent is highly configurable! Many aspects of the agent's behavior can be configured for your needs, such as exporter choice, exporter config (like where data is sent), trace context propagation headers, and much more. -[Click here to see the detailed list of configuration environment variables and system properties][config]. +For a detailed list of agent configuration options, see the [agent configuration docs][config-agent]. + +For a detailed list of additional SDK configuration environment variables and system properties, +see the [SDK configuration docs][config-sdk]. *Note: Config parameter names are very likely to change over time, so please check back here when trying out a new version! @@ -183,7 +186,9 @@ Thanks to all the people who already contributed! -[config]: https://opentelemetry.io/docs/instrumentation/java/automatic/agent-config/ +[config-agent]: https://opentelemetry.io/docs/zero-code/java/agent/configuration/ + +[config-sdk]: https://opentelemetry.io/docs/languages/java/configuration/ [manual]: https://opentelemetry.io/docs/instrumentation/java/manual/