diff options
Diffstat (limited to 'integrations/cloud-notifications/metadata.yaml')
| -rw-r--r-- | integrations/cloud-notifications/metadata.yaml | 111 |
1 files changed, 82 insertions, 29 deletions
diff --git a/integrations/cloud-notifications/metadata.yaml b/integrations/cloud-notifications/metadata.yaml index 323fbda6a..eadc53e87 100644 --- a/integrations/cloud-notifications/metadata.yaml +++ b/integrations/cloud-notifications/metadata.yaml @@ -26,7 +26,7 @@ 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 Business Subscription** + 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) @@ -50,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 @@ -91,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. @@ -101,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 @@ -116,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: @@ -134,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 @@ -184,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 @@ -227,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. @@ -278,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. @@ -331,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 @@ -380,8 +381,8 @@ 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 **administrator**. - - The Space to be on **Business** plan or higher. + - 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 @@ -429,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 @@ -447,14 +448,15 @@ - **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' @@ -474,8 +476,8 @@ To add Splunk 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 - 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 @@ -493,6 +495,45 @@ - 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: name: 'Webhook' @@ -511,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 @@ -543,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 | | :-- | :-- | :-- | @@ -555,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". | @@ -565,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. |