From: Lukas Wagner <l.wagner@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [pve-devel] [PATCH many v7 00/19] notifications: notification metadata matching improvements
Date: Mon, 10 Jun 2024 10:40:19 +0200 [thread overview]
Message-ID: <20240610084038.71643-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:
- job-id: Job ID for backup-jobs or replication-jobs
- 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)
NOTE: Might need a versionened break, since the widget-toolkit-patches
depend on new APIs provided by pve-manager. If the API is not present,
creating matchers with 'match-field' does not work (cannot load lists
of known values/fields)
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) --> already included a patch for
this
- widget-toolkit relies on a new API endpoint provided by pve-manager:
--> we require a versioned break in widget-toolkit on pve-manager
Changelog:
- v7: incorporated some more feedback from @Fiona, thx!
- Fixed error when switching from 'exact' to 'regex' if the text field
was empty
- rebased to latest master
- 'backport' doc improvements from PBS
- bumped widget-toolkit dep
- v6: incorporate feedback from @Fiona, thx!
- rename 'id' -> 'job-id' in VZDump API handler
- consolidate 'replication-job'/'backup-job' to 'job-id'
- Move 'job-id' setting to advanced tab in backup job edit.
- Don't use 'internal' flag to mark translatable fields, since
the only field where that's necessary is 'type' for now - so
just add a hardcoded check
- 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-guest-common:
Lukas Wagner (1):
vzdump: common: allow 'job-id' as a parameter without being in schema
src/PVE/VZDump/Common.pm | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
pve-manager:
Lukas Wagner (9):
api: jobs: vzdump: pass job 'job-id' parameter
ui: dc: backup: send 'job-id' property when starting a backup job
manually
ui: dc: backup: allow to set custom job id in advanced settings
api: replication: add 'job-id' 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
d/control: bump proxmox-widget-toolkit dependency to 4.1.4
PVE/API2/APT.pm | 3 +-
PVE/API2/Cluster/Notifications.pm | 139 ++++++++++++++++++++
PVE/API2/Replication.pm | 4 +-
PVE/API2/VZDump.pm | 8 ++
PVE/Jobs/VZDump.pm | 4 +-
PVE/VZDump.pm | 14 +-
debian/control | 2 +-
www/manager6/Utils.js | 12 ++
www/manager6/dc/Backup.js | 7 +-
www/manager6/panel/BackupAdvancedOptions.js | 23 ++++
10 files changed, 200 insertions(+), 16 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 (5):
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: fix typo in 'notification'
notifications: backport some rephrased parts from PBS docs
notifications.adoc | 137 +++++++++++++++++++++++++++------------------
1 file changed, 84 insertions(+), 53 deletions(-)
Summary over all repositories:
14 files changed, 726 insertions(+), 254 deletions(-)
--
Generated by git-murpp 0.7.1
_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel
next reply other threads:[~2024-06-10 8:40 UTC|newest]
Thread overview: 30+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-06-10 8:40 Lukas Wagner [this message]
2024-06-10 8:40 ` [pve-devel] [PATCH pve-guest-common v7 01/19] vzdump: common: allow 'job-id' as a parameter without being in schema Lukas Wagner
2024-06-10 8:40 ` [pve-devel] [PATCH manager v7 02/19] api: jobs: vzdump: pass job 'job-id' parameter Lukas Wagner
2024-07-04 12:53 ` Fabian Grünbichler
2024-06-10 8:40 ` [pve-devel] [PATCH manager v7 03/19] ui: dc: backup: send 'job-id' property when starting a backup job manually Lukas Wagner
2024-06-10 8:40 ` [pve-devel] [PATCH manager v7 04/19] ui: dc: backup: allow to set custom job id in advanced settings Lukas Wagner
2024-06-10 8:40 ` [pve-devel] [PATCH manager v7 05/19] api: replication: add 'job-id' to notification metadata Lukas Wagner
2024-07-04 13:08 ` [pve-devel] applied: " Fabian Grünbichler
2024-06-10 8:40 ` [pve-devel] [PATCH manager v7 06/19] vzdump: apt: notification: do not include domain in 'hostname' field Lukas Wagner
2024-07-04 13:08 ` [pve-devel] applied: " Fabian Grünbichler
2024-06-10 8:40 ` [pve-devel] [PATCH manager v7 07/19] api: replication: include 'hostname' field for notifications Lukas Wagner
2024-07-04 13:08 ` [pve-devel] applied: " Fabian Grünbichler
2024-06-10 8:40 ` [pve-devel] [PATCH manager v7 08/19] api: notification: add API for getting known metadata fields/values Lukas Wagner
2024-06-10 8:40 ` [pve-devel] [PATCH manager v7 09/19] ui: utils: add overrides for translatable notification fields/values Lukas Wagner
2024-06-10 8:40 ` [pve-devel] [PATCH manager v7 10/19] d/control: bump proxmox-widget-toolkit dependency to 4.1.4 Lukas Wagner
2024-06-10 8:40 ` [pve-devel] [PATCH widget-toolkit v7 11/19] notification: matcher: match-field: show known fields/values Lukas Wagner
2024-06-10 8:40 ` [pve-devel] [PATCH widget-toolkit v7 12/19] notification: matcher: move match-field formulas to local viewModel Lukas Wagner
2024-06-10 8:40 ` [pve-devel] [PATCH widget-toolkit v7 13/19] notification: matcher: move match-calendar fields to panel Lukas Wagner
2024-06-10 8:40 ` [pve-devel] [PATCH widget-toolkit v7 14/19] notification: matcher: move match-severity " Lukas Wagner
2024-06-10 8:40 ` [pve-devel] [PATCH docs v7 15/19] notification: clarify that 'hostname' does not include the domain Lukas Wagner
2024-07-04 13:12 ` [pve-devel] applied: " Fabian Grünbichler
2024-06-10 8:40 ` [pve-devel] [PATCH docs v7 16/19] notifications: describe new notification metadata fields Lukas Wagner
2024-06-10 8:40 ` [pve-devel] [PATCH docs v7 17/19] notifications: match-field 'exact'-mode can now match multiple values Lukas Wagner
2024-06-10 8:40 ` [pve-devel] [PATCH docs v7 18/19] notifications: fix typo in 'notification' Lukas Wagner
2024-07-04 13:12 ` [pve-devel] applied: " Fabian Grünbichler
2024-06-10 8:40 ` [pve-devel] [PATCH docs v7 19/19] notifications: backport some rephrased parts from PBS docs Lukas Wagner
2024-07-04 13:13 ` [pve-devel] applied: " Fabian Grünbichler
2024-07-04 12:56 ` [pve-devel] [PATCH many v7 00/19] notifications: notification metadata matching improvements Fabian Grünbichler
2024-07-04 13:32 ` Lukas Wagner
2024-07-05 13:59 ` [pve-devel] superseded: " 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=20240610084038.71643-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