diff options
Diffstat (limited to 'src/health/notifications')
51 files changed, 331 insertions, 113 deletions
diff --git a/src/health/notifications/README.md b/src/health/notifications/README.md index 5a2b032a3..e930e261f 100644 --- a/src/health/notifications/README.md +++ b/src/health/notifications/README.md @@ -10,10 +10,10 @@ The default script is `alarm-notify.sh`. > > This file mentions editing configuration files. > -> - To edit configuration files in a safe way, we provide the [`edit config` script](/docs/netdata-agent/configuration/README.md#edit-netdataconf)located in your [Netdata config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory) (typically is `/etc/netdata`) that creates the proper file and opens it in an editor automatically. +> - To edit configuration files in a safe way, we provide the [`edit config` script](/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config)located in your [Netdata config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory) (typically is `/etc/netdata`) that creates the proper file and opens it in an editor automatically. > Note that to run the script you need to be inside your Netdata config directory. > -> - Please also note that after most configuration changes you will need to [restart the Agent](/packaging/installer/README.md#maintaining-a-netdata-agent-installation) for the changes to take effect. +> - Please also note that after most configuration changes you will need to [restart the Agent](/docs/netdata-agent/start-stop-restart.md) for the changes to take effect. > > It is recommended to use this way for configuring Netdata. @@ -29,7 +29,7 @@ It uses **roles**. For example `sysadmin`, `webmaster`, `dba`, etc. Each alert is assigned to one or more roles, using the `to` line of the alert configuration. For example, here is the alert configuration for `ram.conf` that defaults to the role `sysadmin`: -```conf +```text alarm: ram_in_use on: system.ram class: Utilization @@ -52,7 +52,7 @@ Then `alarm-notify.sh` uses its own configuration file `health_alarm_notify.conf Here is an example, of the `sysadmin`'s role recipients for the email notification. You can send the notification to multiple recipients by separating the emails with a space. -```conf +```text ############################################################################### # RECIPIENTS PER ROLE @@ -84,7 +84,7 @@ You can edit `health_alarm_notify.conf` using the `edit-config` script to config - **Recipients** per role per notification method - ```conf + ```text role_recipients_email[sysadmin]="${DEFAULT_RECIPIENT_EMAIL}" role_recipients_pushover[sysadmin]="${DEFAULT_RECIPIENT_PUSHOVER}" role_recipients_pushbullet[sysadmin]="${DEFAULT_RECIPIENT_PUSHBULLET}" @@ -132,7 +132,7 @@ When you define recipients per role for notification methods, you can append `|c In the following examples, the first recipient receives all the alerts, while the second one receives only notifications for alerts that have at some point become critical. The second user may still receive warning and clear notifications, but only for the event that previously caused a critical alert. -```conf +```text email : "user1@example.com user2@example.com|critical" pushover : "2987343...9437837 8756278...2362736|critical" telegram : "111827421 112746832|critical" @@ -158,7 +158,7 @@ This works for all notification methods (including the default recipients). If you need to send curl based notifications (pushover, pushbullet, slack, alerta, flock, discord, telegram) via a proxy, you should set these variables to your proxy address: -```conf +```text export http_proxy="http://10.0.0.1:3128/" export https_proxy="http://10.0.0.1:3128/" ``` @@ -173,7 +173,7 @@ If you have an Internet facing netdata (or you have copied the images/ folder of netdata to your web server), set its URL here, to fetch the notification images from it. -```conf +```text images_base_url="http://my.public.netdata.server:19999" ``` diff --git a/src/health/notifications/alarm-notify.sh.in b/src/health/notifications/alarm-notify.sh.in index c7c44cb11..d7baa7345 100755 --- a/src/health/notifications/alarm-notify.sh.in +++ b/src/health/notifications/alarm-notify.sh.in @@ -769,6 +769,9 @@ fi # check custom [ -z "${DEFAULT_RECIPIENT_CUSTOM}" ] && SEND_CUSTOM="NO" +# check ilert +[ -z "${ILERT_ALERT_SOURCE_URL}" ] && SEND_ILERT="NO" + # ----------------------------------------------------------------------------- # check the availability of targets @@ -798,7 +801,8 @@ check_supported_targets() { [ "${SEND_DYNATRACE}" = "YES" ] || [ "${SEND_OPSGENIE}" = "YES" ] || [ "${SEND_GOTIFY}" = "YES" ] || - [ "${SEND_NTFY}" = "YES" ]; then + [ "${SEND_NTFY}" = "YES" ] || + [ "${SEND_ILERT}" = "YES" ]; then # if we need curl, check for the curl command if [ -z "${curl}" ]; then curl="$(command -v curl 2>/dev/null)" @@ -828,6 +832,7 @@ check_supported_targets() { SEND_OPSGENIE="NO" SEND_GOTIFY="NO" SEND_NTFY="NO" + SEND_ILERT="NO" fi fi @@ -983,7 +988,8 @@ for method in "${SEND_EMAIL}" \ "${SEND_DYNATRACE}" \ "${SEND_OPSGENIE}" \ "${SEND_GOTIFY}" \ - "${SEND_NTFY}" ; do + "${SEND_NTFY}" \ + "${SEND_ILERT}" ; do if [ "${method}" == "YES" ]; then proceed=1 @@ -2432,6 +2438,50 @@ send_ntfy() { } # ----------------------------------------------------------------------------- +# ilert sender + +send_ilert() { + local payload httpcode + [ "${SEND_ILERT}" != "YES" ] && return 1 + + if [ -z "${ILERT_ALERT_SOURCE_URL}" ] ; then + info "Can't send ilert notification, because ILERT_ALERT_SOURCE_URL is not defined" + return 1 + fi + + payload=$(cat <<EOF + { + "alert" : "${name}", + "alert_url" : "${goto_url}", + "alarm_id" : ${alarm_id}, + "chart" : "${chart}", + "date" : "${when}", + "duration" : "${duration_txt}", + "host" : "${host}", + "info" : "${info}", + "message" : "${status_message}", + "severity": ${status}, + "total_critical" : "${total_critical}", + "total_warnings" : "${total_warnings}", + "value" : "${value_string}", + "image_url": "${image}", + "src" : "${src}" + } +EOF +) + + httpcode=$(docurl -X POST -H "Content-Type: application/json" -d "${payload}" "${ILERT_ALERT_SOURCE_URL}") + if [ "${httpcode}" = "200" ] || [ "${httpcode}" = "202" ]; then + info "sent ilert event for ${notification_description}" + else + error "failed to send ilert event for ${notification_description}, with HTTP response status code ${httpcode}." + return 1 + fi + + return 0 +} + +# ----------------------------------------------------------------------------- # prepare the content of the notification # the url to send the user on click @@ -3604,6 +3654,11 @@ send_ntfy "${DEFAULT_RECIPIENT_NTFY}" SENT_NTFY=$? # ----------------------------------------------------------------------------- +# send messages to ilert +send_ilert +SENT_ILERT=$? + +# ----------------------------------------------------------------------------- # let netdata know for state in "${SENT_EMAIL}" \ "${SENT_PUSHOVER}" \ @@ -3632,7 +3687,8 @@ for state in "${SENT_EMAIL}" \ "${SENT_DYNATRACE}" \ "${SENT_OPSGENIE}" \ "${SENT_GOTIFY}" \ - "${SENT_NTFY}"; do + "${SENT_NTFY}" \ + "${SENT_ILERT}"; do if [ "${state}" -eq 0 ]; then # we sent something exit 0 diff --git a/src/health/notifications/alerta/README.md b/src/health/notifications/alerta/README.md index 40fef3fd7..4999f1db4 100644 --- a/src/health/notifications/alerta/README.md +++ b/src/health/notifications/alerta/README.md @@ -39,8 +39,8 @@ You can send Netdata alerts to Alerta to see alerts coming from many Netdata hos The configuration file name for this integration is `health_alarm_notify.conf`. -You can edit the configuration file using the `edit-config` script from the -Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). +You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script from the +Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata @@ -71,7 +71,7 @@ You will need an API key to send messages from any source, if Alerta is configur The `DEFAULT_RECIPIENT_CUSTOM` can be edited in the following entries at the bottom of the same file: -```conf +```text role_recipients_alerta[sysadmin]="Systems" role_recipients_alerta[domainadmin]="Domains" role_recipients_alerta[dba]="Databases Systems" diff --git a/src/health/notifications/alerta/metadata.yaml b/src/health/notifications/alerta/metadata.yaml index f815032b9..363dd6e2b 100644 --- a/src/health/notifications/alerta/metadata.yaml +++ b/src/health/notifications/alerta/metadata.yaml @@ -58,7 +58,7 @@ detailed_description: | The `DEFAULT_RECIPIENT_CUSTOM` can be edited in the following entries at the bottom of the same file: - ```conf + ```text role_recipients_alerta[sysadmin]="Systems" role_recipients_alerta[domainadmin]="Domains" role_recipients_alerta[dba]="Databases Systems" diff --git a/src/health/notifications/awssns/README.md b/src/health/notifications/awssns/README.md index b5a4cc5f4..8bcaf045c 100644 --- a/src/health/notifications/awssns/README.md +++ b/src/health/notifications/awssns/README.md @@ -56,8 +56,8 @@ You can send notifications through Amazon SNS using Netdata's Agent alert notifi The configuration file name for this integration is `health_alarm_notify.conf`. -You can edit the configuration file using the `edit-config` script from the -Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). +You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script from the +Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata @@ -124,7 +124,7 @@ All roles will default to this variable if left unconfigured. You can have different recipient Topics per **role**, by editing `DEFAULT_RECIPIENT_AWSSNS` with the Topic ARN you want, in the following entries at the bottom of the same file: -```conf +```text role_recipients_awssns[sysadmin]="arn:aws:sns:us-east-2:123456789012:Systems" role_recipients_awssns[domainadmin]="arn:aws:sns:us-east-2:123456789012:Domains" role_recipients_awssns[dba]="arn:aws:sns:us-east-2:123456789012:Databases" @@ -143,7 +143,7 @@ role_recipients_awssns[sitemgr]="arn:aws:sns:us-east-2:123456789012:Sites" An example working configuration would be: ```yaml -```conf +```text #------------------------------------------------------------------------------ # Amazon SNS notifications diff --git a/src/health/notifications/awssns/metadata.yaml b/src/health/notifications/awssns/metadata.yaml index 93389bad0..0eb704d4a 100644 --- a/src/health/notifications/awssns/metadata.yaml +++ b/src/health/notifications/awssns/metadata.yaml @@ -104,7 +104,7 @@ You can have different recipient Topics per **role**, by editing `DEFAULT_RECIPIENT_AWSSNS` with the Topic ARN you want, in the following entries at the bottom of the same file: - ```conf + ```text role_recipients_awssns[sysadmin]="arn:aws:sns:us-east-2:123456789012:Systems" role_recipients_awssns[domainadmin]="arn:aws:sns:us-east-2:123456789012:Domains" role_recipients_awssns[dba]="arn:aws:sns:us-east-2:123456789012:Databases" @@ -122,7 +122,7 @@ enabled: false description: 'An example working configuration would be:' config: | - ```conf + ```text #------------------------------------------------------------------------------ # Amazon SNS notifications diff --git a/src/health/notifications/custom/README.md b/src/health/notifications/custom/README.md index 785aec59d..ba20f1c9c 100644 --- a/src/health/notifications/custom/README.md +++ b/src/health/notifications/custom/README.md @@ -36,8 +36,8 @@ Netdata Agent's alert notification feature allows you to send custom notificatio The configuration file name for this integration is `health_alarm_notify.conf`. -You can edit the configuration file using the `edit-config` script from the -Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). +You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script from the +Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata diff --git a/src/health/notifications/discord/README.md b/src/health/notifications/discord/README.md index 128e04a44..5d6cda8e4 100644 --- a/src/health/notifications/discord/README.md +++ b/src/health/notifications/discord/README.md @@ -38,8 +38,8 @@ Send notifications to Discord using Netdata's Agent alert notification feature, The configuration file name for this integration is `health_alarm_notify.conf`. -You can edit the configuration file using the `edit-config` script from the -Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). +You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script from the +Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata @@ -61,7 +61,7 @@ The following options can be defined for this notification All roles will default to this variable if left unconfigured. You can then have different channels per role, by editing `DEFAULT_RECIPIENT_DISCORD` with the channel you want, in the following entries at the bottom of the same file: -```conf +```text role_recipients_discord[sysadmin]="systems" role_recipients_discord[domainadmin]="domains" role_recipients_discord[dba]="databases systems" diff --git a/src/health/notifications/discord/metadata.yaml b/src/health/notifications/discord/metadata.yaml index a46a8ec98..f62a1fc08 100644 --- a/src/health/notifications/discord/metadata.yaml +++ b/src/health/notifications/discord/metadata.yaml @@ -45,7 +45,7 @@ detailed_description: | All roles will default to this variable if left unconfigured. You can then have different channels per role, by editing `DEFAULT_RECIPIENT_DISCORD` with the channel you want, in the following entries at the bottom of the same file: - ```conf + ```text role_recipients_discord[sysadmin]="systems" role_recipients_discord[domainadmin]="domains" role_recipients_discord[dba]="databases systems" diff --git a/src/health/notifications/dynatrace/README.md b/src/health/notifications/dynatrace/README.md index 6785cdb82..7764f893c 100644 --- a/src/health/notifications/dynatrace/README.md +++ b/src/health/notifications/dynatrace/README.md @@ -41,8 +41,8 @@ You can send notifications to Dynatrace using Netdata's Agent alert notification The configuration file name for this integration is `health_alarm_notify.conf`. -You can edit the configuration file using the `edit-config` script from the -Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). +You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script from the +Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata diff --git a/src/health/notifications/email/README.md b/src/health/notifications/email/README.md index 1e831d58e..781ab7d53 100644 --- a/src/health/notifications/email/README.md +++ b/src/health/notifications/email/README.md @@ -37,8 +37,8 @@ Send notifications via Email using Netdata's Agent alert notification feature, w The configuration file name for this integration is `health_alarm_notify.conf`. -You can edit the configuration file using the `edit-config` script from the -Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). +You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script from the +Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata @@ -60,7 +60,7 @@ The following options can be defined for this notification All roles will default to this variable if left unconfigured. The `DEFAULT_RECIPIENT_CUSTOM` can be edited in the following entries at the bottom of the same file: -```conf +```text role_recipients_email[sysadmin]="systems@example.com" role_recipients_email[domainadmin]="domains@example.com" role_recipients_email[dba]="databases@example.com systems@example.com" diff --git a/src/health/notifications/email/metadata.yaml b/src/health/notifications/email/metadata.yaml index f0d4a62a9..cbef3ab27 100644 --- a/src/health/notifications/email/metadata.yaml +++ b/src/health/notifications/email/metadata.yaml @@ -44,7 +44,7 @@ detailed_description: | All roles will default to this variable if left unconfigured. The `DEFAULT_RECIPIENT_CUSTOM` can be edited in the following entries at the bottom of the same file: - ```conf + ```text role_recipients_email[sysadmin]="systems@example.com" role_recipients_email[domainadmin]="domains@example.com" role_recipients_email[dba]="databases@example.com systems@example.com" diff --git a/src/health/notifications/flock/README.md b/src/health/notifications/flock/README.md index 332ede832..5db467cd3 100644 --- a/src/health/notifications/flock/README.md +++ b/src/health/notifications/flock/README.md @@ -37,8 +37,8 @@ Send notifications to Flock using Netdata's Agent alert notification feature, wh The configuration file name for this integration is `health_alarm_notify.conf`. -You can edit the configuration file using the `edit-config` script from the -Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). +You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script from the +Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata @@ -59,7 +59,7 @@ The following options can be defined for this notification ##### DEFAULT_RECIPIENT_FLOCK You can have different channels per role, by editing DEFAULT_RECIPIENT_FLOCK with the channel you want, in the following entries at the bottom of the same file: -```conf +```text role_recipients_flock[sysadmin]="systems" role_recipients_flock[domainadmin]="domains" role_recipients_flock[dba]="databases systems" diff --git a/src/health/notifications/flock/metadata.yaml b/src/health/notifications/flock/metadata.yaml index 62e7f4995..619c0a0a6 100644 --- a/src/health/notifications/flock/metadata.yaml +++ b/src/health/notifications/flock/metadata.yaml @@ -43,7 +43,7 @@ required: true detailed_description: | You can have different channels per role, by editing DEFAULT_RECIPIENT_FLOCK with the channel you want, in the following entries at the bottom of the same file: - ```conf + ```text role_recipients_flock[sysadmin]="systems" role_recipients_flock[domainadmin]="domains" role_recipients_flock[dba]="databases systems" diff --git a/src/health/notifications/gotify/README.md b/src/health/notifications/gotify/README.md index f0f8a7edb..7ddeda55b 100644 --- a/src/health/notifications/gotify/README.md +++ b/src/health/notifications/gotify/README.md @@ -38,8 +38,8 @@ You can send alerts to your Gotify instance using Netdata's Agent alert notifica The configuration file name for this integration is `health_alarm_notify.conf`. -You can edit the configuration file using the `edit-config` script from the -Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). +You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script from the +Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata diff --git a/src/health/notifications/health_alarm_notify.conf b/src/health/notifications/health_alarm_notify.conf index 9dcec27ae..84d6d6225 100755 --- a/src/health/notifications/health_alarm_notify.conf +++ b/src/health/notifications/health_alarm_notify.conf @@ -845,6 +845,15 @@ NTFY_ACCESS_TOKEN="" DEFAULT_RECIPIENT_NTFY="" #------------------------------------------------------------------------------ +# ilert global notification options +SEND_ILERT="YES" + +# Api key +ILERT_ALERT_SOURCE_URL="" + +DEFAULT_RECIPIENT_ILERT="" + +#------------------------------------------------------------------------------ # custom notifications # @@ -984,6 +993,8 @@ custom_sender() { # role_recipients_ntfy[sysadmin]="${DEFAULT_RECIPIENT_NTFY}" +# role_recipients_ilert[sysadmin]="${DEFAULT_RECIPIENT_ILERT}" + # ----------------------------------------------------------------------------- # DNS related alarms @@ -1041,6 +1052,8 @@ custom_sender() { # role_recipients_ntfy[domainadmin]="${DEFAULT_RECIPIENT_NTFY}" +# role_recipients_ilert[domainadmin]="${DEFAULT_RECIPIENT_ILERT}" + # ----------------------------------------------------------------------------- # database servers alarms # mysql, redis, memcached, postgres, etc @@ -1099,6 +1112,8 @@ custom_sender() { # role_recipients_ntfy[dba]="${DEFAULT_RECIPIENT_NTFY}" +# role_recipients_ilert[dba]="databases ${DEFAULT_RECIPIENT_ILERT}" + # ----------------------------------------------------------------------------- # web servers alarms # apache, nginx, lighttpd, etc @@ -1157,6 +1172,8 @@ custom_sender() { # role_recipients_ntfy[webmaster]="${DEFAULT_RECIPIENT_NTFY}" +# role_recipients_ilert[webmaster]="${DEFAULT_RECIPIENT_ILERT}" + # ----------------------------------------------------------------------------- # proxy servers alarms # squid, etc @@ -1215,6 +1232,8 @@ custom_sender() { # role_recipients_ntfy[proxyadmin]="${DEFAULT_RECIPIENT_NTFY}" +# role_recipients_ilert[proxyadmin]="${DEFAULT_RECIPIENT_ILERT}" + # ----------------------------------------------------------------------------- # peripheral devices # UPS, photovoltaics, etc @@ -1270,3 +1289,5 @@ custom_sender() { # role_recipients_gotify[sitemgr]="${DEFAULT_RECIPIENT_GOTIFY}" # role_recipients_ntfy[sitemgr]="${DEFAULT_RECIPIENT_NTFY}" + +# role_recipients_ilert[sitemgr]="${DEFAULT_RECIPIENT_ILERT}" diff --git a/src/health/notifications/ilert/README.md b/src/health/notifications/ilert/README.md new file mode 100644 index 000000000..6d6541ddd --- /dev/null +++ b/src/health/notifications/ilert/README.md @@ -0,0 +1,96 @@ +<!--startmeta +custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/health/notifications/ilert/README.md" +meta_yaml: "https://github.com/netdata/netdata/edit/master/src/health/notifications/ilert/metadata.yaml" +sidebar_label: "ilert" +learn_status: "Published" +learn_rel_path: "Alerts & Notifications/Notifications/Agent Dispatched Notifications" +message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE NOTIFICATION'S metadata.yaml FILE" +endmeta--> + +# ilert + + +<img src="https://netdata.cloud/img/ilert.svg" width="150"/> + + +ilert is an alerting and incident management tool. It helps teams reduce response times by enhancing monitoring and ticketing tools with reliable alerts, automatic escalations, on-call schedules, and features for incident response, communication, and status updates. +Sending notification to ilert via Netdata's Agent alert notification feature includes links, images and resolving of corresponding alerts. + + + +<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> + +## Setup + +### Prerequisites + +#### + +- A Netdata alert source in ilert. You can create a [Netdata alert source](https://docs.ilert.com/inbound-integrations/netdata) in [ilert](https://www.ilert.com/). +- Access to the terminal where Netdata Agent is running + + + +### Configuration + +#### File + +The configuration file name for this integration is `health_alarm_notify.conf`. + + +You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script from the +Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). + +```bash +cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata +sudo ./edit-config health_alarm_notify.conf +``` +#### Options + +The following options can be defined for this notification + +<details open><summary>Config Options</summary> + +| Name | Description | Default | Required | +|:----|:-----------|:-------|:--------:| +| SEND_ILERT | Set `SEND_ILERT` to YES | YES | yes | +| ILERT_ALERT_SOURCE_URL | Set `ILERT_ALERT_SOURCE_URL` to your Netdata alert source url in ilert. | | yes | + +</details> + +#### Examples + +##### Basic Configuration + + + +```yaml +SEND_ILERT="YES" +ILERT_ALERT_SOURCE_URL="https://api.ilert.com/api/v1/events/netdata/{API-KEY}" + +``` + + +## Troubleshooting + +### Test Notification + +You can run the following command by hand, to test alerts configuration: + +```bash +# become user netdata +sudo su -s /bin/bash netdata + +# enable debugging info on the console +export NETDATA_ALARM_NOTIFY_DEBUG=1 + +# send test alarms to sysadmin +/usr/libexec/netdata/plugins.d/alarm-notify.sh test + +# send test alarms to any role +/usr/libexec/netdata/plugins.d/alarm-notify.sh test "ROLE" +``` + +Note that this will test _all_ alert mechanisms for the selected role. + + diff --git a/src/health/notifications/ilert/metadata.yaml b/src/health/notifications/ilert/metadata.yaml new file mode 100644 index 000000000..7e2454834 --- /dev/null +++ b/src/health/notifications/ilert/metadata.yaml @@ -0,0 +1,55 @@ +# yamllint disable rule:line-length +--- +- id: "notify-ilert" + meta: + name: "ilert" + link: "https://www.ilert.com/" + categories: + - notify.agent + icon_filename: "ilert.svg" + keywords: + - ilert + overview: + notification_description: | + ilert is an alerting and incident management tool. It helps teams reduce response times by enhancing monitoring and ticketing tools with reliable alerts, automatic escalations, on-call schedules, and features for incident response, communication, and status updates. + Sending notification to ilert via Netdata's Agent alert notification feature includes links, images and resolving of corresponding alerts. + notification_limitations: "" + setup: + prerequisites: + list: + - title: "" + description: | + - A Netdata alert source in ilert. You can create a [Netdata alert source](https://docs.ilert.com/inbound-integrations/netdata) in [ilert](https://www.ilert.com/). + - Access to the terminal where Netdata Agent is running + configuration: + file: + name: "health_alarm_notify.conf" + options: + description: "The following options can be defined for this notification" + folding: + title: "Config Options" + enabled: true + list: + - name: "SEND_ILERT" + default_value: "YES" + description: "Set `SEND_ILERT` to YES" + required: true + - name: "ILERT_ALERT_SOURCE_URL" + default_value: "" + description: "Set `ILERT_ALERT_SOURCE_URL` to your Netdata alert source url in ilert." + required: true + examples: + folding: + enabled: true + title: "" + list: + - name: "Basic Configuration" + folding: + enabled: false + description: "" + config: | + SEND_ILERT="YES" + ILERT_ALERT_SOURCE_URL="https://api.ilert.com/api/v1/events/netdata/{API-KEY}" + troubleshooting: + problems: + list: [] diff --git a/src/health/notifications/irc/README.md b/src/health/notifications/irc/README.md index 76d3f5bc2..5674fb39d 100644 --- a/src/health/notifications/irc/README.md +++ b/src/health/notifications/irc/README.md @@ -37,8 +37,8 @@ Send notifications to IRC using Netdata's Agent alert notification feature, whic The configuration file name for this integration is `health_alarm_notify.conf`. -You can edit the configuration file using the `edit-config` script from the -Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). +You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script from the +Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata @@ -76,7 +76,7 @@ nc="/usr/bin/nc" ##### DEFAULT_RECIPIENT_IRC The `DEFAULT_RECIPIENT_IRC` can be edited in the following entries at the bottom of the same file: -```conf +```text role_recipients_irc[sysadmin]="#systems" role_recipients_irc[domainadmin]="#domains" role_recipients_irc[dba]="#databases #systems" diff --git a/src/health/notifications/irc/metadata.yaml b/src/health/notifications/irc/metadata.yaml index aa2593f91..4a7585eef 100644 --- a/src/health/notifications/irc/metadata.yaml +++ b/src/health/notifications/irc/metadata.yaml @@ -69,7 +69,7 @@ required: true detailed_description: | The `DEFAULT_RECIPIENT_IRC` can be edited in the following entries at the bottom of the same file: - ```conf + ```text role_recipients_irc[sysadmin]="#systems" role_recipients_irc[domainadmin]="#domains" role_recipients_irc[dba]="#databases #systems" diff --git a/src/health/notifications/kavenegar/README.md b/src/health/notifications/kavenegar/README.md index eedd43a23..ff4479d6d 100644 --- a/src/health/notifications/kavenegar/README.md +++ b/src/health/notifications/kavenegar/README.md @@ -38,8 +38,8 @@ You can send notifications to Kavenegar using Netdata's Agent alert notification The configuration file name for this integration is `health_alarm_notify.conf`. -You can edit the configuration file using the `edit-config` script from the -Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). +You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script from the +Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata @@ -63,7 +63,7 @@ The following options can be defined for this notification All roles will default to this variable if lest unconfigured. You can then have different SMS recipients per role, by editing `DEFAULT_RECIPIENT_KAVENEGAR` with the SMS recipients you want, in the following entries at the bottom of the same file: -```conf +```text role_recipients_kavenegar[sysadmin]="09100000000" role_recipients_kavenegar[domainadmin]="09111111111" role_recipients_kavenegar[dba]="0922222222" diff --git a/src/health/notifications/kavenegar/metadata.yaml b/src/health/notifications/kavenegar/metadata.yaml index 559dbac09..70c87b637 100644 --- a/src/health/notifications/kavenegar/metadata.yaml +++ b/src/health/notifications/kavenegar/metadata.yaml @@ -50,7 +50,7 @@ All roles will default to this variable if lest unconfigured. You can then have different SMS recipients per role, by editing `DEFAULT_RECIPIENT_KAVENEGAR` with the SMS recipients you want, in the following entries at the bottom of the same file: - ```conf + ```text role_recipients_kavenegar[sysadmin]="09100000000" role_recipients_kavenegar[domainadmin]="09111111111" role_recipients_kavenegar[dba]="0922222222" diff --git a/src/health/notifications/matrix/README.md b/src/health/notifications/matrix/README.md index 3c01a9ef2..c0387d211 100644 --- a/src/health/notifications/matrix/README.md +++ b/src/health/notifications/matrix/README.md @@ -39,8 +39,8 @@ Send notifications to Matrix network rooms using Netdata's Agent alert notificat The configuration file name for this integration is `health_alarm_notify.conf`. -You can edit the configuration file using the `edit-config` script from the -Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). +You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script from the +Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata @@ -77,7 +77,7 @@ All roles will default to this variable if left unconfigured. You can have different Rooms per role, by editing `DEFAULT_RECIPIENT_MATRIX` with the `!roomid:homeservername` you want, in the following entries at the bottom of the same file: -```conf +```text role_recipients_matrix[sysadmin]="!roomid1:homeservername" role_recipients_matrix[domainadmin]="!roomid2:homeservername" role_recipients_matrix[dba]="!roomid3:homeservername" diff --git a/src/health/notifications/matrix/metadata.yaml b/src/health/notifications/matrix/metadata.yaml index db7f92eb1..770e0905a 100644 --- a/src/health/notifications/matrix/metadata.yaml +++ b/src/health/notifications/matrix/metadata.yaml @@ -61,7 +61,7 @@ You can have different Rooms per role, by editing `DEFAULT_RECIPIENT_MATRIX` with the `!roomid:homeservername` you want, in the following entries at the bottom of the same file: - ```conf + ```text role_recipients_matrix[sysadmin]="!roomid1:homeservername" role_recipients_matrix[domainadmin]="!roomid2:homeservername" role_recipients_matrix[dba]="!roomid3:homeservername" diff --git a/src/health/notifications/messagebird/README.md b/src/health/notifications/messagebird/README.md index 4b668fce3..d961a3b4d 100644 --- a/src/health/notifications/messagebird/README.md +++ b/src/health/notifications/messagebird/README.md @@ -37,8 +37,8 @@ Send notifications to MessageBird using Netdata's Agent alert notification featu The configuration file name for this integration is `health_alarm_notify.conf`. -You can edit the configuration file using the `edit-config` script from the -Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). +You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script from the +Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata @@ -62,7 +62,7 @@ The following options can be defined for this notification All roles will default to this variable if left unconfigured. You can then have different recipients per role, by editing `DEFAULT_RECIPIENT_MESSAGEBIRD` with the number you want, in the following entries at the bottom of the same file: -```conf +```text role_recipients_messagebird[sysadmin]="+15555555555" role_recipients_messagebird[domainadmin]="+15555555556" role_recipients_messagebird[dba]="+15555555557" diff --git a/src/health/notifications/messagebird/metadata.yaml b/src/health/notifications/messagebird/metadata.yaml index a97cdc712..3ba65ecf3 100644 --- a/src/health/notifications/messagebird/metadata.yaml +++ b/src/health/notifications/messagebird/metadata.yaml @@ -49,7 +49,7 @@ All roles will default to this variable if left unconfigured. You can then have different recipients per role, by editing `DEFAULT_RECIPIENT_MESSAGEBIRD` with the number you want, in the following entries at the bottom of the same file: - ```conf + ```text role_recipients_messagebird[sysadmin]="+15555555555" role_recipients_messagebird[domainadmin]="+15555555556" role_recipients_messagebird[dba]="+15555555557" diff --git a/src/health/notifications/msteams/README.md b/src/health/notifications/msteams/README.md index e24730777..91fe7a081 100644 --- a/src/health/notifications/msteams/README.md +++ b/src/health/notifications/msteams/README.md @@ -38,8 +38,8 @@ You can send Netdata alerts to Microsoft Teams using Netdata's Agent alert notif The configuration file name for this integration is `health_alarm_notify.conf`. -You can edit the configuration file using the `edit-config` script from the -Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). +You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script from the +Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata @@ -64,7 +64,7 @@ In Microsoft Teams the channel name is encoded in the URI after `/IncomingWebhoo All roles will default to this variable if left unconfigured. You can have different channels per role, by editing `DEFAULT_RECIPIENT_MSTEAMS` with the channel you want, in the following entries at the bottom of the same file: -```conf +```text role_recipients_msteams[sysadmin]="CHANNEL1" role_recipients_msteams[domainadmin]="CHANNEL2" role_recipients_msteams[dba]="databases CHANNEL3" diff --git a/src/health/notifications/msteams/metadata.yaml b/src/health/notifications/msteams/metadata.yaml index 72de507a4..d37c08c0a 100644 --- a/src/health/notifications/msteams/metadata.yaml +++ b/src/health/notifications/msteams/metadata.yaml @@ -50,7 +50,7 @@ All roles will default to this variable if left unconfigured. You can have different channels per role, by editing `DEFAULT_RECIPIENT_MSTEAMS` with the channel you want, in the following entries at the bottom of the same file: - ```conf + ```text role_recipients_msteams[sysadmin]="CHANNEL1" role_recipients_msteams[domainadmin]="CHANNEL2" role_recipients_msteams[dba]="databases CHANNEL3" diff --git a/src/health/notifications/ntfy/README.md b/src/health/notifications/ntfy/README.md index a03e30304..39613338b 100644 --- a/src/health/notifications/ntfy/README.md +++ b/src/health/notifications/ntfy/README.md @@ -39,8 +39,8 @@ You can send alerts to an ntfy server using Netdata's Agent alert notification f The configuration file name for this integration is `health_alarm_notify.conf`. -You can edit the configuration file using the `edit-config` script from the -Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). +You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script from the +Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata @@ -67,7 +67,7 @@ You can define multiple recipient URLs like this: `https://SERVER1/TOPIC1` `http All roles will default to this variable if left unconfigured. You can then have different servers and/or topics per role, by editing DEFAULT_RECIPIENT_NTFY with the server-topic combination you want, in the following entries at the bottom of the same file: -```conf +```text role_recipients_ntfy[sysadmin]="https://SERVER1/TOPIC1" role_recipients_ntfy[domainadmin]="https://SERVER2/TOPIC2" role_recipients_ntfy[dba]="https://SERVER3/TOPIC3" diff --git a/src/health/notifications/ntfy/metadata.yaml b/src/health/notifications/ntfy/metadata.yaml index 0d6c0beac..90ce3f6cd 100644 --- a/src/health/notifications/ntfy/metadata.yaml +++ b/src/health/notifications/ntfy/metadata.yaml @@ -45,7 +45,7 @@ All roles will default to this variable if left unconfigured. You can then have different servers and/or topics per role, by editing DEFAULT_RECIPIENT_NTFY with the server-topic combination you want, in the following entries at the bottom of the same file: - ```conf + ```text role_recipients_ntfy[sysadmin]="https://SERVER1/TOPIC1" role_recipients_ntfy[domainadmin]="https://SERVER2/TOPIC2" role_recipients_ntfy[dba]="https://SERVER3/TOPIC3" diff --git a/src/health/notifications/opsgenie/README.md b/src/health/notifications/opsgenie/README.md index fa5859d7d..2a4dc1fd8 100644 --- a/src/health/notifications/opsgenie/README.md +++ b/src/health/notifications/opsgenie/README.md @@ -38,8 +38,8 @@ You can send notifications to Opsgenie using Netdata's Agent alert notification The configuration file name for this integration is `health_alarm_notify.conf`. -You can edit the configuration file using the `edit-config` script from the -Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). +You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script from the +Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata diff --git a/src/health/notifications/pagerduty/README.md b/src/health/notifications/pagerduty/README.md index ae45e5385..d85dd46c9 100644 --- a/src/health/notifications/pagerduty/README.md +++ b/src/health/notifications/pagerduty/README.md @@ -40,8 +40,8 @@ You can send notifications to PagerDuty using Netdata's Agent alert notification The configuration file name for this integration is `health_alarm_notify.conf`. -You can edit the configuration file using the `edit-config` script from the -Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). +You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script from the +Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata @@ -63,7 +63,7 @@ The following options can be defined for this notification All roles will default to this variable if left unconfigured. The `DEFAULT_RECIPIENT_PD` can be edited in the following entries at the bottom of the same file: -```conf +```text role_recipients_pd[sysadmin]="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxa" role_recipients_pd[domainadmin]="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxb" role_recipients_pd[dba]="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxc" diff --git a/src/health/notifications/pagerduty/metadata.yaml b/src/health/notifications/pagerduty/metadata.yaml index 6fc1d640e..3973825fc 100644 --- a/src/health/notifications/pagerduty/metadata.yaml +++ b/src/health/notifications/pagerduty/metadata.yaml @@ -44,7 +44,7 @@ All roles will default to this variable if left unconfigured. The `DEFAULT_RECIPIENT_PD` can be edited in the following entries at the bottom of the same file: - ```conf + ```text role_recipients_pd[sysadmin]="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxa" role_recipients_pd[domainadmin]="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxb" role_recipients_pd[dba]="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxc" diff --git a/src/health/notifications/prowl/README.md b/src/health/notifications/prowl/README.md index 0d206cee0..ba00b3212 100644 --- a/src/health/notifications/prowl/README.md +++ b/src/health/notifications/prowl/README.md @@ -43,8 +43,8 @@ Send notifications to Prowl using Netdata's Agent alert notification feature, wh The configuration file name for this integration is `health_alarm_notify.conf`. -You can edit the configuration file using the `edit-config` script from the -Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). +You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script from the +Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata @@ -66,7 +66,7 @@ The following options can be defined for this notification All roles will default to this variable if left unconfigured. The `DEFAULT_RECIPIENT_PROWL` can be edited in the following entries at the bottom of the same file: -```conf +```text role_recipients_prowl[sysadmin]="AAAAAAAA" role_recipients_prowl[domainadmin]="BBBBBBBBB" role_recipients_prowl[dba]="CCCCCCCCC" diff --git a/src/health/notifications/prowl/metadata.yaml b/src/health/notifications/prowl/metadata.yaml index b3f0e0a1e..3142d155c 100644 --- a/src/health/notifications/prowl/metadata.yaml +++ b/src/health/notifications/prowl/metadata.yaml @@ -43,7 +43,7 @@ All roles will default to this variable if left unconfigured. The `DEFAULT_RECIPIENT_PROWL` can be edited in the following entries at the bottom of the same file: - ```conf + ```text role_recipients_prowl[sysadmin]="AAAAAAAA" role_recipients_prowl[domainadmin]="BBBBBBBBB" role_recipients_prowl[dba]="CCCCCCCCC" diff --git a/src/health/notifications/pushbullet/README.md b/src/health/notifications/pushbullet/README.md index 1b30f4c97..0f22b5d54 100644 --- a/src/health/notifications/pushbullet/README.md +++ b/src/health/notifications/pushbullet/README.md @@ -37,8 +37,8 @@ Send notifications to Pushbullet using Netdata's Agent alert notification featur The configuration file name for this integration is `health_alarm_notify.conf`. -You can edit the configuration file using the `edit-config` script from the -Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). +You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script from the +Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata @@ -63,7 +63,7 @@ You can define multiple entries like this: user1@email.com user2@email.com. All roles will default to this variable if left unconfigured. The `DEFAULT_RECIPIENT_PUSHBULLET` can be edited in the following entries at the bottom of the same file: -```conf +```text role_recipients_pushbullet[sysadmin]="user1@email.com" role_recipients_pushbullet[domainadmin]="user2@mail.com" role_recipients_pushbullet[dba]="#channel1" diff --git a/src/health/notifications/pushbullet/metadata.yaml b/src/health/notifications/pushbullet/metadata.yaml index 430033cca..03ee41233 100644 --- a/src/health/notifications/pushbullet/metadata.yaml +++ b/src/health/notifications/pushbullet/metadata.yaml @@ -47,7 +47,7 @@ All roles will default to this variable if left unconfigured. The `DEFAULT_RECIPIENT_PUSHBULLET` can be edited in the following entries at the bottom of the same file: - ```conf + ```text role_recipients_pushbullet[sysadmin]="user1@email.com" role_recipients_pushbullet[domainadmin]="user2@mail.com" role_recipients_pushbullet[dba]="#channel1" diff --git a/src/health/notifications/pushover/README.md b/src/health/notifications/pushover/README.md index 9d30dfa97..8a296691b 100644 --- a/src/health/notifications/pushover/README.md +++ b/src/health/notifications/pushover/README.md @@ -41,8 +41,8 @@ Send notification to Pushover using Netdata's Agent alert notification feature, The configuration file name for this integration is `health_alarm_notify.conf`. -You can edit the configuration file using the `edit-config` script from the -Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). +You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script from the +Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata @@ -65,7 +65,7 @@ The following options can be defined for this notification All roles will default to this variable if left unconfigured. The `DEFAULT_RECIPIENT_PUSHOVER` can be edited in the following entries at the bottom of the same file: -```conf +```text role_recipients_pushover[sysadmin]="USERTOKEN1" role_recipients_pushover[domainadmin]="USERTOKEN2" role_recipients_pushover[dba]="USERTOKEN3 USERTOKEN4" diff --git a/src/health/notifications/pushover/metadata.yaml b/src/health/notifications/pushover/metadata.yaml index 9af729ea8..e45f909b3 100644 --- a/src/health/notifications/pushover/metadata.yaml +++ b/src/health/notifications/pushover/metadata.yaml @@ -49,7 +49,7 @@ All roles will default to this variable if left unconfigured. The `DEFAULT_RECIPIENT_PUSHOVER` can be edited in the following entries at the bottom of the same file: - ```conf + ```text role_recipients_pushover[sysadmin]="USERTOKEN1" role_recipients_pushover[domainadmin]="USERTOKEN2" role_recipients_pushover[dba]="USERTOKEN3 USERTOKEN4" diff --git a/src/health/notifications/rocketchat/README.md b/src/health/notifications/rocketchat/README.md index b9b0d5687..f23032bd0 100644 --- a/src/health/notifications/rocketchat/README.md +++ b/src/health/notifications/rocketchat/README.md @@ -38,8 +38,8 @@ Send notifications to Rocket.Chat using Netdata's Agent alert notification featu The configuration file name for this integration is `health_alarm_notify.conf`. -You can edit the configuration file using the `edit-config` script from the -Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). +You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script from the +Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata @@ -62,7 +62,7 @@ The following options can be defined for this notification All roles will default to this variable if left unconfigured. The `DEFAULT_RECIPIENT_ROCKETCHAT` can be edited in the following entries at the bottom of the same file: -```conf +```text role_recipients_rocketchat[sysadmin]="systems" role_recipients_rocketchat[domainadmin]="domains" role_recipients_rocketchat[dba]="databases systems" diff --git a/src/health/notifications/rocketchat/metadata.yaml b/src/health/notifications/rocketchat/metadata.yaml index f644b93e1..17ee37acb 100644 --- a/src/health/notifications/rocketchat/metadata.yaml +++ b/src/health/notifications/rocketchat/metadata.yaml @@ -46,7 +46,7 @@ All roles will default to this variable if left unconfigured. The `DEFAULT_RECIPIENT_ROCKETCHAT` can be edited in the following entries at the bottom of the same file: - ```conf + ```text role_recipients_rocketchat[sysadmin]="systems" role_recipients_rocketchat[domainadmin]="domains" role_recipients_rocketchat[dba]="databases systems" diff --git a/src/health/notifications/slack/README.md b/src/health/notifications/slack/README.md index 35cb75a18..10fc707c9 100644 --- a/src/health/notifications/slack/README.md +++ b/src/health/notifications/slack/README.md @@ -38,8 +38,8 @@ Send notifications to a Slack workspace using Netdata's Agent alert notification The configuration file name for this integration is `health_alarm_notify.conf`. -You can edit the configuration file using the `edit-config` script from the -Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). +You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script from the +Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata diff --git a/src/health/notifications/smstools3/README.md b/src/health/notifications/smstools3/README.md index dafc0b7f4..ee8eb6c8d 100644 --- a/src/health/notifications/smstools3/README.md +++ b/src/health/notifications/smstools3/README.md @@ -42,8 +42,8 @@ The SMS Server Tools 3 is a SMS Gateway software which can send and receive shor The configuration file name for this integration is `health_alarm_notify.conf`. -You can edit the configuration file using the `edit-config` script from the -Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). +You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script from the +Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata @@ -74,7 +74,7 @@ sendsms="/usr/bin/sendsms" All roles will default to this variable if left unconfigured. You can then have different phone numbers per role, by editing `DEFAULT_RECIPIENT_SMS` with the phone number you want, in the following entries at the bottom of the same file: -```conf +```text role_recipients_sms[sysadmin]="PHONE1" role_recipients_sms[domainadmin]="PHONE2" role_recipients_sms[dba]="PHONE3" diff --git a/src/health/notifications/smstools3/metadata.yaml b/src/health/notifications/smstools3/metadata.yaml index 3a29183a5..e23e41c41 100644 --- a/src/health/notifications/smstools3/metadata.yaml +++ b/src/health/notifications/smstools3/metadata.yaml @@ -57,7 +57,7 @@ All roles will default to this variable if left unconfigured. You can then have different phone numbers per role, by editing `DEFAULT_RECIPIENT_SMS` with the phone number you want, in the following entries at the bottom of the same file: - ```conf + ```text role_recipients_sms[sysadmin]="PHONE1" role_recipients_sms[domainadmin]="PHONE2" role_recipients_sms[dba]="PHONE3" diff --git a/src/health/notifications/syslog/README.md b/src/health/notifications/syslog/README.md index 72534b1c8..0428533f5 100644 --- a/src/health/notifications/syslog/README.md +++ b/src/health/notifications/syslog/README.md @@ -37,8 +37,8 @@ Send notifications to Syslog using Netdata's Agent alert notification feature, w The configuration file name for this integration is `health_alarm_notify.conf`. -You can edit the configuration file using the `edit-config` script from the -Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). +You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script from the +Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata @@ -78,7 +78,7 @@ All roles will default to this variable if left unconfigured. You can then have different recipients per role, by editing DEFAULT_RECIPIENT_SYSLOG with the recipient you want, in the following entries at the bottom of the same file: -```conf +```text role_recipients_syslog[sysadmin]="daemon.notice@loghost1:514/netdata" role_recipients_syslog[domainadmin]="daemon.notice@loghost2:514/netdata" role_recipients_syslog[dba]="daemon.notice@loghost3:514/netdata" diff --git a/src/health/notifications/syslog/metadata.yaml b/src/health/notifications/syslog/metadata.yaml index c5f241e76..2793b3ae2 100644 --- a/src/health/notifications/syslog/metadata.yaml +++ b/src/health/notifications/syslog/metadata.yaml @@ -59,7 +59,7 @@ detailed_description: | You can then have different recipients per role, by editing DEFAULT_RECIPIENT_SYSLOG with the recipient you want, in the following entries at the bottom of the same file: - ```conf + ```text role_recipients_syslog[sysadmin]="daemon.notice@loghost1:514/netdata" role_recipients_syslog[domainadmin]="daemon.notice@loghost2:514/netdata" role_recipients_syslog[dba]="daemon.notice@loghost3:514/netdata" diff --git a/src/health/notifications/telegram/README.md b/src/health/notifications/telegram/README.md index 90cca4214..f44cfcb9f 100644 --- a/src/health/notifications/telegram/README.md +++ b/src/health/notifications/telegram/README.md @@ -38,8 +38,8 @@ Send notifications to Telegram using Netdata's Agent alert notification feature, The configuration file name for this integration is `health_alarm_notify.conf`. -You can edit the configuration file using the `edit-config` script from the -Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). +You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script from the +Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata @@ -63,7 +63,7 @@ All roles will default to this variable if left unconfigured. The `DEFAULT_RECIPIENT_CUSTOM` can be edited in the following entries at the bottom of the same file: -```conf +```text role_recipients_telegram[sysadmin]="-49999333324" role_recipients_telegram[domainadmin]="-49999333389" role_recipients_telegram[dba]="-10099992222" diff --git a/src/health/notifications/telegram/metadata.yaml b/src/health/notifications/telegram/metadata.yaml index daa45da72..7fd2f05b5 100644 --- a/src/health/notifications/telegram/metadata.yaml +++ b/src/health/notifications/telegram/metadata.yaml @@ -47,7 +47,7 @@ The `DEFAULT_RECIPIENT_CUSTOM` can be edited in the following entries at the bottom of the same file: - ```conf + ```text role_recipients_telegram[sysadmin]="-49999333324" role_recipients_telegram[domainadmin]="-49999333389" role_recipients_telegram[dba]="-10099992222" diff --git a/src/health/notifications/twilio/README.md b/src/health/notifications/twilio/README.md index cd9b17e7f..18b9ffa2b 100644 --- a/src/health/notifications/twilio/README.md +++ b/src/health/notifications/twilio/README.md @@ -37,8 +37,8 @@ Send notifications to Twilio using Netdata's Agent alert notification feature, w The configuration file name for this integration is `health_alarm_notify.conf`. -You can edit the configuration file using the `edit-config` script from the -Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). +You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script from the +Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory). ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata @@ -62,7 +62,7 @@ The following options can be defined for this notification You can then have different recipients per role, by editing DEFAULT_RECIPIENT_TWILIO with the recipient's number you want, in the following entries at the bottom of the same file: -```conf +```text role_recipients_twilio[sysadmin]="+15555555555" role_recipients_twilio[domainadmin]="+15555555556" role_recipients_twilio[dba]="+15555555557" diff --git a/src/health/notifications/twilio/metadata.yaml b/src/health/notifications/twilio/metadata.yaml index 35fc3f042..594936a1d 100644 --- a/src/health/notifications/twilio/metadata.yaml +++ b/src/health/notifications/twilio/metadata.yaml @@ -52,7 +52,7 @@ detailed_description: | You can then have different recipients per role, by editing DEFAULT_RECIPIENT_TWILIO with the recipient's number you want, in the following entries at the bottom of the same file: - ```conf + ```text role_recipients_twilio[sysadmin]="+15555555555" role_recipients_twilio[domainadmin]="+15555555556" role_recipients_twilio[dba]="+15555555557" diff --git a/src/health/notifications/web/README.md b/src/health/notifications/web/README.md index d7115be3d..baa0bfaaa 100644 --- a/src/health/notifications/web/README.md +++ b/src/health/notifications/web/README.md @@ -1,13 +1,3 @@ -<!-- -title: "Browser pop up agent alert notifications" -sidebar_label: "Browser pop ups" -custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/health/notifications/web/README.md" -learn_status: "Published" -learn_topic_type: "Tasks" -learn_rel_path: "Integrations/Notify/Agent alert notifications" -learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" ---> - # Browser pop up agent alert notifications The Netdata dashboard shows HTML notifications, when it is open. |