summaryrefslogtreecommitdiffstats
path: root/health/notifications
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2023-02-06 16:11:30 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2023-02-06 16:11:30 +0000
commitaa2fe8ccbfcb117efa207d10229eeeac5d0f97c7 (patch)
tree941cbdd387b41c1a81587c20a6df9f0e5e0ff7ab /health/notifications
parentAdding upstream version 1.37.1. (diff)
downloadnetdata-aa2fe8ccbfcb117efa207d10229eeeac5d0f97c7.tar.xz
netdata-aa2fe8ccbfcb117efa207d10229eeeac5d0f97c7.zip
Adding upstream version 1.38.0.upstream/1.38.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r--health/notifications/README.md6
-rwxr-xr-xhealth/notifications/alarm-notify.sh.in130
-rw-r--r--health/notifications/alerta/README.md7
-rw-r--r--health/notifications/awssns/README.md7
-rw-r--r--health/notifications/custom/README.md11
-rw-r--r--health/notifications/discord/README.md21
-rw-r--r--health/notifications/dynatrace/README.md7
-rw-r--r--health/notifications/email/README.md7
-rw-r--r--health/notifications/flock/README.md7
-rw-r--r--health/notifications/gotify/README.md6
-rw-r--r--health/notifications/hangouts/README.md6
-rwxr-xr-xhealth/notifications/health_alarm_notify.conf17
-rw-r--r--health/notifications/irc/README.md7
-rw-r--r--health/notifications/kavenegar/README.md7
-rw-r--r--health/notifications/matrix/README.md6
-rw-r--r--health/notifications/messagebird/README.md7
-rw-r--r--health/notifications/msteams/README.md7
-rw-r--r--health/notifications/opsgenie/README.md16
-rw-r--r--health/notifications/pagerduty/README.md16
-rw-r--r--health/notifications/prowl/README.md7
-rw-r--r--health/notifications/pushbullet/README.md7
-rw-r--r--health/notifications/pushover/README.md7
-rw-r--r--health/notifications/rocketchat/README.md7
-rw-r--r--health/notifications/slack/README.md7
-rw-r--r--health/notifications/smstools3/README.md7
-rw-r--r--health/notifications/stackpulse/README.md8
-rw-r--r--health/notifications/syslog/README.md7
-rw-r--r--health/notifications/telegram/README.md7
-rw-r--r--health/notifications/twilio/README.md7
-rw-r--r--health/notifications/web/README.md11
30 files changed, 287 insertions, 93 deletions
diff --git a/health/notifications/README.md b/health/notifications/README.md
index 0bd6c7649..c59fecced 100644
--- a/health/notifications/README.md
+++ b/health/notifications/README.md
@@ -1,7 +1,11 @@
<!--
title: "Alarm notifications"
description: "Reference documentation for Netdata's alarm notification feature, which supports dozens of endpoints, user roles, and more."
-custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/README.md
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/README.md"
+sidebar_label: "Notifications Reference"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Operations/Alerts"
-->
# Alarm notifications
diff --git a/health/notifications/alarm-notify.sh.in b/health/notifications/alarm-notify.sh.in
index 3edf3d083..0090427a0 100755
--- a/health/notifications/alarm-notify.sh.in
+++ b/health/notifications/alarm-notify.sh.in
@@ -18,7 +18,7 @@
# - emails by @ktsaou
# - slack.com notifications by @ktsaou
# - alerta.io notifications by @kattunga
-# - discordapp.com notifications by @lowfive
+# - discord.com notifications by @lowfive
# - pushover.net notifications by @ktsaou
# - pushbullet.com push notifications by Tiago Peralta @tperalta82 #1070
# - telegram.org notifications by @hashworks #1002
@@ -484,53 +484,105 @@ msteams_migration
# filter a recipient based on alarm event severity
filter_recipient_by_criticality() {
- local method="${1}" x="${2}" r s
- shift
-
- r="${x/|*/}" # the recipient
- s="${x/*|/}" # the severity required for notifying this recipient
+ local method="${1}" recipient_arg="${2}"
+ local tracking_dir tracking_file modifier modifiers recipient="${recipient_arg/|*/}"
+ local mod_critical=0 mod_noclear=0 mod_nowarn=0
# no severity filtering for this person
- [ "${r}" = "${s}" ] && return 0
+ [ "${recipient}" = "${recipient_arg}" ] && return 0
+
+ # find out which modifiers are set
+ modifiers="${recipient_arg#*|}"
+ modifiers="${modifiers//|/ }" # replace pipes with spaces
+ modifiers="${modifiers,,}" # lowercase
+ for modifier in ${modifiers}; do
+ case "${modifier}" in
+ critical) mod_critical=1 ;;
+ noclear) mod_noclear=1 ;;
+ nowarn) mod_nowarn=1 ;;
+
+ *)
+ error "SEVERITY FILTERING for ${recipient_arg} VIA ${method}: invalid modifier '${modifier}'."
+ # invalid modifier, always send notification
+ return 0
+ ;;
+ esac
+ done
- # the severity is invalid
- s="${s^^}"
- if [ "${s}" != "CRITICAL" ]; then
- error "SEVERITY FILTERING for ${x} VIA ${method}: invalid severity '${s,,}', only 'critical' is supported."
- return 0
- fi
+ # set status tracking directory/file var
+ tracking_dir="${NETDATA_CACHE_DIR}/alarm-notify/${method}/${recipient}"
+ tracking_file="${tracking_dir}/${alarm_id}"
- # create the status tracking directory for this user
- [ ! -d "${NETDATA_CACHE_DIR}/alarm-notify/${method}/${r}" ] &&
- mkdir -p "${NETDATA_CACHE_DIR}/alarm-notify/${method}/${r}"
+ # create the status tracking directory for this user if "critical" modifier is set
+ [ "${mod_critical}" == "1" ] && [ ! -d "${tracking_dir}" ] && mkdir -p "${tracking_dir}"
case "${status}" in
- CRITICAL)
- # make sure he will get future notifications for this alarm too
- touch "${NETDATA_CACHE_DIR}/alarm-notify/${method}/${r}/${alarm_id}"
- debug "SEVERITY FILTERING for ${x} VIA ${method}: ALLOW: the alarm is CRITICAL (will now receive next status change)"
- return 0
- ;;
-
- WARNING)
- if [ -f "${NETDATA_CACHE_DIR}/alarm-notify/${method}/${r}/${alarm_id}" ]; then
- # we do not remove the file, so that he will get future notifications of this alarm
- debug "SEVERITY FILTERING for ${x} VIA ${method}: ALLOW: recipient has been notified for this alarm in the past (will still receive next status change)"
- return 0
- fi
- ;;
+ CRITICAL)
+ # "critical" modifier set, create tracking file for future status changes
+ if [ "${mod_critical}" == "1" ]; then
+ touch "${tracking_file}"
+ debug "SEVERITY FILTERING for ${recipient_arg} VIA ${method}: ALLOW: the alarm is CRITICAL (will now receive next status change)"
+ return 0
+ fi
- *)
- if [ -f "${NETDATA_CACHE_DIR}/alarm-notify/${method}/${r}/${alarm_id}" ]; then
- # remove the file, so that he will only receive notifications for CRITICAL states for this alarm
- rm "${NETDATA_CACHE_DIR}/alarm-notify/${method}/${r}/${alarm_id}"
- debug "SEVERITY FILTERING for ${x} VIA ${method}: ALLOW: recipient has been notified for this alarm (will only receive CRITICAL notifications from now on)"
+ # always send CRITICAL notification
+ debug "SEVERITY FILTERING for ${recipient_arg} VIA ${method}: ALLOW: the alarm is CRITICAL"
return 0
- fi
- ;;
+ ;;
+
+ WARNING)
+ # "nowarn" modifier set, block notification
+ if [ "${mod_nowarn}" == "1" ]; then
+ debug "SEVERITY FILTERING for ${recipient_arg} VIA ${method}: BLOCK: recipient should not receive this notification (nowarn modifier set)"
+ return 1
+ fi
+
+ # "critical" modifier not set, send notification
+ if [ "${mod_critical}" == "0" ]; then
+ debug "SEVERITY FILTERING for ${recipient_arg} VIA ${method}: ALLOW: the alarm is WARNING"
+ return 0
+ fi
+
+ # "critical" modifier set, send notification if tracking file exists
+ if [ "${mod_critical}" == "1" ] && [ -f "${tracking_file}" ]; then
+ debug "SEVERITY FILTERING for ${recipient_arg} VIA ${method}: ALLOW: recipient has been notified for this alarm in the past (will still receive next status change)"
+ return 0
+ fi
+ ;;
+
+ CLEAR)
+ # remove tracking file
+ [ -f "${tracking_file}" ] && rm "${tracking_file}"
+
+ # "noclear" modifier set, block notification
+ if [ "${mod_noclear}" == "1" ]; then
+ debug "SEVERITY FILTERING for ${recipient_arg} VIA ${method}: BLOCK: recipient should not receive this notification (noclear modifier set)"
+ return 1
+ fi
+
+ # "critical" modifier not set, send notification
+ if [ "${mod_critical}" == "0" ]; then
+ debug "SEVERITY FILTERING for ${recipient_arg} VIA ${method}: ALLOW: the alarm is CLEAR"
+ return 0
+ fi
+
+ # "critical" modifier set, send notification if tracking file exists
+ if [ "${mod_critical}" == "1" ] && [ -f "${tracking_file}" ]; then
+ debug "SEVERITY FILTERING for ${recipient_arg} VIA ${method}: ALLOW: recipient has been notified for this alarm in the past (no status change will be sent from now)"
+ return 0
+ fi
+ ;;
+
+ *)
+ # "critical" modifier set, send notification if tracking file exists
+ if [ "${mod_critical}" == "1" ] && [ -f "${tracking_file}" ]; then
+ debug "SEVERITY FILTERING for ${recipient_arg} VIA ${method}: ALLOW: recipient has been notified for this alarm in the past (will still receive next status change)"
+ return 0
+ fi
+ ;;
esac
- debug "SEVERITY FILTERING for ${x} VIA ${method}: BLOCK: recipient should not receive this notification"
+ debug "SEVERITY FILTERING for ${recipient_arg} VIA ${method}: BLOCK: recipient should not receive this notification"
return 1
}
@@ -1480,10 +1532,12 @@ send_slack() {
"fields": [
{
"title": "${chart}",
+ "value": "chart",
"short": true
},
{
"title": "${family}",
+ "value": "family",
"short": true
}
],
diff --git a/health/notifications/alerta/README.md b/health/notifications/alerta/README.md
index 9603aae01..5ecf55eea 100644
--- a/health/notifications/alerta/README.md
+++ b/health/notifications/alerta/README.md
@@ -1,7 +1,12 @@
<!--
title: "alerta.io"
+sidebar_label: "Alerta"
description: "Send alarm notifications to Alerta to see the latest health status updates from multiple nodes in a single interface."
-custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/alerta/README.md
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/alerta/README.md"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Setup/Notification/Agent"
+learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
-->
# alerta.io
diff --git a/health/notifications/awssns/README.md b/health/notifications/awssns/README.md
index fc4a665e9..97768399e 100644
--- a/health/notifications/awssns/README.md
+++ b/health/notifications/awssns/README.md
@@ -1,7 +1,12 @@
<!--
title: "Amazon SNS"
+sidebar_label: "Amazon SNS"
description: "hello"
-custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/awssns/README.md
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/awssns/README.md"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Setup/Notification/Agent"
+learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
-->
# Amazon SNS
diff --git a/health/notifications/custom/README.md b/health/notifications/custom/README.md
index edc42623d..df8f88e40 100644
--- a/health/notifications/custom/README.md
+++ b/health/notifications/custom/README.md
@@ -1,6 +1,11 @@
<!--
title: "Custom"
-custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/custom/README.md
+sidebar_label: "Custom endpoint"
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/custom/README.md"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Setup/Notification/Agent"
+learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
-->
# Custom
@@ -8,8 +13,8 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notificat
Netdata allows you to send custom notifications to any endpoint you choose.
To configure custom notifications, you will need to customize `health_alarm_notify.conf`. Open the file for editing
-using [`edit-config`](/docs/configure/nodes.md#use-edit-config-to-edit-configuration-files) from the [Netdata config
-directory](/docs/configure/nodes.md#the-netdata-config-directory), which is typically at `/etc/netdata`.
+using [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#use-edit-config-to-edit-configuration-files) from the [Netdata config
+directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory), which is typically at `/etc/netdata`.
You can look at the other senders in `/usr/libexec/netdata/plugins.d/alarm-notify.sh` for examples of how to modify the `custom_sender()` function in `health_alarm_notify.conf`.
diff --git a/health/notifications/discord/README.md b/health/notifications/discord/README.md
index 568d03bc3..b4cbce533 100644
--- a/health/notifications/discord/README.md
+++ b/health/notifications/discord/README.md
@@ -1,9 +1,14 @@
<!--
-title: "Discordapp.com"
-custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/discord/README.md
+title: "Discord.com"
+sidebar_label: "Discord"
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/discord/README.md"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Setup/Notification/Agent"
+learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
-->
-# Discordapp.com
+# Discord.com
This is what you will get:
@@ -11,7 +16,7 @@ This is what you will get:
You need:
-1. The **incoming webhook URL** as given by Discord. Create a webhook by following the official [Discord documentation](https://support.discordapp.com/hc/en-us/articles/228383668-Intro-to-Webhooks). You can use the same on all your Netdata servers (or you can have multiple if you like - your decision).
+1. The **incoming webhook URL** as given by Discord. Create a webhook by following the official [Discord documentation](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks). You can use the same on all your Netdata servers (or you can have multiple if you like - your decision).
2. One or more Discord channels to post the messages to.
Set them in `/etc/netdata/health_alarm_notify.conf` (to edit it on your system run `/etc/netdata/edit-config health_alarm_notify.conf`), like this:
@@ -27,8 +32,8 @@ Set them in `/etc/netdata/health_alarm_notify.conf` (to edit it on your system r
SEND_DISCORD="YES"
# Create a webhook by following the official documentation -
-# https://support.discordapp.com/hc/en-us/articles/228383668-Intro-to-Webhooks
-DISCORD_WEBHOOK_URL="https://discordapp.com/api/webhooks/XXXXXXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
+# https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks
+DISCORD_WEBHOOK_URL="https://discord.com/api/webhooks/XXXXXXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
# if a role's recipients are not configured, a notification will be send to
# this discord channel (empty = do not send a notification for unconfigured
@@ -45,6 +50,4 @@ role_recipients_discord[dba]="databases systems"
role_recipients_discord[webmaster]="marketing development"
```
-The keywords `systems`, `databases`, `marketing`, `development` are discordapp.com channels (they should already exist within your discord server).
-
-
+The keywords `systems`, `databases`, `marketing`, `development` are discord.com channels (they should already exist within your discord server).
diff --git a/health/notifications/dynatrace/README.md b/health/notifications/dynatrace/README.md
index 3f8ad85b6..a36683933 100644
--- a/health/notifications/dynatrace/README.md
+++ b/health/notifications/dynatrace/README.md
@@ -1,6 +1,11 @@
<!--
title: "Dynatrace"
-custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/dynatrace/README.md
+sidebar_label: "Dynatrace Events"
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/dynatrace/README.md"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Setup/Notification/Agent"
+learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
-->
# Dynatrace
diff --git a/health/notifications/email/README.md b/health/notifications/email/README.md
index 3dc84dd40..01dfd0e6f 100644
--- a/health/notifications/email/README.md
+++ b/health/notifications/email/README.md
@@ -1,6 +1,11 @@
<!--
title: "Email"
-custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/email/README.md
+sidebar_label: "Email"
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/email/README.md"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Setup/Notification/Agent"
+learn_autogeneration_metadata: "{'part_of_cloud': True, 'part_of_agent': True}"
-->
# Email
diff --git a/health/notifications/flock/README.md b/health/notifications/flock/README.md
index b9e0025b3..175f8a466 100644
--- a/health/notifications/flock/README.md
+++ b/health/notifications/flock/README.md
@@ -1,6 +1,11 @@
<!--
title: "Flock"
-custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/flock/README.md
+sidebar_label: "Flock"
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/flock/README.md"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Setup/Notification/Agent"
+learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
-->
# Flock
diff --git a/health/notifications/gotify/README.md b/health/notifications/gotify/README.md
index c253c845c..d01502b65 100644
--- a/health/notifications/gotify/README.md
+++ b/health/notifications/gotify/README.md
@@ -3,6 +3,10 @@ title: "Send notifications to Gotify"
description: "Send alerts to your Gotify instance when an alert gets triggered in Netdata."
sidebar_label: "Gotify"
custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/gotify/README.md
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Setup/Notification/Agent"
+learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
-->
# Send notifications to Gotify
@@ -21,7 +25,7 @@ You can generate a new token in the Gotify Web UI.
To set up Gotify in Netdata:
1. Switch to your [config
-directory](/docs/configure/nodes.md) and edit the file `health_alarm_notify.conf` using the edit config script.
+directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md) and edit the file `health_alarm_notify.conf` using the edit config script.
```bash
./edit-config health_alarm_notify.conf
diff --git a/health/notifications/hangouts/README.md b/health/notifications/hangouts/README.md
index 7554b39cd..45da1bfa0 100644
--- a/health/notifications/hangouts/README.md
+++ b/health/notifications/hangouts/README.md
@@ -2,7 +2,11 @@
title: "Send notifications to Google Hangouts"
description: "Send alerts to Send notifications to Google Hangouts any time an anomaly or performance issue strikes a node in your infrastructure."
sidebar_label: "Google Hangouts"
-custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/hangouts/README.md
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/hangouts/README.md"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Setup/Notification/Agent"
+learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
-->
# Send notifications to Google Hangouts
diff --git a/health/notifications/health_alarm_notify.conf b/health/notifications/health_alarm_notify.conf
index 52de86645..4878661aa 100755
--- a/health/notifications/health_alarm_notify.conf
+++ b/health/notifications/health_alarm_notify.conf
@@ -9,7 +9,7 @@
# - messages to your slack team (slack.com),
# - messages to your alerta server (alerta.io),
# - messages to your flock team (flock.com),
-# - messages to your discord guild (discordapp.com),
+# - messages to your discord guild (discord.com),
# - messages to your telegram chat / group chat (telegram.org)
# - sms messages to your cell phone or any sms enabled device (twilio.com)
# - sms messages to your cell phone or any sms enabled device (messagebird.com)
@@ -160,7 +160,11 @@ sendsms=""
# - pagerduty.com (pd) services
# - irc channels
#
-# You can append |critical to limit the notifications to be sent.
+# You can append modifiers to limit the notifications to be sent:
+# |critical - Send critical notifications and following status changes until
+# the alarm is cleared.
+# |nowarn - Do not send warning notifications.
+# |noclear - Do not send clear notifications.
#
# In these examples, the first recipient receives all the alarms
# while the second one receives only notifications for alarms that
@@ -182,6 +186,11 @@ sendsms=""
# irc : "<irc_channel_1> <irc_channel_2>|critical"
# hangouts : "alarms disasters|critical"
#
+# You can append multiple modifiers. In this example, recipient receives
+# notifications for critical alarms and following status changes except clear
+# notifications.
+# email : "user1@example.com|critical|noclear"
+#
# If a recipient is set to empty string, the default recipient of the given
# notification method (email, pushover, telegram, slack, alerta, etc) will be used.
# To disable a notification, use the recipient called: disabled
@@ -579,7 +588,7 @@ DEFAULT_RECIPIENT_FLOCK=""
#------------------------------------------------------------------------------
-# discord (discordapp.com) global notification options
+# discord (discord.com) global notification options
# multiple recipients can be given like this:
# "CHANNEL1 CHANNEL2 ..."
@@ -588,7 +597,7 @@ DEFAULT_RECIPIENT_FLOCK=""
SEND_DISCORD="YES"
# Create a webhook by following the official documentation -
-# https://support.discordapp.com/hc/en-us/articles/228383668-Intro-to-Webhooks
+# https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks
DISCORD_WEBHOOK_URL=""
# if a role's recipients are not configured, a notification will be send to
diff --git a/health/notifications/irc/README.md b/health/notifications/irc/README.md
index 21c998d11..a4877f48a 100644
--- a/health/notifications/irc/README.md
+++ b/health/notifications/irc/README.md
@@ -1,6 +1,11 @@
<!--
title: "IRC"
-custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/irc/README.md
+sidebar_label: "IRC"
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/irc/README.md"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Setup/Notification/Agent"
+learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
-->
# IRC
diff --git a/health/notifications/kavenegar/README.md b/health/notifications/kavenegar/README.md
index 6123eb901..443fcdba4 100644
--- a/health/notifications/kavenegar/README.md
+++ b/health/notifications/kavenegar/README.md
@@ -1,6 +1,11 @@
<!--
title: "Kavenegar"
-custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/kavenegar/README.md
+sidebar_label: "Kavenegar"
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/kavenegar/README.md"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Setup/Notification/Agent"
+learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
-->
# Kavenegar
diff --git a/health/notifications/matrix/README.md b/health/notifications/matrix/README.md
index 8eeecf55d..80e22da37 100644
--- a/health/notifications/matrix/README.md
+++ b/health/notifications/matrix/README.md
@@ -2,7 +2,11 @@
title: "Send Netdata notifications to Matrix network rooms"
description: "Stay aware of warning or critical anomalies by sending health alarms to Matrix network rooms with Netdata's health monitoring watchdog."
sidebar_label: "Matrix"
-custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/matrix/README.md
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/matrix/README.md"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Setup/Notification/Agent"
+learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
-->
# Matrix
diff --git a/health/notifications/messagebird/README.md b/health/notifications/messagebird/README.md
index f70e86c68..014301985 100644
--- a/health/notifications/messagebird/README.md
+++ b/health/notifications/messagebird/README.md
@@ -1,6 +1,11 @@
<!--
title: "Messagebird"
-custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/messagebird/README.md
+sidebar_label: "Messagebird"
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/messagebird/README.md"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Setup/Notification/Agent"
+learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
-->
# Messagebird
diff --git a/health/notifications/msteams/README.md b/health/notifications/msteams/README.md
index c9a13bac9..75e652a72 100644
--- a/health/notifications/msteams/README.md
+++ b/health/notifications/msteams/README.md
@@ -1,6 +1,11 @@
<!--
title: "Microsoft Teams"
-custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/msteams/README.md
+sidebar_label: "Microsoft Teams"
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/msteams/README.md"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Setup/Notification/Agent"
+learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
-->
# Microsoft Teams
diff --git a/health/notifications/opsgenie/README.md b/health/notifications/opsgenie/README.md
index 640fcd42a..20f14b396 100644
--- a/health/notifications/opsgenie/README.md
+++ b/health/notifications/opsgenie/README.md
@@ -2,7 +2,11 @@
title: "Send notifications to Opsgenie"
description: "Send alerts to your Opsgenie incident response account any time an anomaly or performance issue strikes a node in your infrastructure."
sidebar_label: "Opsgenie"
-custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/opsgenie/README.md
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/opsgenie/README.md"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Setup/Notification/Agent"
+learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
-->
# Send notifications to Opsgenie
@@ -13,9 +17,9 @@ incidents.
The first step is to create a [Netdata integration](https://docs.opsgenie.com/docs/api-integration) in the
[Opsgenie](https://www.atlassian.com/software/opsgenie) dashboard. After this, you need to edit
-`health_alarm_notify.conf` on your system, by running the following from your [config
-directory](/docs/configure/nodes.md):
-
+`health_alarm_notify.conf` on your system, by running the following from
+your [config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md):
+
```bash
./edit-config health_alarm_notify.conf
```
@@ -56,7 +60,7 @@ message:
2020-09-03 23:07:00: alarm-notify.sh: ERROR: failed to send opsgenie notification for: hades test.chart.test_alarm is CRITICAL, with HTTP error code 401.
```
-You can find more details about the Opsgenie error codes in their [response
-docs](https://docs.opsgenie.com/docs/response).
+You can find more details about the Opsgenie error codes in
+their [response docs](https://docs.opsgenie.com/docs/response).
diff --git a/health/notifications/pagerduty/README.md b/health/notifications/pagerduty/README.md
index 30db6379c..c6190e83f 100644
--- a/health/notifications/pagerduty/README.md
+++ b/health/notifications/pagerduty/README.md
@@ -2,7 +2,11 @@
title: "Send alert notifications to PagerDuty"
description: "Send alerts to your PagerDuty dashboard any time an anomaly or performance issue strikes a node in your infrastructure."
sidebar_label: "PagerDuty"
-custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/pagerduty/README.md
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/pagerduty/README.md"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Setup/Notification/Agent"
+learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
-->
# Send alert notifications to PagerDuty
@@ -14,7 +18,7 @@ resolution times.
## What you need to get started
-- An installation of the open-source [Netdata](/docs/get-started.mdx) monitoring agent.
+- An installation of the open-source [Netdata](https://github.com/netdata/netdata/blob/master/docs/get-started.mdx) monitoring agent.
- An installation of the [PagerDuty agent](https://www.pagerduty.com/docs/guides/agent-install-guide/) on the node
running Netdata.
- A PagerDuty `Generic API` service using either the `Events API v2` or `Events API v1`.
@@ -25,8 +29,8 @@ resolution times.
to PagerDuty. Click **Use our API directly** and select either `Events API v2` or `Events API v1`. Once you finish
creating the service, click on the **Integrations** tab to find your **Integration Key**.
-Navigate to the [Netdata config directory](/docs/configure/nodes.md#the-netdata-config-directory) and use
-[`edit-config`](/docs/configure/nodes.md#use-edit-config-to-edit-configuration-files) to open
+Navigate to the [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory) and use
+[`edit-config`](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#use-edit-config-to-edit-configuration-files) to open
`health_alarm_notify.conf`.
```bash
@@ -59,5 +63,5 @@ sudo su -s /bin/bash netdata
Aside from the three values set in `health_alarm_notify.conf`, there is no further configuration required to send alert
notifications to PagerDuty.
-To configure individual alarms, read our [alert configuration](/docs/monitor/configure-alarms.md) doc or
-the [health entity reference](/health/REFERENCE.md) doc.
+To configure individual alarms, read our [alert configuration](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) doc or
+the [health entity reference](https://github.com/netdata/netdata/blob/master/health/REFERENCE.md) doc.
diff --git a/health/notifications/prowl/README.md b/health/notifications/prowl/README.md
index dc136820c..8656c1314 100644
--- a/health/notifications/prowl/README.md
+++ b/health/notifications/prowl/README.md
@@ -1,6 +1,11 @@
<!--
title: "Prowl"
-custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/prowl/README.md
+sidebar_label: "Prowl"
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/prowl/README.md"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Setup/Notification/Agent"
+learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
-->
# Prowl
diff --git a/health/notifications/pushbullet/README.md b/health/notifications/pushbullet/README.md
index 194050bc1..17ed93646 100644
--- a/health/notifications/pushbullet/README.md
+++ b/health/notifications/pushbullet/README.md
@@ -1,6 +1,11 @@
<!--
title: "PushBullet"
-custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/pushbullet/README.md
+sidebar_label: "PushBullet"
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/pushbullet/README.md"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Setup/Notification/Agent"
+learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
-->
# PushBullet
diff --git a/health/notifications/pushover/README.md b/health/notifications/pushover/README.md
index 1e50f7140..4d5ea5a96 100644
--- a/health/notifications/pushover/README.md
+++ b/health/notifications/pushover/README.md
@@ -1,6 +1,11 @@
<!--
title: "PushOver"
-custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/pushover/README.md
+sidebar_label: "PushOver"
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/pushover/README.md"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Setup/Notification/Agent"
+learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
-->
# PushOver
diff --git a/health/notifications/rocketchat/README.md b/health/notifications/rocketchat/README.md
index 96d6160b2..0f7867d0f 100644
--- a/health/notifications/rocketchat/README.md
+++ b/health/notifications/rocketchat/README.md
@@ -1,6 +1,11 @@
<!--
title: "Rocket.Chat"
-custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/rocketchat/README.md
+sidebar_label: "Rocket Chat"
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/rocketchat/README.md"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Setup/Notification/Agent"
+learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
-->
# Rocket.Chat
diff --git a/health/notifications/slack/README.md b/health/notifications/slack/README.md
index ad36ce34a..ad9a21346 100644
--- a/health/notifications/slack/README.md
+++ b/health/notifications/slack/README.md
@@ -1,6 +1,11 @@
<!--
title: "Slack"
-custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/slack/README.md
+sidebar_label: "Slack"
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/slack/README.md"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Setup/Notification/Agent"
+learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
-->
# Slack
diff --git a/health/notifications/smstools3/README.md b/health/notifications/smstools3/README.md
index 6618dfa18..9535c9549 100644
--- a/health/notifications/smstools3/README.md
+++ b/health/notifications/smstools3/README.md
@@ -1,6 +1,11 @@
<!--
title: "SMS Server Tools 3"
-custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/smstools3/README.md
+sidebar_label: "SMS server"
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/smstools3/README.md"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Setup/Notification/Agent"
+learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
-->
# SMS Server Tools 3
diff --git a/health/notifications/stackpulse/README.md b/health/notifications/stackpulse/README.md
index c478fd584..25266e822 100644
--- a/health/notifications/stackpulse/README.md
+++ b/health/notifications/stackpulse/README.md
@@ -2,7 +2,11 @@
title: "Send notifications to StackPulse"
description: "Send alerts to your StackPulse Netdata integration any time an anomaly or performance issue strikes a node in your infrastructure."
sidebar_label: "StackPulse"
-custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/stackpulse/README.md
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/stackpulse/README.md"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Setup/Notification/Agent"
+learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
-->
# Send notifications to StackPulse
@@ -40,7 +44,7 @@ STACKPULSE_WEBHOOK="https://hooks.stackpulse.io/v1/webhooks/YOUR_UNIQUE_ID"
```
4. Now restart Netdata using `sudo systemctl restart netdata`, or the [appropriate
- method](/docs/configure/start-stop-restart.md) for your system. When your node creates an alarm, you can see the
+ method](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for your system. When your node creates an alarm, you can see the
associated notification on your StackPulse Administration Portal
## React to alarms with playbooks
diff --git a/health/notifications/syslog/README.md b/health/notifications/syslog/README.md
index 8b7863a1a..3527decc4 100644
--- a/health/notifications/syslog/README.md
+++ b/health/notifications/syslog/README.md
@@ -1,6 +1,11 @@
<!--
title: "Syslog"
-custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/syslog/README.md
+sidebar_label: "Syslog"
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/syslog/README.md"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Setup/Notification/Agent"
+learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
-->
# Syslog
diff --git a/health/notifications/telegram/README.md b/health/notifications/telegram/README.md
index 2a2ed5623..f80a2838d 100644
--- a/health/notifications/telegram/README.md
+++ b/health/notifications/telegram/README.md
@@ -1,6 +1,11 @@
<!--
title: "Telegram"
-custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/telegram/README.md
+sidebar_label: "Telegram"
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/telegram/README.md"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Setup/Notification/Agent"
+learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
-->
# Telegram
diff --git a/health/notifications/twilio/README.md b/health/notifications/twilio/README.md
index b563c66c1..470b2413b 100644
--- a/health/notifications/twilio/README.md
+++ b/health/notifications/twilio/README.md
@@ -1,6 +1,11 @@
<!--
title: "Twilio"
-custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/twilio/README.md
+sidebar_label: "Twilio"
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/twilio/README.md"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Setup/Notification/Agent"
+learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
-->
# Twilio
diff --git a/health/notifications/web/README.md b/health/notifications/web/README.md
index 185843af5..b4afd9ea7 100644
--- a/health/notifications/web/README.md
+++ b/health/notifications/web/README.md
@@ -1,9 +1,14 @@
<!--
-title: "Dashboard"
-custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/web/README.md
+title: "Pop up"
+sidebar_label: "Pop up notifications"
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/web/README.md"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Setup/Notification/Agent"
+learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}"
-->
-# Dashboard
+# Pop up notifications
The Netdata dashboard shows HTML notifications, when it is open.