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 manager/widget-toolkit/docs v4 00/18] notifications: notification metadata matching improvements
Date: Wed, 28 Feb 2024 11:00:48 +0100	[thread overview]
Message-ID: <20240228100106.87262-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)

Inter-Dependencies:
  - widget-toolkit relies on a new API endpoint provided by pve-manager
  - pve-manager needs the
    "utils: add extendable, translatable notifiction event descriptions"
    patch from the widget-toolkit-part - can be applied ahead of time
  - 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 be bumped as well, in order for the GUI changes to make sense

Changelog:
  - 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 (6):
  combogrid: add 'showClearTrigger' config
  utils: add extendable, translatable notifiction event descriptions
  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:
  13 files changed, 699 insertions(+), 218 deletions(-)

-- 
Generated by git-murpp 0.5.0




             reply	other threads:[~2024-02-28 10:01 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-02-28 10:00 Lukas Wagner [this message]
2024-02-28 10:00 ` [pve-devel] [PATCH manager v4 01/18] api: notifications: add 'smtp' to target index Lukas Wagner
2024-02-28 10:00 ` [pve-devel] [PATCH manager v4 02/18] api: jobs: vzdump: pass job 'id' parameter Lukas Wagner
2024-02-28 10:00 ` [pve-devel] [PATCH manager v4 03/18] ui: dc: backup: send 'id' property when starting a backup job manually Lukas Wagner
2024-02-28 10:00 ` [pve-devel] [PATCH manager v4 04/18] ui: dc: backup: allow to set custom job id in advanced settings Lukas Wagner
2024-02-28 10:00 ` [pve-devel] [PATCH manager v4 05/18] api: replication: add 'replication-job' to notification metadata Lukas Wagner
2024-02-28 10:00 ` [pve-devel] [PATCH manager v4 06/18] vzdump: apt: notification: do not include domain in 'hostname' field Lukas Wagner
2024-02-28 10:00 ` [pve-devel] [PATCH manager v4 07/18] api: replication: include 'hostname' field for notifications Lukas Wagner
2024-02-28 10:00 ` [pve-devel] [PATCH manager v4 08/18] api: notification: add API for getting known metadata fields/values Lukas Wagner
2024-02-28 10:00 ` [pve-devel] [PATCH manager v4 09/18] ui: utils: add overrides for translatable notification fields/values Lukas Wagner
2024-02-28 10:00 ` [pve-devel] [PATCH widget-toolkit v4 10/18] combogrid: add 'showClearTrigger' config Lukas Wagner
2024-02-28 10:41   ` [pve-devel] applied: " Thomas Lamprecht
2024-02-28 10:00 ` [pve-devel] [PATCH widget-toolkit v4 11/18] utils: add extendable, translatable notifiction event descriptions Lukas Wagner
2024-02-28 10:42   ` [pve-devel] applied: " Thomas Lamprecht
2024-02-28 10:01 ` [pve-devel] [PATCH widget-toolkit v4 12/18] notification: matcher: match-field: show known fields/values Lukas Wagner
2024-02-28 10:01 ` [pve-devel] [PATCH widget-toolkit v4 13/18] notification: matcher: move match-field formulas to local viewModel Lukas Wagner
2024-02-28 10:01 ` [pve-devel] [PATCH widget-toolkit v4 14/18] notification: matcher: move match-calendar fields to panel Lukas Wagner
2024-02-28 10:01 ` [pve-devel] [PATCH widget-toolkit v4 15/18] notification: matcher: move match-severity " Lukas Wagner
2024-02-28 10:01 ` [pve-devel] [PATCH docs v4 16/18] notification: clarify that 'hostname' does not include the domain Lukas Wagner
2024-02-28 10:01 ` [pve-devel] [PATCH docs v4 17/18] notifications: describe new notification metadata fields Lukas Wagner
2024-02-28 10:01 ` [pve-devel] [PATCH docs v4 18/18] notifications: match-field 'exact'-mode can now match multiple values 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=20240228100106.87262-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