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

Clarify the SDK environment variables requirement #1193

Open
carlosalberto opened this issue Nov 4, 2020 · 3 comments
Open

Clarify the SDK environment variables requirement #1193

carlosalberto opened this issue Nov 4, 2020 · 3 comments
Labels
area:sdk Related to the SDK priority:p2 Medium priority level release:allowed-for-ga Editorial changes that can still be added before GA since they don't require action by SIGs spec:miscellaneous For issues that don't match any other spec label

Comments

@carlosalberto
Copy link
Contributor

We need to clarify the expectations for the SDK environment variables, as some of them are meant to be supported, GA-wise, only for auto-instrumentation (although the plan is to support them in the SDKs directly after GA). Examples of them are OTEL_TRACE_SAMPLER and OTEL_PROPAGATORS.

@cijothomas left this comment in #1190 which can be used as inspiration 😉

SDKs MAY choose to allow configuration via the environment variables in this specification, but are not required to. If they do, they SHOULD use the names listed in this document.

@carlosalberto carlosalberto added area:sdk Related to the SDK spec:miscellaneous For issues that don't match any other spec label priority:p2 Medium priority level release:allowed-for-ga Editorial changes that can still be added before GA since they don't require action by SIGs labels Nov 4, 2020
@anuraaga
Copy link
Contributor

anuraaga commented Nov 4, 2020

I've been wondering about this in the other direction - why have env variables only for auto instrumentation? SDK may as well support them for non-auto users I guess. In Java I've been wanting to move a lot of the initialization logic to SDK since it seems like a small change with big benefit to SDK users.

@Oberon00
Copy link
Member

Oberon00 commented Nov 4, 2020

In Java I've been wanting to move a lot of the initialization logic to SDK since it seems like a small change with big benefit to SDK users.

It may also be a security issue if your app suddenly starts exporting telemetry because some environment variables are set, especially if it did not do so before.

@Oberon00
Copy link
Member

Oberon00 commented Nov 4, 2020

I would thus prefer:

SDKs MUST NOT use any environment information automatically. SDKs MAY implement a way to request auto-configuration based on environment variables. If they do, they SHOULD use the names listed in this document.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:sdk Related to the SDK priority:p2 Medium priority level release:allowed-for-ga Editorial changes that can still be added before GA since they don't require action by SIGs spec:miscellaneous For issues that don't match any other spec label
Projects
None yet
Development

No branches or pull requests

3 participants