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

Document the usage of tracing #2818

Closed
3 of 8 tasks
Tracked by #2753
WorldSEnder opened this issue Aug 7, 2022 · 1 comment · Fixed by #2831
Closed
3 of 8 tasks
Tracked by #2753

Document the usage of tracing #2818

WorldSEnder opened this issue Aug 7, 2022 · 1 comment · Fixed by #2831

Comments

@WorldSEnder
Copy link
Member

WorldSEnder commented Aug 7, 2022

This is about:

  • A typo
  • Innaccurate/misleading documentation (e.g. technically incorrect advice)
  • Undocumented code
  • Outdated documentation
  • Other

Problem

Since #2814 we're using the [tracing] crate to do logging. This is undocumented and not easily discoverable, so can't be taken advantage of easily by users.

Details about the solution you'd like (Optional)

For users, it should be easy to discover this and some guidance on choosing a good Subscriber that consumes the events and spans logged should be given.

Questionaire (Optional)

  • I'd like to write this documentation
  • I'd like to write this documentation but I'm not sure what's needed
  • I don't have time to add this right now, but maybe later
@martinitus
Copy link

Maybe this is relevant for #2753?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants