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.

Sign up for GitHub

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

Jump to bottom

Ensure documentation and examples reference configuration via ENV #872

Closed
Tracked by #775
ahayworth opened this issue Jul 13, 2021 · 0 comments · Fixed by #874
Closed
Tracked by #775

Ensure documentation and examples reference configuration via ENV #872

ahayworth opened this issue Jul 13, 2021 · 0 comments · Fixed by #874

Comments

@ahayworth
Copy link
Contributor

We've closed #438 with the decision that we are largely comfortable with the Configurator API at the moment; and rather than spending more energy smoothing out the remaining rough edges we will update our documentation.

Specifically we want to ensure that people use ENV variables whenever possible; they are the happy path and well-documented upstream in the API.
@ahayworth ahayworth mentioned this issue Jul 13, 2021
Closed
9 tasks
ahayworth added a commit to ahayworth/opentelemetry-ruby that referenced this issue Jul 13, 2021
@ahayworth
Update docs to rely more on environment variable configuration
4d7540a 
This PR updates our documentation in a few ways:
- Replaces some outdated configuration examples referencing a tracer factory
- Cleans up a reference to a non-existent LMDB example
- Sets the console span exporter for all current instrumentation examples
- Updates docs to reflect how to configure things via the environment whenever possible or reasonable.

Note that this means our examples may not flush to the console since the
BatchSpanProcessor is selected by default. I think this is okay,
honestly, but if it comes up we could figure out a way to select the
SimpleSpanProcessor (as some examples were doing) via the environment.

Fixes open-telemetry#872
@ahayworth ahayworth mentioned this issue Jul 13, 2021
Merged
fbogsany added a commit that referenced this issue Jul 14, 2021
@ahayworth @fbogsany
docs: Update docs to rely more on environment variable configuration (#…
f0738fa 
…874)

This PR updates our documentation in a few ways:
- Replaces some outdated configuration examples referencing a tracer factory
- Cleans up a reference to a non-existent LMDB example
- Sets the console span exporter for all current instrumentation examples
- Updates docs to reflect how to configure things via the environment whenever possible or reasonable.

Note that this means our examples may not flush to the console since the
BatchSpanProcessor is selected by default. I think this is okay,
honestly, but if it comes up we could figure out a way to select the
SimpleSpanProcessor (as some examples were doing) via the environment.

Fixes #872

Co-authored-by: Francis Bogsanyi <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update docs to rely more on environment variable configuration ahayworth/opentelemetry-ruby
1 participant
@ahayworth