1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
use std::collections::HashMap;
use std::str::FromStr;
use std::sync::Arc;
use regex::Regex;
use serde::ser::SerializeMap;
use serde::Serializer;
use serde_json::Value;
use tokio::sync::Mutex;
use tracing::{Event, Subscriber};
use tracing::log::LevelFilter;
use tracing_bunyan_formatter::JsonStorage;
use tracing_subscriber::Layer;
use tracing_subscriber::layer::Context;
use crate::{BackgroundWorker, ChannelSender, Config, EventFilters, WebhookMessageFactory, WebhookMessageInputs, WorkerMessage};
use crate::filters::{Filter, FilterError};
use crate::worker::worker;
/// Layer for forwarding tracing events to webhook endpoints.
pub struct WebhookLayer<C: Config, F: WebhookMessageFactory> {
/// Filter events by their target.
///
/// Filter type semantics:
/// - Subtractive: Exclude an event if the target does NOT MATCH a given regex.
/// - Additive: Exclude an event if the target MATCHES a given regex.
target_filters: EventFilters,
/// 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.
message_filters: Option<EventFilters>,
/// 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.
event_by_field_filters: Option<EventFilters>,
/// Filter fields of events from being sent to Discord.
///
/// Filter type semantics:
/// - Positive: Exclude event fields if the field's key MATCHES any provided regular expressions.
field_exclusion_filters: Option<Vec<Regex>>,
/// Filter events by their level.
level_filter: Option<String>,
app_name: String,
/// Configure the layer's connection to the Webhook API.
config: C,
factory: std::marker::PhantomData<F>,
/// An unbounded sender, which the caller must send `WorkerMessage::Shutdown` in order to cancel
/// worker's receive-send loop.
sender: ChannelSender,
}
impl<C: Config, F: WebhookMessageFactory> WebhookLayer<C, F> {
/// Create a new layer for forwarding messages to Discord, using a specified
/// configuration. This method spawns a task onto the tokio runtime to begin sending tracing
/// events to Discord.
///
/// Returns the tracing_subscriber::Layer impl to add to a registry, an unbounded-mpsc sender
/// used to shutdown the background worker, and a future to spawn as a task on a tokio runtime
/// to initialize the worker's processing and sending of HTTP requests to the Discord API.
pub(crate) fn new(
app_name: String,
target_filters: EventFilters,
message_filters: Option<EventFilters>,
event_by_field_filters: Option<EventFilters>,
field_exclusion_filters: Option<Vec<Regex>>,
level_filter: Option<String>,
config: C,
) -> (WebhookLayer<C, F>, BackgroundWorker) {
let (tx, rx) = tokio::sync::mpsc::unbounded_channel();
let layer = WebhookLayer {
target_filters,
message_filters,
field_exclusion_filters,
event_by_field_filters,
level_filter,
app_name,
config,
factory: Default::default(),
sender: tx.clone(),
};
let worker = BackgroundWorker {
sender: tx,
handle: Arc::new(Mutex::new(Some(tokio::spawn(worker(rx))))),
};
(layer, worker)
}
/// Create a new builder for DiscordLayer.
pub fn builder(app_name: String, target_filters: EventFilters) -> WebhookLayerBuilder<C, F> {
WebhookLayerBuilder::new(app_name, target_filters)
}
}
/// A builder for creating a webhook layer.
///
/// The layer requires a regex for selecting events to be sent to Discord 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 Discord
/// configuration that defaults to searching in the local environment variables.
pub struct WebhookLayerBuilder<C: Config, F: WebhookMessageFactory> {
factory: std::marker::PhantomData<F>,
app_name: String,
target_filters: EventFilters,
message_filters: Option<EventFilters>,
event_by_field_filters: Option<EventFilters>,
field_exclusion_filters: Option<Vec<Regex>>,
level_filters: Option<String>,
config: Option<C>,
}
impl<C: Config, F: WebhookMessageFactory> WebhookLayerBuilder<C, F> {
pub(crate) fn new(app_name: String, target_filters: EventFilters) -> Self {
Self {
factory: Default::default(),
app_name,
target_filters,
message_filters: None,
event_by_field_filters: None,
field_exclusion_filters: None,
level_filters: None,
config: None,
}
}
/// 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.
pub fn message_filters(mut self, filters: EventFilters) -> Self {
self.message_filters = Some(filters);
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.
pub fn event_by_field_filters(mut self, filters: EventFilters) -> Self {
self.event_by_field_filters = Some(filters);
self
}
/// Filter fields of events from being sent to Discord.
///
/// Filter type semantics:
/// - Positive: Exclude event fields if the field's key MATCHES any provided regular expressions.
pub fn field_exclusion_filters(mut self, filters: Vec<Regex>) -> Self {
self.field_exclusion_filters = Some(filters);
self
}
/// Configure the layer's connection to the Discord Webhook API.
pub fn config(mut self, config: C) -> Self {
self.config = Some(config);
self
}
/// Configure which levels of events to send to Discord.
pub fn level_filters(mut self, level_filters: String) -> Self {
self.level_filters = Some(level_filters);
self
}
/// Create a DiscordLayer and its corresponding background worker to (async) send the messages.
pub fn build(self) -> (WebhookLayer<C, F>, BackgroundWorker) {
WebhookLayer::new(
self.app_name,
self.target_filters,
self.message_filters,
self.event_by_field_filters,
self.field_exclusion_filters,
self.level_filters,
self.config.unwrap_or_else(C::new_from_env),
)
}
}
impl<S, C, F> Layer<S> for WebhookLayer<C, F>
where
S: Subscriber + for<'a> tracing_subscriber::registry::LookupSpan<'a>,
C: Config+ 'static,
F: WebhookMessageFactory + 'static,
{
fn on_event(&self, event: &Event<'_>, ctx: Context<'_, S>) {
let current_span = ctx.lookup_current();
let mut event_visitor = JsonStorage::default();
event.record(&mut event_visitor);
let format = || {
const KEYWORDS: [&str; 2] = ["message", "error"];
let target = event.metadata().target();
self.target_filters.process(target)?;
// Extract the "message" field, if provided. Fallback to the target, if missing.
let message = event_visitor
.values()
.get("message")
.and_then(|v| match v {
Value::String(s) => Some(s.as_str()),
_ => None,
})
.or_else(|| {
event_visitor.values().get("error").and_then(|v| match v {
Value::String(s) => Some(s.as_str()),
_ => None,
})
})
.unwrap_or("No message");
self.message_filters.process(message)?;
if let Some(level_filters) = &self.level_filter {
let message_level = {
LevelFilter::from_str(event.metadata().level().as_str())
.map_err(|e| FilterError::IoError(Box::new(e)))?
};
let level_threshold =
LevelFilter::from_str(level_filters).map_err(|e| FilterError::IoError(Box::new(e)))?;
if message_level > level_threshold {
return Err(FilterError::PositiveFilterFailed);
}
}
let mut metadata_buffer = Vec::new();
let mut serializer = serde_json::Serializer::new(&mut metadata_buffer);
let mut map_serializer = serializer.serialize_map(None)?;
// Add all the other fields associated with the event, expect the message we
// already used.
for (key, value) in event_visitor
.values()
.iter()
.filter(|(&key, _)| !KEYWORDS.contains(&key))
.filter(|(&key, _)| self.field_exclusion_filters.process(key).is_ok())
{
self.event_by_field_filters.process(key)?;
map_serializer.serialize_entry(key, value)?;
}
// Add all the fields from the current span, if we have one.
if let Some(span) = ¤t_span {
let extensions = span.extensions();
if let Some(visitor) = extensions.get::<JsonStorage>() {
for (key, value) in visitor.values() {
map_serializer.serialize_entry(key, value)?;
}
}
}
map_serializer.end()?;
let span = match ¤t_span {
Some(span) => span.metadata().name(),
None => "",
};
let metadata = {
let data: HashMap<String, Value> = serde_json::from_slice(metadata_buffer.as_slice()).unwrap();
serde_json::to_string_pretty(&data).unwrap()
};
Ok(F::create(WebhookMessageInputs {
app_name: self.app_name.clone(),
message: message.to_string(),
event_level: *event.metadata().level(),
source_file: event.metadata().file().unwrap_or("Unknown").to_string(),
source_line: event.metadata().line().unwrap_or(0),
target: target.to_string(),
span: span.to_string(),
metadata,
webhook_url: self.config.webhook_url().to_string(),
}))
};
let result: Result<_, FilterError> = format();
if let Ok(formatted) = result {
if let Err(e) = self.sender.send(WorkerMessage::Data(Box::new(formatted))) {
tracing::error!(err = %e, "failed to send discord payload to given channel")
};
}
}
}