From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) by lore.proxmox.com (Postfix) with ESMTPS id 093071FF137 for ; Tue, 03 Mar 2026 16:23:55 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 905701BA42; Tue, 3 Mar 2026 16:24:18 +0100 (CET) From: Christian Ebner To: pbs-devel@lists.proxmox.com Subject: [PATCH proxmox-backup v4 20/22] notification: define templates and template data for thresholds Date: Tue, 3 Mar 2026 16:23:15 +0100 Message-ID: <20260303152317.934256-34-c.ebner@proxmox.com> X-Mailer: git-send-email 2.47.3 In-Reply-To: <20260303152317.934256-1-c.ebner@proxmox.com> References: <20260303152317.934256-1-c.ebner@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Bm-Milter-Handled: 55990f41-d878-4baa-be0a-ee34c49e34d2 X-Bm-Transport-Timestamp: 1772551388682 X-SPAM-LEVEL: Spam detection results: 0 AWL 0.051 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Message-ID-Hash: MIQ2ERNV65H5I7MSBRZ77DQZEJYFQZQW X-Message-ID-Hash: MIQ2ERNV65H5I7MSBRZ77DQZEJYFQZQW X-MailFrom: c.ebner@proxmox.com X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; loop; banned-address; emergency; member-moderation; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header X-Mailman-Version: 3.3.10 Precedence: list List-Id: Proxmox Backup Server development discussion List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: Define the templates and data passed to the renderer, required for the datastore threshold notifications to be rendered and send. Signed-off-by: Christian Ebner --- debian/proxmox-backup-server.install | 2 + src/server/notifications/mod.rs | 39 +++++++++++++++++-- src/server/notifications/template_data.rs | 30 ++++++++++++++ templates/Makefile | 2 + .../default/thresholds-exceeded-body.txt.hbs | 9 +++++ .../thresholds-exceeded-subject.txt.hbs | 1 + 6 files changed, 79 insertions(+), 4 deletions(-) create mode 100644 templates/default/thresholds-exceeded-body.txt.hbs create mode 100644 templates/default/thresholds-exceeded-subject.txt.hbs diff --git a/debian/proxmox-backup-server.install b/debian/proxmox-backup-server.install index 254a4b4b4..1f1d9b601 100644 --- a/debian/proxmox-backup-server.install +++ b/debian/proxmox-backup-server.install @@ -67,6 +67,8 @@ usr/share/proxmox-backup/templates/default/tape-load-body.txt.hbs usr/share/proxmox-backup/templates/default/tape-load-subject.txt.hbs usr/share/proxmox-backup/templates/default/test-body.txt.hbs usr/share/proxmox-backup/templates/default/test-subject.txt.hbs +usr/share/proxmox-backup/templates/default/thresholds-exceeded-body.txt.hbs +usr/share/proxmox-backup/templates/default/thresholds-exceeded-subject.txt.hbs usr/share/proxmox-backup/templates/default/verify-err-body.txt.hbs usr/share/proxmox-backup/templates/default/verify-err-subject.txt.hbs usr/share/proxmox-backup/templates/default/verify-ok-body.txt.hbs diff --git a/src/server/notifications/mod.rs b/src/server/notifications/mod.rs index 95ff9ef18..d877fc7c6 100644 --- a/src/server/notifications/mod.rs +++ b/src/server/notifications/mod.rs @@ -23,10 +23,10 @@ const SPOOL_DIR: &str = concatcp!(pbs_buildcfg::PROXMOX_BACKUP_STATE_DIR, "/noti mod template_data; use template_data::{ - AcmeErrTemplateData, CommonData, GcErrTemplateData, GcOkTemplateData, - PackageUpdatesTemplateData, PruneErrTemplateData, PruneOkTemplateData, SyncErrTemplateData, - SyncOkTemplateData, TapeBackupErrTemplateData, TapeBackupOkTemplateData, TapeLoadTemplateData, - VerifyErrTemplateData, VerifyOkTemplateData, + AcmeErrTemplateData, CommonData, DatastoreThresholdExceededTemplateData, GcErrTemplateData, + GcOkTemplateData, PackageUpdatesTemplateData, PruneErrTemplateData, PruneOkTemplateData, + SyncErrTemplateData, SyncOkTemplateData, TapeBackupErrTemplateData, TapeBackupOkTemplateData, + TapeLoadTemplateData, VerifyErrTemplateData, VerifyOkTemplateData, }; /// Initialize the notification system by setting context in proxmox_notify @@ -575,6 +575,37 @@ pub fn send_certificate_renewal_mail(result: &Result<(), Error>) -> Result<(), E Ok(()) } +/// send notification if datastore values are exceeding the set threshold limit. +pub fn send_datastore_threshold_exceeded( + datastore: &str, + threshold: &str, + limit: u64, + value: u64, +) -> Result<(), Error> { + let metadata = HashMap::from([ + ("datastore".into(), datastore.into()), + ("hostname".into(), proxmox_sys::nodename().into()), + ("type".into(), "thresholds".into()), + ]); + + let template_data = DatastoreThresholdExceededTemplateData::new( + datastore.to_string(), + threshold.to_string(), + limit, + value, + ); + + let notification = Notification::from_template( + Severity::Warning, + "thresholds-exceeded", + serde_json::to_value(template_data)?, + metadata, + ); + + send_notification(notification)?; + Ok(()) +} + /// Lookup users email address pub fn lookup_user_email(userid: &Userid) -> Option { if let Ok(user_config) = pbs_config::user::cached_config() { diff --git a/src/server/notifications/template_data.rs b/src/server/notifications/template_data.rs index f410730e1..d01744671 100644 --- a/src/server/notifications/template_data.rs +++ b/src/server/notifications/template_data.rs @@ -342,3 +342,33 @@ pub struct VerifyErrTemplateData { /// The list of snapshots that failed to verify. pub failed_snapshot_list: Vec, } + +/// Template data for the datastore threshold exceeded template. +#[derive(Serialize)] +#[serde(rename_all = "kebab-case")] +pub struct DatastoreThresholdExceededTemplateData { + /// Common properties. + #[serde(flatten)] + pub common: CommonData, + /// The datastore. + pub datastore: String, + /// The threshold which value was exceeded. + pub threshold: String, + /// The set threshold value. + pub limit: u64, + /// The value exceeding the threshold. + pub value: u64, +} + +impl DatastoreThresholdExceededTemplateData { + /// Create new a new instance. + pub fn new(datastore: String, threshold: String, limit: u64, value: u64) -> Self { + Self { + common: CommonData::new(), + datastore, + threshold, + limit, + value, + } + } +} diff --git a/templates/Makefile b/templates/Makefile index 0539902eb..8a4586d78 100644 --- a/templates/Makefile +++ b/templates/Makefile @@ -25,6 +25,8 @@ NOTIFICATION_TEMPLATES= \ default/tape-load-subject.txt.hbs \ default/test-body.txt.hbs \ default/test-subject.txt.hbs \ + default/thresholds-exceeded-body.txt.hbs \ + default/thresholds-exceeded-subject.txt.hbs \ default/verify-err-body.txt.hbs \ default/verify-ok-body.txt.hbs \ default/verify-err-subject.txt.hbs \ diff --git a/templates/default/thresholds-exceeded-body.txt.hbs b/templates/default/thresholds-exceeded-body.txt.hbs new file mode 100644 index 000000000..e7cab6bf3 --- /dev/null +++ b/templates/default/thresholds-exceeded-body.txt.hbs @@ -0,0 +1,9 @@ +Datastore: {{datastore}} +Threshold: {{threshold}} +Limit: {{limit}} + +Threshold {{threshold}}: limit {{limit}} exceeded by value {{value}}. + +Please visit the web interface for further details: + +<{{base-url}}/#DataStore-{{datastore}}> diff --git a/templates/default/thresholds-exceeded-subject.txt.hbs b/templates/default/thresholds-exceeded-subject.txt.hbs new file mode 100644 index 000000000..5aefb8778 --- /dev/null +++ b/templates/default/thresholds-exceeded-subject.txt.hbs @@ -0,0 +1 @@ +Threshold Exceeded For Datastore '{{datastore}}' -- 2.47.3