From b5f8ee61a7f7e9bd291dd26b0585d03eb686c941 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 5 May 2024 13:19:16 +0200 Subject: Adding upstream version 1.46.3. Signed-off-by: Daniel Baumann --- health/notifications/discord/Makefile.inc | 12 --- health/notifications/discord/README.md | 117 ----------------------------- health/notifications/discord/metadata.yaml | 76 ------------------- 3 files changed, 205 deletions(-) delete mode 100644 health/notifications/discord/Makefile.inc delete mode 100644 health/notifications/discord/README.md delete mode 100644 health/notifications/discord/metadata.yaml (limited to 'health/notifications/discord') diff --git a/health/notifications/discord/Makefile.inc b/health/notifications/discord/Makefile.inc deleted file mode 100644 index 78de7231b..000000000 --- a/health/notifications/discord/Makefile.inc +++ /dev/null @@ -1,12 +0,0 @@ -# SPDX-License-Identifier: GPL-3.0-or-later - -# THIS IS NOT A COMPLETE Makefile -# IT IS INCLUDED BY ITS PARENT'S Makefile.am -# IT IS REQUIRED TO REFERENCE ALL FILES RELATIVE TO THE PARENT - -# install these files -dist_noinst_DATA += \ - discord/README.md \ - discord/Makefile.inc \ - $(NULL) - diff --git a/health/notifications/discord/README.md b/health/notifications/discord/README.md deleted file mode 100644 index 8b473a7e8..000000000 --- a/health/notifications/discord/README.md +++ /dev/null @@ -1,117 +0,0 @@ - - -# Discord - - - - - -Send notifications to Discord using Netdata's Agent alert notification feature, which supports dozens of endpoints, user roles, and more. - - - - - -## Setup - -### Prerequisites - -#### - -- 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). -- One or more Discord channels to post the messages to -- 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` script from the -Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.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 - -
Config Options - -| Name | Description | Default | Required | -|:----|:-----------|:-------|:--------:| -| SEND_DISCORD | Set `SEND_DISCORD` to YES | YES | yes | -| DISCORD_WEBHOOK_URL | set `DISCORD_WEBHOOK_URL` to your webhook URL. | | yes | -| DEFAULT_RECIPIENT_DISCORD | Set `DEFAULT_RECIPIENT_DISCORD` to the channel you want the alert notifications to be sent to. You can define multiple channels like this: `alerts` `systems`. | | yes | - -##### DEFAULT_RECIPIENT_DISCORD - -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 -role_recipients_discord[sysadmin]="systems" -role_recipients_discord[domainadmin]="domains" -role_recipients_discord[dba]="databases systems" -role_recipients_discord[webmaster]="marketing development" -role_recipients_discord[proxyadmin]="proxy-admin" -role_recipients_discord[sitemgr]="sites" -``` - -The values you provide should already exist as Discord channels in your server. - - -
- -#### Examples - -##### Basic Configuration - - - -```yaml -#------------------------------------------------------------------------------ -# discord (discordapp.com) global notification options - -SEND_DISCORD="YES" -DISCORD_WEBHOOK_URL="https://discord.com/api/webhooks/XXXXXXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" -DEFAULT_RECIPIENT_DISCORD="alerts" - -``` - - -## 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/health/notifications/discord/metadata.yaml b/health/notifications/discord/metadata.yaml deleted file mode 100644 index a46a8ec98..000000000 --- a/health/notifications/discord/metadata.yaml +++ /dev/null @@ -1,76 +0,0 @@ -# yamllint disable rule:line-length ---- -- id: 'notify-discord' - meta: - name: 'Discord' - link: 'https://discord.com/' - categories: - - notify.agent - icon_filename: 'discord.png' - keywords: - - Discord - overview: - notification_description: | - Send notifications to Discord using Netdata's Agent alert notification feature, which supports dozens of endpoints, user roles, and more. - notification_limitations: '' - setup: - prerequisites: - list: - - title: '' - description: | - - 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). - - One or more Discord channels to post the messages to - - 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_DISCORD' - default_value: 'YES' - description: "Set `SEND_DISCORD` to YES" - required: true - - name: 'DISCORD_WEBHOOK_URL' - default_value: '' - description: "set `DISCORD_WEBHOOK_URL` to your webhook URL." - required: true - - name: 'DEFAULT_RECIPIENT_DISCORD' - default_value: '' - description: "Set `DEFAULT_RECIPIENT_DISCORD` to the channel you want the alert notifications to be sent to. You can define multiple channels like this: `alerts` `systems`. " - required: true - 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 - role_recipients_discord[sysadmin]="systems" - role_recipients_discord[domainadmin]="domains" - role_recipients_discord[dba]="databases systems" - role_recipients_discord[webmaster]="marketing development" - role_recipients_discord[proxyadmin]="proxy-admin" - role_recipients_discord[sitemgr]="sites" - ``` - - The values you provide should already exist as Discord channels in your server. - examples: - folding: - enabled: true - title: '' - list: - - name: 'Basic Configuration' - folding: - enabled: false - description: '' - config: | - #------------------------------------------------------------------------------ - # discord (discordapp.com) global notification options - - SEND_DISCORD="YES" - DISCORD_WEBHOOK_URL="https://discord.com/api/webhooks/XXXXXXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - DEFAULT_RECIPIENT_DISCORD="alerts" - troubleshooting: - problems: - list: [] -- cgit v1.2.3