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 docs v4 17/18] notifications: describe new notification metadata fields
Date: Wed, 28 Feb 2024 11:01:05 +0100	[thread overview]
Message-ID: <20240228100106.87262-18-l.wagner@proxmox.com> (raw)
In-Reply-To: <20240228100106.87262-1-l.wagner@proxmox.com>

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
---
 notifications.adoc | 21 ++++++++++++---------
 1 file changed, 12 insertions(+), 9 deletions(-)

diff --git a/notifications.adoc b/notifications.adoc
index 57053c8..0eeed6a 100644
--- a/notifications.adoc
+++ b/notifications.adoc
@@ -289,19 +289,22 @@ Notification Events
 
 [width="100%",options="header"]
 |===========================================================================
-| Event                        | `type`            | Severity | Metadata fields (in addition to `type`)
-| System updates available     |`package-updates`  | `info`   | `hostname`
-| Cluster node fenced          |`fencing`          | `error`  | `hostname`
-| Storage replication failed   |`replication`      | `error`  | -
-| Backup finished              |`vzdump`           | `info` (`error` on failure) | `hostname`
-| Mail for root                |`system-mail`      | `unknown`| -
+| Event                            | `type`            | Severity | Metadata fields (in addition to `type`)
+| System updates available         |`package-updates`  | `info`   | `hostname`
+| Cluster node fenced              |`fencing`          | `error`  | `hostname`
+| Storage replication job failed   |`replication`      | `error`  | `hostname`, `replication-job`
+| Backup succeeded                 |`vzdump`           | `info`   | `hostname`, `backup-job` (only for backup jobs)
+| Backup failed                    |`vzdump`           | `error`  | `hostname`, `backup-job` (only for backup jobs)
+| Mail for root                    |`system-mail`      | `unknown`| `hostname`
 |===========================================================================
 
 [width="100%",options="header"]
 |=======================================================================
-| Field name | Description
-| `type`     | Type of the notifcation
-| `hostname` | Hostname, without domain (e.g. `pve1`)
+| Field name        | Description
+| `type`            | Type of the notifcation
+| `hostname`        | Hostname, without domain (e.g. `pve1`)
+| `backup-job`      | Backup job ID
+| `replication-job` | Replication job ID
 |=======================================================================
 
 System Mail Forwarding
-- 
2.39.2





  parent 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 [pve-devel] [PATCH manager/widget-toolkit/docs v4 00/18] notifications: notification metadata matching improvements Lukas Wagner
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 ` Lukas Wagner [this message]
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-18-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