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

attributes: update & improve docs #1215

Merged
merged 5 commits into from
Feb 2, 2021
Merged

attributes: update & improve docs #1215

merged 5 commits into from
Feb 2, 2021

Conversation

hawkw
Copy link
Member

@hawkw hawkw commented Jan 28, 2021

The tracing-attributes documentation for instrument is out of date
and could use some improvement. In particular, it doesn't mention that
empty fields can be created in instrument's fields argument, and
states that dotted fields are forbidden and that field values must be
literals, both of which are no longer the case. See also #1210 and
#1211.

This branch updates the docs to correct the false statements, and also
fleshes out the usage examples a bit.

I wasn't sure what to do with the old examples --- some of them are now
redundant, but it's also useful to have a big list of examples for every
allowed form. Any thoughts?

hawkw added 3 commits January 28, 2021 14:59
@hawkw
attributes: update docs to allow dotted fields
1eaaa33 
I also made some other improvements while I was here.

Signed-off-by: Eliza Weisman <eliza@buoyant.io>
@hawkw
attributes: start improving docs
9b16d49 
Signed-off-by: Eliza Weisman <eliza@buoyant.io>
@hawkw
attributes: add a bunch of new docs
b5ad058 
Signed-off-by: Eliza Weisman <eliza@buoyant.io>
@hawkw hawkw requested a review from davidbarsky January 28, 2021 23:06
@hawkw hawkw requested a review from a team as a code owner January 28, 2021 23:06
@hawkw
fixup doctests
19da775 
Signed-off-by: Eliza Weisman <eliza@buoyant.io>
davidbarsky
davidbarsky approved these changes Feb 1, 2021
View reviewed changes
Copy link
Member

@davidbarsky davidbarsky left a comment

Choose a reason for hiding this comment

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

These are great improvements. I had a few comments about use tracing_attributes, but then I realized they were being hidden. LGTM!

@hawkw
fix big slices not being Debug on old rusts
30c5162 
Signed-off-by: Eliza Weisman <eliza@buoyant.io>
@hawkw hawkw merged commit a018071 into v0.1.x Feb 2, 2021
hawkw added a commit that referenced this pull request Feb 4, 2021
@hawkw
attributes: prepare to release v0.1.12
47f7da5 
Fixed

