[pve-devel] [PATCH manager/widget-toolkit/docs v4 00/18] notifications: notification metadata matching improvements
Lukas Wagner
l.wagner at proxmox.com
Wed Feb 28 11:00:48 CET 2024
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
More information about the pve-devel
mailing list