Server: {{ hostname }}
-There are {{ rows | length }} rows.
-"#; - let alert: AlertDefinition = serde_yml::from_str(&alert).unwrap(); - let alert = alert.normalise(&Default::default()); - assert_eq!(alert.interval, std::time::Duration::default()); - assert!( - matches!(alert.source, TicketSource::Sql { sql } if sql == "SELECT $1::timestamptz;") - ); - assert!(matches!(alert.send[0], SendTarget::Email { .. })); - } - - #[test] - fn test_alert_parse_shell() { - let alert = r#" -shell: bash -run: echo foobar -"#; - let alert: AlertDefinition = serde_yml::from_str(&alert).unwrap(); - let alert = alert.normalise(&Default::default()); - assert_eq!(alert.interval, std::time::Duration::default()); - assert!( - matches!(alert.source, TicketSource::Shell { shell, run } if shell == "bash" && run == "echo foobar") - ); - } - - #[test] - fn test_alert_parse_invalid_source() { - let alert = r#" -shell: bash -"#; - assert!(matches!( - serde_yml::from_str::Server: {{ hostname }}
-There are {{ rows | length }} rows.
-"#; - let alert: AlertDefinition = serde_yml::from_str(&alert).unwrap(); - let alert = alert.normalise(&Default::default()); - assert_eq!(alert.interval, std::time::Duration::default()); - assert!(matches!(alert.send[0], SendTarget::Email { .. })); - } -} +mod tests; diff --git a/crates/bestool/src/actions/tamanu/alerts/command.rs b/crates/bestool/src/actions/tamanu/alerts/command.rs new file mode 100644 index 0000000..1a18345 --- /dev/null +++ b/crates/bestool/src/actions/tamanu/alerts/command.rs @@ -0,0 +1,462 @@ +use std::{ + collections::HashMap, + convert::Infallible, + env::current_dir, + path::{Path, PathBuf}, + sync::Arc, + time::Duration, +}; + +use clap::Parser; +use futures::{future::join_all, TryFutureExt}; +use miette::{Context as _, IntoDiagnostic, Result}; +use tokio::{task::JoinSet, time::timeout}; +use tracing::{debug, error, info, warn}; +use walkdir::WalkDir; + +use super::{definition::AlertDefinition, targets::AlertTargets}; +use crate::actions::{ + tamanu::{config::load_config, find_tamanu, TamanuArgs}, + Context, +}; + +/// Execute alert definitions against Tamanu. +/// +/// An alert definition is a YAML file that describes a single alert +/// source and targets to send triggered alerts to. +/// +/// This tool reads both database and email credentials from Tamanu's own +/// configuration files, see the tamanu subcommand help (one level above) for +/// more on how that's determined. +/// +/// # Example +/// +/// ```yaml +/// sql: | +/// SELECT * FROM fhir.jobs +/// WHERE error IS NOT NULL +/// AND created_at > $1 +/// +/// send: +/// - target: email: +/// addresses: [alerts@tamanu.io] +/// subject: "FHIR job errors ({{ hostname }})" +/// template: | +/// Automated alert! There have been {{ rows | length }} FHIR jobs +/// with errors in the past {{ interval }}. Here are the first 5: +/// {% for row in rows | first(5) %} +/// - {{ row.topic }}: {{ row.error }} +/// {% endfor %} +/// ``` +/// +/// # Template variables +/// +/// Templates are rendered with [Tera](https://keats.github.io/tera/docs/#templates). +/// +/// - `rows`: the result of the SQL query, as a list of objects (if source = sql) +/// - `output`: the result of the shell command (if source = shell) +/// - `interval`: the duration string of the alert interval +/// - `hostname`: the hostname of the machine running this command +/// - `filename`: the name of the alert definition file +/// - `now`: the current date and time +/// +/// Additionally you can `{% include "subject" %}` to include the rendering of +/// the subject template in the email template. +/// +/// # Sources +/// +/// Each alert must have one source that it executes to determine whether the +/// alert is triggered or not. Current sources: `sql`, `shell`. +/// +/// ## SQL +/// +/// This source executes a SQL query, which can have a binding for a datetime in +/// the past to limit results by; returning any rows indicates an alert trigger. +/// +/// ```yaml +/// sql: | +/// SELECT 1 + 1 +/// ``` +/// +/// ### Query binding parameters +/// +/// The SQL query will be passed exactly the number of parameters it expects. +/// The parameters are always provided in this order: +/// +/// - `$1`: the datetime of the start of the interval (timestamp with time zone) +/// - `$2`: the interval duration (interval) +/// +/// ## Shell +/// +/// This source executes a shell script. Returning a non-zero exit code +/// indicates an alert trigger. The stdout of the script will be the `output` +/// template variable. +/// +/// ```yaml +/// shell: bash +/// run: | +/// echo foo +/// exit 1 +/// ``` +/// +/// # Send targets +/// +/// You can send triggered alerts to one or more different targets. Current send +/// targets are: `email`, `slack`, `zendesk`. Note that you can have multiple +/// targets of the same type. +/// +/// ## Email +/// +/// ```yaml +/// send: +/// - target: email +/// addresses: +/// - staff@job.com +/// - support@job.com +/// ``` +/// +/// ## Slack +/// +/// ```yaml +/// send: +/// - target: slack +/// webhook: https://hooks.slack.com/services/... +/// template: | +/// _Alert!_ There are {{ rows | length }} rows with errors. +/// ``` +/// +/// You can customise the payload sent to Slack by specifying fields: +/// +/// ```yaml +/// send: +/// - target: slack +/// webhook: https://hooks.slack.com/services/... +/// # ... +/// fields: +/// - name: alertname +/// field: filename # this will be replaced with the filename of the alert +/// - name: deployment +/// value: production # this will be the exact value 'production' +/// ``` +/// +/// The default set of fields is: +/// +/// ```yaml +/// - name: hostname +/// field: hostname +/// - name: filename +/// field: filename +/// - name: subject +/// field: subject +/// - name: message +/// field: body +/// ``` +/// +/// Overriding the `fields` will replace the default set entirely (so you may +/// want to include all the ones you're not changing). +/// +/// ## Zendesk (authenticated) +/// +/// ```yaml +/// send: +/// - target: zendesk +/// endpoint: https://example.zendesk.com/api/v2/requests +/// credentials: +/// email: foo@example.com +/// password: pass +/// ticket_form_id: 500 +/// custom_fields: +/// - id: 100 +/// value: tamanu_ +/// - id: 200 +/// value: Test +/// ``` +/// +/// ## Zendesk (anonymous) +/// +/// ```yaml +/// send: +/// - target: zendesk +/// endpoint: https://example.zendesk.com/api/v2/requests +/// requester: Name of requester +/// ticket_form_id: 500 +/// custom_fields: +/// - id: 100 +/// value: tamanu_ +/// - id: 200 +/// value: Test +/// ``` +/// +/// ## External targets +/// +/// It can be tedious to specify and update the same addresses in many different +/// alert files, especially for more complex send targets. You can create a +/// `_targets.yml` file in any of the `--dir`s (if there are multiple such files +/// they will be merged). +/// +/// ```yaml +/// targets: +/// - id: email-staff +/// target: email +/// addresses: +/// - staff@job.com +/// - id: zendesk-normal +/// target: zendesk +/// endpoint: https://... +/// credentials: +/// email: the@bear.com +/// password: ichooseyou +/// ``` +/// +/// The `subject` and `template` fields are omitted in the `_targets.yml`. +/// +/// Then in the alerts file, specify `external` targets, with the relevant `id`s +/// and the `subject` and `template`: +/// +/// ```yaml +/// send: +/// - target: external +/// id: email-staff +/// subject: [Alert] Something is wrong +/// template: | +///Server: {{ hostname }}
+There are {{ rows | length }} rows.
+"#; + let alert: AlertDefinition = serde_yml::from_str(&alert).unwrap(); + let alert = alert.normalise(&Default::default()); + assert_eq!(alert.interval, std::time::Duration::default()); + assert!(matches!(alert.source, TicketSource::Sql { sql } if sql == "SELECT $1::timestamptz;")); + assert!(matches!(alert.send[0], SendTarget::Email { .. })); +} + +#[test] +fn test_alert_parse_shell() { + let alert = r#" +shell: bash +run: echo foobar +"#; + let alert: AlertDefinition = serde_yml::from_str(&alert).unwrap(); + let alert = alert.normalise(&Default::default()); + assert_eq!(alert.interval, std::time::Duration::default()); + assert!( + matches!(alert.source, TicketSource::Shell { shell, run } if shell == "bash" && run == "echo foobar") + ); +} + +#[test] +fn test_alert_parse_invalid_source() { + let alert = r#" +shell: bash +"#; + assert!(matches!( + serde_yml::from_str::Server: {{ hostname }}
+There are {{ rows | length }} rows.
+"#; + let alert: AlertDefinition = serde_yml::from_str(&alert).unwrap(); + let alert = alert.normalise(&Default::default()); + assert_eq!(alert.interval, std::time::Duration::default()); + assert!(matches!(alert.send[0], SendTarget::Email { .. })); +} diff --git a/crates/bestool/src/actions/tamanu/backup.rs b/crates/bestool/src/actions/tamanu/backup.rs index 51ae5a2..9fc685d 100644 --- a/crates/bestool/src/actions/tamanu/backup.rs +++ b/crates/bestool/src/actions/tamanu/backup.rs @@ -20,12 +20,14 @@ use tracing::{debug, info, instrument, warn}; use crate::{ actions::{ - tamanu::{config::load_config, find_package, find_postgres_bin, find_tamanu, TamanuArgs}, + tamanu::{config::load_config, find_postgres_bin, find_tamanu, TamanuArgs}, Context, }, now_time, }; +use super::config::TamanuConfig; + /// Backup a local Tamanu database to a single file. /// /// This finds the database from the Tamanu's configuration. The output will be written to a file @@ -96,20 +98,6 @@ pub struct BackupArgs { pub key: KeyArgs, } -#[derive(serde::Deserialize, Debug)] -#[serde(rename_all = "camelCase")] -pub struct TamanuConfig { - pub canonical_host_name: String, - pub db: TamanuDb, -} - -#[derive(serde::Deserialize, Debug)] -pub struct TamanuDb { - pub name: String, - pub username: String, - pub password: String, -} - pub async fn run(ctx: Context