diff options
author | Satyadeep Ashwathnarayana <96257330+sashwathn@users.noreply.github.com> | 2023-07-28 13:55:03 +0530 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-07-28 13:55:03 +0530 |
commit | 78cb40c5d594cc8efbeba05c0ce4965cf11c3ff1 (patch) | |
tree | 33286004a40759c1d2bb5432c2ffc69970971f1c /integrations | |
parent | 79c9af877df9bba2b4d8c8e18fce7ec1df3256d8 (diff) |
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
Diffstat (limited to 'integrations')
-rw-r--r-- | integrations/cloud-notifications/metadata.yaml | 76 |
1 files changed, 76 insertions, 0 deletions
diff --git a/integrations/cloud-notifications/metadata.yaml b/integrations/cloud-notifications/metadata.yaml new file mode 100644 index 0000000000..12dbc53d83 --- /dev/null +++ b/integrations/cloud-notifications/metadata.yaml @@ -0,0 +1,76 @@ +# yamllint disable rule:line-length +--- +- id: 'notify-discord' + meta: + name: 'Discord' + link: 'https://discord.com/' + categories: + - notify.cloud + icon_filename: 'discord.png' + keywords: + - discord + - community + overview: + notification_description: "From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on Discord." + notification_limitations: '' + setup: + prerequisites: + list: + - title: 'Netdata Access' + description: | + - A Netdata Cloud account + - Access to the Netdata Space as an administrator + - title: 'Discord Server Configuration' + description: | + You need to have a Discord server able to receive [webhook integrations](https://support.discord.com/hc/en-us/articles/228383668). + Steps to configure your Discord server to receive notifications from Netdata: + + 1. Go to `Server Settings` --> `Integrations` + 2. **Create Webhook** or **View Webhooks** if you already have some defined + 3. Specify the **Name** and **Channel** on your new webhook + 4. Use Webhook URL to add your notification configuration on Netdata UI + + - title: '' + description: | + + ## Configuration Steps + + 1. Click on the **Space settings** cog (located above your profile icon) + 2. Click on the **Notification** tab + 3. Click on the **+ Add configuration** button (near the top-right corner of your screen) + 4. On the **Discord** card click on **+ Add** + 5. A modal will be presented to you to enter the required details to enable the configuration: + * **Notification settings** are Netdata specific settings + - Configuration name - you can optionally provide a name for your configuration you can easily refer to it + - 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 + - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only + * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Discord: + - Define the type channel you want to send notifications to: **Text channel** or **Forum channel** + - Webhook URL - URL provided on Discord for the channel you want to receive your notifications. + - Thread name - if the Discord channel is a **Forum channel** you will need to provide the thread name as well + + + configuration: + file: + name: '' + description: '' + options: + description: '' + folding: + title: '' + enabled: true + list: + - name: '' + default_value: '' + description: '' + required: false + examples: + folding: + enabled: true + title: '' + list: + - name: '' + folding: + enabled: false + description: '' + config: '' |