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

Improvement of agent and collector tags documentation #519

Open
pbdger opened this issue Aug 10, 2021 · 1 comment
Open

Improvement of agent and collector tags documentation #519

pbdger opened this issue Aug 10, 2021 · 1 comment

Comments

@pbdger
Copy link

pbdger commented Aug 10, 2021

Improvement of agent and collector tags documentation

Problem - what in Jaeger blocks you from solving the requirement?

There is no description in the CLI documentation (https://www.jaegertracing.io/docs/1.25/cli/) that environment variables and their value can also be accessed for the agent and collector tags.

The deployment documentation (https://www.jaegertracing.io/docs/1.25/deployment/#agent-level-tags) describes this feature.

I suggest to include this feature documentation in the CLI documentation as well. Alternatively, you could also link to the deployment documentation in the CLI documentation.

@albertteoh
Copy link
Contributor

@pbdger, I believe the CLI docs are intentionally meant to be quite general and apply to all CLI parameters.

https://www.jaegertracing.io/docs/1.25/deployment/#agent-level-tags provides guidance on a capability that is specific to the --agent.tags flag, i.e. making environment variables accessible from a flag value.

As such, I think the documentation here is appropriate unless if I misunderstood something and if so, please provide a PR and we can discuss your suggestion there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants