Skip to content

Commit

Permalink
subscriber: fix outdated formatter docs (#1893)
Browse files Browse the repository at this point in the history
This fixes outdated statements in the docs for the `Full` and `Compact`
logging formats.

Closes #1880.

Signed-off-by: Eliza Weisman <eliza@buoyant.io>
  • Loading branch information
hawkw committed Feb 3, 2022
1 parent c1d6909 commit b083ace
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions tracing-subscriber/src/fmt/format/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -298,13 +298,17 @@ pub struct FieldFnVisitor<'a, F> {
}
/// Marker for `Format` that indicates that the compact log format should be used.
///
/// The compact format only includes the fields from the most recently entered span.
/// The compact format includes fields from all currently entered spans, after
/// the event's fields. Span fields are not grouped by span, and span names are
/// not shown. In addition, a more compact representation of each event's
/// [`Level`](tracing::Level) is used.
#[derive(Default, Debug, Copy, Clone, Eq, PartialEq)]
pub struct Compact;

/// Marker for `Format` that indicates that the verbose log format should be used.
/// Marker for `Format` that indicates that the default log format should be used.
///
/// The full format includes fields from all entered spans.
/// This format shows the span context before printing event data. Spans are
/// displayed including their names and fields.
#[derive(Default, Debug, Copy, Clone, Eq, PartialEq)]
pub struct Full;

Expand Down

0 comments on commit b083ace

Please sign in to comment.