Struct BetterStackLayer

pub struct BetterStackLayer { /* private fields */ }

A tracing layer that sends log events to Better Stack.

BetterStackLayer implements the tracing_subscriber::Layer trait and can be used with any tracing subscriber to automatically send structured log events to Better Stack’s log management platform.

The layer batches events for efficient transmission and handles retries automatically based on the provided configuration.

Example

use tracing_subscriber::prelude::*;
use tracing_better_stack::{BetterStackLayer, BetterStackConfig};

let layer = BetterStackLayer::new(
    BetterStackConfig::builder("s1234567.us-east-9.betterstackdata.com", "source_token")
        .batch_size(100)
        .build()
);

tracing_subscriber::registry()
    .with(layer)
    .init();

Implementations

impl BetterStackLayer

pub fn new(config: BetterStackConfig) -> Self

Creates a new Better Stack layer with the specified configuration.

The layer will lazily initialize its background processor on the first log event when a Tokio runtime is available.

Arguments

• config - Better Stack configuration specifying endpoint, credentials, and batching behavior

Example

use tracing_better_stack::{BetterStackLayer, BetterStackConfig};

let config = BetterStackConfig::builder("s1234567.us-east-9.betterstackdata.com", "your-source-token")
    .batch_size(200)
    .build();
let layer = BetterStackLayer::new(config);

pub fn builder( ingesting_host: impl Into<String>, source_token: impl Into<String>, ) -> BetterStackConfigBuilder

Creates a configuration builder for Better Stack.

This is a convenience method that creates a BetterStackConfigBuilder for configuring the layer with a fluent API.

Arguments

• ingesting_host - The Better Stack ingesting host for your source
• source_token - Your Better Stack source token for authentication

Example

use tracing_subscriber::prelude::*;
use tracing_better_stack::BetterStackLayer;
use std::time::Duration;

let config = BetterStackLayer::builder("s1234567.us-east-9.betterstackdata.com", "your-source-token")
    .batch_size(200)
    .batch_timeout(Duration::from_secs(10))
    .include_spans(false)
    .build();
let layer = BetterStackLayer::new(config);

tracing_subscriber::registry()
    .with(layer)
    .init();

Trait Implementations

impl<S> Layer<S> for BetterStackLayer

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

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_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_close(&self, _id: Id, _ctx: Context<'_, S>)

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

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> + Send + Sync>

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

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