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

core: document the callsite module #2088

Merged
merged 4 commits into from
Apr 22, 2022
Merged

core: document the callsite module #2088

merged 4 commits into from
Apr 22, 2022

Conversation

hawkw
Copy link
Member

@hawkw hawkw commented Apr 22, 2022

Currently, there isn't a lot of documentation explaining what callsites
and registration are for, and how they work. There's some documentation
explaining this stuff, but it's all on the register_callsite method,
rather than in the callsite module itself. We should fix that.

This branch adds new documentation to tracing-core's callsite
module. Hopefully this should shine some light on how this part of
tracing works.

@hawkw
core: document the callsite module
6b42837 
Currently, there isn't a lot of documentation explaining what callsites
and registration are for, and how they work. There's some documentation
explaining this stuff, but it's all on the `register_callsite` *method*,
rather than in the `callsite` module itself. We should fix that.

This branch adds new documentation to `tracing-core`'s `callsite`
module. Hopefully this should shine some light on how this part of
tracing works.
@hawkw hawkw requested a review from davidbarsky April 22, 2022 17:16
@hawkw hawkw requested a review from carllerche as a code owner April 22, 2022 17:16
@hawkw hawkw enabled auto-merge (squash) April 22, 2022 17:16
@hawkw
fix link in collect
7c9f22a 
Signed-off-by: Eliza Weisman <eliza@buoyant.io>
@hawkw
add links
d2e46f4 
Signed-off-by: Eliza Weisman <eliza@buoyant.io>
@hawkw
fix typos (thanks @JamesHallowell!)
2aaaaa5 
Signed-off-by: Eliza Weisman <eliza@buoyant.io>
@hawkw
Copy link
Member Author

hawkw commented Apr 22, 2022

Thanks for finding those typos @JamesHallowell!

