Ingest new documentation (#1881)

Co-authored-by: netdatabot <[email protected]>
netdata · Nov 9, 2023 · d5bd1d9 · d5bd1d9
1 parent f9bb7b8
commit d5bd1d9
Show file tree

Hide file tree

Showing 12 changed files with 73 additions and 8 deletions.
diff --git a/docs/alerting/notifications/centralized-cloud-notifications/amazon-sns.mdx b/docs/alerting/notifications/centralized-cloud-notifications/amazon-sns.mdx
@@ -0,0 +1,59 @@
+---
+custom_edit_url: "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"
+sidebar_position: "902083"
+learn_link: "https://learn.netdata.cloud/docs/alerting/notifications/centralized-cloud-notifications/amazon-sns"
+---
+
+
+# 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/...tifications/centralized-cloud-notifications/centralized-cloud-notifications.mdx b/...tifications/centralized-cloud-notifications/centralized-cloud-notifications.mdx
@@ -13,6 +13,10 @@ import { Grid, Box } from '@site/src/components/Grid_integrations';
 
 <Grid  columns="4">
 
+<Box banner="by Netdata" banner_color="#00ab44" to="/docs/alerting/notifications/centralized-cloud-notifications/amazon-sns"  title="Amazon SNS">
+    <img custom-image src="https://netdata.cloud/img/awssns.png" style={{width: '90%', maxHeight: '100%', verticalAlign: 'middle' }}/>
+</Box>
+
 <Box banner="by Netdata" banner_color="#00ab44" to="/docs/alerting/notifications/centralized-cloud-notifications/discord"  title="Discord">
     <img custom-image src="https://netdata.cloud/img/discord.png" style={{width: '90%', maxHeight: '100%', verticalAlign: 'middle' }}/>
 </Box>

diff --git a/docs/alerting/notifications/centralized-cloud-notifications/discord.mdx b/docs/alerting/notifications/centralized-cloud-notifications/discord.mdx
@@ -4,7 +4,7 @@ sidebar_label: "Discord"
 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"
-sidebar_position: "902083"
+sidebar_position: "902084"
 learn_link: "https://learn.netdata.cloud/docs/alerting/notifications/centralized-cloud-notifications/discord"
 ---
 

diff --git a/docs/alerting/notifications/centralized-cloud-notifications/mattermost.mdx b/docs/alerting/notifications/centralized-cloud-notifications/mattermost.mdx
@@ -4,7 +4,7 @@ sidebar_label: "Mattermost"
 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"
-sidebar_position: "902084"
+sidebar_position: "902085"
 learn_link: "https://learn.netdata.cloud/docs/alerting/notifications/centralized-cloud-notifications/mattermost"
 ---
 

diff --git a/docs/alerting/notifications/centralized-cloud-notifications/opsgenie.mdx b/docs/alerting/notifications/centralized-cloud-notifications/opsgenie.mdx
@@ -4,7 +4,7 @@ sidebar_label: "Opsgenie"
 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"
-sidebar_position: "902085"
+sidebar_position: "902086"
 learn_link: "https://learn.netdata.cloud/docs/alerting/notifications/centralized-cloud-notifications/opsgenie"
 ---
 

diff --git a/docs/alerting/notifications/centralized-cloud-notifications/pagerduty.mdx b/docs/alerting/notifications/centralized-cloud-notifications/pagerduty.mdx
@@ -4,7 +4,7 @@ sidebar_label: "PagerDuty"
 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"
-sidebar_position: "902086"
+sidebar_position: "902087"
 learn_link: "https://learn.netdata.cloud/docs/alerting/notifications/centralized-cloud-notifications/pagerduty"
 ---
 

diff --git a/docs/alerting/notifications/centralized-cloud-notifications/rocketchat.mdx b/docs/alerting/notifications/centralized-cloud-notifications/rocketchat.mdx
@@ -4,7 +4,7 @@ sidebar_label: "RocketChat"
 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"
-sidebar_position: "902087"
+sidebar_position: "902088"
 learn_link: "https://learn.netdata.cloud/docs/alerting/notifications/centralized-cloud-notifications/rocketchat"
 ---
 

diff --git a/docs/alerting/notifications/centralized-cloud-notifications/slack.mdx b/docs/alerting/notifications/centralized-cloud-notifications/slack.mdx
@@ -4,7 +4,7 @@ sidebar_label: "Slack"
 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"
-sidebar_position: "902088"
+sidebar_position: "902089"
 learn_link: "https://learn.netdata.cloud/docs/alerting/notifications/centralized-cloud-notifications/slack"
 ---
 

diff --git a/docs/alerting/notifications/centralized-cloud-notifications/webhook.mdx b/docs/alerting/notifications/centralized-cloud-notifications/webhook.mdx
@@ -4,7 +4,7 @@ sidebar_label: "Webhook"
 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"
-sidebar_position: "902089"
+sidebar_position: "902090"
 learn_link: "https://learn.netdata.cloud/docs/alerting/notifications/centralized-cloud-notifications/webhook"
 ---
 

diff --git a/...figuring/optimizing-metrics-database/change-how-long-netdata-stores-metrics.mdx b/...figuring/optimizing-metrics-database/change-how-long-netdata-stores-metrics.mdx
@@ -48,7 +48,7 @@ on the maximum retention and the memory used by Netdata is described in detail,
 ```
 
 The default "update every iterations" of 60 means that if a metric is collected per second in Tier 0, then
-we will have a data point every minute in tier 1 and every minute in tier 2. 
+we will have a data point every minute in tier 1 and every hour in tier 2. 
 
 Up to 5 tiers are supported. You may add, or remove tiers and/or modify these multipliers, as long as the 
 product of all the "update every iterations" does not exceed 65535 (number of points for each tier0 point).

diff --git a/ingest/generated_map.tsv b/ingest/generated_map.tsv
@@ -630,6 +630,7 @@ https://github.com/netdata/netdata/edit/master/health/notifications/twilio/READM
 https://github.com/netdata/netdata/edit/master/docs/cloud/alerts-notifications/notifications.md	Centralized Cloud Notifications Reference	Published	Alerting/Notifications/Centralized Cloud Notifications	Configure Netdata Cloud to send notifications to your team whenever any node on your infrastructure triggers an alert threshold.			
 https://github.com/netdata/netdata/edit/master/docs/cloud/alerts-notifications/manage-notification-methods.md	Manage notification methods	Published	Alerting/Notifications/Centralized Cloud Notifications	Instructions on how to manage notification methods			
 https://github.com/netdata/netdata/edit/master/docs/cloud/alerts-notifications/manage-alert-notification-silencing-rules.md	Manage alert notification silencing rules	Published	Alerting/Notifications/Centralized Cloud Notifications	Master Netdata alert management via notification silencing rules for efficient and focused monitoring.			
+https://github.com/netdata/netdata/edit/master/integrations/cloud-notifications/integrations/amazon_sns.md	Amazon SNS	Published	Alerting/Notifications/Centralized Cloud Notifications		https://github.com/netdata/netdata/edit/master/integrations/cloud-notifications/metadata.yaml		DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE NOTIFICATION'S metadata.yaml FILE
 https://github.com/netdata/netdata/edit/master/integrations/cloud-notifications/integrations/discord.md	Discord	Published	Alerting/Notifications/Centralized Cloud Notifications		https://github.com/netdata/netdata/edit/master/integrations/cloud-notifications/metadata.yaml		DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE NOTIFICATION'S metadata.yaml FILE
 https://github.com/netdata/netdata/edit/master/integrations/cloud-notifications/integrations/mattermost.md	Mattermost	Published	Alerting/Notifications/Centralized Cloud Notifications		https://github.com/netdata/netdata/edit/master/integrations/cloud-notifications/metadata.yaml		DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE NOTIFICATION'S metadata.yaml FILE
 https://github.com/netdata/netdata/edit/master/integrations/cloud-notifications/integrations/opsgenie.md	Opsgenie	Published	Alerting/Notifications/Centralized Cloud Notifications		https://github.com/netdata/netdata/edit/master/integrations/cloud-notifications/metadata.yaml		DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE NOTIFICATION'S metadata.yaml FILE

diff --git a/ingest/one_commit_back_file-dict.tsv b/ingest/one_commit_back_file-dict.tsv
@@ -609,6 +609,7 @@ https://github.com/netdata/netdata/edit/master/database/engine/README.md	/docs/a
 https://github.com/netdata/netdata/edit/master/build_external/README.md	/docs/installing/build-the-netdata-agent-yourself/external-build-system
 https://github.com/netdata/netdata/edit/master/integrations/cloud-notifications/integrations/pagerduty.md	/docs/alerting/notifications/centralized-cloud-notifications/pagerduty
 https://github.com/netdata/netdata/edit/master/integrations/cloud-notifications/integrations/slack.md	/docs/alerting/notifications/centralized-cloud-notifications/slack
+https://github.com/netdata/netdata/edit/master/integrations/cloud-notifications/integrations/amazon_sns.md	/docs/alerting/notifications/centralized-cloud-notifications/amazon-sns
 https://github.com/netdata/netdata/edit/master/integrations/cloud-notifications/integrations/discord.md	/docs/alerting/notifications/centralized-cloud-notifications/discord
 https://github.com/netdata/netdata/edit/master/integrations/cloud-notifications/integrations/mattermost.md	/docs/alerting/notifications/centralized-cloud-notifications/mattermost
 https://github.com/netdata/netdata/edit/master/integrations/cloud-notifications/integrations/webhook.md	/docs/alerting/notifications/centralized-cloud-notifications/webhook