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

#[instrument(name = "")] not documented #725

Closed
jonhoo opened this issue May 21, 2020 · 3 comments
Closed

#[instrument(name = "")] not documented #725

jonhoo opened this issue May 21, 2020 · 3 comments
Labels
crate/attributes Related to the `tracing-attributes` crate kind/docs

Comments

@jonhoo
Copy link
Contributor

jonhoo commented May 21, 2020

The #[instrument] parameter name to set the name of the generated span is not currently documented anywhere. Silly readers (like myself) may end up setting target instead, since it looks most like name, which definitely does not do what you want it to :p
@hawkw hawkw added crate/attributes Related to the `tracing-attributes` crate kind/docs labels May 21, 2020
@hawkw
Copy link
Member

hawkw commented May 21, 2020

I think this was an oversight on my part, thanks for catching it! Will make sure it gets fixed.

@LukeMathWalker
Copy link
Contributor

Just bumped into this myself today 👍

@anton-dutov anton-dutov mentioned this issue Aug 7, 2020
Merged
hawkw pushed a commit that referenced this issue Aug 7, 2020
@anton-dutov
docs: add docs for instrument(name) (#897)
ed28c1f 
## Motivation

Not found in documentation how to change generated span name name, only in
sources, then i found issue #725  

## Solution

Documentation added
@hawkw
Copy link
Member

hawkw commented Aug 7, 2020

Fixed by #897!

@hawkw hawkw closed this as completed Aug 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
crate/attributes Related to the `tracing-attributes` crate kind/docs
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@jonhoo @hawkw @LukeMathWalker