- Compiler error when using `#[instrument(err)]` on functions with
  mutable parameters ([#1167])
- Missing function visibility modifier when using `#[instrument]` with
  `async-trait` ([#977])
- Multiple documentation fixes and improvements ([#965], [#981],
  [#1215])

 Changed

- `tracing-futures` dependency is no longer required when using
  `#[instrument]` on async functions ([#808])

Thanks to @nagisa, @Txuritan, @TaKO8Ki, and @okready for contributing to
this release!

[#1167]: #1167
[#977]: #977
[#965]: #965
[#981]: #981
[#1215]: #1215
[#808]: #808
hawkw added a commit that referenced this pull request Feb 4, 2021
@hawkw
attributes: prepare to release v0.1.12
c40ea96 
Fixed

- Compiler error when using `#[instrument(err)]` on functions with
  mutable parameters ([#1167])
- Missing function visibility modifier when using `#[instrument]` with
  `async-trait` ([#977])
- Multiple documentation fixes and improvements ([#965], [#981],
  [#1215])

 Changed

- `tracing-futures` dependency is no longer required when using
  `#[instrument]` on async functions ([#808])

Thanks to @nagisa, @Txuritan, @TaKO8Ki, and @okready for contributing to
this release!

[#1167]: #1167
[#977]: #977
[#965]: #965
[#981]: #981
[#1215]: #1215
[#808]: #808
@hawkw hawkw mentioned this pull request Feb 4, 2021
Merged
hawkw added a commit that referenced this pull request Feb 4, 2021
@hawkw
attributes: prepare to release v0.1.12 (#1221)
a3f2c0c 
### Fixed

- Compiler error when using `#[instrument(err)]` on functions with
  mutable parameters ([#1167])
- Missing function visibility modifier when using `#[instrument]` with
  `async-trait` ([#977])
- Multiple documentation fixes and improvements ([#965], [#981],
  [#1215])

 ### Changed

- `tracing-futures` dependency is no longer required when using
  `#[instrument]` on async functions ([#808])

Thanks to @nagisa, @Txuritan, @TaKO8Ki, and @okready for contributing to
this release!

[#1167]: #1167
[#977]: #977
[#965]: #965
[#981]: #981
[#1215]: #1215
[#808]: #808
hawkw added a commit that referenced this pull request Feb 4, 2021
@hawkw
tracing: prepare to release v0.1.23
30630c8 
Fixed

- **attributes**: Compiler error when using `#[instrument(err)]` on
  functions with mutable parameters ([#1167])
- **attributes**: Missing function visibility modifier when using
  `#[instrument]` with `async-trait` ([#977])
- **attributes** Removed unused `syn` features ([#928])
- **log**: Fixed an issue where the `tracing` macros would generate code
  for events whose levels are disabled statically by the `log` crate's
  `static_max_level_XXX` features ([#1175])
- Fixed deprecations and clippy lints ([#1195])
- Several documentation fixes and improvements ([#941], [#965], [#981],
  [#1146], [#1215])

Changed

- **attributes**: `tracing-futures` dependency is no longer required
  when using `#[instrument]` on async functions ([#808])
- **attributes**: Updated `tracing-attributes` minimum dependency to
  v0.1.12 ([#1222])

Thanks to @nagisa, @Txuritan, @TaKO8Ki, @okready, and @krojew for
contributing to this release!
@hawkw hawkw mentioned this pull request Feb 4, 2021
Merged
hawkw added a commit that referenced this pull request Feb 4, 2021
@hawkw
tracing: prepare to release v0.1.23 (#1223)
27929d9 
### Fixed

- **attributes**: Compiler error when using `#[instrument(err)]` on
  functions with mutable parameters ([#1167])
- **attributes**: Missing function visibility modifier when using
  `#[instrument]` with `async-trait` ([#977])
- **attributes** Removed unused `syn` features ([#928])
- **log**: Fixed an issue where the `tracing` macros would generate code
  for events whose levels are disabled statically by the `log` crate's
  `static_max_level_XXX` features ([#1175])
- Fixed deprecations and clippy lints ([#1195])
- Several documentation fixes and improvements ([#941], [#965], [#981],
  [#1146], [#1215])

### Changed

- **attributes**: `tracing-futures` dependency is no longer required
  when using `#[instrument]` on async functions ([#808])
- **attributes**: Updated `tracing-attributes` minimum dependency to
  v0.1.12 ([#1222])

Thanks to @nagisa, @Txuritan, @TaKO8Ki, @okready, and @krojew for
contributing to this release!
@dependabot dependabot bot mentioned this pull request Mar 18, 2021
Closed
@davidbarsky davidbarsky mentioned this pull request Sep 26, 2023
Merged
kaffarell pushed a commit to kaffarell/tracing that referenced this pull request May 22, 2024
@hawkw @kaffarell
attributes: update & improve docs (tokio-rs#1215)
36b4dcb 
The `tracing-attributes` documentation for `instrument` is out of date
and could use some improvement. In particular, it doesn't mention that
empty fields can be created in `instrument`'s `fields` argument, and
states that dotted fields are forbidden and that field values must be
literals, both of which are no longer the case. See also tokio-rs#1210 and
tokio-rs#1211.

This branch updates the docs to correct the false statements, and also
fleshes out the usage examples a bit.

I wasn't sure what to do with the old examples --- some of them are now
redundant, but it's also useful to have a big list of examples for every
allowed form. Any thoughts?

Signed-off-by: Eliza Weisman <eliza@buoyant.io>
kaffarell pushed a commit to kaffarell/tracing that referenced this pull request May 22, 2024
@hawkw @kaffarell
attributes: prepare to release v0.1.12 (tokio-rs#1221)
173709c 
### Fixed

- Compiler error when using `#[instrument(err)]` on functions with
  mutable parameters ([tokio-rs#1167])
- Missing function visibility modifier when using `#[instrument]` with
  `async-trait` ([tokio-rs#977])
- Multiple documentation fixes and improvements ([tokio-rs#965], [tokio-rs#981],
  [tokio-rs#1215])

 ### Changed

- `tracing-futures` dependency is no longer required when using
  `#[instrument]` on async functions ([tokio-rs#808])

Thanks to @nagisa, @Txuritan, @TaKO8Ki, and @okready for contributing to
this release!

[tokio-rs#1167]: tokio-rs#1167
[tokio-rs#977]: tokio-rs#977
[tokio-rs#965]: tokio-rs#965
[tokio-rs#981]: tokio-rs#981
[tokio-rs#1215]: tokio-rs#1215
[tokio-rs#808]: tokio-rs#808
kaffarell pushed a commit to kaffarell/tracing that referenced this pull request May 22, 2024
@hawkw @kaffarell
tracing: prepare to release v0.1.23 (tokio-rs#1223)
51db6cf 
### Fixed

- **attributes**: Compiler error when using `#[instrument(err)]` on
  functions with mutable parameters ([tokio-rs#1167])
- **attributes**: Missing function visibility modifier when using
  `#[instrument]` with `async-trait` ([tokio-rs#977])
- **attributes** Removed unused `syn` features ([tokio-rs#928])
- **log**: Fixed an issue where the `tracing` macros would generate code
  for events whose levels are disabled statically by the `log` crate's
  `static_max_level_XXX` features ([tokio-rs#1175])
- Fixed deprecations and clippy lints ([tokio-rs#1195])
- Several documentation fixes and improvements ([tokio-rs#941], [tokio-rs#965], [tokio-rs#981],
  [tokio-rs#1146], [tokio-rs#1215])

### Changed

- **attributes**: `tracing-futures` dependency is no longer required
  when using `#[instrument]` on async functions ([tokio-rs#808])
- **attributes**: Updated `tracing-attributes` minimum dependency to
  v0.1.12 ([tokio-rs#1222])

Thanks to @nagisa, @Txuritan, @TaKO8Ki, @okready, and @krojew for
contributing to this release!
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@davidbarsky davidbarsky davidbarsky approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@hawkw @davidbarsky