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.

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

Documentation for Compact format incorrectly states span names are not shown #1909

Closed
lilyball opened this issue Feb 7, 2022 · 1 comment

Comments

@lilyball
Copy link
Contributor

lilyball commented Feb 7, 2022

Bug Report

Version

tracing-subscriber v0.3.8

Crates

tracing-subscriber

Description

In tracing-subscriber v0.3.8 (#1893) the documentation on Compact was updated to say

Span fields are not grouped by span, and span names are not shown.

The first half of this is true, but the second half is not, it does indeed show span names, it just doesn't group the fields with them. There's not even an option to hide them (SubscriberBuilder::with_span_list() exists but is only callable when formatting as JSON).

hawkw added a commit that referenced this issue Feb 15, 2022
## Motivation

Currently, the RustDoc for the `format::Compact` formatter in
`tracing-subscriber` describes the output from the `master` (v0.2.x)
version of the formatter, not the version on the v0.1.x branch.

## Solution

This PR updates the documentation to describe the actual output format.
Also, I added an example of the formatter in the `examples` directory.

Closes #1909
@hawkw
Copy link
Member

hawkw commented Feb 15, 2022

Closed by #1926

@hawkw hawkw closed this as completed Feb 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants