-
Notifications
You must be signed in to change notification settings - Fork 77
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Document supported environment variables #229
Comments
Bump - As a new user, this is still very much needed. Perhaps some info could be added in the "Configuration" section of the README? |
Also from #233:
|
@open-telemetry/go-instrumentation-maintainers, can you double-check if I have not missed any important reference in the issue description? Should someone wanting to document all env vars be able to find all env vars? |
Looks like a good starting point to me 👍 |
On second thought, we don't handle any events. No need to document those conf opts. |
We should have a dedicated page with all possible configuration settings. Example from .NET Automatic Instrumentation: https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/blob/main/docs/config.md
Here is how we can find some env vars coming from this repo: https://github.com/search?q=repo%3Aopen-telemetry%2Fopentelemetry-go-instrumentation%20%22OTEL_&type=code
We need to remember to also document config which comes from the dependencies e.g.
I think these env vars are supported as well (documentation for these env vars: https://opentelemetry.io/docs/specs/otel/configuration/sdk-environment-variables/):
OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT
OTEL_SPAN_ATTRIBUTE_VALUE_LENGTH_LIMIT
OTEL_SPAN_EVENT_COUNT_LIMIT
OTEL_SPAN_LINK_COUNT_LIMIT
OTEL_EVENT_ATTRIBUTE_COUNT_LIMIT
OTEL_LINK_ATTRIBUTE_COUNT_LIMIT
(IMO it is better not to document this env var as it is not documented in OTel Go SDK also other env vars offer more fine-grained control)OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT
(IMO it is better not to document this env var as it is not documented in OTel Go SDK also other env vars offer more fine-grained control)OTEL_ATTRIBUTE_COUNT_LIMIT
The text was updated successfully, but these errors were encountered: