Struct BunyanFormattingLayer

pub struct BunyanFormattingLayer<W: for<'a> MakeWriter<'a> + 'static> { /* private fields */ }

This layer is exclusively concerned with formatting information using the Bunyan format. It relies on the upstream JsonStorageLayer to get access to the fields attached to each span.

Implementations

impl<W: for<'a> MakeWriter<'a> + 'static> BunyanFormattingLayer<W>

pub fn new(name: String, make_writer: W) -> Self

Create a new BunyanFormattingLayer.

You have to specify:

• a name, which will be attached to all formatted records according to the Bunyan format;
• a make_writer, which will be used to get a Write instance to write formatted records to.

Using stdout

use tracing_bunyan_formatter::BunyanFormattingLayer;

let formatting_layer = BunyanFormattingLayer::new("tracing_example".into(), std::io::stdout);

If you prefer, you can use closure syntax:

use tracing_bunyan_formatter::BunyanFormattingLayer;

let formatting_layer = BunyanFormattingLayer::new("tracing_example".into(), || std::io::stdout());

pub fn with_default_fields( name: String, make_writer: W, default_fields: HashMap<String, Value>, ) -> Self

Add default fields to all formatted records.

use std::collections::HashMap;
use serde_json::json;
use tracing_bunyan_formatter::BunyanFormattingLayer;

let mut default_fields = HashMap::new();
default_fields.insert("custom_field".to_string(), json!("custom_value"));
let formatting_layer = BunyanFormattingLayer::with_default_fields(
    "test".into(),
    std::io::stdout,
    default_fields,
);

pub fn skip_fields<Fields, Field>( self, fields: Fields, ) -> Result<Self, SkipFieldError>

where Fields: Iterator<Item = Field>, Field: Into<String>,

Add fields to skip when formatting with this layer.

It returns an error if you try to skip a required core Bunyan field (e.g. name). You can skip optional core Bunyan fields (e.g. line, file, target).

use tracing_bunyan_formatter::BunyanFormattingLayer;

let skipped_fields = vec!["skipped"];
let formatting_layer = BunyanFormattingLayer::new("test".into(), std::io::stdout)
    .skip_fields(skipped_fields.into_iter())
    .expect("One of the specified fields cannot be skipped");

Trait Implementations

impl<W: Default + for<'a> MakeWriter<'a> + 'static> Default for BunyanFormattingLayer<W>

fn default() -> BunyanFormattingLayer<W>

Returns the “default value” for a type.

impl<S, W> Layer<S> for BunyanFormattingLayer<W>

where S: Subscriber + for<'a> LookupSpan<'a>, W: for<'a> MakeWriter<'a> + 'static,

fn on_event(&self, event: &Event<'_>, ctx: Context<'_, S>)

Notifies this layer that an event has occurred.

fn on_new_span(&self, _attrs: &Attributes<'_>, id: &Id, ctx: Context<'_, S>)

Notifies this layer that a new span was constructed with the given Attributes and Id.

fn on_close(&self, id: Id, ctx: Context<'_, S>)

Notifies this layer that the span with the given ID has been closed.

fn on_register_dispatch(&self, subscriber: &Dispatch)

Performs late initialization when installing this layer as a Subscriber.

fn on_layer(&mut self, subscriber: &mut S)

Performs late initialization when attaching a Layer to a Subscriber.

fn register_callsite(&self, metadata: &'static Metadata<'static>) -> Interest

Registers a new callsite with this layer, returning whether or not the layer is interested in being notified about the callsite, similarly to Subscriber::register_callsite.

fn enabled(&self, metadata: &Metadata<'_>, ctx: Context<'_, S>) -> bool

Returns true if this layer is interested in a span or event with the given metadata in the current Context, similarly to Subscriber::enabled.

fn on_record(&self, _span: &Id, _values: &Record<'_>, _ctx: Context<'_, S>)

Notifies this layer that a span with the given Id recorded the given values.

fn on_follows_from(&self, _span: &Id, _follows: &Id, _ctx: Context<'_, S>)

Notifies this layer that a span with the ID span recorded that it follows from the span with the ID follows.

fn event_enabled(&self, _event: &Event<'_>, _ctx: Context<'_, S>) -> bool

Called before on_event, to determine if on_event should be called.

fn on_enter(&self, _id: &Id, _ctx: Context<'_, S>)

Notifies this layer that a span with the given ID was entered.

fn on_exit(&self, _id: &Id, _ctx: Context<'_, S>)

Notifies this layer that the span with the given ID was exited.

fn on_id_change(&self, _old: &Id, _new: &Id, _ctx: Context<'_, S>)

Notifies this layer that a span ID has been cloned, and that the subscriber returned a different ID.

fn and_then<L>(self, layer: L) -> Layered<L, Self, S>

where L: Layer<S>, Self: Sized,

Composes this layer around the given Layer, returning a Layered struct implementing Layer.

fn with_subscriber(self, inner: S) -> Layered<Self, S>

where Self: Sized,

Composes this Layer with the given Subscriber, returning a Layered struct that implements Subscriber.

fn with_filter<F>(self, filter: F) -> Filtered<Self, F, S>

where Self: Sized, F: Filter<S>,

Combines self with a Filter, returning a Filtered layer.

fn boxed(self) -> Box<dyn Layer<S> + Sync + Send>

where Self: Sized + Layer<S> + Send + Sync + 'static, S: Subscriber,

Erases the type of this Layer, returning a Boxed dyn Layer trait object.