Skip to content
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

Open
pellared opened this issue Jul 21, 2023 · 5 comments · May be fixed by #981
Open

Document supported environment variables #229

pellared opened this issue Jul 21, 2023 · 5 comments · May be fixed by #981
Labels
documentation Improvements or additions to documentation

Comments

@pellared
Copy link
Member

pellared commented Jul 21, 2023

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
  • 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 (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)
@pellared pellared added the documentation Improvements or additions to documentation label Jul 21, 2023
@MA3CIN
Copy link
Contributor

MA3CIN commented Mar 17, 2024

Bump - As a new user, this is still very much needed. Perhaps some info could be added in the "Configuration" section of the README?

@damemi
Copy link
Contributor

damemi commented Apr 1, 2024

Also from #233:

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

Remember to also document config which comes from the dependencies e.g. https://github.com/open-telemetry/opentelemetry-go/tree/main/exporters/otlp/otlptrace#environment-variables

@MrAlias MrAlias assigned MrAlias and pellared and unassigned MrAlias Apr 9, 2024
@pellared pellared removed their assignment Jul 26, 2024
@pellared pellared changed the title Document the scope of automatic instrumentation Document configuration of automatic instrumentation Jul 26, 2024
@pellared pellared changed the title Document configuration of automatic instrumentation Document supported environment variables Jul 26, 2024
@pellared
Copy link
Member Author

@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?

@MrAlias
Copy link
Contributor

MrAlias commented Jul 30, 2024

Looks like a good starting point to me 👍

@MrAlias
Copy link
Contributor

MrAlias commented Jul 30, 2024

On second thought, we don't handle any events. No need to document those conf opts.

@pauljwil pauljwil linked a pull request Jul 31, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Development

Successfully merging a pull request may close this issue.

4 participants