Fix issues with Cloud Notification Integrations metadata (#18745)
Fotis Voutsas committed
Oct 10, 2024 at 16:02 UTC
e8c5c3d9d3d8a99121814b3319e9ff01c1fc4f4e
15 files changed
+885
-956
integrations/cloud-notifications/integrations/amazon_sns.md
+19
-23
@@ -13,7 +13,7 @@ endmeta-->
13
<img src="https://netdata.cloud/img/awssns.png" width="150"/>
14
15
16
-From the Cloud interface, you can manage your space's notification settings and from these you can add a specific configuration to get notifications delivered on AWS SNS.
16
+From the Netdata Cloud UI, you can configure notification delivery to AWS SNS.
17
18
19
<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
@@ -22,36 +22,32 @@ From the Cloud interface, you can manage your space's notification settings and
22
23
### Prerequisites
24
25
-To add AWS SNS notification you need:
26
-
25
- A Netdata Cloud account
26
- Access to the space as an **Admin**
27
- The Space needs to be on a paid plan
30
-- Have an AWS account with AWS SNS access, for more details check [how to configure this on AWS SNS](#settings-on-aws-sns)
28
+- An AWS account with AWS SNS access
29
32
-### Steps
30
+### AWS SNS Configuration
31
34
-1. Click on the **Space settings** cog (located above your profile icon)
35
-2. Click on the **Notification** tab
36
-3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
37
-4. On the **AwsSns** card click on **+ Add**
38
-5. A modal will be presented to you to enter the required details to enable the configuration:
39
- * **Notification settings** are Netdata specific settings
40
- - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
41
- - 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
42
- - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
43
- * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For AWS SNS:
44
- - Topic ARN - topic provided on AWS SNS (with region) for where to publish your notifications. For more details check [how to configure this on AWS SNS](#settings-on-aws-sns)
45
-
46
-### Settings on AWS SNS
47
-
48
-To enable the webhook integration on AWS SNS you need:
32
1. [Setting up access for Amazon SNS](https://docs.aws.amazon.com/sns/latest/dg/sns-setting-up.html)
33
2. Create a topic
34
- On AWS SNS management console click on **Create topic**
52
- - On the **Details** section, the standard type and provide the topic name
35
+ - On the **Details** section, select the standard type and provide the topic name
36
- On the **Access policy** section, change the **Publishers** option to **Only the specified AWS accounts** and provide the Netdata AWS account **(123269920060)** that will be used to publish notifications to the topic being created
54
- - Finally, click on **Create topic** on the bottom of the page
55
-3. Now, use the new **Topic ARN** while adding AWS SNS integration on your space.
37
+3. Copy the **Topic ARN** in order to add it to your integration configuration in the Netdata Cloud UI
38
+
39
+### Netdata Configuration
40
+
41
+1. Click on the **Space settings** cog (located above your profile icon)
42
+2. Click on the **Alerts & Notifications** tab
43
+3. Click on the **+ Add configuration** button
44
+4. Add the AWS SNS Integration
45
+5. A modal will be presented to you to enter the required details to enable the integration:
46
+ - **Notification settings**
47
+ - Configuration name (optional): A name for your configuration in order to easily refer to it
48
+ - Rooms: A list of Rooms for which you want to be notified
49
+ - Notifications: The notifications which you want to be notified
50
+ - **Integration configuration**
51
+ - Topic ARN: The topic provided on AWS SNS (with region) for where to publish your notifications.
52
53
integrations/cloud-notifications/integrations/discord.md
+19
-19
@@ -13,7 +13,7 @@ endmeta-->
13
<img src="https://netdata.cloud/img/discord.png" width="150"/>
14
15
16
-From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on Discord.
16
+From the Netdata Cloud UI, you can configure notification delivery to your Discord server.
17
18
19
<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
@@ -21,30 +21,30 @@ From the Netdata Cloud UI, you can manage your space's notification settings and
21
## Setup
22
23
### Prerequisites
24
+
25
- A Netdata Cloud account
25
-- Access to the Netdata Space as an **Admin**
26
-- You need to have a Discord server able to receive webhooks integrations.
26
+- Access to the Space as an **Admin**
27
28
### Discord Server Configuration
29
-Steps to configure your Discord server to receive [webhook notifications](https://support.discord.com/hc/en-us/articles/228383668) from Netdata:
30
-1. Go to `Server Settings` --> `Integrations`
29
+
30
+1. Go to **Server Settings** --> **Integrations**
31
2. **Create Webhook** or **View Webhooks** if you already have some defined
32
3. Specify the **Name** and **Channel** on your new webhook
33
-4. Use Webhook URL to add your notification configuration on Netdata UI
33
+4. Keep note of the **Webhook URL** as you will need it for the configuration of the integration on the Netdata Cloud UI
34
+
35
+### Netdata Configuration
36
35
-### Netdata Configuration Steps
37
1. Click on the **Space settings** cog (located above your profile icon)
37
-2. Click on the **Notification** tab
38
-3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
39
-4. On the **Discord** card click on **+ Add**
40
-5. A modal will be presented to you to enter the required details to enable the configuration:
41
- * **Notification settings** are Netdata specific settings
42
- - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
43
- - 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
44
- - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
45
- * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Discord:
46
- - Define the type channel you want to send notifications to: **Text channel** or **Forum channel**
47
- - Webhook URL - URL provided on Discord for the channel you want to receive your notifications.
48
- - Thread name - if the Discord channel is a **Forum channel** you will need to provide the thread name as well
38
+2. Click on the **Alerts & Notifications** tab
39
+3. Click on the **+ Add configuration** button
40
+4. Add the Discord Integration
41
+5. A modal will be presented to you to enter the required details to enable the integration:
42
+ - **Notification settings**
43
+ - Configuration name (optional): A name for your configuration in order to easily refer to it
44
+ - Rooms: A list of Rooms for which you want to be notified
45
+ - Notifications: The notifications which you want to be notified
46
+ - **Integration configuration**
47
+ - Webhook URL: The URL you copied from the previous section
48
+ - Channel Parameters: Select the channel type which the notifications will be sent to, if it is a Forum channel, you need to specify a thread name
49
50
integrations/cloud-notifications/integrations/ilert.md
+21
-26
@@ -13,7 +13,7 @@ endmeta-->
13
<img src="https://netdata.cloud/img/ilert.svg" width="150"/>
14
15
16
-From the Cloud interface, you can manage your space's notification settings and from there you can add a specific configuration to get notifications delivered on ilert.
16
+From the Netdata Cloud UI, you can configure notification delivery to ilert.
17
18
19
<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
@@ -22,40 +22,35 @@ From the Cloud interface, you can manage your space's notification settings and
22
23
### Prerequisites
24
25
-To add ilert notification you need:
26
-
25
- A Netdata Cloud account
28
-- Access to the space as an **Admin**
26
+- Access to the Space as an **Admin**
27
- The Space needs to be on a paid plan
28
- You need to have permissions on ilert to add new Alert sources.
29
32
-### Settings on ilert
30
+### ilert Configuration
31
34
-1. **Access the Alert sources Settings**: From the navigation bar, open the Alert sources drop down and click "Alert sources".
35
-2. **Create a New Alert source**: Click on the "+ Create a new alert source" button.
36
-3. **Configure an Alert source**:
37
- - select "API integration" and click Next
38
- - provide a name that suits the source's purpose, for example Netdata
39
- - select Escalation policy
40
- - select Alert grouping (optional)
41
- - review all configurations and click "Finish setup"
42
-4. **Obtain the API Key**:
43
- - Once the Alert source is created, you will be provided with an API key.
44
- - Copy this API Key, as it will be required to configure the integration on Netdata Cloud.
32
+1. From the navigation bar, open the Alert sources drop down and click "Alert sources"
33
+2. Click on the "+ Create a new alert source" button
34
+3. Configure an Alert source:
35
+ - Select "API integration" and click Next
36
+ - Provide a name that suits the source's purpose, for example "Netdata"
37
+ - Select Escalation policy
38
+ - Select Alert grouping (optional)
39
+4. Obtain the API Key:
40
+ - Once the Alert source is created, you will be provided with an API key. Copy it in order to add it to your integration configuration in the Netdata Cloud UI
41
46
-### Settings on Netdata Cloud
42
+### Netdata Configuration
43
44
1. Click on the **Space settings** cog (located above your profile icon)
45
2. Click on the **Alerts & Notifications** tab
46
3. Click on the **+ Add configuration** button
51
-4. Click on **+ Add** on the **ilert** card
52
-5. A modal will be presented in order to enter the required details to enable the configuration:
53
-
54
-- **Notification settings** are Netdata specific settings
55
- - Configuration name: provide a descriptive name for your configuration to easily identify it.
56
- - Rooms: select the nodes or areas of your infrastructure you want to receive notifications about.
57
- - Notification: choose the type of notifications you want to receive.
58
- - **Integration configuration** are the required integration settings, which vary by notification method. For ilert:
59
- - Alert Source API key.
47
+4. Add the ilert Integration
48
+5. A modal will be presented to you to enter the required details to enable the integration:
49
+ - **Notification settings**
50
+ - Configuration name (optional): A name for your configuration in order to easily refer to it
51
+ - Rooms: A list of Rooms for which you want to be notified
52
+ - Notifications: The notifications which you want to be notified
53
+ - **Integration configuration**
54
+ - Alert Source API key: The key you copied in the ilert configuration step.
55
56
integrations/cloud-notifications/integrations/mattermost.md
+18
-24
@@ -13,7 +13,7 @@ endmeta-->
13
<img src="https://netdata.cloud/img/mattermost.png" width="150"/>
14
15
16
-From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on Mattermost.
16
+From the Netdata Cloud UI, you can configure notification delivery to Mattermost.
17
18
19
<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
@@ -23,38 +23,32 @@ From the Netdata Cloud UI, you can manage your space's notification settings and
23
### Prerequisites
24
25
- A Netdata Cloud account
26
-- Access to the Netdata Space as an **Admin**
27
-- The Netdata Space needs to be on a paid plan
26
+- Access to the Space as an **Admin**
27
+- The Space needs to be on a paid plan
28
- You need to have permissions on Mattermost to add new integrations.
29
-- You need to have a Mattermost app on your workspace to receive the webhooks.
29
30
### Mattermost Server Configuration
31
33
-Steps to configure your Mattermost to receive notifications from Netdata:
34
-
32
1. In Mattermost, go to Product menu > Integrations > Incoming Webhook
36
- - If you don’t have the Integrations option, incoming webhooks may not be enabled on your Mattermost server or may be disabled for non-admins. They can be enabled by a System Admin from System Console > Integrations > Integration Management. Once incoming webhooks are enabled, continue with the steps below.
37
-2. Select Add Incoming Webhook and add a name and description for the webhook. The description can be up to 500 characters
33
+ - If you don't have the Integrations option, incoming webhooks may not be enabled on your Mattermost server or may be disabled for non-admins. They can be enabled by a System Admin from System Console > Integrations > Integration Management. Once incoming webhooks are enabled, continue with the steps below.
34
+2. Select Add Incoming Webhook and add a name and description for the webhook.
35
3. Select the channel to receive webhook payloads, then select Add to create the webhook
39
-4. You will end up with a webhook endpoint that looks like below:
40
- `https://your-mattermost-server.com/hooks/xxx-generatedkey-xxx`
41
-
42
- - Treat this endpoint as a secret. Anyone who has it will be able to post messages to your Mattermost instance.
36
+4. You will end up with a webhook URL that looks like `https://your-mattermost-server.com/hooks/xxx-generatedkey-xxx`, copy it in order to add it to your integration configuration in the Netdata Cloud UI
37
44
-For more details please check Mattermost's article [Incoming webhooks for Mattermost](https://developers.mattermost.com/integrate/webhooks/incoming/).
38
+For more details please check [Incoming webhooks for Mattermost](https://developers.mattermost.com/integrate/webhooks/incoming/).
39
46
-### Netdata Configuration Steps
40
+### Netdata Configuration
41
42
1. Click on the **Space settings** cog (located above your profile icon)
49
-2. Click on the **Notification** tab
50
-3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
51
-4. On the **Mattermost** card click on **+ Add**
52
-5. A modal will be presented to you to enter the required details to enable the configuration:
53
- * **Notification settings** are Netdata specific settings
54
- - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
55
- - 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
56
- - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
57
- * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Mattermost:
58
- - Webhook URL - URL provided on Mattermost for the channel you want to receive your notifications
43
+2. Click on the **Alerts & Notifications** tab
44
+3. Click on the **+ Add configuration** button
45
+4. Add the Mattermost Integration
46
+5. A modal will be presented to you to enter the required details to enable the integration:
47
+ - **Notification settings**
48
+ - Configuration name (optional): A name for your configuration in order to easily refer to it
49
+ - Rooms: A list of Rooms for which you want to be notified
50
+ - Notifications: The notifications which you want to be notified
51
+ - **Integration configuration**
52
+ - Webhook URL: URL provided on Mattermost for the channel you want to receive your notifications
53
54
integrations/cloud-notifications/integrations/microsoft_teams.md
+29
-33
@@ -13,7 +13,7 @@ endmeta-->
13
<img src="https://netdata.cloud/img/teams.svg" width="150"/>
14
15
16
-From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications to a Microsoft Teams channel.
16
+From the Netdata Cloud UI, you can configure notification delivery to a Microsoft Teams channel.
17
18
19
<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
@@ -22,37 +22,33 @@ From the Netdata Cloud UI, you can manage your space's notification settings and
22
23
### Prerequisites
24
25
-To add Microsoft Teams notifications integration to your Netdata Cloud space you will need the following:
26
-
27
-- A Netdata Cloud account.
28
-- Access to the Netdata Cloud space as an **Admin**.
29
-- The Space to be on a paid plan.
30
-- A [Microsoft Teams Essentials subscription](https://www.microsoft.com/en-sg/microsoft-teams/essentials) or higher. Note that this is a **paid** feature.
31
-
32
-### Settings on Microsoft Teams
33
-
34
-1. **Access the Channel Settings**: Navigate to the desired Microsoft Teams channel and hover over the channel name. Click the three dots (ellipsis) icon that appears.
35
-2. **Create a New Workflow**: Select "Workflows" from the options, then choose "Post to a channel when a webhook request is received."
36
-3. **Configure Workflow Details**:
37
- - Give your workflow a descriptive name, such as "Netdata Alerts."
38
- - Select the target team and channel to receive notifications.
39
- - Click "Add workflow."
40
-4. **Obtain the Webhook URL**:
41
- - Once the workflow is created, you will receive a unique Workflow Webhook URL.
42
- - Copy this URL, as it will be required to configure Netdata Cloud.
43
-
44
-### Settings on Netdata Cloud
45
-
46
-1. Click on the **Space settings** cog (located above your profile icon).
47
-2. Click on the **Notification** tab.
48
-3. Click on the **+ Add configuration** button (near the top-right corner of your screen).
49
-4. On the **Microsoft Teams** card click on **+ Add**.
50
-5. A modal will be presented to you to enter the required details to enable the configuration:
51
- * **Notification settings** are Netdata specific settings:
52
- - Configuration name - you can optionally provide a name for your configuration you can easily refer to it.
53
- - 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.
54
- - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only.
55
- * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Microsoft Teams:
56
- - Microsoft Teams Incoming Webhook URL - the _Incoming Webhook URL_ that was generated earlier.
25
+- A Netdata Cloud account
26
+- Access to the Space as an **Admin**
27
+- The Space needs to be on a paid plan
28
+- A [Microsoft Teams Essentials subscription](https://www.microsoft.com/en-sg/microsoft-teams/essentials) or higher. Note that this is a **paid** feature
29
+
30
+### Microsoft Teams Configuration
31
+
32
+1. Navigate to the desired Microsoft Teams channel and hover over the channel name. Click the three dots icon that appears
33
+2. Select "Workflows" from the options, then choose "Post to a channel when a webhook request is received"
34
+3. **Configure Workflow Details**
35
+ - Give your workflow a name, such as "Netdata Alerts"
36
+ - Select the target team and channel where you will receive notifications
37
+ - Click "Add workflow"
38
+4. Once the workflow is created, you will receive a unique Workflow Webhook URL, copy it, in order to add it to your integration configuration in the Netdata Cloud UI
39
+
40
+### Netdata Configuration
41
+
42
+1. Click on the **Space settings** cog (located above your profile icon)
43
+2. Click on the **Alerts & Notifications** tab
44
+3. Click on the **+ Add configuration** button
45
+4. Add the Microsoft Teams Integration
46
+5. A modal will be presented to you to enter the required details to enable the integration:
47
+ - **Notification settings**
48
+ - Configuration name (optional): A name for your configuration in order to easily refer to it
49
+ - Rooms: A list of Rooms for which you want to be notified
50
+ - Notifications: The notifications which you want to be notified
51
+ - **Integration configuration**
52
+ - Microsoft Teams Incoming Webhook URL: The Incoming Webhook URL that you copied earlier.
53
54
integrations/cloud-notifications/integrations/netdata_mobile_app.md
+16
-16
@@ -13,7 +13,7 @@ endmeta-->
13
<img src="https://netdata.cloud/img/netdata.png" width="150"/>
14
15
16
-From the Netdata Cloud UI, you can manage your user notification settings and enable the configuration to deliver notifications on the Netdata Mobile Application.
16
+From the Netdata Cloud UI, you can configure notification delivery to the Netdata Mobile Application.
17
18
19
<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
@@ -21,21 +21,21 @@ From the Netdata Cloud UI, you can manage your user notification settings and en
21
## Setup
22
23
### Prerequisites
24
+
25
- A Netdata Cloud account
25
-- You need to have the Netdata Mobile Application installed on your [Android](https://play.google.com/store/apps/details?id=cloud.netdata.android&pli=1) or [iOS](https://apps.apple.com/in/app/netdata-mobile/id6474659622) phone.
26
-
27
-### Netdata Mobile App Configuration
28
-Steps to login to the Netdata Mobile Application to receive alert and reachability and alert notifications:
29
-1. Download the Netdata Mobile Application from [Google Play Store](https://play.google.com/store/apps/details?id=cloud.netdata.android&pli=1) or the [iOS App Store](https://apps.apple.com/in/app/netdata-mobile/id6474659622)
30
-2. Open the App and Choose the Sign In Option
31
- - Sign In with Email Address: Enter the Email Address of your registered Netdata Cloud Account and Click on the Verification link received by Email on your mobile device.
32
- - Sign In with QR Code: Scan the QR Code from your `Netdata Cloud` UI under **User Settings** --> **Notifications** --> **Mobile App Notifications** --> **Show QR Code**
33
-3. Start receiving alert and reachability notifications for your **Space(s)** on a **Paid Subscription plan**
34
-
35
-### Netdata Configuration Steps
36
-1. Click on the **User settings** on the bottom left of your screen (your profile icon)
37
-2. Click on the **Notifications** tab
38
-3. Enable **Mobile App Notifications** if disabled (Enabled by default)
39
-4. Use the **Show QR Code** Option to login to your mobile device by scanning the **QR Code**
26
+- You need to have the Netdata Mobile App installed on your [Android](https://play.google.com/store/apps/details?id=cloud.netdata.android&pli=1) or [iOS](https://apps.apple.com/in/app/netdata-mobile/id6474659622) phone.
27
+
28
+### Netdata Mobile App Configuration and device linking
29
+
30
+In order to login to the Netdata Mobile App
31
+
32
+1. Download the Netdata Mobile App from [Google Play Store](https://play.google.com/store/apps/details?id=cloud.netdata.android&pli=1) or the [iOS App Store](https://apps.apple.com/in/app/netdata-mobile/id6474659622)
33
+2. Open the App and Choose your Sign-in option
34
+ - Email Address: Enter the email address of your registered Netdata Cloud account and click on the verification link received by email on your mobile device.
35
+ - Sign-in with QR Code: Scan the QR code from the Netdata Cloud UI under **Profile Picture** --> **Settings** --> **Notifications** --> **Mobile App Notifications** --> **Show QR Code**
36
+
37
+### Netdata Configuration
38
+
39
+After linking your device, enable the toggle for **Mobile App Notifications** under the same settings panel.
40
41
integrations/cloud-notifications/integrations/opsgenie.md
+16
-19
@@ -13,7 +13,7 @@ endmeta-->
13
<img src="https://netdata.cloud/img/opsgenie.png" width="150"/>
14
15
16
-From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on Opsgenie.
16
+From the Netdata Cloud UI, you can configure notification delivery to Opsgenie.
17
18
19
<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
@@ -23,30 +23,27 @@ From the Netdata Cloud UI, you can manage your space's notification settings and
23
### Prerequisites
24
25
- A Netdata Cloud account
26
-- Access to the Netdata Space as an **Admin**
27
-- The Netdata Space needs to be on a paid plan
26
+- Access to the Space as an **Admin**
27
+- The Space needs to be on a paid plan
28
- You need to have permissions on Opsgenie to add new integrations.
29
30
### Opsgenie Server Configuration
31
32
-Steps to configure your Opsgenie to receive notifications from Netdata:
32
+1. Go to the integrations tab of your team, click **Add integration**
33
+2. Pick **API** from the available integrations and copy the API Key in order to add it to your integration configuration in the Netdata Cloud UI
34
34
-1. Go to integrations tab of your team, click **Add integration**
35
-2. Pick **API** from available integrations. Copy your API Key and press **Save Integration**.
36
-3. Paste copied API key into the corresponding field in **Integration configuration** section of Opsgenie modal window in Netdata.
37
-
38
-### Netdata Configuration Steps
35
+### Netdata Configuration
36
37
1. Click on the **Space settings** cog (located above your profile icon)
41
-2. Click on the **Notification** tab
42
-3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
43
-4. On the **Opsgenie** card click on **+ Add**
44
-5. A modal will be presented to you to enter the required details to enable the configuration:
45
- * **Notification settings** are Netdata specific settings
46
- - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
47
- - 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
48
- - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
49
- * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Opsgenie:
50
- - API Key - a key provided on Opsgenie for the channel you want to receive your notifications.
38
+2. Click on the **Alerts & Notifications** tab
39
+3. Click on the **+ Add configuration** button
40
+4. Add the Opsgenie Integration
41
+5. A modal will be presented to you to enter the required details to enable the integration:
42
+ - **Notification settings**
43
+ - Configuration name (optional): A name for your configuration in order to easily refer to it
44
+ - Rooms: A list of Rooms for which you want to be notified
45
+ - Notifications: The notifications which you want to be notified
46
+ - **Integration configuration**
47
+ - API Key: The key provided on Opsgenie for the channel you want to receive your notifications
48
49
integrations/cloud-notifications/integrations/pagerduty.md
+18
-19
@@ -13,7 +13,7 @@ endmeta-->
13
<img src="https://netdata.cloud/img/pagerduty.png" width="150"/>
14
15
16
-From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on PagerDuty.
16
+From the Netdata Cloud UI, you can configure notification delivery to PagerDuty.
17
18
19
<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
@@ -21,32 +21,31 @@ From the Netdata Cloud UI, you can manage your space's notification settings and
21
## Setup
22
23
### Prerequisites
24
+
25
- A Netdata Cloud account
25
-- Access to the Netdata Space as an **Admin**
26
-- The Netdata Space needs to be on a paid plan
26
+- Access to the Space as an **Admin**
27
+- The Space needs to be on a paid plan
28
- You need to have a PagerDuty service to receive events using webhooks.
29
29
-
30
### PagerDuty Server Configuration
31
-Steps to configure your PagerDuty to receive notifications from Netdata:
31
32
1. Create a service to receive events from your services directory page on PagerDuty
34
-2. At step 3, select `Events API V2` Integration or **View Webhooks** if you already have some defined
35
-3. Once the service is created, you will be redirected to its configuration page, where you can copy the **Integration Key** and **Integration URL (Alert Events)** fields to add them to your notification configuration in the Netdata UI.
33
+2. On the third step of the service creation, select `Events API V2` Integration
34
+3. Once the service is created, you will be redirected to its configuration page, where you can copy the **Integration Key** and **Integration URL (Alert Events)** in order to add them to your integration configuration in the Netdata Cloud UI
35
37
-### Netdata Configuration Steps
36
+### Netdata Configuration
37
38
1. Click on the **Space settings** cog (located above your profile icon)
40
-2. Click on the **Notification** tab
41
-3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
42
-4. On the **PagerDuty** card click on **+ Add**
43
-5. A modal will be presented to you to enter the required details to enable the configuration:
44
- * **Notification settings** are Netdata specific settings
45
- - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
46
- - 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
47
- - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
48
- * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For PagerDuty:
49
- - Integration Key - is a 32 character key provided by PagerDuty to receive events on your service.
50
- - Integration URL (Alert Events) - is the URL provided by PagerDuty where we will send notifications.
39
+2. Click on the **Alerts & Notifications** tab
40
+3. Click on the **+ Add configuration** button
41
+4. Add the PagerDuty Integration
42
+5. A modal will be presented to you to enter the required details to enable the integration:
43
+ - **Notification settings**
44
+ - Configuration name (optional): A name for your configuration in order to easily refer to it
45
+ - Rooms: A list of Rooms for which you want to be notified
46
+ - Notifications: The notifications which you want to be notified
47
+ - **Integration configuration**
48
+ - Integration Key: A 32 character key provided by PagerDuty to receive events on your service.
49
+ - Integration URL (Alert Events): The URL provided by PagerDuty where Netdata Cloud will send notifications.
50
51
integrations/cloud-notifications/integrations/rocketchat.md
+22
-27
@@ -13,7 +13,7 @@ endmeta-->
13
<img src="https://netdata.cloud/img/rocketchat.png" width="150"/>
14
15
16
-From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on RocketChat.
16
+From the Netdata Cloud UI, you can configure notification delivery to RocketChat.
17
18
19
<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
@@ -23,38 +23,33 @@ From the Netdata Cloud UI, you can manage your space's notification settings and
23
### Prerequisites
24
25
- A Netdata Cloud account
26
-- Access to the Netdata Space as an **Admin**
27
-- The Netdata Space needs to be on a paid plan
28
-- You need to have permissions on Mattermost to add new integrations.
29
-- You need to have a RocketChat app on your workspace to receive the webhooks.
26
+- Access to the Space as an **Admin**
27
+- The Space needs to be on a paid plan
28
+- You need to have permissions on RocketChat to add new integrations.
29
31
-### Mattermost Server Configuration
30
+### RocketChat Server Configuration
31
33
-Steps to configure your RocketChat to receive notifications from Netdata:
32
+Steps to configure your RocketChat server to receive notifications from Netdata Cloud:
33
35
-1. In RocketChat, Navigate to Administration > Workspace > Integrations.
36
-2. Click **+New** at the top right corner.
37
-3. For more details about each parameter, check [create-a-new-incoming-webhook](https://docs.rocket.chat/use-rocket.chat/workspace-administration/integrations#create-a-new-incoming-webhook).
38
-4. After configuring integration, click Save.
39
-5. You will end up with a webhook endpoint that looks like below:
40
- `https://your-server.rocket.chat/hooks/YYYYYYYYYYYYYYYYYYYYYYYY/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX`
41
- - Treat this endpoint as a secret. Anyone who has it will be able to post messages to your RocketChat instance.
34
+1. In RocketChat, Navigate to Administration > Workspace > Integrations
35
+2. Click **+New** at the top right corner
36
+3. For more details about each parameter, check [Create a new incoming webhook](https://docs.rocket.chat/use-rocket.chat/workspace-administration/integrations#create-a-new-incoming-webhook)
37
+4. You will end up with a webhook endpoint that looks like `https://your-server.rocket.chat/hooks/YYYYYYYYYYYYYYYYYYYYYYYY/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX`, copy it in order to add it to your integration configuration in the Netdata Cloud UI
38
39
+For more details please check [Incoming webhooks for RocketChat](https://docs.rocket.chat/use-rocket.chat/workspace-administration/integrations/).
40
44
-For more details please check RocketChat's article Incoming webhooks for [RocketChat](https://docs.rocket.chat/use-rocket.chat/workspace-administration/integrations/).
45
-
46
-### Netdata Configuration Steps
41
+### Netdata Configuration
42
43
1. Click on the **Space settings** cog (located above your profile icon)
49
-2. Click on the **Notification** tab
50
-3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
51
-4. On the **RocketChat** card click on **+ Add**
52
-5. A modal will be presented to you to enter the required details to enable the configuration:
53
- * **Notification settings** are Netdata specific settings
54
- - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
55
- - 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
56
- - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
57
- * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For RocketChat:
58
- - Webhook URL - URL provided on RocketChat for the channel you want to receive your notifications.
44
+2. Click on the **Alerts & Notifications** tab
45
+3. Click on the **+ Add configuration** button
46
+4. Add the PagerDuty Integration
47
+5. A modal will be presented to you to enter the required details to enable the integration:
48
+ - **Notification settings**
49
+ - Configuration name (optional): A name for your configuration in order to easily refer to it
50
+ - Rooms: A list of Rooms for which you want to be notified
51
+ - Notifications: The notifications which you want to be notified
52
+ - **Integration configuration**
53
+ - Webhook URL: URL provided on RocketChat for the channel you want to receive your notifications
54
55
integrations/cloud-notifications/integrations/slack.md
+20
-22
@@ -13,7 +13,7 @@ endmeta-->
13
<img src="https://netdata.cloud/img/slack.png" width="150"/>
14
15
16
-From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on Slack.
16
+From the Netdata Cloud UI, you can configure notification delivery to Slack.
17
18
19
<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
@@ -23,36 +23,34 @@ From the Netdata Cloud UI, you can manage your space's notification settings and
23
### Prerequisites
24
25
- A Netdata Cloud account
26
-- Access to the Netdata Space as an **Admin**
27
-- The Netdata Space needs to be on a paid plan
26
+- Access to the Space as an **Admin**
27
+- The Space needs to be on a paid plan
28
- You need to have a Slack app on your workspace to receive the Webhooks.
29
30
### Slack Server Configuration
31
32
-Steps to configure your Slack to receive notifications from Netdata:
33
-
34
-1. Create an app to receive webhook integrations. Check [Create an app](https://api.slack.com/apps?new_app=1) from Slack documentation for further details
32
+1. Create an app to receive webhook integrations. Check the [Slack documentation](https://api.slack.com/apps?new_app=1) for further details
33
2. Install the app on your workspace
34
3. Configure Webhook URLs for your workspace
37
- - On your app go to **Incoming Webhooks** and click on **activate incoming webhooks**
38
- - At the bottom of **Webhook URLs for Your Workspace** section you have **Add New Webhook to Workspace**
39
- - After pressing that specify the channel where you want your notifications to be delivered
40
- - Once completed copy the Webhook URL that you will need to add to your notification configuration on Netdata UI
35
+ - On your app go to **Incoming Webhooks** and click on **activate incoming webhooks**
36
+ - At the bottom of **Webhook URLs for Your Workspace** section you have **Add New Webhook to Workspace**
37
+ - Specify the channel where you want your notifications to be delivered
38
+ - Once completed, copy the Webhook URL in order to add it to your integration configuration in the Netdata Cloud UI
39
42
-For more details please check Slacks's article [Incoming webhooks for Slack](https://slack.com/help/articles/115005265063-Incoming-webhooks-for-Slack).
40
+For more details please check [Incoming webhooks for Slack](https://slack.com/help/articles/115005265063-Incoming-webhooks-for-Slack).
41
44
-### Netdata Configuration Steps
42
+### Netdata Configuration
43
44
1. Click on the **Space settings** cog (located above your profile icon)
47
-2. Click on the **Notification** tab
48
-3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
49
-4. On the **Slack** card click on **+ Add**
50
-5. A modal will be presented to you to enter the required details to enable the configuration:
51
- * **Notification settings** are Netdata specific settings
52
- - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
53
- - 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
54
- - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
55
- * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Slack:
56
- - Webhook URL - URL provided on Slack for the channel you want to receive your notifications.
45
+2. Click on the **Alerts & Notifications** tab
46
+3. Click on the **+ Add configuration** button
47
+4. Add the Slack Integration
48
+5. A modal will be presented to you to enter the required details to enable the integration:
49
+ - **Notification settings**
50
+ - Configuration name (optional): A name for your configuration in order to easily refer to it
51
+ - Rooms: A list of Rooms for which you want to be notified
52
+ - Notifications: The notifications which you want to be notified
53
+ - **Integration configuration**
54
+ - Webhook URL: URL provided on Slack for the channel you want to receive your notifications
55
56
integrations/cloud-notifications/integrations/splunk.md
+15
-17
@@ -13,7 +13,7 @@ endmeta-->
13
<img src="https://netdata.cloud/img/splunk-black.svg" width="150"/>
14
15
16
-From the Cloud interface, you can manage your space's notification settings and from these you can add a specific configuration to get notifications delivered on Splunk.
16
+From the Netdata Cloud UI, you can configure notification delivery to Splunk.
17
18
19
<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
@@ -22,26 +22,24 @@ From the Cloud interface, you can manage your space's notification settings and
22
23
### Prerequisites
24
25
-To add Splunk notification you need:
26
-
25
- A Netdata Cloud account
28
-- Access to the space as an **Admin**
26
+- Access to the Space as an **Admin**
27
- The Space needs to be on a paid plan
30
-- URI and token for your Splunk HTTP Event Collector. Refer to the [Splunk documentation](https://docs.splunk.com/Documentation/Splunk/latest/Data/UsetheHTTPEventCollector) for detailed instructions.
28
+- The URI and token for your Splunk HTTP Event Collector. Refer to the [Splunk documentation](https://docs.splunk.com/Documentation/Splunk/latest/Data/UsetheHTTPEventCollector) for detailed instructions on how to set it up.
29
32
-### Steps
30
+### Netdata Configuration
31
32
1. Click on the **Space settings** cog (located above your profile icon)
35
-2. Click on the **Notification** tab
36
-3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
37
-4. On the **Splunk** card click on **+ Add**
38
-5. A modal will be presented to you to enter the required details to enable the configuration:
39
- - **Notification settings** are Netdata specific settings
40
- - Configuration name - provide a descriptive name for your configuration to easily identify it.
41
- - Rooms - select the nodes or areas of your infrastructure you want to receive notifications about.
42
- - Notification - choose the type of notifications you want to receive: All Alerts and unreachable, All Alerts, Critical only.
43
- - **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Splunk:
44
- - HTTP Event Collector URI - The URI of your HTTP event collector in Splunk
45
- - HTTP Event Collector Token - the token that Splunk provided to you when you created the HTTP Event Collector
33
+2. Click on the **Alerts & Notifications** tab
34
+3. Click on the **+ Add configuration** button
35
+4. Add the Splunk Integration
36
+5. A modal will be presented to you to enter the required details to enable the integration:
37
+ - **Notification settings**
38
+ - Configuration name (optional): A name for your configuration in order to easily refer to it
39
+ - Rooms: A list of Rooms for which you want to be notified
40
+ - Notifications: The notifications which you want to be notified
41
+ - **Integration configuration**
42
+ - HTTP Event Collector URI: The URI of your HTTP event collector in Splunk
43
+ - HTTP Event Collector Token: The token that Splunk provided to you when you created the HTTP Event Collector
44
45
integrations/cloud-notifications/integrations/splunk_victorops.md
+13
-15
@@ -13,7 +13,7 @@ endmeta-->
13
<img src="https://netdata.cloud/img/victorops.svg" width="150"/>
14
15
16
-From the Cloud interface, you can manage your space's notification settings and from there you can add a specific configuration to get notifications delivered on Splunk On-Call/VictorOps.
16
+From the Netdata Cloud UI, you can configure notification delivery to Splunk On-Call/VictorOps.
17
18
19
<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
@@ -22,25 +22,23 @@ From the Cloud interface, you can manage your space's notification settings and
22
23
### Prerequisites
24
25
-To add Splunk VictorOps notification (also known as Splunk On-Call) you need:
26
-
25
- A Netdata Cloud account
28
-- Access to the space as an **Admin**
26
+- Access to the Space as an **Admin**
27
- The Space needs to be on a paid plan
30
-- Destination URL for your Splunk VictorOps REST Endpoint Integration. Refer to the [VictorOps documentation](https://help.victorops.com/knowledge-base/rest-endpoint-integration-guide) for detailed instructions.
28
+- The Destination URL for your Splunk VictorOps REST Endpoint Integration. Refer to the [VictorOps documentation](https://help.victorops.com/knowledge-base/rest-endpoint-integration-guide) for detailed instructions.
29
32
-### Steps
30
+### Netdata Configuration
31
32
1. Click on the **Space settings** cog (located above your profile icon)
35
-2. Click on the **Notification** tab
36
-3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
37
-4. On the **Splunk VictorOps** card click on **+ Add**
38
-5. A modal will be presented to you to enter the required details to enable the configuration:
39
- - **Notification settings** are Netdata specific settings
40
- - Configuration name - provide a descriptive name for your configuration to easily identify it.
41
- - Rooms - select the nodes or areas of your infrastructure you want to receive notifications about.
42
- - Notification - choose the type of notifications you want to receive: All Alerts and unreachable, All Alerts, Critical only.
43
- - **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Splunk VictorOps:
33
+2. Click on the **Alerts & Notifications** tab
34
+3. Click on the **+ Add configuration** button
35
+4. Add the Splunk VictorOps Integration
36
+5. A modal will be presented to you to enter the required details to enable the integration:
37
+ - **Notification settings**
38
+ - Configuration name (optional): A name for your configuration in order to easily refer to it
39
+ - Rooms: A list of Rooms for which you want to be notified
40
+ - Notifications: The notifications which you want to be notified
41
+ - **Integration configuration**
42
- Destination URL - The URL provided by VictorOps of your REST endpoint.
43
44
integrations/cloud-notifications/integrations/telegram.md
+20
-22
@@ -13,7 +13,7 @@ endmeta-->
13
<img src="https://netdata.cloud/img/telegram.svg" width="150"/>
14
15
16
-From the Cloud interface, you can manage your space's notification settings and from these you can add a specific configuration to get notifications delivered on Telegram.
16
+From the Netdata Cloud UI, you can configure notification delivery to Telegram.
17
18
19
<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
@@ -22,30 +22,12 @@ From the Cloud interface, you can manage your space's notification settings and
22
23
### Prerequisites
24
25
-To add Telegram notification you need:
26
-
25
- A Netdata Cloud account
28
-- Access to the space as an **Admin**
26
+- Access to the Space as an **Admin**
27
- The Space needs to be on a paid plan
30
-- The Telegram bot token, chat ID and _optionally_ the topic ID
31
-
32
-### Steps
28
+- The Telegram bot token, chat ID and optionally the topic ID
29
34
-1. Click on the **Space settings** cog (located above your profile icon)
35
-2. Click on the **Notification** tab
36
-3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
37
-4. On the **Telegram** card click on **+ Add**
38
-5. A modal will be presented to you to enter the required details to enable the configuration:
39
- - **Notification settings** are Netdata specific settings
40
- - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
41
- - 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
42
- - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
43
- - **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Telegram:
44
- - Bot Token - the token of your bot
45
- - Chat ID - the chat id where your bot will deliver messages to
46
- - Topic ID - the identifier of the chat topic to which your bot will send messages. If omitted or 0, messages will be sent to the General topic. If topics are not supported, messages will be sent to the chat.
47
-
48
-### Getting the Telegram bot token, chat ID and topic ID
30
+### Telegram Configuration
31
32
- Bot token: To create one bot, contact the [@BotFather](https://t.me/BotFather) bot and send the command `/newbot` and follow the instructions. **Start a conversation with your bot or invite it into the group where you want it to send notifications**.
33
- To get the chat ID you have two options:
@@ -53,4 +35,20 @@ To add Telegram notification you need:
35
- Alternatively, you can get the chat ID directly from the bot API. Send your bot a command in the chat you want to use, then check `https://api.telegram.org/bot{YourBotToken}/getUpdates`, eg. `https://api.telegram.org/bot111122223:7OpFlFFRzRBbrUUmIjj5HF9Ox2pYJZy5/getUpdates`
36
- To get the topic ID, the easiest way is this: Post a message to that topic, then right-click on it and select `Copy Message Link`. Paste it on a scratchpad and notice that it has the following structure `https://t.me/c/XXXXXXXXXX/YY/ZZ`. The topic ID is `YY` (integer).
37
38
+### Netdata Configuration
39
+
40
+1. Click on the **Space settings** cog (located above your profile icon)
41
+2. Click on the **Alerts & Notifications** tab
42
+3. Click on the **+ Add configuration** button
43
+4. Add the Telegram Integration
44
+5. A modal will be presented to you to enter the required details to enable the integration:
45
+ - **Notification settings**
46
+ - Configuration name (optional): A name for your configuration in order to easily refer to it
47
+ - Rooms: A list of Rooms for which you want to be notified
48
+ - Notifications: The notifications which you want to be notified
49
+ - **Integration configuration**
50
+ - Bot Token: The token of your bot
51
+ - Chat ID: The chat id where your bot will deliver messages to
52
+ - Topic ID: The identifier of the chat topic to which your bot will send messages. If omitted or 0, messages will be sent to the General topic. If topics are not supported, messages will be sent to the chat.
53
+
54
integrations/cloud-notifications/integrations/webhook.md
+148
-148
@@ -13,7 +13,7 @@ endmeta-->
13
<img src="https://netdata.cloud/img/webhook.svg" width="150"/>
14
15
16
-From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on a webhook using a predefined schema.
16
+From the Netdata Cloud UI, you can configure notification delivery to a webhook using a predefined schema.
17
18
19
<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
@@ -23,142 +23,142 @@ From the Netdata Cloud UI, you can manage your space's notification settings and
23
### Prerequisites
24
25
- A Netdata Cloud account
26
-- Access to the Netdata Space as an **Admin**
27
-- The Netdata Space needs to be on a paid plan
26
+- Access to the Space as an **Admin**
27
+- The Space needs to be on a paid plan
28
- You need to have an app that allows you to receive webhooks following a predefined schema.
29
30
-### Netdata Configuration Steps
30
+### Netdata Configuration
31
32
1. Click on the **Space settings** cog (located above your profile icon)
33
-2. Click on the **Notification** tab
34
-3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
35
-4. On the **Webhook** card click on **+ Add**
33
+2. Click on the **Alerts & Notifications** tab
34
+3. Click on the **+ Add configuration** button
35
+4. Add the Webhook integration
36
5. A modal will be presented to you to enter the required details to enable the configuration:
37
- * **Notification settings** are Netdata specific settings
38
- - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
39
- - 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
40
- - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
41
- * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Webhook:
42
- - Webhook URL - webhook URL is the url of the service that Netdata will send notifications to. In order to keep the communication secured, we only accept HTTPS urls.
43
- - Extra headers - these are optional key-value pairs that you can set to be included in the HTTP requests sent to the webhook URL.
44
- - Authentication Mechanism - Netdata webhook integration supports 3 different authentication mechanisms.
45
- * Mutual TLS (recommended) - default authentication mechanism used if no other method is selected.
46
- * Basic - the client sends a request with an Authorization header that includes a base64-encoded string in the format **username:password**. These will settings will be required inputs.
47
- * Bearer - the client sends a request with an Authorization header that includes a **bearer token**. This setting will be a required input.
37
+ - **Notification settings**
38
+ - Configuration name (optional): A name for your configuration in order to easily refer to it
39
+ - Rooms: A list of Rooms for which you want to be notified
40
+ - Notifications: The notifications which you want to be notified
41
+ - **Integration configuration**
42
+ - Webhook URL: The url of the service that Netdata will send notifications to. In order to keep the communication secured, Netdata only accepts HTTPS urls.
43
+ - Extra headers: Optional key-value pairs that you can set to be included in the HTTP requests sent to the webhook URL.
44
+ - Authentication Mechanism, Netdata webhook integration supports 3 different authentication mechanisms.
45
+ - Mutual TLS (recommended): Default authentication mechanism used if no other method is selected
46
+ - Basic: The client sends a request with an Authorization header that includes a base64-encoded string in the format **username:password**.
47
+ - Bearer: The client sends a request with an Authorization header that includes a **bearer token**.
48
49
+### Webhook service
50
50
- ### Webhook service
51
+A webhook service allows your application to receive real-time alerts from Netdata by sending HTTP requests to a specified URL.
52
52
- A webhook integration allows your application to receive real-time alerts from Netdata by sending HTTP requests to a specified URL. In this document, we'll go over the steps to set up a generic webhook integration, including adding headers, and implementing different types of authorization mechanisms.
53
+In this section, we'll go over the steps to set up a generic webhook service, including adding headers, and implementing different types of authorization mechanisms.
54
54
- #### Netdata webhook integration
55
+#### Netdata webhook integration
56
56
- A webhook integration is a way for one service to notify another service about events that occur within it. This is done by sending an HTTP POST request to a specified URL (known as the "webhook URL") when an event occurs.
57
+Netdata webhook integration service will send alert and reachability notifications to the destination service as soon as they are detected.
58
58
- Netdata webhook integration service will send alert and reachability notifications to the destination service as soon as they are detected.
59
+For alert notifications, the content sent to the destination service contains a JSON object with the following properties:
60
60
- For alert notifications, the content sent to the destination service contains a JSON object with the following properties:
61
+| field | type | description |
62
+|:----------------------------------|:--------------------------------|:--------------------------------------------------------------------------|
63
+| message | string | A summary message of the alert. |
64
+| alert | string | The alert the notification is related to. |
65
+| info | string | Additional info related with the alert. |
66
+| chart | string | The chart associated with the alert. |
67
+| context | string | The chart context. |
68
+| space | string | The space where the node that raised the alert is assigned. |
69
+| Rooms | object\[object(string,string)\] | Object with list of Rooms names and urls where the node belongs to. |
70
+| family | string | Context family. |
71
+| class | string | Classification of the alert, e.g. `Error`. |
72
+| severity | string | Alert severity, can be one of `warning`, `critical` or `clear`. |
73
+| date | string | Date of the alert in ISO8601 format. |
74
+| duration | string | Duration the alert has been raised. |
75
+| additional_active_critical_alerts | integer | Number of additional critical alerts currently existing on the same node. |
76
+| additional_active_warning_alerts | integer | Number of additional warning alerts currently existing on the same node. |
77
+| alert_url | string | Netdata Cloud URL for this alert. |
78
62
- | field | type | description |
63
- | :-- | :-- | :-- |
64
- | message | string | A summary message of the alert. |
65
- | alarm | string | The alarm the notification is about. |
66
- | info | string | Additional info related with the alert. |
67
- | chart | string | The chart associated with the alert. |
68
- | context | string | The chart context. |
69
- | space | string | The space where the node that raised the alert is assigned. |
70
- | Rooms | object[object(string,string)] | Object with list of Rooms names and urls where the node belongs to. |
71
- | family | string | Context family. |
72
- | class | string | Classification of the alert, e.g. "Error". |
73
- | severity | string | Alert severity, can be one of "warning", "critical" or "clear". |
74
- | date | string | Date of the alert in ISO8601 format. |
75
- | duration | string | Duration the alert has been raised. |
76
- | additional_active_critical_alerts | integer | Number of additional critical alerts currently existing on the same node. |
77
- | additional_active_warning_alerts | integer | Number of additional warning alerts currently existing on the same node. |
78
- | alarm_url | string | Netdata Cloud URL for this alarm. |
79
+For reachability notifications, the JSON object will contain the following properties:
80
80
- For reachability notifications, the JSON object will contain the following properties:
81
+| field | type | description |
82
+|:-----------------|:--------|:------------------------------------------------------------------------------------------------------------------------------|
83
+| message | string | A summary message of the reachability alert. |
84
+| url | string | Netdata Cloud URL for the host experiencing the reachability alert. |
85
+| host | string | The hostname experiencing the reachability alert. |
86
+| severity | string | Severity for this notification. If host is reachable, severity will be `info`, if host is unreachable, it will be `critical`. |
87
+| status | object | An object with the status information. |
88
+| status.reachable | boolean | `true` if host is reachable, `false` otherwise |
89
+| status.text | string | Can be `reachable` or `unreachable` |
90
82
- | field | type | description |
83
- | :-- | :-- | :-- |
84
- | message | string | A summary message of the reachability alert. |
85
- | url | string | Netdata Cloud URL for the host experiencing the reachability alert. |
86
- | host | string | the host experiencing the reachability alert. |
87
- | severity | string | severity for this notification. If host is reachable, severity will be 'info', if host is unreachable, it will be 'critical'. |
88
- | status | object | an object with the status information. |
89
- | status.reachable | boolean | true if host is reachable, false otherwise |
90
- | status.text | string | can be 'reachable' or 'unreachable' |
91
+#### Extra headers
92
92
- #### Extra headers
93
+When setting up a webhook service, the user can specify a set of headers to be included in the HTTP requests sent to the webhook URL.
94
94
- When setting up a webhook integration, the user can specify a set of headers to be included in the HTTP requests sent to the webhook URL.
95
+By default, the following headers will be sent in the HTTP request
96
96
- By default, the following headers will be sent in the HTTP request
97
+ | **Header** | **Value** |
98
+ |:------------:|------------------|
99
+ | Content-Type | application/json |
100
98
- | **Header** | **Value** |
99
- |:-------------------------------:|-----------------------------|
100
- | Content-Type | application/json |
101
+#### Authentication mechanisms
102
102
- #### Authentication mechanisms
103
+Netdata webhook integration supports 3 different authentication mechanisms:
104
104
- Netdata webhook integration supports 3 different authentication mechanisms:
105
+##### Mutual TLS authentication (recommended)
106
106
- ##### Mutual TLS authentication (recommended)
107
+In mutual Transport Layer Security (mTLS) authentication, the client and the server authenticate each other using X.509 certificates. This ensures that the client is connecting to the intended server, and that the server is only accepting connections from authorized clients.
108
108
- In mutual Transport Layer Security (mTLS) authentication, the client and the server authenticate each other using X.509 certificates. This ensures that the client is connecting to the intended server, and that the server is only accepting connections from authorized clients.
109
+This is the default authentication mechanism used if no other method is selected.
110
110
- This is the default authentication mechanism used if no other method is selected.
111
+To take advantage of mutual TLS, you can configure your server to verify Netdata's client certificate. In order to achieve this, the Netdata client sending the notification supports mutual TLS (mTLS) to identify itself with a client certificate that your server can validate.
112
112
- To take advantage of mutual TLS, you can configure your server to verify Netdata's client certificate. In order to achieve this, the Netdata client sending the notification supports mutual TLS (mTLS) to identify itself with a client certificate that your server can validate.
113
+The steps to perform this validation are as follows:
114
114
- The steps to perform this validation are as follows:
115
-
116
- - Store Netdata CA certificate on a file in your disk. The content of this file should be:
115
+- Store Netdata CA certificate on a file in your disk. The content of this file should be:
116
117
<details>
118
<summary>Netdata CA certificate</summary>
119
121
- ```
122
- -----BEGIN CERTIFICATE-----
123
- MIIF0jCCA7qgAwIBAgIUDV0rS5jXsyNX33evHEQOwn9fPo0wDQYJKoZIhvcNAQEN
124
- BQAwgYAxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlhMRYwFAYDVQQH
125
- Ew1TYW4gRnJhbmNpc2NvMRYwFAYDVQQKEw1OZXRkYXRhLCBJbmMuMRIwEAYDVQQL
126
- EwlDbG91ZCBTUkUxGDAWBgNVBAMTD05ldGRhdGEgUm9vdCBDQTAeFw0yMzAyMjIx
127
- MjQzMDBaFw0zMzAyMTkxMjQzMDBaMIGAMQswCQYDVQQGEwJVUzETMBEGA1UECBMK
128
- Q2FsaWZvcm5pYTEWMBQGA1UEBxMNU2FuIEZyYW5jaXNjbzEWMBQGA1UEChMNTmV0
129
- ZGF0YSwgSW5jLjESMBAGA1UECxMJQ2xvdWQgU1JFMRgwFgYDVQQDEw9OZXRkYXRh
130
- IFJvb3QgQ0EwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQCwIg7z3R++
131
- ppQYYVVoMIDlhWO3qVTMsAQoJYEvVa6fqaImUBLW/k19LUaXgUJPohB7gBp1pkjs
132
- QfY5dBo8iFr7MDHtyiAFjcQV181sITTMBEJwp77R4slOXCvrreizhTt1gvf4S1zL
133
- qeHBYWEgH0RLrOAqD0jkOHwewVouO0k3Wf2lEbCq3qRk2HeDvkv0LR7sFC+dDms8
134
- fDHqb/htqhk+FAJELGRqLeaFq1Z5Eq1/9dk4SIeHgK5pdYqsjpBzOTmocgriw6he
135
- s7F3dOec1ZZdcBEAxOjbYt4e58JwuR81cWAVMmyot5JNCzYVL9e5Vc5n22qt2dmc
136
- Tzw2rLOPt9pT5bzbmyhcDuNg2Qj/5DySAQ+VQysx91BJRXyUimqE7DwQyLhpQU72
137
- jw29lf2RHdCPNmk8J1TNropmpz/aI7rkperPugdOmxzP55i48ECbvDF4Wtazi+l+
138
- 4kx7ieeLfEQgixy4lRUUkrgJlIDOGbw+d2Ag6LtOgwBiBYnDgYpvLucnx5cFupPY
139
- Cy3VlJ4EKUeQQSsz5kVmvotk9MED4sLx1As8V4e5ViwI5dCsRfKny7BeJ6XNPLnw
140
- PtMh1hbiqCcDmB1urCqXcMle4sRhKccReYOwkLjLLZ80A+MuJuIEAUUuEPCwywzU
141
- R7pagYsmvNgmwIIuJtB6mIJBShC7TpJG+wIDAQABo0IwQDAOBgNVHQ8BAf8EBAMC
142
- AQYwDwYDVR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQU9IbvOsPSUrpr8H2zSafYVQ9e
143
- Ft8wDQYJKoZIhvcNAQENBQADggIBABQ08aI31VKZs8jzg+y/QM5cvzXlVhcpkZsY
144
- 1VVBr0roSBw9Pld9SERrEHto8PVXbadRxeEs4sKivJBKubWAooQ6NTvEB9MHuGnZ
145
- VCU+N035Gq/mhBZgtIs/Zz33jTB2ju3G4Gm9VTZbVqd0OUxFs41Iqvi0HStC3/Io
146
- rKi7crubmp5f2cNW1HrS++ScbTM+VaKVgQ2Tg5jOjou8wtA+204iYXlFpw9Q0qnP
147
- qq6ix7TfLLeRVp6mauwPsAJUgHZluz7yuv3r7TBdukU4ZKUmfAGIPSebtB3EzXfH
148
- 7Y326xzv0hEpjvDHLy6+yFfTdBSrKPsMHgc9bsf88dnypNYL8TUiEHlcTgCGU8ts
149
- ud8sWN2M5FEWbHPNYRVfH3xgY2iOYZzn0i+PVyGryOPuzkRHTxDLPIGEWE5susM4
150
- X4bnNJyKH1AMkBCErR34CLXtAe2ngJlV/V3D4I8CQFJdQkn9tuznohUU/j80xvPH
151
- FOcDGQYmh4m2aIJtlNVP6+/92Siugb5y7HfslyRK94+bZBg2D86TcCJWaaZOFUrR
152
- Y3WniYXsqM5/JI4OOzu7dpjtkJUYvwtg7Qb5jmm8Ilf5rQZJhuvsygzX6+WM079y
153
- nsjoQAm6OwpTN5362vE9SYu1twz7KdzBlUkDhePEOgQkWfLHBJWwB+PvB1j/cUA3
154
- 5zrbwvQf
155
- -----END CERTIFICATE-----
156
- ```
120
+ ```text
121
+ -----BEGIN CERTIFICATE-----
122
+ MIIF0jCCA7qgAwIBAgIUDV0rS5jXsyNX33evHEQOwn9fPo0wDQYJKoZIhvcNAQEN
123
+ BQAwgYAxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlhMRYwFAYDVQQH
124
+ Ew1TYW4gRnJhbmNpc2NvMRYwFAYDVQQKEw1OZXRkYXRhLCBJbmMuMRIwEAYDVQQL
125
+ EwlDbG91ZCBTUkUxGDAWBgNVBAMTD05ldGRhdGEgUm9vdCBDQTAeFw0yMzAyMjIx
126
+ MjQzMDBaFw0zMzAyMTkxMjQzMDBaMIGAMQswCQYDVQQGEwJVUzETMBEGA1UECBMK
127
+ Q2FsaWZvcm5pYTEWMBQGA1UEBxMNU2FuIEZyYW5jaXNjbzEWMBQGA1UEChMNTmV0
128
+ ZGF0YSwgSW5jLjESMBAGA1UECxMJQ2xvdWQgU1JFMRgwFgYDVQQDEw9OZXRkYXRh
129
+ IFJvb3QgQ0EwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQCwIg7z3R++
130
+ ppQYYVVoMIDlhWO3qVTMsAQoJYEvVa6fqaImUBLW/k19LUaXgUJPohB7gBp1pkjs
131
+ QfY5dBo8iFr7MDHtyiAFjcQV181sITTMBEJwp77R4slOXCvrreizhTt1gvf4S1zL
132
+ qeHBYWEgH0RLrOAqD0jkOHwewVouO0k3Wf2lEbCq3qRk2HeDvkv0LR7sFC+dDms8
133
+ fDHqb/htqhk+FAJELGRqLeaFq1Z5Eq1/9dk4SIeHgK5pdYqsjpBzOTmocgriw6he
134
+ s7F3dOec1ZZdcBEAxOjbYt4e58JwuR81cWAVMmyot5JNCzYVL9e5Vc5n22qt2dmc
135
+ Tzw2rLOPt9pT5bzbmyhcDuNg2Qj/5DySAQ+VQysx91BJRXyUimqE7DwQyLhpQU72
136
+ jw29lf2RHdCPNmk8J1TNropmpz/aI7rkperPugdOmxzP55i48ECbvDF4Wtazi+l+
137
+ 4kx7ieeLfEQgixy4lRUUkrgJlIDOGbw+d2Ag6LtOgwBiBYnDgYpvLucnx5cFupPY
138
+ Cy3VlJ4EKUeQQSsz5kVmvotk9MED4sLx1As8V4e5ViwI5dCsRfKny7BeJ6XNPLnw
139
+ PtMh1hbiqCcDmB1urCqXcMle4sRhKccReYOwkLjLLZ80A+MuJuIEAUUuEPCwywzU
140
+ R7pagYsmvNgmwIIuJtB6mIJBShC7TpJG+wIDAQABo0IwQDAOBgNVHQ8BAf8EBAMC
141
+ AQYwDwYDVR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQU9IbvOsPSUrpr8H2zSafYVQ9e
142
+ Ft8wDQYJKoZIhvcNAQENBQADggIBABQ08aI31VKZs8jzg+y/QM5cvzXlVhcpkZsY
143
+ 1VVBr0roSBw9Pld9SERrEHto8PVXbadRxeEs4sKivJBKubWAooQ6NTvEB9MHuGnZ
144
+ VCU+N035Gq/mhBZgtIs/Zz33jTB2ju3G4Gm9VTZbVqd0OUxFs41Iqvi0HStC3/Io
145
+ rKi7crubmp5f2cNW1HrS++ScbTM+VaKVgQ2Tg5jOjou8wtA+204iYXlFpw9Q0qnP
146
+ qq6ix7TfLLeRVp6mauwPsAJUgHZluz7yuv3r7TBdukU4ZKUmfAGIPSebtB3EzXfH
147
+ 7Y326xzv0hEpjvDHLy6+yFfTdBSrKPsMHgc9bsf88dnypNYL8TUiEHlcTgCGU8ts
148
+ ud8sWN2M5FEWbHPNYRVfH3xgY2iOYZzn0i+PVyGryOPuzkRHTxDLPIGEWE5susM4
149
+ X4bnNJyKH1AMkBCErR34CLXtAe2ngJlV/V3D4I8CQFJdQkn9tuznohUU/j80xvPH
150
+ FOcDGQYmh4m2aIJtlNVP6+/92Siugb5y7HfslyRK94+bZBg2D86TcCJWaaZOFUrR
151
+ Y3WniYXsqM5/JI4OOzu7dpjtkJUYvwtg7Qb5jmm8Ilf5rQZJhuvsygzX6+WM079y
152
+ nsjoQAm6OwpTN5362vE9SYu1twz7KdzBlUkDhePEOgQkWfLHBJWwB+PvB1j/cUA3
153
+ 5zrbwvQf
154
+ -----END CERTIFICATE-----
155
+ ```
156
+
157
</details>
158
159
- - Enable client certificate validation on the web server that is doing the TLS termination. Below we show you how to perform this configuration in `NGINX` and `Apache`
159
+- Enable client certificate validation on the web server that is doing the TLS termination. Below there are examples on how to perform this configuration in `NGINX` and `Apache`.
160
161
- **NGINX**
161
+ **NGINX**
162
163
```bash
164
server {
@@ -172,7 +172,7 @@ From the Netdata Cloud UI, you can manage your space's notification settings and
172
if ($ssl_client_s_dn !~ "CN=app.netdata.cloud") {
173
return 403;
174
}
175
- # ... existing location configuration ...
175
+ # ... existing location configuration ...
176
}
177
}
178
```
@@ -192,68 +192,68 @@ From the Netdata Cloud UI, you can manage your space's notification settings and
192
</Directory>
193
```
194
195
- ##### Basic authentication
195
+##### Basic authentication
196
197
- In basic authorization, the client sends a request with an Authorization header that includes a base64-encoded string in the format username:password. The server then uses this information to authenticate the client. If this authentication method is selected, the user can set the user and password that will be used when connecting to the destination service.
197
+In basic authorization, the client sends a request with an Authorization header that includes a base64-encoded string in the format username:password. The server then uses this information to authenticate the client. If this authentication method is selected, the user can set the user and password that will be used when connecting to the destination service.
198
199
- ##### Bearer token authentication
199
+##### Bearer token authentication
200
201
- In bearer token authentication, the client sends a request with an Authorization header that includes a bearer token. The server then uses this token to authenticate the client. Bearer tokens are typically generated by an authentication service, and are passed to the client after a successful authentication. If this method is selected, the user can set the token to be used for connecting to the destination service.
201
+In bearer token authentication, the client sends a request with an Authorization header that includes a bearer token. The server then uses this token to authenticate the client. Bearer tokens are typically generated by an authentication service, and are passed to the client after a successful authentication. If this method is selected, the user can set the token to be used for connecting to the destination service.
202
203
- ##### Challenge secret
203
+##### Challenge secret
204
205
- To validate that you have ownership of the web application that will receive the webhook events, we are using a challenge response check mechanism.
205
+To validate that you have ownership of the web application that will receive the webhook events, Netdata is using a challenge response check mechanism.
206
207
- This mechanism works as follows:
207
+This mechanism works as follows:
208
209
- - The challenge secret parameter that you provide is a shared secret between you and Netdata only.
210
- - On your request for creating a new Webhook integration, we will make a GET request to the url of the webhook, adding a query parameter `crc_token`, consisting of a random string.
211
- - You will receive this request on your application and it must construct an encrypted response, consisting of a base64-encoded HMAC SHA-256 hash created from the crc_token and the shared secret. The response will be in the format:
209
+- The challenge secret parameter that you provide is a shared secret between only you and Netdata.
210
+- On your request for creating a new Webhook integration, Netdata will make a GET request to the URL of the webhook, adding a query parameter `crc_token`, consisting of a random string.
211
+- You will receive this request on your application and it must construct an encrypted response, consisting of a base64-encoded HMAC SHA-256 hash created from the crc_token and the shared secret. The response will be in the format:
212
213
- ```json
214
- {
213
+ ```json
214
+ {
215
"response_token": "sha256=9GKoHJYmcHIkhD+C182QWN79YBd+D+Vkj4snmZrfNi4="
216
- }
217
- ```
216
+ }
217
+ ```
218
219
- - We will compare your application's response with the hash that we will generate using the challenge secret, and if they are the same, the integration creation will succeed.
219
+- Netdata will compare your application's response with the hash that it will generate using the challenge secret, and if they are the same, the integration creation will succeed.
220
221
- We will do this validation everytime you update your integration configuration.
221
+Netdata does this validation every time you update your integration configuration.
222
223
- - Response requirements:
224
- - A base64 encoded HMAC SHA-256 hash created from the crc_token and the shared secret.
225
- - Valid response_token and JSON format.
226
- - Latency less than 5 seconds.
227
- - 200 HTTP response code.
223
+- Response requirements:
224
+ - A base64 encoded HMAC SHA-256 hash created from the crc_token and the shared secret.
225
+ - Valid response_token and JSON format.
226
+ - Latency less than 5 seconds.
227
+ - 200 HTTP response code.
228
229
- **Example response token generation in Python:**
229
+**Example response token generation in Python:**
230
231
- Here you can see how to define a handler for a Flask application in python 3:
231
+Here you can see how to define a handler for a Flask application in python 3:
232
233
- ```python
234
- import base64
235
- import hashlib
236
- import hmac
237
- import json
233
+```python
234
+import base64
235
+import hashlib
236
+import hmac
237
+import json
238
239
- key ='YOUR_CHALLENGE_SECRET'
239
+key ='YOUR_CHALLENGE_SECRET'
240
241
- @app.route('/webhooks/netdata')
242
- def webhook_challenge():
243
- token = request.args.get('crc_token').encode('ascii')
241
+@app.route('/webhooks/netdata')
242
+def webhook_challenge():
243
+token = request.args.get('crc_token').encode('ascii')
244
245
- # creates HMAC SHA-256 hash from incomming token and your consumer secret
246
- sha256_hash_digest = hmac.new(key.encode(),
247
- msg=token,
248
- digestmod=hashlib.sha256).digest()
245
+# creates HMAC SHA-256 hash from incomming token and your consumer secret
246
+sha256_hash_digest = hmac.new(key.encode(),
247
+ msg=token,
248
+ digestmod=hashlib.sha256).digest()
249
250
- # construct response data with base64 encoded hash
251
- response = {
252
- 'response_token': 'sha256=' + base64.b64encode(sha256_hash_digest).decode('ascii')
253
- }
250
+# construct response data with base64 encoded hash
251
+response = {
252
+ 'response_token': 'sha256=' + base64.b64encode(sha256_hash_digest).decode('ascii')
253
+}
254
255
- # returns properly formatted json response
256
- return json.dumps(response)
257
- ```
255
+# returns properly formatted json response
256
+return json.dumps(response)
257
+```
258
259
integrations/cloud-notifications/metadata.yaml
+491
-526
@@ -1,746 +1,664 @@
1
# yamllint disable rule:line-length
2
---
3
-- id: 'notify-cloud-mobile-app'
3
+- id: "notify-cloud-mobile-app"
4
meta:
5
- name: 'Netdata Mobile App'
6
- link: 'https://netdata.cloud'
5
+ name: "Netdata Mobile App"
6
+ link: "https://netdata.cloud"
7
categories:
8
- notify.cloud
9
- icon_filename: 'netdata.png'
9
+ icon_filename: "netdata.png"
10
keywords:
11
- mobile-app
12
- phone
13
- personal-notifications
14
overview:
15
- notification_description: "From the Netdata Cloud UI, you can manage your user notification settings and enable the configuration to deliver notifications on the Netdata Mobile Application."
16
- notification_limitations: ''
15
+ notification_description: "From the Netdata Cloud UI, you can configure notification delivery to the Netdata Mobile Application."
16
+ notification_limitations: ""
17
setup:
18
description: |
19
### Prerequisites
20
+
21
- A Netdata Cloud account
21
- - You need to have the Netdata Mobile Application installed on your [Android](https://play.google.com/store/apps/details?id=cloud.netdata.android&pli=1) or [iOS](https://apps.apple.com/in/app/netdata-mobile/id6474659622) phone.
22
-
23
- ### Netdata Mobile App Configuration
24
- Steps to login to the Netdata Mobile Application to receive alert and reachability and alert notifications:
25
- 1. Download the Netdata Mobile Application from [Google Play Store](https://play.google.com/store/apps/details?id=cloud.netdata.android&pli=1) or the [iOS App Store](https://apps.apple.com/in/app/netdata-mobile/id6474659622)
26
- 2. Open the App and Choose the Sign In Option
27
- - Sign In with Email Address: Enter the Email Address of your registered Netdata Cloud Account and Click on the Verification link received by Email on your mobile device.
28
- - Sign In with QR Code: Scan the QR Code from your `Netdata Cloud` UI under **User Settings** --> **Notifications** --> **Mobile App Notifications** --> **Show QR Code**
29
- 3. Start receiving alert and reachability notifications for your **Space(s)** on a **Paid Subscription plan**
30
-
31
- ### Netdata Configuration Steps
32
- 1. Click on the **User settings** on the bottom left of your screen (your profile icon)
33
- 2. Click on the **Notifications** tab
34
- 3. Enable **Mobile App Notifications** if disabled (Enabled by default)
35
- 4. Use the **Show QR Code** Option to login to your mobile device by scanning the **QR Code**
36
-- id: 'notify-cloud-discord'
22
+ - You need to have the Netdata Mobile App installed on your [Android](https://play.google.com/store/apps/details?id=cloud.netdata.android&pli=1) or [iOS](https://apps.apple.com/in/app/netdata-mobile/id6474659622) phone.
23
+
24
+ ### Netdata Mobile App Configuration and device linking
25
+
26
+ In order to login to the Netdata Mobile App
27
+
28
+ 1. Download the Netdata Mobile App from [Google Play Store](https://play.google.com/store/apps/details?id=cloud.netdata.android&pli=1) or the [iOS App Store](https://apps.apple.com/in/app/netdata-mobile/id6474659622)
29
+ 2. Open the App and Choose your Sign-in option
30
+ - Email Address: Enter the email address of your registered Netdata Cloud account and click on the verification link received by email on your mobile device.
31
+ - Sign-in with QR Code: Scan the QR code from the Netdata Cloud UI under **Profile Picture** --> **Settings** --> **Notifications** --> **Mobile App Notifications** --> **Show QR Code**
32
+
33
+ ### Netdata Configuration
34
+
35
+ After linking your device, enable the toggle for **Mobile App Notifications** under the same settings panel.
36
+
37
+- id: "notify-cloud-discord"
38
meta:
38
- name: 'Discord'
39
- link: 'https://discord.com/'
39
+ name: "Discord"
40
+ link: "https://discord.com/"
41
categories:
42
- notify.cloud
42
- icon_filename: 'discord.png'
43
+ icon_filename: "discord.png"
44
keywords:
45
- discord
46
- community
47
overview:
47
- notification_description: "From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on Discord."
48
- notification_limitations: ''
48
+ notification_description: "From the Netdata Cloud UI, you can configure notification delivery to your Discord server."
49
+ notification_limitations: ""
50
setup:
51
description: |
52
### Prerequisites
53
+
54
- A Netdata Cloud account
53
- - Access to the Netdata Space as an **Admin**
54
- - You need to have a Discord server able to receive webhooks integrations.
55
+ - Access to the Space as an **Admin**
56
57
### Discord Server Configuration
57
- Steps to configure your Discord server to receive [webhook notifications](https://support.discord.com/hc/en-us/articles/228383668) from Netdata:
58
- 1. Go to `Server Settings` --> `Integrations`
58
+
59
+ 1. Go to **Server Settings** --> **Integrations**
60
2. **Create Webhook** or **View Webhooks** if you already have some defined
61
3. Specify the **Name** and **Channel** on your new webhook
61
- 4. Use Webhook URL to add your notification configuration on Netdata UI
62
+ 4. Keep note of the **Webhook URL** as you will need it for the configuration of the integration on the Netdata Cloud UI
63
+
64
+ ### Netdata Configuration
65
63
- ### Netdata Configuration Steps
66
1. Click on the **Space settings** cog (located above your profile icon)
65
- 2. Click on the **Notification** tab
66
- 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
67
- 4. On the **Discord** card click on **+ Add**
68
- 5. A modal will be presented to you to enter the required details to enable the configuration:
69
- * **Notification settings** are Netdata specific settings
70
- - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
71
- - 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
72
- - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
73
- * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Discord:
74
- - Define the type channel you want to send notifications to: **Text channel** or **Forum channel**
75
- - Webhook URL - URL provided on Discord for the channel you want to receive your notifications.
76
- - Thread name - if the Discord channel is a **Forum channel** you will need to provide the thread name as well
77
-
78
-- id: 'notify-cloud-pagerduty'
67
+ 2. Click on the **Alerts & Notifications** tab
68
+ 3. Click on the **+ Add configuration** button
69
+ 4. Add the Discord Integration
70
+ 5. A modal will be presented to you to enter the required details to enable the integration:
71
+ - **Notification settings**
72
+ - Configuration name (optional): A name for your configuration in order to easily refer to it
73
+ - Rooms: A list of Rooms for which you want to be notified
74
+ - Notifications: The notifications which you want to be notified
75
+ - **Integration configuration**
76
+ - Webhook URL: The URL you copied from the previous section
77
+ - Channel Parameters: Select the channel type which the notifications will be sent to, if it is a Forum channel, you need to specify a thread name
78
+
79
+- id: "notify-cloud-pagerduty"
80
meta:
80
- name: 'PagerDuty'
81
- link: 'https://www.pagerduty.com/'
81
+ name: "PagerDuty"
82
+ link: "https://www.pagerduty.com/"
83
categories:
84
- notify.cloud
84
- icon_filename: 'pagerduty.png'
85
+ icon_filename: "pagerduty.png"
86
keywords:
87
- pagerduty
88
overview:
88
- notification_description: "From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on PagerDuty."
89
- notification_limitations: ''
89
+ notification_description: "From the Netdata Cloud UI, you can configure notification delivery to PagerDuty."
90
+ notification_limitations: ""
91
setup:
92
description: |
93
### Prerequisites
94
+
95
- A Netdata Cloud account
94
- - Access to the Netdata Space as an **Admin**
95
- - The Netdata Space needs to be on a paid plan
96
+ - Access to the Space as an **Admin**
97
+ - The Space needs to be on a paid plan
98
- You need to have a PagerDuty service to receive events using webhooks.
99
98
-
100
### PagerDuty Server Configuration
100
- Steps to configure your PagerDuty to receive notifications from Netdata:
101
102
1. Create a service to receive events from your services directory page on PagerDuty
103
- 2. At step 3, select `Events API V2` Integration or **View Webhooks** if you already have some defined
104
- 3. Once the service is created, you will be redirected to its configuration page, where you can copy the **Integration Key** and **Integration URL (Alert Events)** fields to add them to your notification configuration in the Netdata UI.
103
+ 2. On the third step of the service creation, select `Events API V2` Integration
104
+ 3. Once the service is created, you will be redirected to its configuration page, where you can copy the **Integration Key** and **Integration URL (Alert Events)** in order to add them to your integration configuration in the Netdata Cloud UI
105
106
- ### Netdata Configuration Steps
106
+ ### Netdata Configuration
107
108
1. Click on the **Space settings** cog (located above your profile icon)
109
- 2. Click on the **Notification** tab
110
- 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
111
- 4. On the **PagerDuty** card click on **+ Add**
112
- 5. A modal will be presented to you to enter the required details to enable the configuration:
113
- * **Notification settings** are Netdata specific settings
114
- - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
115
- - 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
116
- - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
117
- * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For PagerDuty:
118
- - Integration Key - is a 32 character key provided by PagerDuty to receive events on your service.
119
- - Integration URL (Alert Events) - is the URL provided by PagerDuty where we will send notifications.
120
-
121
-- id: 'notify-cloud-slack'
109
+ 2. Click on the **Alerts & Notifications** tab
110
+ 3. Click on the **+ Add configuration** button
111
+ 4. Add the PagerDuty Integration
112
+ 5. A modal will be presented to you to enter the required details to enable the integration:
113
+ - **Notification settings**
114
+ - Configuration name (optional): A name for your configuration in order to easily refer to it
115
+ - Rooms: A list of Rooms for which you want to be notified
116
+ - Notifications: The notifications which you want to be notified
117
+ - **Integration configuration**
118
+ - Integration Key: A 32 character key provided by PagerDuty to receive events on your service.
119
+ - Integration URL (Alert Events): The URL provided by PagerDuty where Netdata Cloud will send notifications.
120
+
121
+- id: "notify-cloud-slack"
122
meta:
123
- name: 'Slack'
124
- link: 'https://slack.com/'
123
+ name: "Slack"
124
+ link: "https://slack.com/"
125
categories:
126
- notify.cloud
127
- icon_filename: 'slack.png'
127
+ icon_filename: "slack.png"
128
keywords:
129
- slack
130
overview:
131
- notification_description: "From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on Slack."
132
- notification_limitations: ''
131
+ notification_description: "From the Netdata Cloud UI, you can configure notification delivery to Slack."
132
+ notification_limitations: ""
133
setup:
134
description: |
135
### Prerequisites
136
137
- A Netdata Cloud account
138
- - Access to the Netdata Space as an **Admin**
139
- - The Netdata Space needs to be on a paid plan
138
+ - Access to the Space as an **Admin**
139
+ - The Space needs to be on a paid plan
140
- You need to have a Slack app on your workspace to receive the Webhooks.
141
142
### Slack Server Configuration
143
144
- Steps to configure your Slack to receive notifications from Netdata:
145
-
146
- 1. Create an app to receive webhook integrations. Check [Create an app](https://api.slack.com/apps?new_app=1) from Slack documentation for further details
144
+ 1. Create an app to receive webhook integrations. Check the [Slack documentation](https://api.slack.com/apps?new_app=1) for further details
145
2. Install the app on your workspace
146
3. Configure Webhook URLs for your workspace
149
- - On your app go to **Incoming Webhooks** and click on **activate incoming webhooks**
150
- - At the bottom of **Webhook URLs for Your Workspace** section you have **Add New Webhook to Workspace**
151
- - After pressing that specify the channel where you want your notifications to be delivered
152
- - Once completed copy the Webhook URL that you will need to add to your notification configuration on Netdata UI
147
+ - On your app go to **Incoming Webhooks** and click on **activate incoming webhooks**
148
+ - At the bottom of **Webhook URLs for Your Workspace** section you have **Add New Webhook to Workspace**
149
+ - Specify the channel where you want your notifications to be delivered
150
+ - Once completed, copy the Webhook URL in order to add it to your integration configuration in the Netdata Cloud UI
151
154
- For more details please check Slacks's article [Incoming webhooks for Slack](https://slack.com/help/articles/115005265063-Incoming-webhooks-for-Slack).
152
+ For more details please check [Incoming webhooks for Slack](https://slack.com/help/articles/115005265063-Incoming-webhooks-for-Slack).
153
156
- ### Netdata Configuration Steps
154
+ ### Netdata Configuration
155
156
1. Click on the **Space settings** cog (located above your profile icon)
159
- 2. Click on the **Notification** tab
160
- 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
161
- 4. On the **Slack** card click on **+ Add**
162
- 5. A modal will be presented to you to enter the required details to enable the configuration:
163
- * **Notification settings** are Netdata specific settings
164
- - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
165
- - 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
166
- - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
167
- * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Slack:
168
- - Webhook URL - URL provided on Slack for the channel you want to receive your notifications.
169
-
170
-- id: 'notify-cloud-opsgenie'
157
+ 2. Click on the **Alerts & Notifications** tab
158
+ 3. Click on the **+ Add configuration** button
159
+ 4. Add the Slack Integration
160
+ 5. A modal will be presented to you to enter the required details to enable the integration:
161
+ - **Notification settings**
162
+ - Configuration name (optional): A name for your configuration in order to easily refer to it
163
+ - Rooms: A list of Rooms for which you want to be notified
164
+ - Notifications: The notifications which you want to be notified
165
+ - **Integration configuration**
166
+ - Webhook URL: URL provided on Slack for the channel you want to receive your notifications
167
+
168
+- id: "notify-cloud-opsgenie"
169
meta:
172
- name: 'Opsgenie'
173
- link: 'https://www.atlassian.com/software/opsgenie'
170
+ name: "Opsgenie"
171
+ link: "https://www.atlassian.com/software/opsgenie"
172
categories:
173
- notify.cloud
176
- icon_filename: 'opsgenie.png'
174
+ icon_filename: "opsgenie.png"
175
keywords:
176
- opsgenie
177
- atlassian
178
overview:
181
- notification_description: "From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on Opsgenie."
182
- notification_limitations: ''
179
+ notification_description: "From the Netdata Cloud UI, you can configure notification delivery to Opsgenie."
180
+ notification_limitations: ""
181
setup:
182
description: |
183
### Prerequisites
184
185
- A Netdata Cloud account
188
- - Access to the Netdata Space as an **Admin**
189
- - The Netdata Space needs to be on a paid plan
186
+ - Access to the Space as an **Admin**
187
+ - The Space needs to be on a paid plan
188
- You need to have permissions on Opsgenie to add new integrations.
189
190
### Opsgenie Server Configuration
191
194
- Steps to configure your Opsgenie to receive notifications from Netdata:
195
-
196
- 1. Go to integrations tab of your team, click **Add integration**
197
- 2. Pick **API** from available integrations. Copy your API Key and press **Save Integration**.
198
- 3. Paste copied API key into the corresponding field in **Integration configuration** section of Opsgenie modal window in Netdata.
192
+ 1. Go to the integrations tab of your team, click **Add integration**
193
+ 2. Pick **API** from the available integrations and copy the API Key in order to add it to your integration configuration in the Netdata Cloud UI
194
200
- ### Netdata Configuration Steps
195
+ ### Netdata Configuration
196
197
1. Click on the **Space settings** cog (located above your profile icon)
203
- 2. Click on the **Notification** tab
204
- 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
205
- 4. On the **Opsgenie** card click on **+ Add**
206
- 5. A modal will be presented to you to enter the required details to enable the configuration:
207
- * **Notification settings** are Netdata specific settings
208
- - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
209
- - 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
210
- - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
211
- * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Opsgenie:
212
- - API Key - a key provided on Opsgenie for the channel you want to receive your notifications.
213
-
214
-- id: 'notify-cloud-mattermost'
198
+ 2. Click on the **Alerts & Notifications** tab
199
+ 3. Click on the **+ Add configuration** button
200
+ 4. Add the Opsgenie Integration
201
+ 5. A modal will be presented to you to enter the required details to enable the integration:
202
+ - **Notification settings**
203
+ - Configuration name (optional): A name for your configuration in order to easily refer to it
204
+ - Rooms: A list of Rooms for which you want to be notified
205
+ - Notifications: The notifications which you want to be notified
206
+ - **Integration configuration**
207
+ - API Key: The key provided on Opsgenie for the channel you want to receive your notifications
208
+
209
+- id: "notify-cloud-mattermost"
210
meta:
216
- name: 'Mattermost'
217
- link: 'https://mattermost.com/'
211
+ name: "Mattermost"
212
+ link: "https://mattermost.com/"
213
categories:
214
- notify.cloud
220
- icon_filename: 'mattermost.png'
215
+ icon_filename: "mattermost.png"
216
keywords:
217
- mattermost
218
overview:
224
- notification_description: "From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on Mattermost."
225
- notification_limitations: ''
219
+ notification_description: "From the Netdata Cloud UI, you can configure notification delivery to Mattermost."
220
+ notification_limitations: ""
221
setup:
222
description: |
223
### Prerequisites
224
225
- A Netdata Cloud account
231
- - Access to the Netdata Space as an **Admin**
232
- - The Netdata Space needs to be on a paid plan
226
+ - Access to the Space as an **Admin**
227
+ - The Space needs to be on a paid plan
228
- You need to have permissions on Mattermost to add new integrations.
234
- - You need to have a Mattermost app on your workspace to receive the webhooks.
229
230
### Mattermost Server Configuration
231
238
- Steps to configure your Mattermost to receive notifications from Netdata:
239
-
232
1. In Mattermost, go to Product menu > Integrations > Incoming Webhook
241
- - If you don’t have the Integrations option, incoming webhooks may not be enabled on your Mattermost server or may be disabled for non-admins. They can be enabled by a System Admin from System Console > Integrations > Integration Management. Once incoming webhooks are enabled, continue with the steps below.
242
- 2. Select Add Incoming Webhook and add a name and description for the webhook. The description can be up to 500 characters
233
+ - If you don't have the Integrations option, incoming webhooks may not be enabled on your Mattermost server or may be disabled for non-admins. They can be enabled by a System Admin from System Console > Integrations > Integration Management. Once incoming webhooks are enabled, continue with the steps below.
234
+ 2. Select Add Incoming Webhook and add a name and description for the webhook.
235
3. Select the channel to receive webhook payloads, then select Add to create the webhook
244
- 4. You will end up with a webhook endpoint that looks like below:
245
- `https://your-mattermost-server.com/hooks/xxx-generatedkey-xxx`
246
-
247
- - Treat this endpoint as a secret. Anyone who has it will be able to post messages to your Mattermost instance.
236
+ 4. You will end up with a webhook URL that looks like `https://your-mattermost-server.com/hooks/xxx-generatedkey-xxx`, copy it in order to add it to your integration configuration in the Netdata Cloud UI
237
249
- For more details please check Mattermost's article [Incoming webhooks for Mattermost](https://developers.mattermost.com/integrate/webhooks/incoming/).
238
+ For more details please check [Incoming webhooks for Mattermost](https://developers.mattermost.com/integrate/webhooks/incoming/).
239
251
- ### Netdata Configuration Steps
240
+ ### Netdata Configuration
241
242
1. Click on the **Space settings** cog (located above your profile icon)
254
- 2. Click on the **Notification** tab
255
- 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
256
- 4. On the **Mattermost** card click on **+ Add**
257
- 5. A modal will be presented to you to enter the required details to enable the configuration:
258
- * **Notification settings** are Netdata specific settings
259
- - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
260
- - 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
261
- - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
262
- * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Mattermost:
263
- - Webhook URL - URL provided on Mattermost for the channel you want to receive your notifications
264
-
265
-- id: 'notify-cloud-rocketchat'
243
+ 2. Click on the **Alerts & Notifications** tab
244
+ 3. Click on the **+ Add configuration** button
245
+ 4. Add the Mattermost Integration
246
+ 5. A modal will be presented to you to enter the required details to enable the integration:
247
+ - **Notification settings**
248
+ - Configuration name (optional): A name for your configuration in order to easily refer to it
249
+ - Rooms: A list of Rooms for which you want to be notified
250
+ - Notifications: The notifications which you want to be notified
251
+ - **Integration configuration**
252
+ - Webhook URL: URL provided on Mattermost for the channel you want to receive your notifications
253
+
254
+- id: "notify-cloud-rocketchat"
255
meta:
267
- name: 'RocketChat'
268
- link: 'https://www.rocket.chat/'
256
+ name: "RocketChat"
257
+ link: "https://www.rocket.chat/"
258
categories:
259
- notify.cloud
271
- icon_filename: 'rocketchat.png'
260
+ icon_filename: "rocketchat.png"
261
keywords:
262
- rocketchat
263
overview:
275
- notification_description: "From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on RocketChat."
276
- notification_limitations: ''
264
+ notification_description: "From the Netdata Cloud UI, you can configure notification delivery to RocketChat."
265
+ notification_limitations: ""
266
setup:
267
description: |
268
### Prerequisites
269
270
- A Netdata Cloud account
282
- - Access to the Netdata Space as an **Admin**
283
- - The Netdata Space needs to be on a paid plan
284
- - You need to have permissions on Mattermost to add new integrations.
285
- - You need to have a RocketChat app on your workspace to receive the webhooks.
286
-
287
- ### Mattermost Server Configuration
271
+ - Access to the Space as an **Admin**
272
+ - The Space needs to be on a paid plan
273
+ - You need to have permissions on RocketChat to add new integrations.
274
289
- Steps to configure your RocketChat to receive notifications from Netdata:
275
+ ### RocketChat Server Configuration
276
291
- 1. In RocketChat, Navigate to Administration > Workspace > Integrations.
292
- 2. Click **+New** at the top right corner.
293
- 3. For more details about each parameter, check [create-a-new-incoming-webhook](https://docs.rocket.chat/use-rocket.chat/workspace-administration/integrations#create-a-new-incoming-webhook).
294
- 4. After configuring integration, click Save.
295
- 5. You will end up with a webhook endpoint that looks like below:
296
- `https://your-server.rocket.chat/hooks/YYYYYYYYYYYYYYYYYYYYYYYY/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX`
297
- - Treat this endpoint as a secret. Anyone who has it will be able to post messages to your RocketChat instance.
277
+ Steps to configure your RocketChat server to receive notifications from Netdata Cloud:
278
279
+ 1. In RocketChat, Navigate to Administration > Workspace > Integrations
280
+ 2. Click **+New** at the top right corner
281
+ 3. For more details about each parameter, check [Create a new incoming webhook](https://docs.rocket.chat/use-rocket.chat/workspace-administration/integrations#create-a-new-incoming-webhook)
282
+ 4. You will end up with a webhook endpoint that looks like `https://your-server.rocket.chat/hooks/YYYYYYYYYYYYYYYYYYYYYYYY/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX`, copy it in order to add it to your integration configuration in the Netdata Cloud UI
283
300
- For more details please check RocketChat's article Incoming webhooks for [RocketChat](https://docs.rocket.chat/use-rocket.chat/workspace-administration/integrations/).
284
+ For more details please check [Incoming webhooks for RocketChat](https://docs.rocket.chat/use-rocket.chat/workspace-administration/integrations/).
285
302
- ### Netdata Configuration Steps
286
+ ### Netdata Configuration
287
288
1. Click on the **Space settings** cog (located above your profile icon)
305
- 2. Click on the **Notification** tab
306
- 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
307
- 4. On the **RocketChat** card click on **+ Add**
308
- 5. A modal will be presented to you to enter the required details to enable the configuration:
309
- * **Notification settings** are Netdata specific settings
310
- - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
311
- - 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
312
- - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
313
- * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For RocketChat:
314
- - Webhook URL - URL provided on RocketChat for the channel you want to receive your notifications.
315
-
316
-- id: 'notify-cloud-awssns'
289
+ 2. Click on the **Alerts & Notifications** tab
290
+ 3. Click on the **+ Add configuration** button
291
+ 4. Add the PagerDuty Integration
292
+ 5. A modal will be presented to you to enter the required details to enable the integration:
293
+ - **Notification settings**
294
+ - Configuration name (optional): A name for your configuration in order to easily refer to it
295
+ - Rooms: A list of Rooms for which you want to be notified
296
+ - Notifications: The notifications which you want to be notified
297
+ - **Integration configuration**
298
+ - Webhook URL: URL provided on RocketChat for the channel you want to receive your notifications
299
+
300
+- id: "notify-cloud-awssns"
301
meta:
318
- name: 'Amazon SNS'
319
- link: 'https://aws.amazon.com/sns/'
302
+ name: "Amazon SNS"
303
+ link: "https://aws.amazon.com/sns/"
304
categories:
305
- notify.cloud
322
- icon_filename: 'awssns.png'
306
+ icon_filename: "awssns.png"
307
keywords:
308
- awssns
309
overview:
326
- notification_description: "From the Cloud interface, you can manage your space's notification settings and from these you can add a specific configuration to get notifications delivered on AWS SNS."
327
- notification_limitations: ''
310
+ notification_description: "From the Netdata Cloud UI, you can configure notification delivery to AWS SNS."
311
+ notification_limitations: ""
312
setup:
313
description: |
314
### Prerequisites
315
332
- To add AWS SNS notification you need:
333
-
316
- A Netdata Cloud account
317
- Access to the space as an **Admin**
318
- The Space needs to be on a paid plan
337
- - Have an AWS account with AWS SNS access, for more details check [how to configure this on AWS SNS](#settings-on-aws-sns)
319
+ - An AWS account with AWS SNS access
320
339
- ### Steps
321
+ ### AWS SNS Configuration
322
341
- 1. Click on the **Space settings** cog (located above your profile icon)
342
- 2. Click on the **Notification** tab
343
- 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
344
- 4. On the **AwsSns** card click on **+ Add**
345
- 5. A modal will be presented to you to enter the required details to enable the configuration:
346
- * **Notification settings** are Netdata specific settings
347
- - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
348
- - 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
349
- - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
350
- * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For AWS SNS:
351
- - Topic ARN - topic provided on AWS SNS (with region) for where to publish your notifications. For more details check [how to configure this on AWS SNS](#settings-on-aws-sns)
352
-
353
- ### Settings on AWS SNS
354
-
355
- To enable the webhook integration on AWS SNS you need:
323
1. [Setting up access for Amazon SNS](https://docs.aws.amazon.com/sns/latest/dg/sns-setting-up.html)
324
2. Create a topic
325
- On AWS SNS management console click on **Create topic**
359
- - On the **Details** section, the standard type and provide the topic name
326
+ - On the **Details** section, select the standard type and provide the topic name
327
- On the **Access policy** section, change the **Publishers** option to **Only the specified AWS accounts** and provide the Netdata AWS account **(123269920060)** that will be used to publish notifications to the topic being created
361
- - Finally, click on **Create topic** on the bottom of the page
362
- 3. Now, use the new **Topic ARN** while adding AWS SNS integration on your space.
328
+ 3. Copy the **Topic ARN** in order to add it to your integration configuration in the Netdata Cloud UI
329
364
-- id: 'notify-cloud-microsoftteams'
330
+ ### Netdata Configuration
331
+
332
+ 1. Click on the **Space settings** cog (located above your profile icon)
333
+ 2. Click on the **Alerts & Notifications** tab
334
+ 3. Click on the **+ Add configuration** button
335
+ 4. Add the AWS SNS Integration
336
+ 5. A modal will be presented to you to enter the required details to enable the integration:
337
+ - **Notification settings**
338
+ - Configuration name (optional): A name for your configuration in order to easily refer to it
339
+ - Rooms: A list of Rooms for which you want to be notified
340
+ - Notifications: The notifications which you want to be notified
341
+ - **Integration configuration**
342
+ - Topic ARN: The topic provided on AWS SNS (with region) for where to publish your notifications.
343
+
344
+- id: "notify-cloud-microsoftteams"
345
meta:
366
- name: 'Microsoft Teams'
367
- link: 'https://www.microsoft.com/en-us/microsoft-teams'
346
+ name: "Microsoft Teams"
347
+ link: "https://www.microsoft.com/en-us/microsoft-teams"
348
categories:
349
- notify.cloud
370
- icon_filename: 'teams.svg'
350
+ icon_filename: "teams.svg"
351
keywords:
352
- microsoft
353
- teams
354
overview:
375
- notification_description: "From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications to a Microsoft Teams channel."
376
- notification_limitations: ''
355
+ notification_description: "From the Netdata Cloud UI, you can configure notification delivery to a Microsoft Teams channel."
356
+ notification_limitations: ""
357
setup:
358
description: |
359
### Prerequisites
360
381
- To add Microsoft Teams notifications integration to your Netdata Cloud space you will need the following:
382
-
383
- - A Netdata Cloud account.
384
- - Access to the Netdata Cloud space as an **Admin**.
385
- - The Space to be on a paid plan.
386
- - A [Microsoft Teams Essentials subscription](https://www.microsoft.com/en-sg/microsoft-teams/essentials) or higher. Note that this is a **paid** feature.
387
-
388
- ### Settings on Microsoft Teams
361
+ - A Netdata Cloud account
362
+ - Access to the Space as an **Admin**
363
+ - The Space needs to be on a paid plan
364
+ - A [Microsoft Teams Essentials subscription](https://www.microsoft.com/en-sg/microsoft-teams/essentials) or higher. Note that this is a **paid** feature
365
390
- 1. **Access the Channel Settings**: Navigate to the desired Microsoft Teams channel and hover over the channel name. Click the three dots (ellipsis) icon that appears.
391
- 2. **Create a New Workflow**: Select "Workflows" from the options, then choose "Post to a channel when a webhook request is received."
392
- 3. **Configure Workflow Details**:
393
- - Give your workflow a descriptive name, such as "Netdata Alerts."
394
- - Select the target team and channel to receive notifications.
395
- - Click "Add workflow."
396
- 4. **Obtain the Webhook URL**:
397
- - Once the workflow is created, you will receive a unique Workflow Webhook URL.
398
- - Copy this URL, as it will be required to configure Netdata Cloud.
366
+ ### Microsoft Teams Configuration
367
400
- ### Settings on Netdata Cloud
368
+ 1. Navigate to the desired Microsoft Teams channel and hover over the channel name. Click the three dots icon that appears
369
+ 2. Select "Workflows" from the options, then choose "Post to a channel when a webhook request is received"
370
+ 3. **Configure Workflow Details**
371
+ - Give your workflow a name, such as "Netdata Alerts"
372
+ - Select the target team and channel where you will receive notifications
373
+ - Click "Add workflow"
374
+ 4. Once the workflow is created, you will receive a unique Workflow Webhook URL, copy it, in order to add it to your integration configuration in the Netdata Cloud UI
375
402
- 1. Click on the **Space settings** cog (located above your profile icon).
403
- 2. Click on the **Notification** tab.
404
- 3. Click on the **+ Add configuration** button (near the top-right corner of your screen).
405
- 4. On the **Microsoft Teams** card click on **+ Add**.
406
- 5. A modal will be presented to you to enter the required details to enable the configuration:
407
- * **Notification settings** are Netdata specific settings:
408
- - Configuration name - you can optionally provide a name for your configuration you can easily refer to it.
409
- - 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.
410
- - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only.
411
- * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Microsoft Teams:
412
- - Microsoft Teams Incoming Webhook URL - the _Incoming Webhook URL_ that was generated earlier.
376
+ ### Netdata Configuration
377
414
-
415
-- id: 'notify-cloud-telegram'
378
+ 1. Click on the **Space settings** cog (located above your profile icon)
379
+ 2. Click on the **Alerts & Notifications** tab
380
+ 3. Click on the **+ Add configuration** button
381
+ 4. Add the Microsoft Teams Integration
382
+ 5. A modal will be presented to you to enter the required details to enable the integration:
383
+ - **Notification settings**
384
+ - Configuration name (optional): A name for your configuration in order to easily refer to it
385
+ - Rooms: A list of Rooms for which you want to be notified
386
+ - Notifications: The notifications which you want to be notified
387
+ - **Integration configuration**
388
+ - Microsoft Teams Incoming Webhook URL: The Incoming Webhook URL that you copied earlier.
389
+
390
+- id: "notify-cloud-telegram"
391
meta:
417
- name: 'Telegram'
418
- link: 'https://telegram.org/'
392
+ name: "Telegram"
393
+ link: "https://telegram.org/"
394
categories:
395
- notify.cloud
421
- icon_filename: 'telegram.svg'
396
+ icon_filename: "telegram.svg"
397
keywords:
398
- Telegram
399
overview:
425
- notification_description: "From the Cloud interface, you can manage your space's notification settings and from these you can add a specific configuration to get notifications delivered on Telegram."
426
- notification_limitations: ''
400
+ notification_description: "From the Netdata Cloud UI, you can configure notification delivery to Telegram."
401
+ notification_limitations: ""
402
setup:
403
description: |
404
### Prerequisites
405
431
- To add Telegram notification you need:
432
-
406
- A Netdata Cloud account
434
- - Access to the space as an **Admin**
407
+ - Access to the Space as an **Admin**
408
- The Space needs to be on a paid plan
436
- - The Telegram bot token, chat ID and _optionally_ the topic ID
437
-
438
- ### Steps
439
-
440
- 1. Click on the **Space settings** cog (located above your profile icon)
441
- 2. Click on the **Notification** tab
442
- 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
443
- 4. On the **Telegram** card click on **+ Add**
444
- 5. A modal will be presented to you to enter the required details to enable the configuration:
445
- - **Notification settings** are Netdata specific settings
446
- - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
447
- - 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
448
- - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
449
- - **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Telegram:
450
- - Bot Token - the token of your bot
451
- - Chat ID - the chat id where your bot will deliver messages to
452
- - Topic ID - the identifier of the chat topic to which your bot will send messages. If omitted or 0, messages will be sent to the General topic. If topics are not supported, messages will be sent to the chat.
409
+ - The Telegram bot token, chat ID and optionally the topic ID
410
454
- ### Getting the Telegram bot token, chat ID and topic ID
411
+ ### Telegram Configuration
412
413
- Bot token: To create one bot, contact the [@BotFather](https://t.me/BotFather) bot and send the command `/newbot` and follow the instructions. **Start a conversation with your bot or invite it into the group where you want it to send notifications**.
414
- To get the chat ID you have two options:
415
- Contact the [@myidbot](https://t.me/myidbot) bot and send the `/getid` command to get your personal chat ID, or invite it into a group and use the `/getgroupid` command to get the group chat ID.
416
- Alternatively, you can get the chat ID directly from the bot API. Send your bot a command in the chat you want to use, then check `https://api.telegram.org/bot{YourBotToken}/getUpdates`, eg. `https://api.telegram.org/bot111122223:7OpFlFFRzRBbrUUmIjj5HF9Ox2pYJZy5/getUpdates`
417
- To get the topic ID, the easiest way is this: Post a message to that topic, then right-click on it and select `Copy Message Link`. Paste it on a scratchpad and notice that it has the following structure `https://t.me/c/XXXXXXXXXX/YY/ZZ`. The topic ID is `YY` (integer).
461
-- id: 'notify-cloud-splunk'
462
- meta:
463
- name: 'Splunk'
464
- link: 'https://splunk.com/'
465
- categories:
466
- - notify.cloud
467
- icon_filename: 'splunk-black.svg'
468
- keywords:
469
- - Splunk
470
- overview:
471
- notification_description: "From the Cloud interface, you can manage your space's notification settings and from these you can add a specific configuration to get notifications delivered on Splunk."
472
- notification_limitations: ''
473
- setup:
474
- description: |
475
- ### Prerequisites
418
477
- To add Splunk notification you need:
478
-
479
- - A Netdata Cloud account
480
- - Access to the space as an **Admin**
481
- - The Space needs to be on a paid plan
482
- - URI and token for your Splunk HTTP Event Collector. Refer to the [Splunk documentation](https://docs.splunk.com/Documentation/Splunk/latest/Data/UsetheHTTPEventCollector) for detailed instructions.
483
-
484
- ### Steps
419
+ ### Netdata Configuration
420
421
1. Click on the **Space settings** cog (located above your profile icon)
487
- 2. Click on the **Notification** tab
488
- 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
489
- 4. On the **Splunk** card click on **+ Add**
490
- 5. A modal will be presented to you to enter the required details to enable the configuration:
491
- - **Notification settings** are Netdata specific settings
492
- - Configuration name - provide a descriptive name for your configuration to easily identify it.
493
- - Rooms - select the nodes or areas of your infrastructure you want to receive notifications about.
494
- - Notification - choose the type of notifications you want to receive: All Alerts and unreachable, All Alerts, Critical only.
495
- - **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Splunk:
496
- - HTTP Event Collector URI - The URI of your HTTP event collector in Splunk
497
- - HTTP Event Collector Token - the token that Splunk provided to you when you created the HTTP Event Collector
498
-
499
-- id: 'notify-cloud-victorops'
422
+ 2. Click on the **Alerts & Notifications** tab
423
+ 3. Click on the **+ Add configuration** button
424
+ 4. Add the Telegram Integration
425
+ 5. A modal will be presented to you to enter the required details to enable the integration:
426
+ - **Notification settings**
427
+ - Configuration name (optional): A name for your configuration in order to easily refer to it
428
+ - Rooms: A list of Rooms for which you want to be notified
429
+ - Notifications: The notifications which you want to be notified
430
+ - **Integration configuration**
431
+ - Bot Token: The token of your bot
432
+ - Chat ID: The chat id where your bot will deliver messages to
433
+ - Topic ID: The identifier of the chat topic to which your bot will send messages. If omitted or 0, messages will be sent to the General topic. If topics are not supported, messages will be sent to the chat.
434
+
435
+- id: "notify-cloud-splunk"
436
meta:
501
- name: 'Splunk VictorOps'
502
- link: 'https://www.splunk.com/en_us/about-splunk/acquisitions/splunk-on-call.html'
437
+ name: "Splunk"
438
+ link: "https://splunk.com/"
439
categories:
440
- notify.cloud
505
- icon_filename: 'victorops.svg'
441
+ icon_filename: "splunk-black.svg"
442
keywords:
507
- - VictorOps
443
- Splunk
509
- - On-Call
444
overview:
511
- notification_description: "From the Cloud interface, you can manage your space's notification settings and from there you can add a specific configuration to get notifications delivered on Splunk On-Call/VictorOps."
512
- notification_limitations: ''
445
+ notification_description: "From the Netdata Cloud UI, you can configure notification delivery to Splunk."
446
+ notification_limitations: ""
447
setup:
448
description: |
449
### Prerequisites
450
517
- To add Splunk VictorOps notification (also known as Splunk On-Call) you need:
518
-
451
- A Netdata Cloud account
520
- - Access to the space as an **Admin**
452
+ - Access to the Space as an **Admin**
453
- The Space needs to be on a paid plan
522
- - Destination URL for your Splunk VictorOps REST Endpoint Integration. Refer to the [VictorOps documentation](https://help.victorops.com/knowledge-base/rest-endpoint-integration-guide) for detailed instructions.
454
+ - The URI and token for your Splunk HTTP Event Collector. Refer to the [Splunk documentation](https://docs.splunk.com/Documentation/Splunk/latest/Data/UsetheHTTPEventCollector) for detailed instructions on how to set it up.
455
524
- ### Steps
456
+ ### Netdata Configuration
457
458
1. Click on the **Space settings** cog (located above your profile icon)
527
- 2. Click on the **Notification** tab
528
- 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
529
- 4. On the **Splunk VictorOps** card click on **+ Add**
530
- 5. A modal will be presented to you to enter the required details to enable the configuration:
531
- - **Notification settings** are Netdata specific settings
532
- - Configuration name - provide a descriptive name for your configuration to easily identify it.
533
- - Rooms - select the nodes or areas of your infrastructure you want to receive notifications about.
534
- - Notification - choose the type of notifications you want to receive: All Alerts and unreachable, All Alerts, Critical only.
535
- - **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Splunk VictorOps:
536
- - Destination URL - The URL provided by VictorOps of your REST endpoint.
537
-
538
-- id: 'notify-cloud-ilert'
459
+ 2. Click on the **Alerts & Notifications** tab
460
+ 3. Click on the **+ Add configuration** button
461
+ 4. Add the Splunk Integration
462
+ 5. A modal will be presented to you to enter the required details to enable the integration:
463
+ - **Notification settings**
464
+ - Configuration name (optional): A name for your configuration in order to easily refer to it
465
+ - Rooms: A list of Rooms for which you want to be notified
466
+ - Notifications: The notifications which you want to be notified
467
+ - **Integration configuration**
468
+ - HTTP Event Collector URI: The URI of your HTTP event collector in Splunk
469
+ - HTTP Event Collector Token: The token that Splunk provided to you when you created the HTTP Event Collector
470
+
471
+- id: "notify-cloud-victorops"
472
meta:
540
- name: 'Ilert'
541
- link: 'https://www.ilert.com/'
473
+ name: "Splunk VictorOps"
474
+ link: "https://www.splunk.com/en_us/about-splunk/acquisitions/splunk-on-call.html"
475
categories:
476
- notify.cloud
544
- icon_filename: 'ilert.svg'
477
+ icon_filename: "victorops.svg"
478
keywords:
546
- - ilert
479
+ - VictorOps
480
+ - Splunk
481
+ - On-Call
482
overview:
548
- notification_description: "From the Cloud interface, you can manage your space's notification settings and from there you can add a specific configuration to get notifications delivered on ilert."
549
- notification_limitations: ''
483
+ notification_description: "From the Netdata Cloud UI, you can configure notification delivery to Splunk On-Call/VictorOps."
484
+ notification_limitations: ""
485
setup:
486
description: |
487
### Prerequisites
488
554
- To add ilert notification you need:
555
-
489
- A Netdata Cloud account
557
- - Access to the space as an **Admin**
490
+ - Access to the Space as an **Admin**
491
- The Space needs to be on a paid plan
559
- - You need to have permissions on ilert to add new Alert sources.
560
-
561
- ### Settings on ilert
492
+ - The Destination URL for your Splunk VictorOps REST Endpoint Integration. Refer to the [VictorOps documentation](https://help.victorops.com/knowledge-base/rest-endpoint-integration-guide) for detailed instructions.
493
563
- 1. **Access the Alert sources Settings**: From the navigation bar, open the Alert sources drop down and click "Alert sources".
564
- 2. **Create a New Alert source**: Click on the "+ Create a new alert source" button.
565
- 3. **Configure an Alert source**:
566
- - select "API integration" and click Next
567
- - provide a name that suits the source's purpose, for example Netdata
568
- - select Escalation policy
569
- - select Alert grouping (optional)
570
- - review all configurations and click "Finish setup"
571
- 4. **Obtain the API Key**:
572
- - Once the Alert source is created, you will be provided with an API key.
573
- - Copy this API Key, as it will be required to configure the integration on Netdata Cloud.
574
-
575
- ### Settings on Netdata Cloud
494
+ ### Netdata Configuration
495
496
1. Click on the **Space settings** cog (located above your profile icon)
497
2. Click on the **Alerts & Notifications** tab
498
3. Click on the **+ Add configuration** button
580
- 4. Click on **+ Add** on the **ilert** card
581
- 5. A modal will be presented in order to enter the required details to enable the configuration:
582
-
583
- - **Notification settings** are Netdata specific settings
584
- - Configuration name: provide a descriptive name for your configuration to easily identify it.
585
- - Rooms: select the nodes or areas of your infrastructure you want to receive notifications about.
586
- - Notification: choose the type of notifications you want to receive.
587
- - **Integration configuration** are the required integration settings, which vary by notification method. For ilert:
588
- - Alert Source API key.
589
-
590
-- id: 'notify-cloud-webhook'
499
+ 4. Add the Splunk VictorOps Integration
500
+ 5. A modal will be presented to you to enter the required details to enable the integration:
501
+ - **Notification settings**
502
+ - Configuration name (optional): A name for your configuration in order to easily refer to it
503
+ - Rooms: A list of Rooms for which you want to be notified
504
+ - Notifications: The notifications which you want to be notified
505
+ - **Integration configuration**
506
+ - Destination URL - The URL provided by VictorOps of your REST endpoint.
507
+
508
+- id: "notify-cloud-webhook"
509
meta:
592
- name: 'Webhook'
593
- link: 'https://en.wikipedia.org/wiki/Webhook'
510
+ name: "Webhook"
511
+ link: "https://en.wikipedia.org/wiki/Webhook"
512
categories:
513
- notify.cloud
596
- icon_filename: 'webhook.svg'
514
+ icon_filename: "webhook.svg"
515
keywords:
516
- generic webhooks
517
- webhooks
518
overview:
601
- notification_description: "From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on a webhook using a predefined schema."
602
- notification_limitations: ''
519
+ notification_description: "From the Netdata Cloud UI, you can configure notification delivery to a webhook using a predefined schema."
520
+ notification_limitations: ""
521
setup:
522
description: |
523
### Prerequisites
524
525
- A Netdata Cloud account
608
- - Access to the Netdata Space as an **Admin**
609
- - The Netdata Space needs to be on a paid plan
526
+ - Access to the Space as an **Admin**
527
+ - The Space needs to be on a paid plan
528
- You need to have an app that allows you to receive webhooks following a predefined schema.
529
612
- ### Netdata Configuration Steps
530
+ ### Netdata Configuration
531
532
1. Click on the **Space settings** cog (located above your profile icon)
615
- 2. Click on the **Notification** tab
616
- 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
617
- 4. On the **Webhook** card click on **+ Add**
533
+ 2. Click on the **Alerts & Notifications** tab
534
+ 3. Click on the **+ Add configuration** button
535
+ 4. Add the Webhook integration
536
5. A modal will be presented to you to enter the required details to enable the configuration:
619
- * **Notification settings** are Netdata specific settings
620
- - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
621
- - 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
622
- - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
623
- * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Webhook:
624
- - Webhook URL - webhook URL is the url of the service that Netdata will send notifications to. In order to keep the communication secured, we only accept HTTPS urls.
625
- - Extra headers - these are optional key-value pairs that you can set to be included in the HTTP requests sent to the webhook URL.
626
- - Authentication Mechanism - Netdata webhook integration supports 3 different authentication mechanisms.
627
- * Mutual TLS (recommended) - default authentication mechanism used if no other method is selected.
628
- * Basic - the client sends a request with an Authorization header that includes a base64-encoded string in the format **username:password**. These will settings will be required inputs.
629
- * Bearer - the client sends a request with an Authorization header that includes a **bearer token**. This setting will be a required input.
630
-
537
+ - **Notification settings**
538
+ - Configuration name (optional): A name for your configuration in order to easily refer to it
539
+ - Rooms: A list of Rooms for which you want to be notified
540
+ - Notifications: The notifications which you want to be notified
541
+ - **Integration configuration**
542
+ - Webhook URL: The url of the service that Netdata will send notifications to. In order to keep the communication secured, Netdata only accepts HTTPS urls.
543
+ - Extra headers: Optional key-value pairs that you can set to be included in the HTTP requests sent to the webhook URL.
544
+ - Authentication Mechanism, Netdata webhook integration supports 3 different authentication mechanisms.
545
+ - Mutual TLS (recommended): Default authentication mechanism used if no other method is selected
546
+ - Basic: The client sends a request with an Authorization header that includes a base64-encoded string in the format **username:password**.
547
+ - Bearer: The client sends a request with an Authorization header that includes a **bearer token**.
548
632
- ### Webhook service
549
+ ### Webhook service
550
634
- A webhook integration allows your application to receive real-time alerts from Netdata by sending HTTP requests to a specified URL. In this document, we'll go over the steps to set up a generic webhook integration, including adding headers, and implementing different types of authorization mechanisms.
551
+ A webhook service allows your application to receive real-time alerts from Netdata by sending HTTP requests to a specified URL.
552
636
- #### Netdata webhook integration
553
+ In this section, we'll go over the steps to set up a generic webhook service, including adding headers, and implementing different types of authorization mechanisms.
554
638
- A webhook integration is a way for one service to notify another service about events that occur within it. This is done by sending an HTTP POST request to a specified URL (known as the "webhook URL") when an event occurs.
555
+ #### Netdata webhook integration
556
640
- Netdata webhook integration service will send alert and reachability notifications to the destination service as soon as they are detected.
557
+ Netdata webhook integration service will send alert and reachability notifications to the destination service as soon as they are detected.
558
642
- For alert notifications, the content sent to the destination service contains a JSON object with the following properties:
559
+ For alert notifications, the content sent to the destination service contains a JSON object with the following properties:
560
644
- | field | type | description |
645
- | :-- | :-- | :-- |
646
- | message | string | A summary message of the alert. |
647
- | alarm | string | The alarm the notification is about. |
648
- | info | string | Additional info related with the alert. |
649
- | chart | string | The chart associated with the alert. |
650
- | context | string | The chart context. |
651
- | space | string | The space where the node that raised the alert is assigned. |
652
- | Rooms | object[object(string,string)] | Object with list of Rooms names and urls where the node belongs to. |
653
- | family | string | Context family. |
654
- | class | string | Classification of the alert, e.g. "Error". |
655
- | severity | string | Alert severity, can be one of "warning", "critical" or "clear". |
656
- | date | string | Date of the alert in ISO8601 format. |
657
- | duration | string | Duration the alert has been raised. |
658
- | additional_active_critical_alerts | integer | Number of additional critical alerts currently existing on the same node. |
659
- | additional_active_warning_alerts | integer | Number of additional warning alerts currently existing on the same node. |
660
- | alarm_url | string | Netdata Cloud URL for this alarm. |
561
+ | field | type | description |
562
+ |:----------------------------------|:--------------------------------|:--------------------------------------------------------------------------|
563
+ | message | string | A summary message of the alert. |
564
+ | alert | string | The alert the notification is related to. |
565
+ | info | string | Additional info related with the alert. |
566
+ | chart | string | The chart associated with the alert. |
567
+ | context | string | The chart context. |
568
+ | space | string | The space where the node that raised the alert is assigned. |
569
+ | Rooms | object\[object(string,string)\] | Object with list of Rooms names and urls where the node belongs to. |
570
+ | family | string | Context family. |
571
+ | class | string | Classification of the alert, e.g. `Error`. |
572
+ | severity | string | Alert severity, can be one of `warning`, `critical` or `clear`. |
573
+ | date | string | Date of the alert in ISO8601 format. |
574
+ | duration | string | Duration the alert has been raised. |
575
+ | additional_active_critical_alerts | integer | Number of additional critical alerts currently existing on the same node. |
576
+ | additional_active_warning_alerts | integer | Number of additional warning alerts currently existing on the same node. |
577
+ | alert_url | string | Netdata Cloud URL for this alert. |
578
662
- For reachability notifications, the JSON object will contain the following properties:
579
+ For reachability notifications, the JSON object will contain the following properties:
580
664
- | field | type | description |
665
- | :-- | :-- | :-- |
666
- | message | string | A summary message of the reachability alert. |
667
- | url | string | Netdata Cloud URL for the host experiencing the reachability alert. |
668
- | host | string | the host experiencing the reachability alert. |
669
- | severity | string | severity for this notification. If host is reachable, severity will be 'info', if host is unreachable, it will be 'critical'. |
670
- | status | object | an object with the status information. |
671
- | status.reachable | boolean | true if host is reachable, false otherwise |
672
- | status.text | string | can be 'reachable' or 'unreachable' |
581
+ | field | type | description |
582
+ |:-----------------|:--------|:------------------------------------------------------------------------------------------------------------------------------|
583
+ | message | string | A summary message of the reachability alert. |
584
+ | url | string | Netdata Cloud URL for the host experiencing the reachability alert. |
585
+ | host | string | The hostname experiencing the reachability alert. |
586
+ | severity | string | Severity for this notification. If host is reachable, severity will be `info`, if host is unreachable, it will be `critical`. |
587
+ | status | object | An object with the status information. |
588
+ | status.reachable | boolean | `true` if host is reachable, `false` otherwise |
589
+ | status.text | string | Can be `reachable` or `unreachable` |
590
674
- #### Extra headers
591
+ #### Extra headers
592
676
- When setting up a webhook integration, the user can specify a set of headers to be included in the HTTP requests sent to the webhook URL.
593
+ When setting up a webhook service, the user can specify a set of headers to be included in the HTTP requests sent to the webhook URL.
594
678
- By default, the following headers will be sent in the HTTP request
595
+ By default, the following headers will be sent in the HTTP request
596
680
- | **Header** | **Value** |
681
- |:-------------------------------:|-----------------------------|
682
- | Content-Type | application/json |
597
+ | **Header** | **Value** |
598
+ |:------------:|------------------|
599
+ | Content-Type | application/json |
600
684
- #### Authentication mechanisms
601
+ #### Authentication mechanisms
602
686
- Netdata webhook integration supports 3 different authentication mechanisms:
603
+ Netdata webhook integration supports 3 different authentication mechanisms:
604
688
- ##### Mutual TLS authentication (recommended)
605
+ ##### Mutual TLS authentication (recommended)
606
690
- In mutual Transport Layer Security (mTLS) authentication, the client and the server authenticate each other using X.509 certificates. This ensures that the client is connecting to the intended server, and that the server is only accepting connections from authorized clients.
607
+ In mutual Transport Layer Security (mTLS) authentication, the client and the server authenticate each other using X.509 certificates. This ensures that the client is connecting to the intended server, and that the server is only accepting connections from authorized clients.
608
692
- This is the default authentication mechanism used if no other method is selected.
609
+ This is the default authentication mechanism used if no other method is selected.
610
694
- To take advantage of mutual TLS, you can configure your server to verify Netdata's client certificate. In order to achieve this, the Netdata client sending the notification supports mutual TLS (mTLS) to identify itself with a client certificate that your server can validate.
611
+ To take advantage of mutual TLS, you can configure your server to verify Netdata's client certificate. In order to achieve this, the Netdata client sending the notification supports mutual TLS (mTLS) to identify itself with a client certificate that your server can validate.
612
696
- The steps to perform this validation are as follows:
613
+ The steps to perform this validation are as follows:
614
698
- - Store Netdata CA certificate on a file in your disk. The content of this file should be:
615
+ - Store Netdata CA certificate on a file in your disk. The content of this file should be:
616
617
<details>
618
<summary>Netdata CA certificate</summary>
619
703
- ```
704
- -----BEGIN CERTIFICATE-----
705
- MIIF0jCCA7qgAwIBAgIUDV0rS5jXsyNX33evHEQOwn9fPo0wDQYJKoZIhvcNAQEN
706
- BQAwgYAxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlhMRYwFAYDVQQH
707
- Ew1TYW4gRnJhbmNpc2NvMRYwFAYDVQQKEw1OZXRkYXRhLCBJbmMuMRIwEAYDVQQL
708
- EwlDbG91ZCBTUkUxGDAWBgNVBAMTD05ldGRhdGEgUm9vdCBDQTAeFw0yMzAyMjIx
709
- MjQzMDBaFw0zMzAyMTkxMjQzMDBaMIGAMQswCQYDVQQGEwJVUzETMBEGA1UECBMK
710
- Q2FsaWZvcm5pYTEWMBQGA1UEBxMNU2FuIEZyYW5jaXNjbzEWMBQGA1UEChMNTmV0
711
- ZGF0YSwgSW5jLjESMBAGA1UECxMJQ2xvdWQgU1JFMRgwFgYDVQQDEw9OZXRkYXRh
712
- IFJvb3QgQ0EwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQCwIg7z3R++
713
- ppQYYVVoMIDlhWO3qVTMsAQoJYEvVa6fqaImUBLW/k19LUaXgUJPohB7gBp1pkjs
714
- QfY5dBo8iFr7MDHtyiAFjcQV181sITTMBEJwp77R4slOXCvrreizhTt1gvf4S1zL
715
- qeHBYWEgH0RLrOAqD0jkOHwewVouO0k3Wf2lEbCq3qRk2HeDvkv0LR7sFC+dDms8
716
- fDHqb/htqhk+FAJELGRqLeaFq1Z5Eq1/9dk4SIeHgK5pdYqsjpBzOTmocgriw6he
717
- s7F3dOec1ZZdcBEAxOjbYt4e58JwuR81cWAVMmyot5JNCzYVL9e5Vc5n22qt2dmc
718
- Tzw2rLOPt9pT5bzbmyhcDuNg2Qj/5DySAQ+VQysx91BJRXyUimqE7DwQyLhpQU72
719
- jw29lf2RHdCPNmk8J1TNropmpz/aI7rkperPugdOmxzP55i48ECbvDF4Wtazi+l+
720
- 4kx7ieeLfEQgixy4lRUUkrgJlIDOGbw+d2Ag6LtOgwBiBYnDgYpvLucnx5cFupPY
721
- Cy3VlJ4EKUeQQSsz5kVmvotk9MED4sLx1As8V4e5ViwI5dCsRfKny7BeJ6XNPLnw
722
- PtMh1hbiqCcDmB1urCqXcMle4sRhKccReYOwkLjLLZ80A+MuJuIEAUUuEPCwywzU
723
- R7pagYsmvNgmwIIuJtB6mIJBShC7TpJG+wIDAQABo0IwQDAOBgNVHQ8BAf8EBAMC
724
- AQYwDwYDVR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQU9IbvOsPSUrpr8H2zSafYVQ9e
725
- Ft8wDQYJKoZIhvcNAQENBQADggIBABQ08aI31VKZs8jzg+y/QM5cvzXlVhcpkZsY
726
- 1VVBr0roSBw9Pld9SERrEHto8PVXbadRxeEs4sKivJBKubWAooQ6NTvEB9MHuGnZ
727
- VCU+N035Gq/mhBZgtIs/Zz33jTB2ju3G4Gm9VTZbVqd0OUxFs41Iqvi0HStC3/Io
728
- rKi7crubmp5f2cNW1HrS++ScbTM+VaKVgQ2Tg5jOjou8wtA+204iYXlFpw9Q0qnP
729
- qq6ix7TfLLeRVp6mauwPsAJUgHZluz7yuv3r7TBdukU4ZKUmfAGIPSebtB3EzXfH
730
- 7Y326xzv0hEpjvDHLy6+yFfTdBSrKPsMHgc9bsf88dnypNYL8TUiEHlcTgCGU8ts
731
- ud8sWN2M5FEWbHPNYRVfH3xgY2iOYZzn0i+PVyGryOPuzkRHTxDLPIGEWE5susM4
732
- X4bnNJyKH1AMkBCErR34CLXtAe2ngJlV/V3D4I8CQFJdQkn9tuznohUU/j80xvPH
733
- FOcDGQYmh4m2aIJtlNVP6+/92Siugb5y7HfslyRK94+bZBg2D86TcCJWaaZOFUrR
734
- Y3WniYXsqM5/JI4OOzu7dpjtkJUYvwtg7Qb5jmm8Ilf5rQZJhuvsygzX6+WM079y
735
- nsjoQAm6OwpTN5362vE9SYu1twz7KdzBlUkDhePEOgQkWfLHBJWwB+PvB1j/cUA3
736
- 5zrbwvQf
737
- -----END CERTIFICATE-----
738
- ```
620
+ ```text
621
+ -----BEGIN CERTIFICATE-----
622
+ MIIF0jCCA7qgAwIBAgIUDV0rS5jXsyNX33evHEQOwn9fPo0wDQYJKoZIhvcNAQEN
623
+ BQAwgYAxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlhMRYwFAYDVQQH
624
+ Ew1TYW4gRnJhbmNpc2NvMRYwFAYDVQQKEw1OZXRkYXRhLCBJbmMuMRIwEAYDVQQL
625
+ EwlDbG91ZCBTUkUxGDAWBgNVBAMTD05ldGRhdGEgUm9vdCBDQTAeFw0yMzAyMjIx
626
+ MjQzMDBaFw0zMzAyMTkxMjQzMDBaMIGAMQswCQYDVQQGEwJVUzETMBEGA1UECBMK
627
+ Q2FsaWZvcm5pYTEWMBQGA1UEBxMNU2FuIEZyYW5jaXNjbzEWMBQGA1UEChMNTmV0
628
+ ZGF0YSwgSW5jLjESMBAGA1UECxMJQ2xvdWQgU1JFMRgwFgYDVQQDEw9OZXRkYXRh
629
+ IFJvb3QgQ0EwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQCwIg7z3R++
630
+ ppQYYVVoMIDlhWO3qVTMsAQoJYEvVa6fqaImUBLW/k19LUaXgUJPohB7gBp1pkjs
631
+ QfY5dBo8iFr7MDHtyiAFjcQV181sITTMBEJwp77R4slOXCvrreizhTt1gvf4S1zL
632
+ qeHBYWEgH0RLrOAqD0jkOHwewVouO0k3Wf2lEbCq3qRk2HeDvkv0LR7sFC+dDms8
633
+ fDHqb/htqhk+FAJELGRqLeaFq1Z5Eq1/9dk4SIeHgK5pdYqsjpBzOTmocgriw6he
634
+ s7F3dOec1ZZdcBEAxOjbYt4e58JwuR81cWAVMmyot5JNCzYVL9e5Vc5n22qt2dmc
635
+ Tzw2rLOPt9pT5bzbmyhcDuNg2Qj/5DySAQ+VQysx91BJRXyUimqE7DwQyLhpQU72
636
+ jw29lf2RHdCPNmk8J1TNropmpz/aI7rkperPugdOmxzP55i48ECbvDF4Wtazi+l+
637
+ 4kx7ieeLfEQgixy4lRUUkrgJlIDOGbw+d2Ag6LtOgwBiBYnDgYpvLucnx5cFupPY
638
+ Cy3VlJ4EKUeQQSsz5kVmvotk9MED4sLx1As8V4e5ViwI5dCsRfKny7BeJ6XNPLnw
639
+ PtMh1hbiqCcDmB1urCqXcMle4sRhKccReYOwkLjLLZ80A+MuJuIEAUUuEPCwywzU
640
+ R7pagYsmvNgmwIIuJtB6mIJBShC7TpJG+wIDAQABo0IwQDAOBgNVHQ8BAf8EBAMC
641
+ AQYwDwYDVR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQU9IbvOsPSUrpr8H2zSafYVQ9e
642
+ Ft8wDQYJKoZIhvcNAQENBQADggIBABQ08aI31VKZs8jzg+y/QM5cvzXlVhcpkZsY
643
+ 1VVBr0roSBw9Pld9SERrEHto8PVXbadRxeEs4sKivJBKubWAooQ6NTvEB9MHuGnZ
644
+ VCU+N035Gq/mhBZgtIs/Zz33jTB2ju3G4Gm9VTZbVqd0OUxFs41Iqvi0HStC3/Io
645
+ rKi7crubmp5f2cNW1HrS++ScbTM+VaKVgQ2Tg5jOjou8wtA+204iYXlFpw9Q0qnP
646
+ qq6ix7TfLLeRVp6mauwPsAJUgHZluz7yuv3r7TBdukU4ZKUmfAGIPSebtB3EzXfH
647
+ 7Y326xzv0hEpjvDHLy6+yFfTdBSrKPsMHgc9bsf88dnypNYL8TUiEHlcTgCGU8ts
648
+ ud8sWN2M5FEWbHPNYRVfH3xgY2iOYZzn0i+PVyGryOPuzkRHTxDLPIGEWE5susM4
649
+ X4bnNJyKH1AMkBCErR34CLXtAe2ngJlV/V3D4I8CQFJdQkn9tuznohUU/j80xvPH
650
+ FOcDGQYmh4m2aIJtlNVP6+/92Siugb5y7HfslyRK94+bZBg2D86TcCJWaaZOFUrR
651
+ Y3WniYXsqM5/JI4OOzu7dpjtkJUYvwtg7Qb5jmm8Ilf5rQZJhuvsygzX6+WM079y
652
+ nsjoQAm6OwpTN5362vE9SYu1twz7KdzBlUkDhePEOgQkWfLHBJWwB+PvB1j/cUA3
653
+ 5zrbwvQf
654
+ -----END CERTIFICATE-----
655
+ ```
656
+
657
</details>
658
741
- - Enable client certificate validation on the web server that is doing the TLS termination. Below we show you how to perform this configuration in `NGINX` and `Apache`
659
+ - Enable client certificate validation on the web server that is doing the TLS termination. Below there are examples on how to perform this configuration in `NGINX` and `Apache`.
660
743
- **NGINX**
661
+ **NGINX**
662
663
```bash
664
server {
@@ -754,7 +672,7 @@
672
if ($ssl_client_s_dn !~ "CN=app.netdata.cloud") {
673
return 403;
674
}
757
- # ... existing location configuration ...
675
+ # ... existing location configuration ...
676
}
677
}
678
```
@@ -774,66 +692,113 @@
692
</Directory>
693
```
694
777
- ##### Basic authentication
695
+ ##### Basic authentication
696
779
- In basic authorization, the client sends a request with an Authorization header that includes a base64-encoded string in the format username:password. The server then uses this information to authenticate the client. If this authentication method is selected, the user can set the user and password that will be used when connecting to the destination service.
697
+ In basic authorization, the client sends a request with an Authorization header that includes a base64-encoded string in the format username:password. The server then uses this information to authenticate the client. If this authentication method is selected, the user can set the user and password that will be used when connecting to the destination service.
698
781
- ##### Bearer token authentication
699
+ ##### Bearer token authentication
700
783
- In bearer token authentication, the client sends a request with an Authorization header that includes a bearer token. The server then uses this token to authenticate the client. Bearer tokens are typically generated by an authentication service, and are passed to the client after a successful authentication. If this method is selected, the user can set the token to be used for connecting to the destination service.
701
+ In bearer token authentication, the client sends a request with an Authorization header that includes a bearer token. The server then uses this token to authenticate the client. Bearer tokens are typically generated by an authentication service, and are passed to the client after a successful authentication. If this method is selected, the user can set the token to be used for connecting to the destination service.
702
785
- ##### Challenge secret
703
+ ##### Challenge secret
704
787
- To validate that you have ownership of the web application that will receive the webhook events, we are using a challenge response check mechanism.
705
+ To validate that you have ownership of the web application that will receive the webhook events, Netdata is using a challenge response check mechanism.
706
789
- This mechanism works as follows:
707
+ This mechanism works as follows:
708
791
- - The challenge secret parameter that you provide is a shared secret between you and Netdata only.
792
- - On your request for creating a new Webhook integration, we will make a GET request to the url of the webhook, adding a query parameter `crc_token`, consisting of a random string.
793
- - You will receive this request on your application and it must construct an encrypted response, consisting of a base64-encoded HMAC SHA-256 hash created from the crc_token and the shared secret. The response will be in the format:
709
+ - The challenge secret parameter that you provide is a shared secret between only you and Netdata.
710
+ - On your request for creating a new Webhook integration, Netdata will make a GET request to the URL of the webhook, adding a query parameter `crc_token`, consisting of a random string.
711
+ - You will receive this request on your application and it must construct an encrypted response, consisting of a base64-encoded HMAC SHA-256 hash created from the crc_token and the shared secret. The response will be in the format:
712
795
- ```json
796
- {
713
+ ```json
714
+ {
715
"response_token": "sha256=9GKoHJYmcHIkhD+C182QWN79YBd+D+Vkj4snmZrfNi4="
798
- }
799
- ```
716
+ }
717
+ ```
718
801
- - We will compare your application's response with the hash that we will generate using the challenge secret, and if they are the same, the integration creation will succeed.
719
+ - Netdata will compare your application's response with the hash that it will generate using the challenge secret, and if they are the same, the integration creation will succeed.
720
803
- We will do this validation everytime you update your integration configuration.
721
+ Netdata does this validation every time you update your integration configuration.
722
805
- - Response requirements:
806
- - A base64 encoded HMAC SHA-256 hash created from the crc_token and the shared secret.
807
- - Valid response_token and JSON format.
808
- - Latency less than 5 seconds.
809
- - 200 HTTP response code.
723
+ - Response requirements:
724
+ - A base64 encoded HMAC SHA-256 hash created from the crc_token and the shared secret.
725
+ - Valid response_token and JSON format.
726
+ - Latency less than 5 seconds.
727
+ - 200 HTTP response code.
728
811
- **Example response token generation in Python:**
729
+ **Example response token generation in Python:**
730
813
- Here you can see how to define a handler for a Flask application in python 3:
731
+ Here you can see how to define a handler for a Flask application in python 3:
732
815
- ```python
816
- import base64
817
- import hashlib
818
- import hmac
819
- import json
733
+ ```python
734
+ import base64
735
+ import hashlib
736
+ import hmac
737
+ import json
738
821
- key ='YOUR_CHALLENGE_SECRET'
739
+ key ='YOUR_CHALLENGE_SECRET'
740
823
- @app.route('/webhooks/netdata')
824
- def webhook_challenge():
825
- token = request.args.get('crc_token').encode('ascii')
741
+ @app.route('/webhooks/netdata')
742
+ def webhook_challenge():
743
+ token = request.args.get('crc_token').encode('ascii')
744
827
- # creates HMAC SHA-256 hash from incomming token and your consumer secret
828
- sha256_hash_digest = hmac.new(key.encode(),
829
- msg=token,
830
- digestmod=hashlib.sha256).digest()
745
+ # creates HMAC SHA-256 hash from incomming token and your consumer secret
746
+ sha256_hash_digest = hmac.new(key.encode(),
747
+ msg=token,
748
+ digestmod=hashlib.sha256).digest()
749
832
- # construct response data with base64 encoded hash
833
- response = {
834
- 'response_token': 'sha256=' + base64.b64encode(sha256_hash_digest).decode('ascii')
835
- }
750
+ # construct response data with base64 encoded hash
751
+ response = {
752
+ 'response_token': 'sha256=' + base64.b64encode(sha256_hash_digest).decode('ascii')
753
+ }
754
837
- # returns properly formatted json response
838
- return json.dumps(response)
839
- ```
755
+ # returns properly formatted json response
756
+ return json.dumps(response)
757
+ ```
758
+
759
+- id: "notify-cloud-ilert"
760
+ meta:
761
+ name: "Ilert"
762
+ link: "https://www.ilert.com/"
763
+ categories:
764
+ - notify.cloud
765
+ icon_filename: "ilert.svg"
766
+ keywords:
767
+ - ilert
768
+ overview:
769
+ notification_description: "From the Netdata Cloud UI, you can configure notification delivery to ilert."
770
+ notification_limitations: ""
771
+ setup:
772
+ description: |
773
+ ### Prerequisites
774
+
775
+ - A Netdata Cloud account
776
+ - Access to the Space as an **Admin**
777
+ - The Space needs to be on a paid plan
778
+ - You need to have permissions on ilert to add new Alert sources.
779
+
780
+ ### ilert Configuration
781
+
782
+ 1. From the navigation bar, open the Alert sources drop down and click "Alert sources"
783
+ 2. Click on the "+ Create a new alert source" button
784
+ 3. Configure an Alert source:
785
+ - Select "API integration" and click Next
786
+ - Provide a name that suits the source's purpose, for example "Netdata"
787
+ - Select Escalation policy
788
+ - Select Alert grouping (optional)
789
+ 4. Obtain the API Key:
790
+ - Once the Alert source is created, you will be provided with an API key. Copy it in order to add it to your integration configuration in the Netdata Cloud UI
791
+
792
+ ### Netdata Configuration
793
+
794
+ 1. Click on the **Space settings** cog (located above your profile icon)
795
+ 2. Click on the **Alerts & Notifications** tab
796
+ 3. Click on the **+ Add configuration** button
797
+ 4. Add the ilert Integration
798
+ 5. A modal will be presented to you to enter the required details to enable the integration:
799
+ - **Notification settings**
800
+ - Configuration name (optional): A name for your configuration in order to easily refer to it
801
+ - Rooms: A list of Rooms for which you want to be notified
802
+ - Notifications: The notifications which you want to be notified
803
+ - **Integration configuration**
804
+ - Alert Source API key: The key you copied in the ilert configuration step.