public inbox for pve-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Lukas Wagner <l.wagner@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [pve-devel] [PATCH v2 many 00/22] notifications: notification metadata matching improvements
Date: Wed, 13 Dec 2023 17:37:39 +0100	[thread overview]
Message-ID: <20231213163801.392492-1-l.wagner@proxmox.com> (raw)

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)

The changes in 'proxmox' affecting the proxmox-notify crate 
require a bump/rebuild of 
  - libpve-perl-rs
  - proxmox-mail-forward

Changelog:
  - 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



proxmox:

Lukas Wagner (3):
  notify: include 'hostname' metadata field for forwarded mails
  notify: include 'type' metadata field for forwarded mails
  notify: matcher: support lists of values for 'exact' match-field mode

 proxmox-notify/src/lib.rs     | 19 ++++++++++++----
 proxmox-notify/src/matcher.rs | 43 +++++++++++++++++++++++++++--------
 2 files changed, 49 insertions(+), 13 deletions(-)


pve-manager:

Lukas Wagner (11):
  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: show 'Job ID' column
  ui: dc: backup: allow to set custom job id in  advanced settings
  api: replication: add 'replication-job' to notification metadata
  ui: replication: show 'Job ID' column
  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         |  15 ++-
 www/manager6/grid/Replication.js  |   3 +-
 9 files changed, 206 insertions(+), 16 deletions(-)


proxmox-widget-toolkit:

Lukas Wagner (5):
  combogrid: add 'showClearTrigger' config
  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/Utils.js                          |  31 ++
 src/data/model/NotificationConfig.js  |  12 +
 src/form/ComboGrid.js                 |   6 +-
 src/window/NotificationMatcherEdit.js | 613 ++++++++++++++++++--------
 4 files changed, 477 insertions(+), 185 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:
  16 files changed, 750 insertions(+), 235 deletions(-)

-- 
murpp v0.4.0





             reply	other threads:[~2023-12-13 16:38 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-12-13 16:37 Lukas Wagner [this message]
2023-12-13 16:37 ` [pve-devel] [PATCH v2 proxmox 01/22] notify: include 'hostname' metadata field for forwarded mails Lukas Wagner
2024-01-10 11:40   ` [pve-devel] applied: " Wolfgang Bumiller
2023-12-13 16:37 ` [pve-devel] [PATCH v2 proxmox 02/22] notify: include 'type' " Lukas Wagner
2023-12-13 16:37 ` [pve-devel] [PATCH v2 proxmox 03/22] notify: matcher: support lists of values for 'exact' match-field mode Lukas Wagner
2023-12-13 16:37 ` [pve-devel] [PATCH v2 pve-manager 04/22] api: notifications: add 'smtp' to target index Lukas Wagner
2023-12-13 16:37 ` [pve-devel] [PATCH v2 pve-manager 05/22] api: jobs: vzdump: pass job 'id' parameter Lukas Wagner
2023-12-13 16:37 ` [pve-devel] [PATCH v2 pve-manager 06/22] ui: dc: backup: send 'id' property when starting a backup job manually Lukas Wagner
2023-12-13 16:37 ` [pve-devel] [PATCH v2 pve-manager 07/22] ui: dc: backup: show 'Job ID' column Lukas Wagner
2023-12-13 16:37 ` [pve-devel] [PATCH v2 pve-manager 08/22] ui: dc: backup: allow to set custom job id in advanced settings Lukas Wagner
2023-12-13 16:37 ` [pve-devel] [PATCH v2 pve-manager 09/22] api: replication: add 'replication-job' to notification metadata Lukas Wagner
2023-12-13 16:37 ` [pve-devel] [PATCH v2 pve-manager 10/22] ui: replication: show 'Job ID' column Lukas Wagner
2023-12-13 16:37 ` [pve-devel] [PATCH v2 pve-manager 11/22] vzdump: apt: notification: do not include domain in 'hostname' field Lukas Wagner
2023-12-13 16:37 ` [pve-devel] [PATCH v2 pve-manager 12/22] api: replication: include 'hostname' field for notifications Lukas Wagner
2023-12-13 16:37 ` [pve-devel] [PATCH v2 pve-manager 13/22] api: notification: add API for getting known metadata fields/values Lukas Wagner
2023-12-13 16:37 ` [pve-devel] [PATCH v2 pve-manager 14/22] ui: utils: add overrides for translatable notification fields/values Lukas Wagner
2023-12-13 16:37 ` [pve-devel] [PATCH v2 proxmox-widget-toolkit 15/22] combogrid: add 'showClearTrigger' config Lukas Wagner
2023-12-13 16:37 ` [pve-devel] [PATCH v2 proxmox-widget-toolkit 16/22] notification: matcher: match-field: show known fields/values Lukas Wagner
2023-12-13 16:37 ` [pve-devel] [PATCH v2 proxmox-widget-toolkit 17/22] notification: matcher: move match-field formulas to local viewModel Lukas Wagner
2023-12-13 16:37 ` [pve-devel] [PATCH v2 proxmox-widget-toolkit 18/22] notification: matcher: move match-calendar fields to panel Lukas Wagner
2023-12-13 16:37 ` [pve-devel] [PATCH v2 proxmox-widget-toolkit 19/22] notification: matcher: move match-severity " Lukas Wagner
2023-12-13 16:37 ` [pve-devel] [PATCH v2 pve-docs 20/22] notification: clarify that 'hostname' does not include the domain Lukas Wagner
2023-12-13 16:38 ` [pve-devel] [PATCH v2 pve-docs 21/22] notifications: describe new notification metadata fields Lukas Wagner
2023-12-13 16:38 ` [pve-devel] [PATCH v2 pve-docs 22/22] notifications: match-field 'exact'-mode can now match multiple values Lukas Wagner
2024-01-08 10:43 ` [pve-devel] [PATCH v2 many 00/22] notifications: notification metadata matching improvements Lukas Wagner
2024-02-16  9:19 ` 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=20231213163801.392492-1-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
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal