[PATCH proxmox-backup v4 20/22] notification: define templates and template data for thresholds

[Christian Ebner <c.ebner@proxmox.com>]

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 <c.ebner@proxmox.com>
---
 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<String> {
     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<String>,
 }
+
+/// 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