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

Allow setting event names in macros. #2699

Merged
merged 8 commits into from
Sep 5, 2023
Merged

Allow setting event names in macros. #2699

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c0a63b5
Allow setting event names in macros.
twitchax Aug 28, 2023
4ac8104
Merge branch 'master' into twitchax/event_name
davidbarsky Aug 29, 2023
f7e4446
Update docs for `event!` `name` option.
twitchax Sep 5, 2023
b8eeacf
Fix docs.
twitchax Sep 5, 2023
14f27f2
Fix poor grammar. 😳
twitchax Sep 5, 2023
2f7ec4c
Update "attributes" paragraph.
twitchax Sep 5, 2023
1c74e37
Fix whitespace.
twitchax Sep 5, 2023
51d8d9f
Remove `name` from optional phrase.
twitchax Sep 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion tracing/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@
//! # use tracing::{span, event, Level};
//! # fn main() {
//! span!(target: "app_spans", Level::TRACE, "my span");
//! event!(target: "app_events", Level::INFO, "something has happened!");
//! event!(name: "event", target: "app_events", Level::INFO, "something has happened!");
//! # }
//! ```
//! ```
Expand Down Expand Up @@ -421,6 +421,7 @@
//! // - "message", with the value "the answer to the ultimate question of life, the
//! // universe, and everything is 42."
//! event!(
//! name: "life",
Copy link
Member

Choose a reason for hiding this comment

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

this example has a block comment explaining the span that will be recorded, and it doesn't mention the overridden name:
https://github.com/tokio-rs/tracing/pull/2699/files#diff-ea2f30245316830135d5b43541a7be0930b4bfded454b5396509770c39a59c7cR417-R422

can we either update that comment, or remove the overridden name from this example?

my preference would probably be to add new examples for overriding event names, rather than including them in existing examples. this example is intended to demonstrate the way that the message field is generated, and overriding the name is not related to message generation. my preference would be to not include things not directly related to the specific thing being demonstrated, so that the user doesn't think they're related...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, makes sense.

Copy link
Member

Choose a reason for hiding this comment

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

great, thanks!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok, addressed!

//! Level::DEBUG,
//! question.answer = answer,
//! question.tricky = true,
Expand Down
Loading
Loading