summaryrefslogtreecommitdiffstats
path: root/integrations/cloud-notifications
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-05 11:19:16 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-07-24 09:53:24 +0000
commitb5f8ee61a7f7e9bd291dd26b0585d03eb686c941 (patch)
treed4d31289c39fc00da064a825df13a0b98ce95b10 /integrations/cloud-notifications
parentAdding upstream version 1.44.3. (diff)
downloadnetdata-b5f8ee61a7f7e9bd291dd26b0585d03eb686c941.tar.xz
netdata-b5f8ee61a7f7e9bd291dd26b0585d03eb686c941.zip
Adding upstream version 1.46.3.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'integrations/cloud-notifications')
-rw-r--r--integrations/cloud-notifications/integrations/amazon_sns.md6
-rw-r--r--integrations/cloud-notifications/integrations/discord.md4
-rw-r--r--integrations/cloud-notifications/integrations/mattermost.md6
-rw-r--r--integrations/cloud-notifications/integrations/microsoft_teams.md57
-rw-r--r--integrations/cloud-notifications/integrations/netdata_mobile_app.md41
-rw-r--r--integrations/cloud-notifications/integrations/opsgenie.md6
-rw-r--r--integrations/cloud-notifications/integrations/pagerduty.md9
-rw-r--r--integrations/cloud-notifications/integrations/rocketchat.md6
-rw-r--r--integrations/cloud-notifications/integrations/slack.md6
-rw-r--r--integrations/cloud-notifications/integrations/splunk.md47
-rw-r--r--integrations/cloud-notifications/integrations/splunk_victorops.md46
-rw-r--r--integrations/cloud-notifications/integrations/telegram.md12
-rw-r--r--integrations/cloud-notifications/integrations/webhook.md28
-rw-r--r--integrations/cloud-notifications/metadata.yaml224
14 files changed, 439 insertions, 59 deletions
diff --git a/integrations/cloud-notifications/integrations/amazon_sns.md b/integrations/cloud-notifications/integrations/amazon_sns.md
index ff16e8d38..45bf0f6da 100644
--- a/integrations/cloud-notifications/integrations/amazon_sns.md
+++ b/integrations/cloud-notifications/integrations/amazon_sns.md
@@ -3,7 +3,7 @@ custom_edit_url: "https://github.com/netdata/netdata/edit/master/integrations/cl
meta_yaml: "https://github.com/netdata/netdata/edit/master/integrations/cloud-notifications/metadata.yaml"
sidebar_label: "Amazon SNS"
learn_status: "Published"
-learn_rel_path: "Alerting/Notifications/Centralized Cloud Notifications"
+learn_rel_path: "Alerts & Notifications/Notifications/Centralized Cloud Notifications"
message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE NOTIFICATION'S metadata.yaml FILE"
endmeta-->
@@ -25,8 +25,8 @@ From the Cloud interface, you can manage your space's notification settings and
To add AWS SNS notification you need:
- A Netdata Cloud account
-- Access to the space as an **administrator**
-- Space needs to be on **Business** plan or higher
+- Access to the space as an **Admin**
+- The Space needs to be on a paid plan
- Have an AWS account with AWS SNS access, for more details check [how to configure this on AWS SNS](#settings-on-aws-sns)
### Steps
diff --git a/integrations/cloud-notifications/integrations/discord.md b/integrations/cloud-notifications/integrations/discord.md
index fc11b7c37..3553d17be 100644
--- a/integrations/cloud-notifications/integrations/discord.md
+++ b/integrations/cloud-notifications/integrations/discord.md
@@ -3,7 +3,7 @@ custom_edit_url: "https://github.com/netdata/netdata/edit/master/integrations/cl
meta_yaml: "https://github.com/netdata/netdata/edit/master/integrations/cloud-notifications/metadata.yaml"
sidebar_label: "Discord"
learn_status: "Published"
-learn_rel_path: "Alerting/Notifications/Centralized Cloud Notifications"
+learn_rel_path: "Alerts & Notifications/Notifications/Centralized Cloud Notifications"
message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE NOTIFICATION'S metadata.yaml FILE"
endmeta-->
@@ -22,7 +22,7 @@ From the Netdata Cloud UI, you can manage your space's notification settings and
### Prerequisites
- A Netdata Cloud account
-- Access to the Netdata Space as an **administrator**
+- Access to the Netdata Space as an **Admin**
- You need to have a Discord server able to receive webhooks integrations.
### Discord Server Configuration
diff --git a/integrations/cloud-notifications/integrations/mattermost.md b/integrations/cloud-notifications/integrations/mattermost.md
index 39c584f48..4302a2e84 100644
--- a/integrations/cloud-notifications/integrations/mattermost.md
+++ b/integrations/cloud-notifications/integrations/mattermost.md
@@ -3,7 +3,7 @@ custom_edit_url: "https://github.com/netdata/netdata/edit/master/integrations/cl
meta_yaml: "https://github.com/netdata/netdata/edit/master/integrations/cloud-notifications/metadata.yaml"
sidebar_label: "Mattermost"
learn_status: "Published"
-learn_rel_path: "Alerting/Notifications/Centralized Cloud Notifications"
+learn_rel_path: "Alerts & Notifications/Notifications/Centralized Cloud Notifications"
message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE NOTIFICATION'S metadata.yaml FILE"
endmeta-->
@@ -23,8 +23,8 @@ From the Netdata Cloud UI, you can manage your space's notification settings and
### Prerequisites
- A Netdata Cloud account
-- Access to the Netdata Space as an **administrator**
-- The Netdata Space needs to be on **Business** plan or higher
+- Access to the Netdata Space as an **Admin**
+- The Netdata Space needs to be on a paid plan
- You need to have permissions on Mattermost to add new integrations.
- You need to have a Mattermost app on your workspace to receive the webhooks.
diff --git a/integrations/cloud-notifications/integrations/microsoft_teams.md b/integrations/cloud-notifications/integrations/microsoft_teams.md
new file mode 100644
index 000000000..203118b3c
--- /dev/null
+++ b/integrations/cloud-notifications/integrations/microsoft_teams.md
@@ -0,0 +1,57 @@
+<!--startmeta
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/integrations/cloud-notifications/integrations/microsoft_teams.md"
+meta_yaml: "https://github.com/netdata/netdata/edit/master/integrations/cloud-notifications/metadata.yaml"
+sidebar_label: "Microsoft Teams"
+learn_status: "Published"
+learn_rel_path: "Alerts & Notifications/Notifications/Centralized Cloud Notifications"
+message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE NOTIFICATION'S metadata.yaml FILE"
+endmeta-->
+
+# Microsoft Teams
+
+
+<img src="https://netdata.cloud/img/teams.svg" width="150"/>
+
+
+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.
+
+
+<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
+
+## Setup
+
+### Prerequisites
+
+To add Microsoft Teams notifications integration to your Netdata Cloud space you will need the following:
+
+- A Netdata Cloud account.
+- Access to the Netdata Cloud space as an **Admin**.
+- The Space to be on a paid plan.
+- A [Microsoft 365 for Business Account](https://www.microsoft.com/en-us/microsoft-365/business). Note that this is a **paid** account.
+
+### Settings on Microsoft Teams
+
+- The integration gets enabled at a team's channel level.
+- Click on the `...` (aka three dots) icon showing up next to the channel name, it should appear when you hover over it.
+- Click on `Connectors`.
+- Look for the `Incoming Webhook` connector and click configure.
+- Provide a name for your Incoming Webhook Connector, for example _Netdata Alerts_. You can also customize it with a proper icon instead of using the default image.
+- Click `Create`.
+- The _Incoming Webhook URL_ is created.
+- That is the URL to be provided to the Netdata Cloud configuration.
+
+### Settings on Netdata Cloud
+
+1. Click on the **Space settings** cog (located above your profile icon).
+2. Click on the **Notification** tab.
+3. Click on the **+ Add configuration** button (near the top-right corner of your screen).
+4. On the **Microsoft Teams** card click on **+ Add**.
+5. A modal will be presented to you to enter the required details to enable the configuration:
+ * **Notification settings** are Netdata specific settings:
+ - Configuration name - you can optionally provide a name for your configuration you can easily refer to it.
+ - Rooms - by specifying a list of Rooms you are select to which nodes or areas of your infrastructure you want to be notified using this configuration.
+ - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only.
+ * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Microsoft Teams:
+ - Microsoft Teams Incoming Webhook URL - the _Incoming Webhook URL_ that was generated earlier.
+
+
diff --git a/integrations/cloud-notifications/integrations/netdata_mobile_app.md b/integrations/cloud-notifications/integrations/netdata_mobile_app.md
new file mode 100644
index 000000000..93de1316b
--- /dev/null
+++ b/integrations/cloud-notifications/integrations/netdata_mobile_app.md
@@ -0,0 +1,41 @@
+<!--startmeta
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/integrations/cloud-notifications/integrations/netdata_mobile_app.md"
+meta_yaml: "https://github.com/netdata/netdata/edit/master/integrations/cloud-notifications/metadata.yaml"
+sidebar_label: "Netdata Mobile App"
+learn_status: "Published"
+learn_rel_path: "Alerts & Notifications/Notifications/Centralized Cloud Notifications"
+message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE NOTIFICATION'S metadata.yaml FILE"
+endmeta-->
+
+# Netdata Mobile App
+
+
+<img src="https://netdata.cloud/img/netdata.png" width="150"/>
+
+
+From the Netdata Cloud UI, you can manage your user notification settings and enable the configuration to deliver notifications on the Netdata Mobile Application.
+
+
+<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
+
+## Setup
+
+### Prerequisites
+- A Netdata Cloud account
+- 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.
+
+### Netdata Mobile App Configuration
+Steps to login to the Netdata Mobile Application to receive alert and reachability and alert notifications:
+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)
+2. Open the App and Choose the Sign In Option
+ - 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.
+ - Sign In with QR Code: Scan the QR Code from your `Netdata Cloud` UI under **User Settings** --> **Notifications** --> **Mobile App Notifications** --> **Show QR Code**
+3. Start receiving alert and reachability notifications for your **Space(s)** on a **Paid Subscription plan**
+
+### Netdata Configuration Steps
+1. Click on the **User settings** on the bottom left of your screen (your profile icon)
+2. Click on the **Notifications** tab
+3. Enable **Mobile App Notifications** if disabled (Enabled by default)
+4. Use the **Show QR Code** Option to login to your mobile device by scanning the **QR Code**
+
+
diff --git a/integrations/cloud-notifications/integrations/opsgenie.md b/integrations/cloud-notifications/integrations/opsgenie.md
index 10e906e14..594945f4c 100644
--- a/integrations/cloud-notifications/integrations/opsgenie.md
+++ b/integrations/cloud-notifications/integrations/opsgenie.md
@@ -3,7 +3,7 @@ custom_edit_url: "https://github.com/netdata/netdata/edit/master/integrations/cl
meta_yaml: "https://github.com/netdata/netdata/edit/master/integrations/cloud-notifications/metadata.yaml"
sidebar_label: "Opsgenie"
learn_status: "Published"
-learn_rel_path: "Alerting/Notifications/Centralized Cloud Notifications"
+learn_rel_path: "Alerts & Notifications/Notifications/Centralized Cloud Notifications"
message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE NOTIFICATION'S metadata.yaml FILE"
endmeta-->
@@ -23,8 +23,8 @@ From the Netdata Cloud UI, you can manage your space's notification settings and
### Prerequisites
- A Netdata Cloud account
-- Access to the Netdata Space as an **administrator**
-- The Netdata Space needs to be on **Business** plan or higher
+- Access to the Netdata Space as an **Admin**
+- The Netdata Space needs to be on a paid plan
- You need to have permissions on Opsgenie to add new integrations.
### Opsgenie Server Configuration
diff --git a/integrations/cloud-notifications/integrations/pagerduty.md b/integrations/cloud-notifications/integrations/pagerduty.md
index eafb6ceb3..274949730 100644
--- a/integrations/cloud-notifications/integrations/pagerduty.md
+++ b/integrations/cloud-notifications/integrations/pagerduty.md
@@ -3,7 +3,7 @@ custom_edit_url: "https://github.com/netdata/netdata/edit/master/integrations/cl
meta_yaml: "https://github.com/netdata/netdata/edit/master/integrations/cloud-notifications/metadata.yaml"
sidebar_label: "PagerDuty"
learn_status: "Published"
-learn_rel_path: "Alerting/Notifications/Centralized Cloud Notifications"
+learn_rel_path: "Alerts & Notifications/Notifications/Centralized Cloud Notifications"
message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE NOTIFICATION'S metadata.yaml FILE"
endmeta-->
@@ -22,8 +22,8 @@ From the Netdata Cloud UI, you can manage your space's notification settings and
### Prerequisites
- A Netdata Cloud account
-- Access to the Netdata Space as an **administrator**
-- The Netdata Space needs to be on **Business** plan or higher
+- Access to the Netdata Space as an **Admin**
+- The Netdata Space needs to be on a paid plan
- You need to have a PagerDuty service to receive events using webhooks.
@@ -32,7 +32,7 @@ Steps to configure your PagerDuty to receive notifications from Netdata:
1. Create a service to receive events from your services directory page on PagerDuty
2. At step 3, select `Events API V2` Integration or **View Webhooks** if you already have some defined
-3. Once the service is created you will be redirected to its configuration page, where you can copy the **integration key**, that you will need need to add to your notification configuration on Netdata UI.
+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.
### Netdata Configuration Steps
@@ -47,5 +47,6 @@ Steps to configure your PagerDuty to receive notifications from Netdata:
- Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
* **Integration configuration** are the specific notification integration required settings, which vary by notification method. For PagerDuty:
- Integration Key - is a 32 character key provided by PagerDuty to receive events on your service.
+ - Integration URL (Alert Events) - is the URL provided by PagerDuty where we will send notifications.
diff --git a/integrations/cloud-notifications/integrations/rocketchat.md b/integrations/cloud-notifications/integrations/rocketchat.md
index d447c28f9..300848232 100644
--- a/integrations/cloud-notifications/integrations/rocketchat.md
+++ b/integrations/cloud-notifications/integrations/rocketchat.md
@@ -3,7 +3,7 @@ custom_edit_url: "https://github.com/netdata/netdata/edit/master/integrations/cl
meta_yaml: "https://github.com/netdata/netdata/edit/master/integrations/cloud-notifications/metadata.yaml"
sidebar_label: "RocketChat"
learn_status: "Published"
-learn_rel_path: "Alerting/Notifications/Centralized Cloud Notifications"
+learn_rel_path: "Alerts & Notifications/Notifications/Centralized Cloud Notifications"
message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE NOTIFICATION'S metadata.yaml FILE"
endmeta-->
@@ -23,8 +23,8 @@ From the Netdata Cloud UI, you can manage your space's notification settings and
### Prerequisites
- A Netdata Cloud account
-- Access to the Netdata Space as an **administrator**
-- The Netdata Space needs to be on **Business** plan or higher
+- Access to the Netdata Space as an **Admin**
+- The Netdata Space needs to be on a paid plan
- You need to have permissions on Mattermost to add new integrations.
- You need to have a RocketChat app on your workspace to receive the webhooks.
diff --git a/integrations/cloud-notifications/integrations/slack.md b/integrations/cloud-notifications/integrations/slack.md
index 162bcbce3..bed51b5ad 100644
--- a/integrations/cloud-notifications/integrations/slack.md
+++ b/integrations/cloud-notifications/integrations/slack.md
@@ -3,7 +3,7 @@ custom_edit_url: "https://github.com/netdata/netdata/edit/master/integrations/cl
meta_yaml: "https://github.com/netdata/netdata/edit/master/integrations/cloud-notifications/metadata.yaml"
sidebar_label: "Slack"
learn_status: "Published"
-learn_rel_path: "Alerting/Notifications/Centralized Cloud Notifications"
+learn_rel_path: "Alerts & Notifications/Notifications/Centralized Cloud Notifications"
message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE NOTIFICATION'S metadata.yaml FILE"
endmeta-->
@@ -23,8 +23,8 @@ From the Netdata Cloud UI, you can manage your space's notification settings and
### Prerequisites
- A Netdata Cloud account
-- Access to the Netdata Space as an **administrator**
-- The Netdata Space needs to be on **Business** plan or higher
+- Access to the Netdata Space as an **Admin**
+- The Netdata Space needs to be on a paid plan
- You need to have a Slack app on your workspace to receive the Webhooks.
### Slack Server Configuration
diff --git a/integrations/cloud-notifications/integrations/splunk.md b/integrations/cloud-notifications/integrations/splunk.md
new file mode 100644
index 000000000..b69032ba6
--- /dev/null
+++ b/integrations/cloud-notifications/integrations/splunk.md
@@ -0,0 +1,47 @@
+<!--startmeta
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/integrations/cloud-notifications/integrations/splunk.md"
+meta_yaml: "https://github.com/netdata/netdata/edit/master/integrations/cloud-notifications/metadata.yaml"
+sidebar_label: "Splunk"
+learn_status: "Published"
+learn_rel_path: "Alerts & Notifications/Notifications/Centralized Cloud Notifications"
+message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE NOTIFICATION'S metadata.yaml FILE"
+endmeta-->
+
+# Splunk
+
+
+<img src="https://netdata.cloud/img/splunk-black.svg" width="150"/>
+
+
+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.
+
+
+<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
+
+## Setup
+
+### Prerequisites
+
+To add Splunk notification you need:
+
+- A Netdata Cloud account
+- Access to the space as an **Admin**
+- The Space needs to be on a paid plan
+- 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.
+
+### Steps
+
+1. Click on the **Space settings** cog (located above your profile icon)
+2. Click on the **Notification** tab
+3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
+4. On the **Splunk** card click on **+ Add**
+5. A modal will be presented to you to enter the required details to enable the configuration:
+ - **Notification settings** are Netdata specific settings
+ - Configuration name - provide a descriptive name for your configuration to easily identify it.
+ - Rooms - select the nodes or areas of your infrastructure you want to receive notifications about.
+ - Notification - choose the type of notifications you want to receive: All Alerts and unreachable, All Alerts, Critical only.
+ - **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Splunk:
+ - HTTP Event Collector URI - The URI of your HTTP event collector in Splunk
+ - HTTP Event Collector Token - the token that Splunk provided to you when you created the HTTP Event Collector
+
+
diff --git a/integrations/cloud-notifications/integrations/splunk_victorops.md b/integrations/cloud-notifications/integrations/splunk_victorops.md
new file mode 100644
index 000000000..f5d7932a0
--- /dev/null
+++ b/integrations/cloud-notifications/integrations/splunk_victorops.md
@@ -0,0 +1,46 @@
+<!--startmeta
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/integrations/cloud-notifications/integrations/splunk_victorops.md"
+meta_yaml: "https://github.com/netdata/netdata/edit/master/integrations/cloud-notifications/metadata.yaml"
+sidebar_label: "Splunk VictorOps"
+learn_status: "Published"
+learn_rel_path: "Alerts & Notifications/Notifications/Centralized Cloud Notifications"
+message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE NOTIFICATION'S metadata.yaml FILE"
+endmeta-->
+
+# Splunk VictorOps
+
+
+<img src="https://netdata.cloud/img/victorops.svg" width="150"/>
+
+
+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.
+
+
+<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
+
+## Setup
+
+### Prerequisites
+
+To add Splunk VictorOps notification (also known as Splunk On-Call) you need:
+
+- A Netdata Cloud account
+- Access to the space as an **Admin**
+- The Space needs to be on a paid plan
+- 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.
+
+### Steps
+
+1. Click on the **Space settings** cog (located above your profile icon)
+2. Click on the **Notification** tab
+3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
+4. On the **Splunk VictorOps** card click on **+ Add**
+5. A modal will be presented to you to enter the required details to enable the configuration:
+ - **Notification settings** are Netdata specific settings
+ - Configuration name - provide a descriptive name for your configuration to easily identify it.
+ - Rooms - select the nodes or areas of your infrastructure you want to receive notifications about.
+ - Notification - choose the type of notifications you want to receive: All Alerts and unreachable, All Alerts, Critical only.
+ - **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Splunk VictorOps:
+ - Destination URL - The URL provided by VictorOps of your REST endpoint.
+
+
diff --git a/integrations/cloud-notifications/integrations/telegram.md b/integrations/cloud-notifications/integrations/telegram.md
index fc3caf457..68e34bacc 100644
--- a/integrations/cloud-notifications/integrations/telegram.md
+++ b/integrations/cloud-notifications/integrations/telegram.md
@@ -3,7 +3,7 @@ custom_edit_url: "https://github.com/netdata/netdata/edit/master/integrations/cl
meta_yaml: "https://github.com/netdata/netdata/edit/master/integrations/cloud-notifications/metadata.yaml"
sidebar_label: "Telegram"
learn_status: "Published"
-learn_rel_path: "Alerting/Notifications/Centralized Cloud Notifications"
+learn_rel_path: "Alerts & Notifications/Notifications/Centralized Cloud Notifications"
message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE NOTIFICATION'S metadata.yaml FILE"
endmeta-->
@@ -25,9 +25,9 @@ From the Cloud interface, you can manage your space's notification settings and
To add Telegram notification you need:
- A Netdata Cloud account
-- Access to the space as an **administrator**
-- Space needs to be on **Business** plan or higher
-- The Telegram bot token and chat ID
+- Access to the space as an **Admin**
+- The Space needs to be on a paid plan
+- The Telegram bot token, chat ID and _optionally_ the topic ID
### Steps
@@ -43,12 +43,14 @@ To add Telegram notification you need:
- **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Telegram:
- Bot Token - the token of your bot
- Chat ID - the chat id where your bot will deliver messages to
+ - 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.
-### Getting the Telegram bot token and chat ID
+### Getting the Telegram bot token, chat ID and topic ID
- 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**.
- To get the chat ID you have two options:
- 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.
- 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`
+- 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).
diff --git a/integrations/cloud-notifications/integrations/webhook.md b/integrations/cloud-notifications/integrations/webhook.md
index ae89e12f3..24ab78232 100644
--- a/integrations/cloud-notifications/integrations/webhook.md
+++ b/integrations/cloud-notifications/integrations/webhook.md
@@ -3,7 +3,7 @@ custom_edit_url: "https://github.com/netdata/netdata/edit/master/integrations/cl
meta_yaml: "https://github.com/netdata/netdata/edit/master/integrations/cloud-notifications/metadata.yaml"
sidebar_label: "Webhook"
learn_status: "Published"
-learn_rel_path: "Alerting/Notifications/Centralized Cloud Notifications"
+learn_rel_path: "Alerts & Notifications/Notifications/Centralized Cloud Notifications"
message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE NOTIFICATION'S metadata.yaml FILE"
endmeta-->
@@ -23,8 +23,8 @@ From the Netdata Cloud UI, you can manage your space's notification settings and
### Prerequisites
- A Netdata Cloud account
-- Access to the Netdata Space as an **administrator**
-- The Netdata Space needs to be on **Pro** plan or higher
+- Access to the Netdata Space as an **Admin**
+- The Netdata Space needs to be on a paid plan
- You need to have an app that allows you to receive webhooks following a predefined schema.
### Netdata Configuration Steps
@@ -55,9 +55,9 @@ From the Netdata Cloud UI, you can manage your space's notification settings and
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.
- Netdata webhook integration service will send alert notifications to the destination service as soon as they are detected.
+ Netdata webhook integration service will send alert and reachability notifications to the destination service as soon as they are detected.
- The notification content sent to the destination service will be a JSON object having these properties:
+ For alert notifications, the content sent to the destination service contains a JSON object with the following properties:
| field | type | description |
| :-- | :-- | :-- |
@@ -67,7 +67,7 @@ From the Netdata Cloud UI, you can manage your space's notification settings and
| chart | string | The chart associated with the alert. |
| context | string | The chart context. |
| space | string | The space where the node that raised the alert is assigned. |
- | rooms | object[object(string,string)] | Object with list of rooms names and urls where the node belongs to. |
+ | Rooms | object[object(string,string)] | Object with list of Rooms names and urls where the node belongs to. |
| family | string | Context family. |
| class | string | Classification of the alert, e.g. "Error". |
| severity | string | Alert severity, can be one of "warning", "critical" or "clear". |
@@ -77,6 +77,18 @@ From the Netdata Cloud UI, you can manage your space's notification settings and
| additional_active_warning_alerts | integer | Number of additional warning alerts currently existing on the same node. |
| alarm_url | string | Netdata Cloud URL for this alarm. |
+ For reachability notifications, the JSON object will contain the following properties:
+
+ | field | type | description |
+ | :-- | :-- | :-- |
+ | message | string | A summary message of the reachability alert. |
+ | url | string | Netdata Cloud URL for the host experiencing the reachability alert. |
+ | host | string | the host experiencing the reachability alert. |
+ | severity | string | severity for this notification. If host is reachable, severity will be 'info', if host is unreachable, it will be 'critical'. |
+ | status | object | an object with the status information. |
+ | status.reachable | boolean | true if host is reachable, false otherwise |
+ | status.text | string | can be 'reachable' or 'unreachable' |
+
#### Extra headers
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.
@@ -188,9 +200,9 @@ From the Netdata Cloud UI, you can manage your space's notification settings and
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.
- ###### Challenge secret
+ ##### Challenge secret
- To validate that you has ownership of the web application that will receive the webhook events, we are using a challenge response check mechanism.
+ To validate that you have ownership of the web application that will receive the webhook events, we are using a challenge response check mechanism.
This mechanism works as follows:
diff --git a/integrations/cloud-notifications/metadata.yaml b/integrations/cloud-notifications/metadata.yaml
index c03317242..eadc53e87 100644
--- a/integrations/cloud-notifications/metadata.yaml
+++ b/integrations/cloud-notifications/metadata.yaml
@@ -1,5 +1,38 @@
# yamllint disable rule:line-length
---
+- id: 'notify-cloud-mobile-app'
+ meta:
+ name: 'Netdata Mobile App'
+ link: 'https://netdata.cloud'
+ categories:
+ - notify.cloud
+ icon_filename: 'netdata.png'
+ keywords:
+ - mobile-app
+ - phone
+ - personal-notifications
+ overview:
+ 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."
+ notification_limitations: ''
+ setup:
+ description: |
+ ### Prerequisites
+ - A Netdata Cloud account
+ - 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.
+
+ ### Netdata Mobile App Configuration
+ Steps to login to the Netdata Mobile Application to receive alert and reachability and alert notifications:
+ 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)
+ 2. Open the App and Choose the Sign In Option
+ - 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.
+ - Sign In with QR Code: Scan the QR Code from your `Netdata Cloud` UI under **User Settings** --> **Notifications** --> **Mobile App Notifications** --> **Show QR Code**
+ 3. Start receiving alert and reachability notifications for your **Space(s)** on a **Paid Subscription plan**
+
+ ### Netdata Configuration Steps
+ 1. Click on the **User settings** on the bottom left of your screen (your profile icon)
+ 2. Click on the **Notifications** tab
+ 3. Enable **Mobile App Notifications** if disabled (Enabled by default)
+ 4. Use the **Show QR Code** Option to login to your mobile device by scanning the **QR Code**
- id: 'notify-cloud-discord'
meta:
name: 'Discord'
@@ -17,7 +50,7 @@
description: |
### Prerequisites
- A Netdata Cloud account
- - Access to the Netdata Space as an **administrator**
+ - Access to the Netdata Space as an **Admin**
- You need to have a Discord server able to receive webhooks integrations.
### Discord Server Configuration
@@ -58,8 +91,8 @@
description: |
### Prerequisites
- A Netdata Cloud account
- - Access to the Netdata Space as an **administrator**
- - The Netdata Space needs to be on **Business** plan or higher
+ - Access to the Netdata Space as an **Admin**
+ - The Netdata Space needs to be on a paid plan
- You need to have a PagerDuty service to receive events using webhooks.
@@ -68,7 +101,7 @@
1. Create a service to receive events from your services directory page on PagerDuty
2. At step 3, select `Events API V2` Integration or **View Webhooks** if you already have some defined
- 3. Once the service is created you will be redirected to its configuration page, where you can copy the **integration key**, that you will need need to add to your notification configuration on Netdata UI.
+ 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.
### Netdata Configuration Steps
@@ -83,6 +116,7 @@
- Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
* **Integration configuration** are the specific notification integration required settings, which vary by notification method. For PagerDuty:
- Integration Key - is a 32 character key provided by PagerDuty to receive events on your service.
+ - Integration URL (Alert Events) - is the URL provided by PagerDuty where we will send notifications.
- id: 'notify-cloud-slack'
meta:
@@ -101,8 +135,8 @@
### Prerequisites
- A Netdata Cloud account
- - Access to the Netdata Space as an **administrator**
- - The Netdata Space needs to be on **Business** plan or higher
+ - Access to the Netdata Space as an **Admin**
+ - The Netdata Space needs to be on a paid plan
- You need to have a Slack app on your workspace to receive the Webhooks.
### Slack Server Configuration
@@ -151,8 +185,8 @@
### Prerequisites
- A Netdata Cloud account
- - Access to the Netdata Space as an **administrator**
- - The Netdata Space needs to be on **Business** plan or higher
+ - Access to the Netdata Space as an **Admin**
+ - The Netdata Space needs to be on a paid plan
- You need to have permissions on Opsgenie to add new integrations.
### Opsgenie Server Configuration
@@ -194,8 +228,8 @@
### Prerequisites
- A Netdata Cloud account
- - Access to the Netdata Space as an **administrator**
- - The Netdata Space needs to be on **Business** plan or higher
+ - Access to the Netdata Space as an **Admin**
+ - The Netdata Space needs to be on a paid plan
- You need to have permissions on Mattermost to add new integrations.
- You need to have a Mattermost app on your workspace to receive the webhooks.
@@ -245,8 +279,8 @@
### Prerequisites
- A Netdata Cloud account
- - Access to the Netdata Space as an **administrator**
- - The Netdata Space needs to be on **Business** plan or higher
+ - Access to the Netdata Space as an **Admin**
+ - The Netdata Space needs to be on a paid plan
- You need to have permissions on Mattermost to add new integrations.
- You need to have a RocketChat app on your workspace to receive the webhooks.
@@ -298,8 +332,8 @@
To add AWS SNS notification you need:
- A Netdata Cloud account
- - Access to the space as an **administrator**
- - Space needs to be on **Business** plan or higher
+ - Access to the space as an **Admin**
+ - The Space needs to be on a paid plan
- Have an AWS account with AWS SNS access, for more details check [how to configure this on AWS SNS](#settings-on-aws-sns)
### Steps
@@ -327,6 +361,56 @@
- Finally, click on **Create topic** on the bottom of the page
3. Now, use the new **Topic ARN** while adding AWS SNS integration on your space.
+- id: 'notify-cloud-microsoftteams'
+ meta:
+ name: 'Microsoft Teams'
+ link: 'https://www.microsoft.com/en-us/microsoft-teams'
+ categories:
+ - notify.cloud
+ icon_filename: 'teams.svg'
+ keywords:
+ - microsoft
+ - teams
+ overview:
+ 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."
+ notification_limitations: ''
+ setup:
+ description: |
+ ### Prerequisites
+
+ To add Microsoft Teams notifications integration to your Netdata Cloud space you will need the following:
+
+ - A Netdata Cloud account.
+ - Access to the Netdata Cloud space as an **Admin**.
+ - The Space to be on a paid plan.
+ - A [Microsoft 365 for Business Account](https://www.microsoft.com/en-us/microsoft-365/business). Note that this is a **paid** account.
+
+ ### Settings on Microsoft Teams
+
+ - The integration gets enabled at a team's channel level.
+ - Click on the `...` (aka three dots) icon showing up next to the channel name, it should appear when you hover over it.
+ - Click on `Connectors`.
+ - Look for the `Incoming Webhook` connector and click configure.
+ - Provide a name for your Incoming Webhook Connector, for example _Netdata Alerts_. You can also customize it with a proper icon instead of using the default image.
+ - Click `Create`.
+ - The _Incoming Webhook URL_ is created.
+ - That is the URL to be provided to the Netdata Cloud configuration.
+
+ ### Settings on Netdata Cloud
+
+ 1. Click on the **Space settings** cog (located above your profile icon).
+ 2. Click on the **Notification** tab.
+ 3. Click on the **+ Add configuration** button (near the top-right corner of your screen).
+ 4. On the **Microsoft Teams** card click on **+ Add**.
+ 5. A modal will be presented to you to enter the required details to enable the configuration:
+ * **Notification settings** are Netdata specific settings:
+ - Configuration name - you can optionally provide a name for your configuration you can easily refer to it.
+ - Rooms - by specifying a list of Rooms you are select to which nodes or areas of your infrastructure you want to be notified using this configuration.
+ - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only.
+ * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Microsoft Teams:
+ - Microsoft Teams Incoming Webhook URL - the _Incoming Webhook URL_ that was generated earlier.
+
+
- id: 'notify-cloud-telegram'
meta:
name: 'Telegram'
@@ -346,9 +430,9 @@
To add Telegram notification you need:
- A Netdata Cloud account
- - Access to the space as an **administrator**
- - Space needs to be on **Business** plan or higher
- - The Telegram bot token and chat ID
+ - Access to the space as an **Admin**
+ - The Space needs to be on a paid plan
+ - The Telegram bot token, chat ID and _optionally_ the topic ID
### Steps
@@ -364,13 +448,91 @@
- **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Telegram:
- Bot Token - the token of your bot
- Chat ID - the chat id where your bot will deliver messages to
+ - 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.
- ### Getting the Telegram bot token and chat ID
+ ### Getting the Telegram bot token, chat ID and topic ID
- 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**.
- To get the chat ID you have two options:
- 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.
- 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`
+ - 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).
+- id: 'notify-cloud-splunk'
+ meta:
+ name: 'Splunk'
+ link: 'https://splunk.com/'
+ categories:
+ - notify.cloud
+ icon_filename: 'splunk-black.svg'
+ keywords:
+ - Splunk
+ overview:
+ 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."
+ notification_limitations: ''
+ setup:
+ description: |
+ ### Prerequisites
+
+ To add Splunk notification you need:
+
+ - A Netdata Cloud account
+ - Access to the space as an **Admin**
+ - The Space needs to be on a paid plan
+ - 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.
+
+ ### Steps
+
+ 1. Click on the **Space settings** cog (located above your profile icon)
+ 2. Click on the **Notification** tab
+ 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
+ 4. On the **Splunk** card click on **+ Add**
+ 5. A modal will be presented to you to enter the required details to enable the configuration:
+ - **Notification settings** are Netdata specific settings
+ - Configuration name - provide a descriptive name for your configuration to easily identify it.
+ - Rooms - select the nodes or areas of your infrastructure you want to receive notifications about.
+ - Notification - choose the type of notifications you want to receive: All Alerts and unreachable, All Alerts, Critical only.
+ - **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Splunk:
+ - HTTP Event Collector URI - The URI of your HTTP event collector in Splunk
+ - HTTP Event Collector Token - the token that Splunk provided to you when you created the HTTP Event Collector
+
+- id: 'notify-cloud-victorops'
+ meta:
+ name: 'Splunk VictorOps'
+ link: 'https://www.splunk.com/en_us/about-splunk/acquisitions/splunk-on-call.html'
+ categories:
+ - notify.cloud
+ icon_filename: 'victorops.svg'
+ keywords:
+ - VictorOps
+ - Splunk
+ - On-Call
+ overview:
+ 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."
+ notification_limitations: ''
+ setup:
+ description: |
+ ### Prerequisites
+
+ To add Splunk VictorOps notification (also known as Splunk On-Call) you need:
+
+ - A Netdata Cloud account
+ - Access to the space as an **Admin**
+ - The Space needs to be on a paid plan
+ - 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.
+
+ ### Steps
+
+ 1. Click on the **Space settings** cog (located above your profile icon)
+ 2. Click on the **Notification** tab
+ 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
+ 4. On the **Splunk VictorOps** card click on **+ Add**
+ 5. A modal will be presented to you to enter the required details to enable the configuration:
+ - **Notification settings** are Netdata specific settings
+ - Configuration name - provide a descriptive name for your configuration to easily identify it.
+ - Rooms - select the nodes or areas of your infrastructure you want to receive notifications about.
+ - Notification - choose the type of notifications you want to receive: All Alerts and unreachable, All Alerts, Critical only.
+ - **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Splunk VictorOps:
+ - Destination URL - The URL provided by VictorOps of your REST endpoint.
- id: 'notify-cloud-webhook'
meta:
@@ -390,8 +552,8 @@
### Prerequisites
- A Netdata Cloud account
- - Access to the Netdata Space as an **administrator**
- - The Netdata Space needs to be on **Pro** plan or higher
+ - Access to the Netdata Space as an **Admin**
+ - The Netdata Space needs to be on a paid plan
- You need to have an app that allows you to receive webhooks following a predefined schema.
### Netdata Configuration Steps
@@ -422,9 +584,9 @@
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.
- Netdata webhook integration service will send alert notifications to the destination service as soon as they are detected.
+ Netdata webhook integration service will send alert and reachability notifications to the destination service as soon as they are detected.
- The notification content sent to the destination service will be a JSON object having these properties:
+ For alert notifications, the content sent to the destination service contains a JSON object with the following properties:
| field | type | description |
| :-- | :-- | :-- |
@@ -434,7 +596,7 @@
| chart | string | The chart associated with the alert. |
| context | string | The chart context. |
| space | string | The space where the node that raised the alert is assigned. |
- | rooms | object[object(string,string)] | Object with list of rooms names and urls where the node belongs to. |
+ | Rooms | object[object(string,string)] | Object with list of Rooms names and urls where the node belongs to. |
| family | string | Context family. |
| class | string | Classification of the alert, e.g. "Error". |
| severity | string | Alert severity, can be one of "warning", "critical" or "clear". |
@@ -444,6 +606,18 @@
| additional_active_warning_alerts | integer | Number of additional warning alerts currently existing on the same node. |
| alarm_url | string | Netdata Cloud URL for this alarm. |
+ For reachability notifications, the JSON object will contain the following properties:
+
+ | field | type | description |
+ | :-- | :-- | :-- |
+ | message | string | A summary message of the reachability alert. |
+ | url | string | Netdata Cloud URL for the host experiencing the reachability alert. |
+ | host | string | the host experiencing the reachability alert. |
+ | severity | string | severity for this notification. If host is reachable, severity will be 'info', if host is unreachable, it will be 'critical'. |
+ | status | object | an object with the status information. |
+ | status.reachable | boolean | true if host is reachable, false otherwise |
+ | status.text | string | can be 'reachable' or 'unreachable' |
+
#### Extra headers
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.
@@ -555,9 +729,9 @@
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.
- ###### Challenge secret
+ ##### Challenge secret
- To validate that you has ownership of the web application that will receive the webhook events, we are using a challenge response check mechanism.
+ To validate that you have ownership of the web application that will receive the webhook events, we are using a challenge response check mechanism.
This mechanism works as follows: