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

Documentation for Compact and Full formats is wrong #1880

Closed
lilyball opened this issue Jan 31, 2022 · 1 comment · Fixed by #1893
Closed

Documentation for Compact and Full formats is wrong #1880

lilyball opened this issue Jan 31, 2022 · 1 comment · Fixed by #1893

Comments

@lilyball
Copy link
Contributor

Bug Report

Version

tracing-subscriber v0.3.7

Crates

tracing-subscriber

Description

The documentation for Compact says

The compact format only includes the fields from the most recently entered span.

The documentation for Full says

The full format includes fields from all entered spans.

This distinction here is wrong. Compact in fact includes fields from all spans. It just moves the fields to the end of the event, after the event's kv pairs.
hawkw added a commit that referenced this issue Feb 3, 2022
@hawkw
subscriber: fix incorrect formatter docs
51f0690 
This fixes outdated statements in the docs for the `Full` and `Compact`
logging formats.

Closes #1880.

Signed-off-by: Eliza Weisman <eliza@buoyant.io>
@hawkw hawkw mentioned this issue Feb 3, 2022
Merged
@hawkw
Copy link
Member

hawkw commented Feb 3, 2022

Thanks for catching that --- those docs are clearly outdated! #1893 should fix this.

hawkw added a commit that referenced this issue Feb 3, 2022
@hawkw
subscriber: fix outdated formatter docs (#1893)
a2ccb98 
This fixes outdated statements in the docs for the `Full` and `Compact`
logging formats.

Closes #1880.

Signed-off-by: Eliza Weisman <eliza@buoyant.io>
hawkw added a commit that referenced this issue Feb 3, 2022
@hawkw
subscriber: fix outdated formatter docs (#1893)
b083ace 
This fixes outdated statements in the docs for the `Full` and `Compact`
logging formats.

Closes #1880.

Signed-off-by: Eliza Weisman <eliza@buoyant.io>
hawkw added a commit that referenced this issue Feb 3, 2022
@hawkw
subscriber: fix outdated formatter docs (#1893)
7103c32 
This fixes outdated statements in the docs for the `Full` and `Compact`
logging formats.

Closes #1880.

Signed-off-by: Eliza Weisman <eliza@buoyant.io>
hawkw added a commit that referenced this issue Feb 3, 2022
@hawkw
subscriber: fix outdated formatter docs (#1893)
682f456 
This fixes outdated statements in the docs for the `Full` and `Compact`
logging formats.

Closes #1880.

Signed-off-by: Eliza Weisman <eliza@buoyant.io>
hawkw added a commit that referenced this issue Feb 3, 2022
@hawkw
subscriber: fix outdated formatter docs (#1893)
2aa1342 
This fixes outdated statements in the docs for the `Full` and `Compact`
logging formats.

Closes #1880.

Signed-off-by: Eliza Weisman <eliza@buoyant.io>
hawkw added a commit that referenced this issue Feb 4, 2022
@hawkw
subscriber: fix outdated formatter docs (#1893)
0f17e76 
This fixes outdated statements in the docs for the `Full` and `Compact`
logging formats.

Closes #1880.

Signed-off-by: Eliza Weisman <eliza@buoyant.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

subscriber: fix incorrect formatter docs tokio-rs/tracing
2 participants
@lilyball @hawkw