@hawkw hawkw disabled auto-merge April 22, 2022 23:19
@hawkw hawkw merged commit 465f10a into master Apr 22, 2022
@hawkw hawkw deleted the eliza/callsite-docs branch April 22, 2022 23:19
hawkw added a commit that referenced this pull request Apr 26, 2022
@hawkw
core: document the callsite module (#2088)
f968517 
Currently, there isn't a lot of documentation explaining what callsites
and registration are for, and how they work. There's some documentation
explaining this stuff, but it's all on the `register_callsite` *method*,
rather than in the `callsite` module itself. We should fix that.

This branch adds new documentation to `tracing-core`'s `callsite`
module. Hopefully this should shine some light on how this part of
tracing works.

Thanks to @JamesHallowell for fixing some typos!

Signed-off-by: Eliza Weisman <eliza@buoyant.io>
@hawkw hawkw mentioned this pull request Apr 26, 2022
Merged
hawkw added a commit that referenced this pull request Apr 26, 2022
@hawkw
core: document the callsite module (#2088)
0e135bc 
Currently, there isn't a lot of documentation explaining what callsites
and registration are for, and how they work. There's some documentation
explaining this stuff, but it's all on the `register_callsite` *method*,
rather than in the `callsite` module itself. We should fix that.

This branch adds new documentation to `tracing-core`'s `callsite`
module. Hopefully this should shine some light on how this part of
tracing works.

Thanks to @JamesHallowell for fixing some typos!

Signed-off-by: Eliza Weisman <eliza@buoyant.io>
hawkw added a commit that referenced this pull request Apr 26, 2022
@hawkw
core: document the callsite module (#2088)
befdca0 
Currently, there isn't a lot of documentation explaining what callsites
and registration are for, and how they work. There's some documentation
explaining this stuff, but it's all on the `register_callsite` *method*,
rather than in the `callsite` module itself. We should fix that.

This branch adds new documentation to `tracing-core`'s `callsite`
module. Hopefully this should shine some light on how this part of
tracing works.

Thanks to @JamesHallowell for fixing some typos!

Signed-off-by: Eliza Weisman <eliza@buoyant.io>
hawkw added a commit that referenced this pull request Jun 7, 2022
@hawkw
core: prepare to release v0.1.27
18fe1c1 
# 0.1.27 (June 7, 2022)

This release of `tracing-core` introduces a new `DefaultCallsite` type,
which can be used by instrumentation crates rather than implementing
their own callsite types. Using `DefaultCallsite` may offer reduced
overhead from callsite registration.

### Added

- `DefaultCallsite`, a pre-written `Callsite` implementation for use in
  instrumentation crates ([#2083])
- `ValueSet::len` and `Record::len` methods returning the number of
  fields in a `ValueSet` or `Record` ([#2152])

### Changed

- Replaced `lazy_static` dependency with `once_cell` ([#2147])

### Documented

- Added documentation to the `callsite` module ([#2088], [#2149])

Thanks to new contributors @jamesmunns and @james7132 for contributing
to this release!

[#2083]: #2083
[#2152]: #2152
[#2147]: #2147
[#2088]: #2088
[#2149]: #2149
@hawkw hawkw mentioned this pull request Jun 7, 2022
Merged
hawkw added a commit that referenced this pull request Jun 7, 2022
@hawkw
core: prepare to release v0.1.27 (#2155)
d6699fe 
# 0.1.27 (June 7, 2022)

This release of `tracing-core` introduces a new `DefaultCallsite` type,
which can be used by instrumentation crates rather than implementing
their own callsite types. Using `DefaultCallsite` may offer reduced
overhead from callsite registration.

### Added

- `DefaultCallsite`, a pre-written `Callsite` implementation for use in
  instrumentation crates ([#2083])
- `ValueSet::len` and `Record::len` methods returning the number of
  fields in a `ValueSet` or `Record` ([#2152])

### Changed

- Replaced `lazy_static` dependency with `once_cell` ([#2147])

### Documented

- Added documentation to the `callsite` module ([#2088], [#2149])

Thanks to new contributors @jamesmunns and @james7132 for contributing
to this release!

[#2083]: #2083
[#2152]: #2152
[#2147]: #2147
[#2088]: #2088
[#2149]: #2149
hawkw added a commit that referenced this pull request Jun 7, 2022
@hawkw
tracing: prepare to releases v0.1.35
2cb6f81 
# 0.1.35 (June 7, 2022)

This release reduces the overhead of callsite registration by using new
`tracing-core` APIs.

### Added

- Use `DefaultCallsite` to reduce callsite registration overhead
  ([#2083])

### Changed

- `tracing-core`: updated to [0.1.27][core-0.1.27]

[core-0.1.27]: https://github.com/tokio-rs/tracing/releases/tag/tracing-core-0.1.27
[#2088]: #2083
hawkw added a commit that referenced this pull request Jun 8, 2022
@hawkw
tracing: prepare to releases v0.1.35 (#2156)
cf98b73 
# 0.1.35 (June 8, 2022)

This release reduces the overhead of callsite registration by using new
`tracing-core` APIs.

### Added

- Use `DefaultCallsite` to reduce callsite registration overhead
  ([#2083])

### Changed

- `tracing-core`: updated to [0.1.27][core-0.1.27]

[core-0.1.27]: https://github.com/tokio-rs/tracing/releases/tag/tracing-core-0.1.27
[#2088]: #2083
@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
core: document the callsite module (tokio-rs#2088)
5c7abbb 
Currently, there isn't a lot of documentation explaining what callsites
and registration are for, and how they work. There's some documentation
explaining this stuff, but it's all on the `register_callsite` *method*,
rather than in the `callsite` module itself. We should fix that.

This branch adds new documentation to `tracing-core`'s `callsite`
module. Hopefully this should shine some light on how this part of
tracing works.

Thanks to @JamesHallowell for fixing some typos!

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
core: prepare to release v0.1.27 (tokio-rs#2155)
08d7c30 
# 0.1.27 (June 7, 2022)

This release of `tracing-core` introduces a new `DefaultCallsite` type,
which can be used by instrumentation crates rather than implementing
their own callsite types. Using `DefaultCallsite` may offer reduced
overhead from callsite registration.

### Added

- `DefaultCallsite`, a pre-written `Callsite` implementation for use in
  instrumentation crates ([tokio-rs#2083])
- `ValueSet::len` and `Record::len` methods returning the number of
  fields in a `ValueSet` or `Record` ([tokio-rs#2152])

### Changed

- Replaced `lazy_static` dependency with `once_cell` ([tokio-rs#2147])

### Documented

- Added documentation to the `callsite` module ([tokio-rs#2088], [tokio-rs#2149])

Thanks to new contributors @jamesmunns and @james7132 for contributing
to this release!

[tokio-rs#2083]: tokio-rs#2083
[tokio-rs#2152]: tokio-rs#2152
[tokio-rs#2147]: tokio-rs#2147
[tokio-rs#2088]: tokio-rs#2088
[tokio-rs#2149]: tokio-rs#2149
kaffarell pushed a commit to kaffarell/tracing that referenced this pull request May 22, 2024
@hawkw @kaffarell
tracing: prepare to releases v0.1.35 (tokio-rs#2156)
5035f85 
# 0.1.35 (June 8, 2022)

This release reduces the overhead of callsite registration by using new
`tracing-core` APIs.

### Added

- Use `DefaultCallsite` to reduce callsite registration overhead
  ([tokio-rs#2083])

### Changed

- `tracing-core`: updated to [0.1.27][core-0.1.27]

[core-0.1.27]: https://github.com/tokio-rs/tracing/releases/tag/tracing-core-0.1.27
[tokio-rs#2088]: tokio-rs#2083
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JamesHallowell JamesHallowell JamesHallowell left review comments

@davidbarsky davidbarsky Awaiting requested review from davidbarsky

@carllerche carllerche Awaiting requested review from carllerche carllerche is a code owner

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

Successfully merging this pull request may close these issues.

None yet
2 participants
@hawkw @JamesHallowell