From: Christian Ebner <c.ebner@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [PATCH proxmox-backup v7 28/34] notification: define templates and template data for thresholds
Date: Wed, 1 Apr 2026 15:48:11 +0200 [thread overview]
Message-ID: <20260401134817.926499-29-c.ebner@proxmox.com> (raw)
In-Reply-To: <20260401134817.926499-1-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>
Reviewed-by: Hannes Laimer <h.laimer@proxmox.com>
Tested-by: Hannes Laimer <h.laimer@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
next prev parent reply other threads:[~2026-04-01 13:55 UTC|newest]
Thread overview: 39+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-04-01 13:47 [PATCH proxmox{,-backup} v7 00/34] partially fix #6563: add s3 counter for statistics and notifications Christian Ebner
2026-04-01 13:47 ` [PATCH proxmox v7 01/34] s3-client: add persistent shared request counters for client Christian Ebner
2026-04-01 13:47 ` [PATCH proxmox v7 02/34] s3-client: add counters for upload/download traffic Christian Ebner
2026-04-01 13:47 ` [PATCH proxmox v7 03/34] s3-client: account for upload traffic on successful request sending Christian Ebner
2026-04-01 13:47 ` [PATCH proxmox v7 04/34] s3-client: account for downloaded bytes in incoming response body Christian Ebner
2026-04-01 13:47 ` [PATCH proxmox v7 05/34] s3-client: request counters: periodically persist counters to file Christian Ebner
2026-04-01 13:47 ` [PATCH proxmox v7 06/34] s3-client: sync flush request counters on client instance drop Christian Ebner
2026-04-01 13:47 ` [PATCH proxmox v7 07/34] s3-client: api-types: define request counter thresholds Christian Ebner
2026-04-01 13:47 ` [PATCH proxmox v7 08/34] s3-client: implement request counter threshold and exceeding callback Christian Ebner
2026-04-01 13:47 ` [PATCH proxmox v7 09/34] pbs-api-types: define api type for s3 request statistics Christian Ebner
2026-04-01 13:47 ` [PATCH proxmox v7 10/34] pbs-api-types: add notification thresholds to datastore config Christian Ebner
2026-04-01 13:47 ` [PATCH proxmox v7 11/34] pbs-api-types: add reset schedule for notification threshold counters Christian Ebner
2026-04-01 13:47 ` [PATCH proxmox-backup v7 12/34] metrics: split common module imports into individual use statements Christian Ebner
2026-04-01 13:47 ` [PATCH proxmox-backup v7 13/34] ui: improve variable name indirectly fixing typo Christian Ebner
2026-04-01 13:47 ` [PATCH proxmox-backup v7 14/34] notifications: template data: fix typos in docstrings Christian Ebner
2026-04-01 13:47 ` [PATCH proxmox-backup v7 15/34] datastore: collect request statistics for s3 backed datastores Christian Ebner
2026-04-01 13:47 ` [PATCH proxmox-backup v7 16/34] datastore: expose request counters " Christian Ebner
2026-04-01 13:48 ` [PATCH proxmox-backup v7 17/34] api: s3: add endpoint to reset s3 request counters Christian Ebner
2026-04-01 13:48 ` [PATCH proxmox-backup v7 18/34] bin: s3: expose request counter reset method as cli command Christian Ebner
2026-04-01 13:48 ` [PATCH proxmox-backup v7 19/34] ui: datastore summary: move store to be part of summary panel Christian Ebner
2026-04-01 13:48 ` [PATCH proxmox-backup v7 20/34] ui: expose s3 request counter statistics in the datastore summary Christian Ebner
2026-04-01 13:48 ` [PATCH proxmox-backup v7 21/34] metrics: collect s3 datastore statistics as rrd metrics Christian Ebner
2026-04-01 13:48 ` [PATCH proxmox-backup v7 22/34] api: admin: expose s3 statistics in datastore rrd data Christian Ebner
2026-04-01 13:48 ` [PATCH proxmox-backup v7 23/34] partially fix #6563: ui: expose s3 rrd charts in datastore summary Christian Ebner
2026-04-01 13:48 ` [PATCH proxmox-backup v7 24/34] datastore: refactor datastore lookup parameters into dedicated type Christian Ebner
2026-04-01 13:48 ` [PATCH proxmox-backup v7 25/34] api: config: update notification thresholds for config and counters Christian Ebner
2026-04-01 13:48 ` [PATCH proxmox-backup v7 26/34] ui: utils: add helper to render notification threshold property string Christian Ebner
2026-04-01 22:32 ` Thomas Lamprecht
2026-04-01 13:48 ` [PATCH proxmox-backup v7 27/34] ui: add notification thresholds edit window Christian Ebner
2026-04-01 13:48 ` Christian Ebner [this message]
2026-04-01 13:48 ` [PATCH proxmox-backup v7 29/34] datastore: add thresholds notification callback on datastore lookup Christian Ebner
2026-04-01 13:48 ` [PATCH proxmox-backup v7 30/34] api/ui: notifications: add 'thresholds' as notification type value Christian Ebner
2026-04-01 13:48 ` [PATCH proxmox-backup v7 31/34] api: config: allow counter reset schedule editing Christian Ebner
2026-04-01 13:48 ` [PATCH proxmox-backup v7 32/34] ui: expose counter reset schedule edit window Christian Ebner
2026-04-01 13:48 ` [PATCH proxmox-backup v7 33/34] bin: proxy: periodically schedule counter reset task Christian Ebner
2026-04-01 13:48 ` [PATCH proxmox-backup v7 34/34] ui: add task description for scheduled counter reset Christian Ebner
2026-04-01 22:20 ` partially-applied: [PATCH proxmox{,-backup} v7 00/34] partially fix #6563: add s3 counter for statistics and notifications Thomas Lamprecht
2026-04-01 22:44 ` applied: " Thomas Lamprecht
2026-04-02 10:54 ` superseded: " Christian Ebner
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20260401134817.926499-29-c.ebner@proxmox.com \
--to=c.ebner@proxmox.com \
--cc=pbs-devel@lists.proxmox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.