diff options
Diffstat (limited to 'integrations/cloud-notifications')
3 files changed, 204 insertions, 0 deletions
diff --git a/integrations/cloud-notifications/integrations/amazon_sns.md b/integrations/cloud-notifications/integrations/amazon_sns.md new file mode 100644 index 000000000..ff16e8d38 --- /dev/null +++ b/integrations/cloud-notifications/integrations/amazon_sns.md @@ -0,0 +1,57 @@ +<!--startmeta +custom_edit_url: "https://github.com/netdata/netdata/edit/master/integrations/cloud-notifications/integrations/amazon_sns.md" +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" +message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE NOTIFICATION'S metadata.yaml FILE" +endmeta--> + +# Amazon SNS + + +<img src="https://netdata.cloud/img/awssns.png" 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 AWS SNS. + + +<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> + +## Setup + +### Prerequisites + +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 +- Have an AWS account with AWS SNS access, for more details check [how to configure this on AWS SNS](#settings-on-aws-sns) + +### 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 **AwsSns** 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 AWS SNS: + - 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) + +### Settings on AWS SNS + +To enable the webhook integration on AWS SNS you need: +1. [Setting up access for Amazon SNS](https://docs.aws.amazon.com/sns/latest/dg/sns-setting-up.html) +2. Create a topic + - On AWS SNS management console click on **Create topic** + - On the **Details** section, the standard type and provide the topic name + - 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 + - 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. + + diff --git a/integrations/cloud-notifications/integrations/telegram.md b/integrations/cloud-notifications/integrations/telegram.md new file mode 100644 index 000000000..fc3caf457 --- /dev/null +++ b/integrations/cloud-notifications/integrations/telegram.md @@ -0,0 +1,54 @@ +<!--startmeta +custom_edit_url: "https://github.com/netdata/netdata/edit/master/integrations/cloud-notifications/integrations/telegram.md" +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" +message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE NOTIFICATION'S metadata.yaml FILE" +endmeta--> + +# Telegram + + +<img src="https://netdata.cloud/img/telegram.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 Telegram. + + +<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> + +## Setup + +### Prerequisites + +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 + +### 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 **Telegram** 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 Telegram: + - Bot Token - the token of your bot + - Chat ID - the chat id where your bot will deliver messages to + +### Getting the Telegram bot token and chat 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` + + diff --git a/integrations/cloud-notifications/metadata.yaml b/integrations/cloud-notifications/metadata.yaml index 93acbdca9..c03317242 100644 --- a/integrations/cloud-notifications/metadata.yaml +++ b/integrations/cloud-notifications/metadata.yaml @@ -279,6 +279,99 @@ * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For RocketChat: - Webhook URL - URL provided on RocketChat for the channel you want to receive your notifications. +- id: 'notify-cloud-awssns' + meta: + name: 'Amazon SNS' + link: 'https://aws.amazon.com/sns/' + categories: + - notify.cloud + icon_filename: 'awssns.png' + keywords: + - awssns + 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 AWS SNS." + notification_limitations: '' + setup: + description: | + ### Prerequisites + + 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 + - Have an AWS account with AWS SNS access, for more details check [how to configure this on AWS SNS](#settings-on-aws-sns) + + ### 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 **AwsSns** 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 AWS SNS: + - 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) + + ### Settings on AWS SNS + + To enable the webhook integration on AWS SNS you need: + 1. [Setting up access for Amazon SNS](https://docs.aws.amazon.com/sns/latest/dg/sns-setting-up.html) + 2. Create a topic + - On AWS SNS management console click on **Create topic** + - On the **Details** section, the standard type and provide the topic name + - 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 + - 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-telegram' + meta: + name: 'Telegram' + link: 'https://telegram.org/' + categories: + - notify.cloud + icon_filename: 'telegram.svg' + keywords: + - Telegram + 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 Telegram." + notification_limitations: '' + setup: + description: | + ### Prerequisites + + 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 + + ### 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 **Telegram** 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 Telegram: + - Bot Token - the token of your bot + - Chat ID - the chat id where your bot will deliver messages to + + ### Getting the Telegram bot token and chat 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` + - id: 'notify-cloud-webhook' meta: name: 'Webhook' |