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

Rename OPENTELEMETRY_COLLECTOR_CONFIG_FILE to appropriate usage #645

Closed
vasireddy99 opened this issue Apr 19, 2023 · 10 comments · Fixed by #1521
Closed

Rename OPENTELEMETRY_COLLECTOR_CONFIG_FILE to appropriate usage #645

vasireddy99 opened this issue Apr 19, 2023 · 10 comments · Fixed by #1521
Labels
bug Something isn't working

Comments

@vasireddy99
Copy link
Contributor

Currently OPENTELEMETRY_COLLECTOR_CONFIG_FILE is a environment variable used to set the config file from any of the config map providers such as http, s3, yaml. etc., as per the naming convention it is not exactly a file as the input to this variable could be URI format example here. Hence creating this issue to see if this can be renamed to OPENTELEMETRY_COLLECTOR_CONFIG instead.

@vasireddy99 vasireddy99 added the bug Something isn't working label Apr 19, 2023
@Aneurysm9
Copy link
Member

I would suggest using OPENTELEMETRY_COLLECTOR_CONFIG_URI as the name of the variable to hold a URI pointing to a collector config.

We should ensure that we continue to support the prior variable for some period of time as a fallback if the new variable is not populated. We should emit a warning into the logs if the old variable is used.

Copy link

github-actions bot commented May 5, 2024

This issue was marked stale. It will be closed in 30 days without additional activity.

@github-actions github-actions bot added the Stale label May 5, 2024
Copy link

github-actions bot commented Jun 9, 2024

Closed as inactive. Feel free to reopen if this issue is still relevant.

@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Jun 9, 2024
@gshpychka
Copy link
Contributor

Still relevant. The name cause some confusion for me initially.

@tylerbenson
Copy link
Member

Certainly open to PRs if someone wants to contribute this change. LMK and I can reopen the issue.

@gshpychka
Copy link
Contributor

Certainly open to PRs if someone wants to contribute this change. LMK and I can reopen the issue.

Would the original name have to be kept for backwards compatibility?

@tylerbenson
Copy link
Member

Assuming that would not be difficult, I'd say yes.

@gshpychka
Copy link
Contributor

Assuming that would not be difficult, I'd say yes.

What's the process for deprecating env vars in this case?

@tylerbenson
Copy link
Member

We don't have any documented process. I would mainly suggest remove it from the documentation so people start using the new one going forward.

@gshpychka
Copy link
Contributor

@tylerbenson can you reopen this issue so that it can be properly closed as complete if/when my PR is merged?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
4 participants