Skip to content
This repository has been archived by the owner on May 23, 2024. It is now read-only.

Doc: add a clearly visible note to create a cfg via FromEnv() if env vars should be active to the readme #517

Closed
Lercher opened this issue Jun 6, 2020 · 1 comment · Fixed by #518

Comments

@Lercher
Copy link
Contributor

Lercher commented Jun 6, 2020

Requirement - what kind of business use case are you trying to solve?

Using configuration environment variables as documented is only active if the configuration object is initialized in a special way.

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

The section explaining the vars has no clearly visible note that it depends on initializing the cfg object by FromEnv and this can be overlooked easily. Moreover the examples in the code file mentioned start with a method that ignores env vars.

Proposal - what do you suggest to solve the problem or improve the existing situation?

Add to the first sentence in https://github.com/jaegertracing/jaeger-client-go#environment-variables something like: ... if the tracer is created from a configuration object that was created via FromEnv() or via ...

Any open questions to address

The godoc for all configuration fields states the env var to be active without a condition, i.e. without referencing to FromEnv. Is it helpful to add such hints?

@yurishkuro
Copy link
Member

feel free to propose a PR

Lercher added a commit to Lercher/jaeger-client-go that referenced this issue Jun 6, 2020
…elds that can be initialized from env vars.
Lercher added a commit to Lercher/jaeger-client-go that referenced this issue Jun 6, 2020
…nitialized from env vars. jaegertracing#517

Signed-off-by: Martin LERCHER <martin.lercher@soprabanking.com>
# for free to subscribe to this conversation on GitHub. Already have an account? #.
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants