[pve-devel] [PATCH v2 many 00/22] notifications: notification metadata matching improvements

[Lukas Wagner]

Superseded-by:
https://lists.proxmox.com/pipermail/pve-devel/2024-February/061778.html

On 12/13/23 17:37, Lukas Wagner wrote:
> 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(-)
> 

-- 
- Lukas