bestool-alertd 6.0.0

(Internal) BES tooling: Alert daemon
Documentation
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
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
use std::collections::HashMap;

use miette::Result;
use tera::Context as TeraCtx;
use tracing::{debug, error, info, warn};

use crate::{
	LogError,
	alert::{AlertDefinition, InternalContext},
	targets::{ExternalTarget, ResolvedTarget, determine_default_target},
};

/// Build the synthetic alert file used by event triggers and clears.
///
/// Embedding the entity key in the file stem keeps the canopy ref stable
/// across trigger and clear for the same logical entity (e.g. the same
/// failing alert), and distinct across different entities.
fn synthetic_alert_file(event_type: &EventType, entity_key: Option<&str>) -> std::path::PathBuf {
	match entity_key {
		Some(key) => format!("[internal:{}:{}]", event_type.as_str(), key).into(),
		None => format!("[internal:{}]", event_type.as_str()).into(),
	}
}

fn synthetic_alert(event_type: &EventType, entity_key: Option<&str>) -> AlertDefinition {
	AlertDefinition {
		file: synthetic_alert_file(event_type, entity_key),
		enabled: true,
		interval: "0 seconds".to_string(),
		interval_duration: std::time::Duration::from_secs(0),
		always_send: crate::alert::AlwaysSend::Boolean(false),
		when_changed: crate::alert::WhenChanged::default(),
		send: Vec::new(),
		// Synthesised internal-event alerts (e.g. source-error, definition-error)
		// aren't tied to a specific server kind — they run wherever the daemon
		// does. `None` means "any" (no filter).
		server_kind: None,
		source: crate::alert::TicketSource::Event {
			event: event_type.clone(),
		},
	}
}

/// Internal event types that can trigger alerts
#[derive(Debug, Clone, PartialEq, Eq, Hash, serde::Deserialize, serde::Serialize)]
#[serde(rename_all = "kebab-case")]
pub enum EventType {
	SourceError,
	DefinitionError,
	DatabaseDown,
}

impl EventType {
	pub fn as_str(&self) -> &'static str {
		match self {
			Self::SourceError => "source-error",
			Self::DefinitionError => "definition-error",
			Self::DatabaseDown => "database-down",
		}
	}
}

/// Context data for an event
#[derive(Debug, Clone)]
pub enum EventContext {
	SourceError {
		alert_file: String,
		error_message: String,
	},
	DefinitionError {
		alert_file: String,
		error_message: String,
	},
	DatabaseDown {
		database_url: String,
		error_message: String,
	},
}

impl EventContext {
	pub fn to_tera_context(&self) -> TeraCtx {
		let mut ctx = TeraCtx::new();
		match self {
			Self::SourceError {
				alert_file,
				error_message,
			} => {
				ctx.insert("alert_file", alert_file);
				ctx.insert("error_message", error_message);
			}
			Self::DefinitionError {
				alert_file,
				error_message,
			} => {
				ctx.insert("alert_file", alert_file);
				ctx.insert("error_message", error_message);
			}
			Self::DatabaseDown {
				database_url,
				error_message,
			} => {
				ctx.insert("database_url", database_url);
				ctx.insert("error_message", error_message);
			}
		}
		ctx
	}
}

/// Manages event-triggered alerts
#[derive(Clone)]
pub struct EventManager {
	/// Alerts that listen for specific events
	event_alerts: HashMap<EventType, Vec<(AlertDefinition, Vec<ResolvedTarget>)>>,
	/// Default target for fallback alerts
	default_target: Option<ResolvedTarget>,
}

impl EventManager {
	pub fn new(
		alerts: Vec<(AlertDefinition, Vec<ResolvedTarget>)>,
		external_targets: &HashMap<String, Vec<ExternalTarget>>,
	) -> Self {
		let mut event_alerts: HashMap<EventType, Vec<(AlertDefinition, Vec<ResolvedTarget>)>> =
			HashMap::new();

		debug!(total_alerts = alerts.len(), "initializing event manager");

		// Separate event-based alerts from regular alerts
		for (alert, targets) in alerts {
			if let crate::alert::TicketSource::Event { event } = &alert.source {
				debug!(
					file = ?alert.file,
					event = event.as_str(),
					targets = targets.len(),
					"registered event alert"
				);
				event_alerts
					.entry(event.clone())
					.or_default()
					.push((alert, targets));
			}
		}

		info!(
			event_types = ?event_alerts.keys().collect::<Vec<_>>(),
			total_event_alerts = event_alerts.values().map(|v| v.len()).sum::<usize>(),
			"event manager initialized"
		);

		let default_target = determine_default_target(external_targets).map(|t| ResolvedTarget {
			target_id: t.id.clone(),
			subject: None,
			template: String::new(),
			conn: t.conn.clone(),
		});
		if let Some(ref target) = default_target {
			let target_desc = match &target.conn {
				crate::targets::TargetConnection::Email(email) => email
					.addresses
					.first()
					.cloned()
					.unwrap_or_else(|| "unknown".into()),
				crate::targets::TargetConnection::Slack(slack) => {
					format!("slack:{}", slack.webhook.host_str().unwrap_or("unknown"))
				}
				crate::targets::TargetConnection::Canopy(_) => "canopy".to_string(),
			};
			info!(
				from = %target_desc,
				"determined default target for fallback alerts"
			);
		}

		Self {
			event_alerts,
			default_target,
		}
	}

