Crate tracing_layer_discord

tracing-layer-discord

tracing-layer-discord provides a Layer implementation for sending tracing events to Discord.

Synopsis

DiscordLayer sends POST requests via tokio and reqwest to a Discord Webhook URL for each new tracing event. The format of the embedded message is statically defined.

This layer also looks for an optional JsonStorageLayer extension on the parent span of each event. This extension may contain additional contextual information for the parent span of an event, which is included into the Discord message.

Installation

Configure the dependencies and pull directly from GitHub:

[dependencies]
tokio = "1.0"
tracing = "0.1"
tracing-layer-discord = "0.1"

Examples

See the full list of examples in examples/.

Simple

In this simple example, a layer is created using Discord configuration in the environment. An orphaned event (one with no parent span) and an event occurring within a span are created in three separate futures, and a number of messages are sent quickly to Discord.

Discord Messages

This screenshots shows the first three Discord messages sent while running this example. More messages are sent but were truncated from these images.

Discord Blocks

By default, messages are sent using Discord Blocks. Here’s an example:

Code example

Run this example locally using the following commands:

$ git clone https://github.com/seanpianka/tracing-layer-discord.git
$ cd tracing-layer-discord
$ cargo run --example simple

You must have Discord configuration exported in the environment.

Source

use regex::Regex;
use tracing::{info, warn, instrument};
use tracing_subscriber::{layer::SubscriberExt, Registry};

use tracing_layer_discord::{EventFilters, DiscordLayer};

#[instrument]
pub async fn create_user(id: u64) -> u64 {
    network_io(id).await;
    info!(param = id, "A user was created");
    id
}

#[instrument]
pub async fn network_io(id: u64) {
    warn!(user_id = id, "some network io happened");
}

pub async fn controller() {
    info!("Orphan event without a parent span");
    let (id1, id2, id3) = tokio::join!(create_user(2), create_user(4), create_user(6));
}

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

    // Initialize the layer and an async background task for sending our Discord messages.
    let (discord_layer, background_worker) = DiscordLayer::builder("my-app-name".to_string(), target_to_filter).build();
    // Initialize the global default subscriber for tracing events.
    let subscriber = Registry::default().with(discord_layer);
    tracing::subscriber::set_global_default(subscriber).unwrap();

    // It must be explicitly started before any messages will be handled.
    background_worker.start().await;
    // Perform our application code that needs tracing and Discord messages.
    controller().await;
    // Waits for all Discord messages to be sent before exiting.
    background_worker.shutdown().await;
}

Structs

BackgroundWorker

This worker manages a background async task that schedules the network requests to send traces to the webhook on the running tokio runtime.

DiscordConfig

Configuration describing how to forward tracing events to Discord.

DiscordLayer

EventFilters

EventFilters describes two optional lists of regular expressions used to filter events.

WebhookLayer

Layer for forwarding tracing events to webhook endpoints.