Rewrite readme page for opentelemetry crate #1586
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1586 +/- ##
=====================================
Coverage 67.3% 67.3%
=====================================
Files 138 138
Lines 19355 19355
=====================================
Hits 13029 13029
Misses 6326 6326 ☔ View full report in Codecov by Sentry. |
| also aligned with the design philosophy of existing telemetry solutions in the | ||
| Rust ecosystem, like `tracing` or `log`, where these crates only offer a facade | ||
| and the actual functionality is enabled through additional crates. | ||
|
|
There was a problem hiding this comment.
It would be good to add a reference to the registry https://opentelemetry.io/ecosystem/registry/?language=rust for Exporters, Propagator, Instrumentation, and more.
I took the liberty to add the missing elements this morning open-telemetry/opentelemetry.io#4062
There was a problem hiding this comment.
Thanks!
I am going to skip that suggestion in this PR, and add it next. I am still thinking what is the best way to ensure success - simply linking to registry won't necessarily help much unless the user is already familiar with OTel space.
Will come back to this.
https://crates.io/crates/opentelemetry The description shown in the crates page is very generic, so this PR is trying to make it crate specific. Not adding examples/getting-started, as it is probably better to stay in docs.rs.
If the direction is good, will fix every other crate (over time...)