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 v5 15/16] notifications: describe new notification metadata fields
Date: Mon, 15 Apr 2024 10:26:13 +0200	[thread overview]
Message-ID: <20240415082614.2515677-16-l.wagner@proxmox.com> (raw)
In-Reply-To: <20240415082614.2515677-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-04-15  8:26 UTC|newest]

Thread overview: 29+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-04-15  8:25 [pve-devel] [PATCH docs/manager/widget-toolkit v5 00/16] notifications: notification metadata matching improvements Lukas Wagner
2024-04-15  8:25 ` [pve-devel] [PATCH manager v5 01/16] api: notifications: add 'smtp' to target index Lukas Wagner
2024-04-19 10:47   ` [pve-devel] applied: " Fiona Ebner
2024-04-15  8:26 ` [pve-devel] [PATCH manager v5 02/16] api: jobs: vzdump: pass job 'id' parameter Lukas Wagner
2024-04-19 11:53   ` Fiona Ebner
2024-04-15  8:26 ` [pve-devel] [PATCH manager v5 03/16] ui: dc: backup: send 'id' property when starting a backup job manually Lukas Wagner
2024-04-15  8:26 ` [pve-devel] [PATCH manager v5 04/16] ui: dc: backup: allow to set custom job id in advanced settings Lukas Wagner
2024-04-19 10:22   ` Fiona Ebner
2024-04-19 10:31   ` Fiona Ebner
2024-04-19 12:23     ` Lukas Wagner
2024-04-15  8:26 ` [pve-devel] [PATCH manager v5 05/16] api: replication: add 'replication-job' to notification metadata Lukas Wagner
2024-04-19 12:02   ` Fiona Ebner
2024-04-19 12:22     ` Lukas Wagner
2024-04-19 13:11       ` Fiona Ebner
2024-04-19 13:15         ` Lukas Wagner
2024-04-15  8:26 ` [pve-devel] [PATCH manager v5 06/16] vzdump: apt: notification: do not include domain in 'hostname' field Lukas Wagner
2024-04-15  8:26 ` [pve-devel] [PATCH manager v5 07/16] api: replication: include 'hostname' field for notifications Lukas Wagner
2024-04-15  8:26 ` [pve-devel] [PATCH manager v5 08/16] api: notification: add API for getting known metadata fields/values Lukas Wagner
2024-04-19 12:59   ` Fiona Ebner
2024-04-19 13:45   ` Fiona Ebner
2024-04-19 14:01     ` Lukas Wagner
2024-04-15  8:26 ` [pve-devel] [PATCH manager v5 09/16] ui: utils: add overrides for translatable notification fields/values Lukas Wagner
2024-04-15  8:26 ` [pve-devel] [PATCH widget-toolkit v5 10/16] notification: matcher: match-field: show known fields/values Lukas Wagner
2024-04-15  8:26 ` [pve-devel] [PATCH widget-toolkit v5 11/16] notification: matcher: move match-field formulas to local viewModel Lukas Wagner
2024-04-15  8:26 ` [pve-devel] [PATCH widget-toolkit v5 12/16] notification: matcher: move match-calendar fields to panel Lukas Wagner
2024-04-15  8:26 ` [pve-devel] [PATCH widget-toolkit v5 13/16] notification: matcher: move match-severity " Lukas Wagner
2024-04-15  8:26 ` [pve-devel] [PATCH docs v5 14/16] notification: clarify that 'hostname' does not include the domain Lukas Wagner
2024-04-15  8:26 ` Lukas Wagner [this message]
2024-04-15  8:26 ` [pve-devel] [PATCH docs v5 16/16] 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=20240415082614.2515677-16-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