	/// Trigger an event with the given context.
	///
	/// `entity_key` identifies the specific subject of the event (e.g. the
	/// erroring alert's file path). It's embedded in the synthetic alert file
	/// so canopy refs are stable across trigger and clear for the same
	/// subject, and distinct across different subjects. Pass `None` for
	/// events that have only one possible subject per host (e.g. the database).
	pub async fn trigger_event(
		&self,
		event_type: EventType,
		ctx: &InternalContext,
		email: Option<&crate::EmailConfig>,
		dry_run: bool,
		event_context: EventContext,
		entity_key: Option<&str>,
	) -> Result<()> {
		info!(
			event = event_type.as_str(),
			entity_key,
			has_alerts = self.event_alerts.contains_key(&event_type),
			has_default_target = self.default_target.is_some(),
			"triggering event"
		);

		// Check if there are explicit alerts for this event
		if let Some(alerts) = self.event_alerts.get(&event_type) {
			info!(count = alerts.len(), "executing event alerts");
			for (alert, targets) in alerts {
				let mut tera_ctx = crate::templates::build_context(alert, jiff::Timestamp::now());
				// Merge event context
				tera_ctx.extend(event_context.to_tera_context());

				for target in targets {
					if let Err(err) = target.send(alert, &mut tera_ctx, email, ctx, dry_run).await {
						error!(file = ?alert.file, "failed to send event alert: {}", LogError(&err));
					}
				}
			}
		} else if let Some(ref default_target) = self.default_target {
			// No explicit alert, use default target with event-specific template
			info!(
				event = event_type.as_str(),
				"using default target for event (no explicit alert configured)"
			);

			let (subject_template, body_template) = default_event_template(&event_type);

			let default_target_for_event = ResolvedTarget {
				target_id: default_target.target_id.clone(),
				subject: Some(subject_template),
				template: body_template,
				conn: default_target.conn.clone(),
			};

			let alert = synthetic_alert(&event_type, entity_key);

			let mut tera_ctx = crate::templates::build_context(&alert, jiff::Timestamp::now());
			tera_ctx.extend(event_context.to_tera_context());

			if let Err(err) = default_target_for_event
				.send(&alert, &mut tera_ctx, email, ctx, dry_run)
				.await
			{
				error!("failed to send default event alert: {}", LogError(&err));
			}
		} else {
			warn!(
				event = event_type.as_str(),
				"no alerts or default target for event, skipping notification"
			);
		}

		Ok(())
	}

	/// Send a clearing notification for an event.
	///
	/// Mirrors `trigger_event`, but calls `send_clear` on each target so
	/// stateful sinks (canopy) flip the corresponding issue to `active=false`.
	/// Non-stateful sinks (email, slack) return immediately — that's the same
	/// behaviour as SQL-alert clears.
	///
	/// `entity_key` must match the value passed to the original
	/// `trigger_event` so the canopy ref lines up.
	pub async fn trigger_clear(
		&self,
		event_type: EventType,
		ctx: &InternalContext,
		dry_run: bool,
		entity_key: Option<&str>,
	) -> Result<()> {
		info!(
			event = event_type.as_str(),
			entity_key,
			has_alerts = self.event_alerts.contains_key(&event_type),
			has_default_target = self.default_target.is_some(),
			"clearing event"
		);

		if let Some(alerts) = self.event_alerts.get(&event_type) {
			info!(count = alerts.len(), "clearing event alerts");
			for (alert, targets) in alerts {
				for target in targets {
					if let Err(err) = target.send_clear(alert, ctx, dry_run).await {
						error!(file = ?alert.file, "failed to clear event alert: {}", LogError(&err));
					}
				}
			}
		} else if let Some(ref default_target) = self.default_target {
			info!(
				event = event_type.as_str(),
				"clearing default target for event"
			);

			let default_target_for_event = ResolvedTarget {
				target_id: default_target.target_id.clone(),
				subject: None,
				template: String::new(),
				conn: default_target.conn.clone(),
			};

			let alert = synthetic_alert(&event_type, entity_key);

			if let Err(err) = default_target_for_event
				.send_clear(&alert, ctx, dry_run)
				.await
			{
				error!("failed to clear default event alert: {}", LogError(&err));
			}
		} else {
			debug!(
				event = event_type.as_str(),
				"no alerts or default target for event, skipping clear"
			);
		}

		Ok(())
	}
}

