From: Lukas Wagner <l.wagner@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [pve-devel] [PATCH v5 pve-manager 06/30] api: replication: send notifications via new notification module
Date: Wed, 26 Jul 2023 11:49:38 +0200 [thread overview]
Message-ID: <20230726095002.325276-7-l.wagner@proxmox.com> (raw)
In-Reply-To: <20230726095002.325276-1-l.wagner@proxmox.com>
If the new 'target-replication' option in datacenter.cfg is set
to a notification target, we send notifications that way.
If it is not set, we continue send a notification to the
default target (mail to root@pam).
There is also a new 'replication' option. It controls whether
to send a notification at all.
Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
---
PVE/API2/Replication.pm | 63 ++++++++++++++++++++++++++++-------------
1 file changed, 43 insertions(+), 20 deletions(-)
diff --git a/PVE/API2/Replication.pm b/PVE/API2/Replication.pm
index 89c5a802..d61518ba 100644
--- a/PVE/API2/Replication.pm
+++ b/PVE/API2/Replication.pm
@@ -15,6 +15,7 @@ use PVE::QemuConfig;
use PVE::QemuServer;
use PVE::LXC::Config;
use PVE::LXC;
+use PVE::Notify;
use PVE::RESTHandler;
@@ -91,6 +92,24 @@ my sub _should_mail_at_failcount {
return $i * 48 == $fail_count;
};
+my $replication_error_subject_template = "Replication Job: '{{job-id}}' failed";
+my $replication_error_body_template = <<EOT;
+{{#verbatim}}
+Replication job '{{job-id}}' with target '{{job-target}}' and schedule '{{job-schedule}}' failed!
+
+Last successful sync: {{timestamp last-sync}}
+Next sync try: {{timestamp next-sync}}
+Failure count: {{failure-count}}
+
+{{#if (eq failure-count 3)}}
+Note: The system will now reduce the frequency of error reports, as the job
+appears to be stuck.
+{{/if}}
+Error:
+{{verbatim-monospaced error}}
+{{/verbatim}}
+EOT
+
my sub _handle_job_err {
my ($job, $err, $mail) = @_;
@@ -103,33 +122,37 @@ my sub _handle_job_err {
return if !_should_mail_at_failcount($fail_count);
- my $schedule = $job->{schedule} // '*/15';
-
- my $msg = "Replication job $job->{id} with target '$job->{target}' and schedule";
- $msg .= " '$schedule' failed!\n";
-
- $msg .= " Last successful sync: ";
- if (my $last_sync = $jobstate->{last_sync}) {
- $msg .= render_timestamp($last_sync) ."\n";
- } else {
- $msg .= "None/Unknown\n";
- }
# not yet updated, so $job->next_sync here is actually the current one.
# NOTE: Copied from PVE::ReplicationState::job_status()
my $next_sync = $job->{next_sync} + 60 * ($fail_count <= 3 ? 5 * $fail_count : 30);
- $msg .= " Next sync try: " . render_timestamp($next_sync) ."\n";
- $msg .= " Failure count: $fail_count\n";
-
- if ($fail_count == 3) {
- $msg .= "\nNote: The system will now reduce the frequency of error reports,";
- $msg .= " as the job appears to be stuck.\n";
- }
+ # The replication job is run every 15 mins if no schedule is set.
+ my $schedule = $job->{schedule} // '*/15';
- $msg .= "\nError:\n$err";
+ my $properties = {
+ "failure-count" => $fail_count,
+ "last-sync" => $jobstate->{last_sync},
+ "next-sync" => $next_sync,
+ "job-id" => $job->{id},
+ "job-target" => $job->{target},
+ "job-schedule" => $schedule,
+ "error" => $err,
+ };
eval {
- PVE::Tools::sendmail('root', "Replication Job: $job->{id} failed", $msg)
+ my $dcconf = PVE::Cluster::cfs_read_file('datacenter.cfg');
+ my $target = $dcconf->{notify}->{'target-replication'} // PVE::Notify::default_target();
+ my $notify = $dcconf->{notify}->{'replication'} // 'always';
+
+ if ($notify eq 'always') {
+ PVE::Notify::error(
+ $target,
+ $replication_error_subject_template,
+ $replication_error_body_template,
+ $properties
+ );
+ }
+
};
warn ": $@" if $@;
}
--
2.39.2
next prev parent reply other threads:[~2023-07-26 9:50 UTC|newest]
Thread overview: 31+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-07-26 9:49 [pve-devel] [PATCH v5 many 00/30] fix #4156: introduce new notification system Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-ha-manager 01/30] manager: send notifications via new notification module Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 02/30] d/control: add dependency to `libpve-notify-perl` Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 03/30] vzdump: send notifications via new notification module Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 04/30] test: rename mail_test.pl to vzdump_notification_test.pl Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 05/30] api: apt: send notification via new notification module Lukas Wagner
2023-07-26 9:49 ` Lukas Wagner [this message]
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 07/30] api: prepare api handler module for notification config Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 08/30] api: notification: add api routes for groups Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 09/30] api: notification: add api routes for sendmail endpoints Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 10/30] api: notification: add api routes for gotify endpoints Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 11/30] api: notification: add api routes for filters Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 12/30] api: notification: allow fetching notification targets Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 13/30] api: notification: allow to test targets Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 14/30] api: notification: disallow removing targets if they are used Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 15/30] ui: backup: allow to select notification target for jobs Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 16/30] ui: backup: adapt backup job details to new notification params Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 17/30] ui: backup: allow to set notification-target for one-off backups Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 18/30] ui: allow to configure notification event -> target mapping Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 19/30] ui: add notification target configuration panel Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 20/30] ui: perm path: add ACL paths for notifications, usb and pci mappings Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 21/30] ui: perm path: increase width of the perm path selector combobox Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 22/30] ui: dc: remove notify key from datacenter option view Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 23/30] vzdump: use <name> as a convention for virtual endpoints/groups Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 24/30] api: notification: make the 'mail-to-root' target visible to any user Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 proxmox-widget-toolkit 25/30] notification: add gui for sendmail notification endpoints Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 proxmox-widget-toolkit 26/30] notification: add gui for gotify " Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 proxmox-widget-toolkit 27/30] notification: add gui for notification groups Lukas Wagner
2023-07-26 9:50 ` [pve-devel] [PATCH v5 proxmox-widget-toolkit 28/30] notification: allow to select filter for notification targets Lukas Wagner
2023-07-26 9:50 ` [pve-devel] [PATCH v5 proxmox-widget-toolkit 29/30] notification: add ui for managing notification filters Lukas Wagner
2023-07-26 9:50 ` [pve-devel] [PATCH v5 pve-docs 30/30] add documentation for the new notification system 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=20230726095002.325276-7-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