From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id 4945C95F7F for ; Mon, 15 Apr 2024 10:26:23 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 2A61049AE for ; Mon, 15 Apr 2024 10:26:23 +0200 (CEST) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [94.136.29.106]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS for ; Mon, 15 Apr 2024 10:26:21 +0200 (CEST) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 29D554480D for ; Mon, 15 Apr 2024 10:26:21 +0200 (CEST) From: Lukas Wagner To: pve-devel@lists.proxmox.com Date: Mon, 15 Apr 2024 10:25:58 +0200 Message-Id: <20240415082614.2515677-1-l.wagner@proxmox.com> X-Mailer: git-send-email 2.39.2 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL -0.005 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 Subject: [pve-devel] [PATCH docs/manager/widget-toolkit v5 00/16] notifications: notification metadata matching improvements X-BeenThere: pve-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox VE development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 15 Apr 2024 08:26:23 -0000 This patch series attempts to improve the user experience when creating notification matchers. Some of the noteworthy changes: - Fixup inconsistent 'hostname' field. Some notification events sent the hostname including a domain, while other did not. This series unifies the behavior, now the field only includes the hostname without a domain. Also updated the docs to reflect this change. - Allow setting a custom backup job ID, similar how we handle it for sync/prune jobs in PBS (to allow recognizable names used in matchers) - Adding columns for backup job ID/replication job ID in the UI - New metadata fields: - backup-job: ID of the backup job (set for backups, unless they are 'ad-hoc' backups) - replication-job: ID of the replication job - Add an API that enumerates known notification metadata fields/values - Suggest known fields/values in match rule window - Some code clean up for match rule edit window - Extended the 'exact' match-field mode - it now allows setting multiple allowed values, separated via ',': e.g. `match-field exact:type=replication,fencing Originally, I created a separate 'list' match type for this, but since the semantics for a list with one value and 'exact' mode are identical, I decided to just extend 'exact'. This is a safe change since there are are no values where a ',' makes any sense (config IDs, hostnames) Inter-Dependencies: - the widget-toolkit dep in pve-manager needs to be bumped to at least 4.1.4 (we need "utils: add mechanism to add and override translatable notification event descriptions in the product specific UIs", otherwise the UI breaks with the pve-manager patches applied) - widget-toolkit relies on a new API endpoint provided by pve-manager - the changes in the backend for matching multiple values in "exact" mode have already been rolled out as of libpve-rs-perl 0.8.8 --> this means that libpve-notify-perl (which pulls in libpve-rs-perl) must depend on libpve-rs-perl 0.8.8 at minimum - otherwise the notification stack cannot understand the comma-separated array of matched values Changelog: - v5: - Rebased onto latest master, resolving some small conflict - v4: - widget-toolkit: break out changes for the utils module so that they can be applied ahead of time to ease dep bumping - don't show Job IDs in the backup/replication job columns - v3: - Drop already applied patches for `proxmox` - Rebase onto latest master - minor conflict resolution was needed - v2: - include 'type' metadata field for forwarded mails --> otherwise it's not possible to match them - include Maximilliano's T-b trailer in UI patches pve-manager: Lukas Wagner (9): api: notifications: add 'smtp' to target index api: jobs: vzdump: pass job 'id' parameter ui: dc: backup: send 'id' property when starting a backup job manually ui: dc: backup: allow to set custom job id in advanced settings api: replication: add 'replication-job' to notification metadata vzdump: apt: notification: do not include domain in 'hostname' field api: replication: include 'hostname' field for notifications api: notification: add API for getting known metadata fields/values ui: utils: add overrides for translatable notification fields/values PVE/API2/APT.pm | 3 +- PVE/API2/Cluster/Notifications.pm | 155 +++++++++++++++++++++++++++++- PVE/API2/Replication.pm | 4 +- PVE/API2/VZDump.pm | 8 ++ PVE/Jobs/VZDump.pm | 4 +- PVE/VZDump.pm | 14 +-- www/manager6/Utils.js | 16 +++ www/manager6/dc/Backup.js | 12 ++- 8 files changed, 204 insertions(+), 12 deletions(-) proxmox-widget-toolkit: Lukas Wagner (4): notification: matcher: match-field: show known fields/values notification: matcher: move match-field formulas to local viewModel notification: matcher: move match-calendar fields to panel notification: matcher: move match-severity fields to panel src/data/model/NotificationConfig.js | 12 + src/window/NotificationMatcherEdit.js | 613 ++++++++++++++++++-------- 2 files changed, 441 insertions(+), 184 deletions(-) pve-docs: Lukas Wagner (3): notification: clarify that 'hostname' does not include the domain notifications: describe new notification metadata fields notifications: match-field 'exact'-mode can now match multiple values notifications.adoc | 39 ++++++++++++++++++--------------------- 1 file changed, 18 insertions(+), 21 deletions(-) Summary over all repositories: 11 files changed, 663 insertions(+), 217 deletions(-) -- Generated by git-murpp 0.7.1