Sample Cloud Notifications metadata for Discord (#15597)
* Added a sample metadata.yaml for Alerta * Fixing training spaces bringing yamlint errors * Sample Cloud Notification matadata for Discord * Add yamllint line-length check disable * Update metadata.yaml
Satyadeep Ashwathnarayana committed
Jul 28, 2023 at 13:55 UTC
78cb40c5d594cc8efbeba05c0ce4965cf11c3ff1
2 files changed
+77
-1
health/notifications/alerta/metadata.yaml
+1
-1
@@ -53,7 +53,7 @@
53
- name: 'DEFAULT_RECIPIENT_ALERTA'
54
default_value: ''
55
description: |
56
- Set `DEFAULT_RECIPIENT_ALERTA`` to the default recipient environment you want the alert notifications to be sent to.
56
+ Set `DEFAULT_RECIPIENT_ALERTA` to the default recipient environment you want the alert notifications to be sent to.
57
All roles will default to this variable if left unconfigured.
58
required: true
59
- name: 'DEFAULT_RECIPIENT_CUSTOM'
integrations/cloud-notifications/metadata.yaml
new
+76
@@ -0,0 +1,76 @@
1
+# yamllint disable rule:line-length
2
+---
3
+- id: 'notify-discord'
4
+ meta:
5
+ name: 'Discord'
6
+ link: 'https://discord.com/'
7
+ categories:
8
+ - notify.cloud
9
+ icon_filename: 'discord.png'
10
+ keywords:
11
+ - discord
12
+ - community
13
+ overview:
14
+ notification_description: "From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on Discord."
15
+ notification_limitations: ''
16
+ setup:
17
+ prerequisites:
18
+ list:
19
+ - title: 'Netdata Access'
20
+ description: |
21
+ - A Netdata Cloud account
22
+ - Access to the Netdata Space as an administrator
23
+ - title: 'Discord Server Configuration'
24
+ description: |
25
+ You need to have a Discord server able to receive [webhook integrations](https://support.discord.com/hc/en-us/articles/228383668).
26
+ Steps to configure your Discord server to receive notifications from Netdata:
27
+
28
+ 1. Go to `Server Settings` --> `Integrations`
29
+ 2. **Create Webhook** or **View Webhooks** if you already have some defined
30
+ 3. Specify the **Name** and **Channel** on your new webhook
31
+ 4. Use Webhook URL to add your notification configuration on Netdata UI
32
+
33
+ - title: ''
34
+ description: |
35
+
36
+ ## Configuration Steps
37
+
38
+ 1. Click on the **Space settings** cog (located above your profile icon)
39
+ 2. Click on the **Notification** tab
40
+ 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
41
+ 4. On the **Discord** card click on **+ Add**
42
+ 5. A modal will be presented to you to enter the required details to enable the configuration:
43
+ * **Notification settings** are Netdata specific settings
44
+ - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
45
+ - Rooms - by specifying a list of Rooms you are select to which nodes or areas of your infrastructure you want to be notified using this configuration
46
+ - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
47
+ * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Discord:
48
+ - Define the type channel you want to send notifications to: **Text channel** or **Forum channel**
49
+ - Webhook URL - URL provided on Discord for the channel you want to receive your notifications.
50
+ - Thread name - if the Discord channel is a **Forum channel** you will need to provide the thread name as well
51
+
52
+
53
+ configuration:
54
+ file:
55
+ name: ''
56
+ description: ''
57
+ options:
58
+ description: ''
59
+ folding:
60
+ title: ''
61
+ enabled: true
62
+ list:
63
+ - name: ''
64
+ default_value: ''
65
+ description: ''
66
+ required: false
67
+ examples:
68
+ folding:
69
+ enabled: true
70
+ title: ''
71
+ list:
72
+ - name: ''
73
+ folding:
74
+ enabled: false
75
+ description: ''
76
+ config: ''