Struct tracing_layer_slack::SlackLayerBuilder

pub struct SlackLayerBuilder { /* private fields */ }

A builder for creating a Slack layer.

The layer requires a regex for selecting events to be sent to Slack by their target. Specifying no filter (e.g. “.*”) will cause an explosion in the number of messages observed by the layer.

Several methods expose initialization of optional filtering mechanisms, along with Slack configuration that defaults to searching in the local environment variables.

Implementations

impl SlackLayerBuilder

pub fn message_filters(self, filters: EventFilters) -> Self

Filter events by their message.

Filter type semantics:

• Positive: Exclude an event if the message MATCHES a given regex, and
• Negative: Exclude an event if the message does NOT MATCH a given regex.

Examples found in repository

examples/exclude_messages_by_content.rs (line 18)

async fn main() {
    let targets_to_filter: EventFilters = (None, None).into();
    let messages_to_exclude = vec![Regex::new("the message we want to exclude").unwrap()];
    let (slack_layer, background_worker) = SlackLayer::builder("test-app".to_string(), targets_to_filter)
        .message_filters((Vec::new(), messages_to_exclude).into())
        .build();
    let subscriber = Registry::default().with(slack_layer);
    tracing::subscriber::set_global_default(subscriber).unwrap();
    handler().await;
    background_worker.shutdown().await;
}

pub fn event_by_field_filters(self, filters: EventFilters) -> Self

Filter events by fields.

Filter type semantics:

• Positive: Exclude the event if its key MATCHES a given regex.
• Negative: Exclude the event if its key does NOT MATCH a given regex.

Examples found in repository

examples/filter_records_by_fields.rs (line 22)

async fn main() {
    let targets_to_filter: EventFilters = Regex::new("filter_records_by_fields").unwrap().into();
    let event_fields_to_filter: EventFilters = Regex::new("password").unwrap().into();
    let (slack_layer, background_worker) = SlackLayer::builder("test-app".to_string(), targets_to_filter)
        .event_by_field_filters(event_fields_to_filter)
        .build();
    let subscriber = Registry::default().with(slack_layer);
    tracing::subscriber::set_global_default(subscriber).unwrap();
    handler().await;
    background_worker.shutdown().await;
}

pub fn field_exclusion_filters(self, filters: Vec<Regex>) -> Self

Filter fields of events from being sent to Slack.

Filter type semantics:

• Positive: Exclude event fields if the field’s key MATCHES any provided regular expressions.

Examples found in repository

examples/exclude_fields_from_messages.rs (line 26)

async fn main() {
    let targets_to_filter: EventFilters = Regex::new("exclude_fields_from_messages").unwrap().into();
    let fields_to_exclude = vec![
        Regex::new(".*token.*").unwrap(),
        Regex::new(".*password.*").unwrap(),
        Regex::new("command").unwrap(),
    ];
    let (slack_layer, background_worker) = SlackLayer::builder("test-app".to_string(), targets_to_filter)
        .field_exclusion_filters(fields_to_exclude)
        .build();
    let subscriber = Registry::default().with(slack_layer);
    tracing::subscriber::set_global_default(subscriber).unwrap();
    handler().await;
    background_worker.shutdown().await;
}

pub fn slack_config(self, config: SlackConfig) -> Self

Configure the layer’s connection to the Slack Webhook API.

pub fn level_filters(self, level_filters: String) -> Self

Configure which levels of events to send to Slack.

Examples found in repository

examples/exclude_messages_below_level.rs (line 17)

async fn main() {
    let targets_to_filter: EventFilters = Regex::new("exclude_messages_below_level").unwrap().into();
    let (slack_layer, background_worker) = SlackLayer::builder("test-app".to_string(), targets_to_filter)
        .level_filters("info".to_string())
        .build();
    let subscriber = Registry::default().with(slack_layer);
    tracing::subscriber::set_global_default(subscriber).unwrap();
    handler().await;
    background_worker.shutdown().await;
}

pub fn build(self) -> (SlackLayer, SlackBackgroundWorker)

Create a SlackLayer and its corresponding background worker to (async) send the messages.

Examples found in repository

examples/simple.rs (line 28)

async fn main() {
    // Only show events from where this example code is the target.
    let target_to_filter: EventFilters = Regex::new("simple").unwrap().into();

    let (slack_layer, background_worker) = SlackLayer::builder("test-app".to_string(), target_to_filter).build();
    let subscriber = Registry::default().with(slack_layer);
    tracing::subscriber::set_global_default(subscriber).unwrap();

    controller().await;
    background_worker.shutdown().await;
}

examples/exclude_messages_below_level.rs (line 18)

async fn main() {
    let targets_to_filter: EventFilters = Regex::new("exclude_messages_below_level").unwrap().into();
    let (slack_layer, background_worker) = SlackLayer::builder("test-app".to_string(), targets_to_filter)
        .level_filters("info".to_string())
        .build();
    let subscriber = Registry::default().with(slack_layer);
    tracing::subscriber::set_global_default(subscriber).unwrap();
    handler().await;
    background_worker.shutdown().await;
}

examples/exclude_messages_by_content.rs (line 19)

async fn main() {
    let targets_to_filter: EventFilters = (None, None).into();
    let messages_to_exclude = vec![Regex::new("the message we want to exclude").unwrap()];
    let (slack_layer, background_worker) = SlackLayer::builder("test-app".to_string(), targets_to_filter)
        .message_filters((Vec::new(), messages_to_exclude).into())
        .build();
    let subscriber = Registry::default().with(slack_layer);
    tracing::subscriber::set_global_default(subscriber).unwrap();
    handler().await;
    background_worker.shutdown().await;
}

examples/filter_records_by_fields.rs (line 23)

async fn main() {
    let targets_to_filter: EventFilters = Regex::new("filter_records_by_fields").unwrap().into();
    let event_fields_to_filter: EventFilters = Regex::new("password").unwrap().into();
    let (slack_layer, background_worker) = SlackLayer::builder("test-app".to_string(), targets_to_filter)
        .event_by_field_filters(event_fields_to_filter)
        .build();
    let subscriber = Registry::default().with(slack_layer);
    tracing::subscriber::set_global_default(subscriber).unwrap();
    handler().await;
    background_worker.shutdown().await;
}

examples/exclude_fields_from_messages.rs (line 27)

async fn main() {
    let targets_to_filter: EventFilters = Regex::new("exclude_fields_from_messages").unwrap().into();
    let fields_to_exclude = vec![
        Regex::new(".*token.*").unwrap(),
        Regex::new(".*password.*").unwrap(),
        Regex::new("command").unwrap(),
    ];
    let (slack_layer, background_worker) = SlackLayer::builder("test-app".to_string(), targets_to_filter)
        .field_exclusion_filters(fields_to_exclude)
        .build();
    let subscriber = Registry::default().with(slack_layer);
    tracing::subscriber::set_global_default(subscriber).unwrap();
    handler().await;
    background_worker.shutdown().await;
}