fn default_event_template(event_type: &EventType) -> (String, String) {
	match event_type {
		EventType::SourceError => (
			"[bestool-alertd] {{ hostname }}: Failed alert: {{ alert_file }}".to_string(),
			"<pre>{{ error_message }}</pre>".to_string(),
		),
		EventType::DefinitionError => (
			"[bestool-alertd] {{ hostname }}: Invalid alert definition: {{ alert_file }}"
				.to_string(),
			"<pre>{{ error_message }}</pre>".to_string(),
		),
		EventType::DatabaseDown => (
			"[bestool-alertd] {{ hostname }}: Database unreachable".to_string(),
			"The PostgreSQL database is unreachable.\n\n\
			 Database URL: {{ database_url }}\n\
			 Error: <pre>{{ error_message }}</pre>\n\n\
			 All SQL-based alerts are non-functional until the database is restored."
				.to_string(),
		),
	}
}

#[cfg(test)]
mod tests {
	use super::*;

	#[test]
	fn test_event_type_parsing() {
		let yaml = "source-error";
		let event: EventType = serde_yaml::from_str(yaml).unwrap();
		assert_eq!(event, EventType::SourceError);
	}

	#[test]
	fn test_event_type_as_str() {
		assert_eq!(EventType::SourceError.as_str(), "source-error");
		assert_eq!(EventType::DefinitionError.as_str(), "definition-error");
		assert_eq!(EventType::DatabaseDown.as_str(), "database-down");
	}

	#[test]
	fn test_event_type_serialization() {
		let event = EventType::SourceError;
		let yaml = serde_yaml::to_string(&event).unwrap();
		assert!(yaml.contains("source-error"));
	}

	#[test]
	fn test_event_context_to_tera_source_error() {
		let ctx = EventContext::SourceError {
			alert_file: "/etc/alerts/test.yml".to_string(),
			error_message: "Something went wrong".to_string(),
		};

		let tera_ctx = ctx.to_tera_context();
		assert_eq!(
			tera_ctx.get("alert_file").unwrap().as_str().unwrap(),
			"/etc/alerts/test.yml"
		);
		assert_eq!(
			tera_ctx.get("error_message").unwrap().as_str().unwrap(),
			"Something went wrong"
		);
	}

	#[test]
	fn test_event_type_database_down() {
		let yaml = "database-down";
		let event: EventType = serde_yaml::from_str(yaml).unwrap();
		assert_eq!(event, EventType::DatabaseDown);
	}

	#[test]
	fn test_event_context_to_tera_database_down() {
		let ctx = EventContext::DatabaseDown {
			database_url: "postgresql://localhost/mydb".to_string(),
			error_message: "connection refused".to_string(),
		};

		let tera_ctx = ctx.to_tera_context();
		assert_eq!(
			tera_ctx.get("database_url").unwrap().as_str().unwrap(),
			"postgresql://localhost/mydb"
		);
		assert_eq!(
			tera_ctx.get("error_message").unwrap().as_str().unwrap(),
			"connection refused"
		);
	}

	#[test]
	fn test_event_type_definition_error() {
		let yaml = "definition-error";
		let event: EventType = serde_yaml::from_str(yaml).unwrap();
		assert_eq!(event, EventType::DefinitionError);
	}

	#[test]
	fn test_event_context_to_tera_definition_error() {
		let ctx = EventContext::DefinitionError {
			alert_file: "/etc/alerts/broken.yml".to_string(),
			error_message: "Invalid YAML syntax".to_string(),
		};

		let tera_ctx = ctx.to_tera_context();
		assert_eq!(
			tera_ctx.get("alert_file").unwrap().as_str().unwrap(),
			"/etc/alerts/broken.yml"
		);
		assert_eq!(
			tera_ctx.get("error_message").unwrap().as_str().unwrap(),
			"Invalid YAML syntax"
		);
	}

	#[test]
	fn synthetic_alert_file_without_entity_key() {
		let path = synthetic_alert_file(&EventType::DatabaseDown, None);
		assert_eq!(path.to_string_lossy(), "[internal:database-down]");
	}

	#[test]
	fn synthetic_alert_file_with_entity_key() {
		let path = synthetic_alert_file(&EventType::SourceError, Some("disk-full.yml"));
		assert_eq!(
			path.to_string_lossy(),
			"[internal:source-error:disk-full.yml]"
		);
	}

	#[test]
	fn synthetic_alert_file_distinguishes_entities() {
		let a = synthetic_alert_file(&EventType::DefinitionError, Some("a.yml"));
		let b = synthetic_alert_file(&EventType::DefinitionError, Some("b.yml"));
		assert_ne!(a, b);
	}

	#[test]
	fn synthetic_alert_file_stem_includes_entity_for_canopy_ref() {
		// build_ref uses file_stem() to form the canopy ref. Verify that
		// trigger and clear with the same entity key produce identical stems.
		let trigger = synthetic_alert_file(&EventType::SourceError, Some("my-alert"));
		let clear = synthetic_alert_file(&EventType::SourceError, Some("my-alert"));
		assert_eq!(trigger.file_stem(), clear.file_stem());

		// And distinct entities produce distinct stems so canopy treats them
		// as separate issues.
		let other = synthetic_alert_file(&EventType::SourceError, Some("other-alert"));
		assert_ne!(trigger.file_stem(), other.file_stem());
	}
}