From: Lukas Wagner <l.wagner@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [PATCH proxmox-backup 46/55] notifications: send all notifications via proxmox-notify's queue
Date: Fri, 13 Nov 2026 16:08:19 +0100 [thread overview]
Message-ID: <20261113150828.756836-47-l.wagner@proxmox.com> (raw)
In-Reply-To: <20261113150828.756836-1-l.wagner@proxmox.com>
Previously, notifications were only queued when sent from an
unprivileged process, which wrote them as JSON files to the spool
directory for the worker in proxmox-backup-api to pick up. Each file
was removed before sending, so a notification was lost if the daemon
stopped while it was being sent. Privileged processes sent
notifications synchronously.
Now every notification is submitted to the queue provided by
proxmox-notify, located in /var/lib/proxmox-backup/notifications/queue.
The queue directory is owned by the privileged user and writable by the
'backup' group, so that both privileged and unprivileged processes can
submit notifications. The worker in proxmox-backup-api is replaced by
proxmox-notify's QueueWorker, which polls the queue every five seconds.
If the worker is interrupted while sending a notification, it retries
sending it up to two times after restart before dropping it.
Notifications that are still in the old spool directory on upgrade
are moved to the new queue when the worker starts.
Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
---
Cargo.toml | 13 ++-
src/bin/proxmox-backup-api.rs | 2 +-
src/server/notifications/mod.rs | 163 ++++++++++++++++----------------
3 files changed, 93 insertions(+), 85 deletions(-)
diff --git a/Cargo.toml b/Cargo.toml
index d609e91fb..bdffd6ffd 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -230,7 +230,18 @@ proxmox-ldap.workspace = true
proxmox-metrics.workspace = true
proxmox-network-api = { workspace = true, features = [ "impl" ] }
proxmox-network-types.workspace = true
-proxmox-notify = { workspace = true, features = [ "pbs-context", "legacy-matchers", "api-impl", "send-impl", "api-types" ]}
+proxmox-notify = {
+ workspace = true,
+ features = [
+ "pbs-context",
+ "legacy-matchers",
+ "api-impl",
+ "send-impl",
+ "api-types",
+ "queue-submitter",
+ "queue-worker"
+ ]
+}
proxmox-openid.workspace = true
proxmox-product-config.workspace = true
proxmox-parallel-handler.workspace = true
diff --git a/src/bin/proxmox-backup-api.rs b/src/bin/proxmox-backup-api.rs
index aad3fabc3..7e38b0225 100644
--- a/src/bin/proxmox-backup-api.rs
+++ b/src/bin/proxmox-backup-api.rs
@@ -60,7 +60,7 @@ async fn run() -> Result<(), Error> {
proxmox_backup::server::create_state_dir()?;
proxmox_backup::server::create_active_operations_dir()?;
proxmox_backup::server::jobstate::create_jobstate_dir()?;
- proxmox_backup::server::notifications::create_spool_dir()?;
+ proxmox_backup::server::notifications::create_notification_dirs()?;
proxmox_backup::tape::create_tape_status_dir()?;
proxmox_backup::tape::create_drive_state_dir()?;
proxmox_backup::tape::create_changer_state_dir()?;
diff --git a/src/server/notifications/mod.rs b/src/server/notifications/mod.rs
index 1e71cd39d..525d8e02b 100644
--- a/src/server/notifications/mod.rs
+++ b/src/server/notifications/mod.rs
@@ -1,15 +1,17 @@
use std::path::Path;
use std::sync::OnceLock;
-use std::time::{Duration, Instant};
+use std::time::Duration;
use anyhow::Error;
use const_format::concatcp;
-use nix::unistd::Uid;
+use nix::sys::stat::Mode;
use proxmox_notify::context::pbs::PBSContext;
+use proxmox_notify::queue::{QueueConsumer, QueueSubmitter, QueueWorker};
use proxmox_notify::{Context, EmailRecipient, Notification, Recipient, Severity};
use proxmox_schema::ApiType;
use proxmox_sys::fs::{CreateOptions, create_path};
+use proxmox_uuid::Uuid;
use crate::tape::TapeNotificationMode;
use pbs_api_types::{
@@ -17,7 +19,9 @@ use pbs_api_types::{
Notify, SyncJobConfig, TapeBackupJobSetup, User, Userid, VerificationJobConfig,
};
-const SPOOL_DIR: &str = concatcp!(pbs_buildcfg::PROXMOX_BACKUP_STATE_DIR, "/notifications");
+const NOTIFICATION_BASE_DIR: &str =
+ concatcp!(pbs_buildcfg::PROXMOX_BACKUP_STATE_DIR, "/notifications");
+const QUEUE_DIR: &str = concatcp!(NOTIFICATION_BASE_DIR, "/queue");
mod template_data;
@@ -35,101 +39,94 @@ pub fn context() -> &'static Context {
CONTEXT.get_or_init(|| Context::new(PBSContext))
}
-/// Create the directory which will be used to temporarily store notifications
-/// which were sent from an unprivileged process.
-pub fn create_spool_dir() -> Result<(), Error> {
+/// Creates directories used for queuing notifications.
+pub fn create_notification_dirs() -> Result<(), Error> {
let backup_user = proxmox_product_config::get_api_user();
let opts = CreateOptions::new()
.owner(backup_user.uid)
.group(backup_user.gid);
- create_path(SPOOL_DIR, None, Some(opts))?;
+ create_path(NOTIFICATION_BASE_DIR, None, Some(opts))?;
+
+ // The queue is writable by anybody in the 'backup' group.
+ let opts = CreateOptions::new()
+ .owner(proxmox_product_config::get_priv_user().uid)
+ .group(backup_user.gid)
+ .perm(Mode::from_bits_truncate(0o0770));
+
+ proxmox_sys::fs::ensure_dir_exists(QUEUE_DIR, &opts, true)?;
+
Ok(())
}
-async fn send_queued_notifications() -> Result<(), Error> {
- let mut read_dir = tokio::fs::read_dir(SPOOL_DIR).await?;
-
- let mut notifications = Vec::new();
-
- while let Some(entry) = read_dir.next_entry().await? {
- let path = entry.path();
-
- if let Some(ext) = path.extension() {
- if ext == "json" {
- let p = path.clone();
-
- let bytes = tokio::fs::read(p).await?;
- let notification: Notification = serde_json::from_slice(&bytes)?;
- notifications.push(notification);
-
- // Currently, there is no retry-mechanism in case of failure...
- // For retries, we'd have to keep track of which targets succeeded/failed
- // to send, so we do not retry notifying a target which succeeded before.
- tokio::fs::remove_file(path).await?;
- }
- }
- }
-
- if notifications.is_empty() {
- return Ok(());
- }
-
- // Make sure that we send the oldest notification first
- notifications.sort_unstable_by_key(|n| n.timestamp());
-
- let context = context();
-
- let res = tokio::task::spawn_blocking(move || {
- let config = pbs_config::notifications::config(context)?;
- for notification in notifications {
- if let Err(err) = proxmox_notify::send(context, &config, ¬ification) {
- log::error!("failed to send notification: {err}");
- }
- }
-
- Ok::<(), Error>(())
- })
- .await?;
-
- if let Err(e) = res {
- log::error!("could not read notification config: {e}");
- }
-
- Ok::<(), Error>(())
-}
-
/// Worker task to periodically send any queued notifications.
pub async fn notification_worker() {
- loop {
- let delay_target = Instant::now() + Duration::from_secs(5);
-
- if let Err(err) = send_queued_notifications().await {
- log::error!("notification worker task error: {err}");
- }
-
- tokio::time::sleep_until(tokio::time::Instant::from_std(delay_target)).await;
+ // At startup, migrate any left-over notifications that weren't delivered
+ // right before the switch to PBS with the newer notification queue/worker.
+ //
+ // FIXME: MAJOR VERSION: Remove
+ if let Err(err) = migrate_leftover_notifications() {
+ log::error!("failed to migrate notifications: {err:#}");
}
+
+ let consumer = QueueConsumer::new(QUEUE_DIR);
+
+ QueueWorker::builder(context().clone(), consumer)
+ .interval(Duration::from_secs(5))
+ .retry_attempts(2)
+ .build()
+ .run()
+ .await;
+}
+
+/// Move any left-over notifications from the old spool directory at
+/// /var/lib/proxmox-backup/notifications to the new queue
+/// at /var/lib/proxmox-backup/notifications/queue
+fn migrate_leftover_notifications() -> Result<(), Error> {
+ let read_dir = std::fs::read_dir(NOTIFICATION_BASE_DIR)?;
+
+ for entry in read_dir.flatten() {
+ if let Some((name, ext)) = entry.file_name().to_string_lossy().split_once(".") {
+ if ext == "json" && Uuid::parse_str(name).is_ok() {
+ let path = entry.path();
+
+ if let Err(err) = migrate_single_notification(&path) {
+ log::error!(
+ "failed to migrate notification at '{p}' to new queue: {err:#}",
+ p = path.display()
+ );
+ }
+ }
+ }
+ }
+
+ Ok(())
+}
+
+fn migrate_single_notification(path: &Path) -> Result<(), Error> {
+ let bytes = std::fs::read(path)?;
+ let notification: Notification = serde_json::from_slice(&bytes)?;
+
+ // Removing the file from the old spool directory before putting it in the new queue is a
+ // deliberate decision: If, for some reason, the old directory is not writable, we don't
+ // want to continue to migrate the same notification over and over again.
+ std::fs::remove_file(path)?;
+
+ let uuid = notification.id().clone();
+
+ // Put notification into new queue
+ send_notification(notification)?;
+
+ log::info!("moved notification with ID '{uuid}' to new notification queue");
+
+ Ok(())
}
fn send_notification(notification: Notification) -> Result<(), Error> {
- let context = context();
-
- if nix::unistd::ROOT == Uid::current() {
- let config = pbs_config::notifications::config(context)?;
- proxmox_notify::send(context, &config, ¬ification)?;
- } else {
- let ser = serde_json::to_vec(¬ification)?;
- let path = Path::new(SPOOL_DIR).join(format!("{id}.json", id = notification.id()));
-
- let backup_user = proxmox_product_config::get_api_user();
- let opts = CreateOptions::new()
- .owner(backup_user.uid)
- .group(backup_user.gid);
- proxmox_sys::fs::replace_file(path, &ser, opts, true)?;
- log::info!("queued notification (id={id})", id = notification.id())
- }
+ let options = proxmox_product_config::default_create_options();
+ let writer = QueueSubmitter::new(QUEUE_DIR, options);
+ writer.submit(¬ification)?;
Ok(())
}
--
2.47.3
next prev parent reply other threads:[~2026-11-13 15:18 UTC|newest]
Thread overview: 58+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-11-13 15:07 [PATCH many 00/55] notify: maintenance, PDM preparations, queue + worker Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 01/55] notify: disallow `unsafe` code Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 02/55] notify: refactor error type Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 03/55] notify: move `Endpoint` trait to endpoint module as pub(crate) Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 04/55] notify: use ConfigDigest instead of raw byte arrays Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 05/55] notify: remove static context and pass context as parameter Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 06/55] notify: matcher: drop unused field matcher verifiers Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 07/55] notify: introduce 'send-impl', 'api-impl' and 'api-types' features Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 08/55] notify: matcher: make matcher validation methods public Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 09/55] notify: make SendmailEndpoint and SmtpEndpoint private types Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 10/55] notify: move `send`, `test_target` and `Bus` to new `send` module Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 11/55] notify: move Origin type to api_types module Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 12/55] notify: move Target " Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 13/55] notify: move Config to config module Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 14/55] notify: move Notification and sub-types to `notification` module Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 15/55] notify: move schema module to api_types Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 16/55] notify: move check_matches from api_types::matcher to send::Bus Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 17/55] notify: move TemplateSource to context module Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 18/55] notify: config: cleanup helpers names and visibility Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 19/55] notify: config: rename section config parser/writer methods Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 20/55] notify: config: pass builtins explicitly when parsing section config Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 21/55] notify: implement PartialEq for all Config types Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 22/55] notify: use typed SectionConfigData Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 23/55] notify: api: api types: rename Deleteable* -> Deletable* Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 24/55] notify: context: parse builtin config only once Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 25/55] notify: context: parse proxy config in trait impl, not at the callsite Lukas Wagner
2026-11-13 15:07 ` [PATCH proxmox 26/55] notify: gate sub-modules with the appropriate feature flags Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox 27/55] notify: fold mail-forwarder feature into send-impl Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox 28/55] notify: forwarded mails: don't hardcode severity and metadata fields Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox 29/55] notify: don't pass uid when instantiating forwarded mail notifications Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox 30/55] notify: derive PartialEq for Notification type Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox 31/55] notify: add getters for severity and fields on " Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox 32/55] notify: add test suite for " Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox 33/55] notify: serialize raw, forwarded mail content as base64 Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox 34/55] notify: unify code paths for legacy-sendmail and regular notifications Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox 35/55] notify: add backwards-compat note to Notification type Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox 36/55] notify: remove 'test_target' API Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox 37/55] notify: replace notification instantiation with builder pattern Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox 38/55] notify: add send receipts Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox 39/55] notify: implement notification queue submitter Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox 40/55] notify: context: add read_config Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox 41/55] notify: queue: add queue consumer Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox 42/55] notify: queue: add worker task Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox-backup 43/55] notifications: don't ignore verification errors in legacy-sendmail mode Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox-backup 44/55] notifications: adapt to proxmox-notify API changes Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox-backup 45/55] api: notification: send test notification via proxmox_notify::send Lukas Wagner
2026-11-13 15:08 ` Lukas Wagner [this message]
2026-11-13 15:08 ` [PATCH proxmox-perl-rs 47/55] pve: notify: adapt to changes in the public API of proxmox-notify Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox-perl-rs 48/55] pve: notify: add `PVE::RS::Notify::enqueue` method Lukas Wagner
2026-11-13 15:08 ` [PATCH pve-cluster 49/55] notify: send notifications via notification queue Lukas Wagner
2026-11-13 15:08 ` [PATCH manager 50/55] vzdump: send legacy-sendmail notifications via simplified API Lukas Wagner
2026-11-13 15:08 ` [PATCH manager 51/55] pve-notify-worker: add new rust-based notification worker daemon Lukas Wagner
2026-11-13 15:08 ` [PATCH manager 52/55] debian: add 'pve-notify-worker' as a dependency Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox-mail-forward 53/55] forward mails via notification queue Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox-mail-forward 54/55] use return code to signal permanent or temporary failure Lukas Wagner
2026-11-13 15:08 ` [PATCH proxmox-mail-forward 55/55] limit size of mail read from stdin Lukas Wagner
2026-11-17 9:35 ` [PATCH many 00/55] notify: maintenance, PDM preparations, queue + worker Lukas Wagner
2026-11-18 9:55 ` superseded: " Lukas Wagner
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=20261113150828.756836-47-l.wagner@proxmox.com \
--to=l.wagner@proxmox.com \
--cc=pve-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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox