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

OpenTelemetry docs should talk only about instrumenting, and not about sdk or exporters. #1256

Closed
cijothomas opened this issue Sep 8, 2023 · 1 comment · Fixed by #1278
Closed
Labels
A-common Area:common issues that not related to specific pillar documentation/examples Improvements or additions to documentation or examples

Comments

@cijothomas
Copy link
Member

OpenTelemetry crate has dev-dependencies on the SDK/stdout crates as they are demonstrated in the docs.

Proposing to remove that dependency, and modify the doc to only show the API usage, without showing anything related to SDK/Exporters. We should say something like "For the telemetry to be exported, need to install additional crates and point to them", so users are aware that OpenTelemetry crate alone is just the facade which does nothing in the absence of further setup.

This approach is used in https://docs.rs/tracing/latest/tracing/ docs already - it just talks about the tracing facade there, and lists the tracing-subscriber/other crates that are required for the traces to land somewhere.

Similar change is done in #1249. There could be more places, but want to get general feedback on this proposal before further cleanups.

@cijothomas cijothomas added documentation/examples Improvements or additions to documentation or examples A-common Area:common issues that not related to specific pillar labels Sep 8, 2023
@shaun-cox
Copy link
Contributor

Yep, I'm favor of this approach too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-common Area:common issues that not related to specific pillar documentation/examples Improvements or additions to documentation or examples
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants