Skip to content

docs: start doc for distributed tracing and logs guidance#3122

Open
cijothomas wants to merge 11 commits into
open-telemetry:mainfrom
cijothomas:cijothomas/dt-guidnace
Open

docs: start doc for distributed tracing and logs guidance#3122
cijothomas wants to merge 11 commits into
open-telemetry:mainfrom
cijothomas:cijothomas/dt-guidnace

Conversation

@cijothomas
Copy link
Copy Markdown
Member

@cijothomas cijothomas commented Aug 5, 2025

Adds initial guidance docs for logs and traces in the OpenTelemetry Rust ecosystem.

  • docs/logs.md — marked Stable.
  • docs/traces.md — marked Work-In-Progress (OpenTelemetry Tracing in this repo is not yet stable).

@codecov
Copy link
Copy Markdown

codecov Bot commented Aug 5, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.8%. Comparing base (8db5a12) to head (a9c02fa).

Additional details and impacted files
@@           Coverage Diff           @@
##            main   #3122     +/-   ##
=======================================
- Coverage   82.8%   82.8%   -0.1%     
=======================================
  Files        130     130             
  Lines      27289   27289             
=======================================
- Hits       22622   22621      -1     
- Misses      4667    4668      +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Comment thread docs/traces.md Outdated
Comment thread docs/traces.md Outdated
Comment thread docs/traces.md Outdated
Comment thread docs/traces.md
Comment thread docs/traces.md Outdated
Comment thread docs/logs.md
Comment thread docs/traces.md Outdated
@github-actions
Copy link
Copy Markdown

Thank you for your contribution! This PR has been automatically marked as stale because it has not had activity in the last 14 days. This may be due to a delay in review on our side or awaiting a response from you; either is fine, and we appreciate your patience.

It will be closed in 14 days if no further activity occurs. Pushing a new commit or leaving a comment will remove the stale label and keep the PR open.

@github-actions github-actions Bot added the Stale label May 12, 2026
@cijothomas cijothomas force-pushed the cijothomas/dt-guidnace branch from 640aa63 to 369b733 Compare May 12, 2026 05:30
@cijothomas cijothomas marked this pull request as ready for review May 12, 2026 05:30
@cijothomas cijothomas requested a review from a team as a code owner May 12, 2026 05:30
@cijothomas
Copy link
Copy Markdown
Member Author

Marked ready for review. @davidbarsky @scottgerring — would appreciate another look; the open threads from your earlier review should now be addressed (intro now leads with a thesis, level-of-detail trimmed). @alessandrobologna — courtesy ping; the tracing-opentelemetry framing is now neutral and I added the tracing-http-propagator example to See Also per your suggestion.

@cijothomas cijothomas removed the Stale label May 12, 2026
Copy link
Copy Markdown
Member

@scottgerring scottgerring left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some nits!

Comment thread docs/logs.md Outdated
Comment thread docs/logs.md Outdated
Comment thread docs/traces.md Outdated
Comment on lines +31 to +33
provides a bridge. It is maintained outside the OpenTelemetry project and
is not part of this repo; we point to it so users are aware of the option
in the broader ecosystem.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can be more succinct here:

Suggested change
provides a bridge. It is maintained outside the OpenTelemetry project and
is not part of this repo; we point to it so users are aware of the option
in the broader ecosystem.
provides a bridge. It is maintained outside the OpenTelemetry project and is not part of this repo.

Comment thread docs/traces.md Outdated
Comment thread docs/traces.md Outdated
@cijothomas
Copy link
Copy Markdown
Member Author

@scottgerring Addressed your comments, thank you!

Copy link
Copy Markdown
Member

@scottgerring scottgerring left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚢

@cijothomas
Copy link
Copy Markdown
Member Author

@open-telemetry/rust-maintainers Please review. I'd like to get more eyes before merging this.

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

Successfully merging this pull request may close these issues.

4 participants