@cryptotaxi247 / netdata-1 / commits / ea98d9a9e

Update Netdata subscription plans documentation (#17571)

* update the plans doc to reflect plans available * update role base access model * view plan n billing updates * change wording * admin wording * update centralized cloud alerts reference doc * remove misleading plan indication * check links, and format files and tables * Update plans.md * Apply suggestions from code review * simplify language in edited docs, make them simpler to grasp * edits from product * Update alerts-configuration-manager.md * Apply suggestions from code review Co-authored-by: Hugo Valente <82235632+hugovalente-pm@users.noreply.github.com> --------- Co-authored-by: Ilya Mashchenko <ilya@netdata.cloud> Co-authored-by: Shyam Sreevalsan <shyam@netdata.cloud> Co-authored-by: Hugo Valente <82235632+hugovalente-pm@users.noreply.github.com>

Fotis Voutsas committed May 2, 2024 at 13:52 UTC ea98d9a9e7875cf2dbf16af720da49321438cd86
9 files changed +293 -545
docs/cloud/alerts-configuration-manager.md
+30 -56
@@ -1,71 +1,45 @@
1 # Creating Alerts with Netdata Alerts Configuration Manager
2
3 -The Netdata Alerts Configuration Manager enables users with [Business subscriptions](https://www.netdata.cloud/pricing/) to create alerts from the Netdata Dashboard with an intuitive user interface.
3 +The Netdata Alerts Configuration Manager enables subscribers to easily set up alerts directly from the Netdata Dashboard. More details on subscriptions can be found [here](https://www.netdata.cloud/pricing/).
4
5 -## Using Alerts Configuration Manager
6 -
7 -1. Go to the **Metrics** tab and navigate to the chart you want to configure an alert for.
8 -
9 -2. Click the **Alert icon** on the top right corner of the chart.
10 - <!--![Alert Icon](https://github.com/netdata/netdata/assets/96257330/88bb4e86-cbc7-4e01-9c84-6b901188c0de)-->
11 -
12 -3. The Alert Configuration Manager will open up with the default thresholds. You can modify the configuration as required and the alert definition on the right will be updated dynamically.
13 - <!--![Alert Configuration Modal](https://github.com/netdata/netdata/assets/96257330/ce39ae64-2ffe-4576-8c92-b7918bb8c91c)-->
14 -
15 -4. If you want more fine-grained control or access to more advanced settings, enable **Show advanced**
16 - <!--![Advance Options](https://github.com/netdata/netdata/assets/96257330/b409b31b-6dc7-484c-a2a4-4e5e471d029b)-->
17 -
18 -5. Copy the alert definition that is generated in the code box and add it to an existing [health configuration file](https://github.com/netdata/netdata/blob/master/src/health/REFERENCE.md#edit-health-configuration-files) or a new custom file under `<path to netdata install>/etc/netdata/health.d/` on a Parent Agent or a Standalone Child Agent.
19 - <!--![Copy the Alert Configuration](https://github.com/netdata/netdata/assets/96257330/c948e280-c6c8-426f-98b1-2b5256cc2707)-->
20 -
21 -6. Reload Netdata Alert Health checks `<path to netdata install>/usr/sbin/netdatacli reload-health` and the new alert is now configured.
5 +## Using the Alerts Configuration Manager
6
7 +1. Navigate to the **Metrics** tab and select the chart you want to configure for alerts.
8 +2. Click the **Alert icon** in the top right corner of the chart.
9 +3. The Alert Configuration Manager will open, showing the default thresholds. Modify these thresholds as needed, the alert definition on the right will update automatically.
10 +4. For additional settings, toggle **Show advanced**.
11 +5. After configuring the alert, copy the generated alert definition from the code box. Paste this into an existing or new custom health configuration file located at `<path to netdata install>/etc/netdata/health.d/` on a Parent Agent or a Standalone Child Agent. The guide to edit health configuration files is available [here](https://github.com/netdata/netdata/blob/master/src/health/REFERENCE.md#edit-health-configuration-files).
12 +6. To activate the new alert, run the command `<path to netdata install>/usr/sbin/netdatacli reload-health`.
13
14 ## Alerts Configuration Manager Sections
15
26 -- **Alert Detection Method**
27 - <!--![Alert Type](https://github.com/netdata/netdata/assets/96257330/c8d83a65-90e7-4b03-9279-585abb359662)-->
28 - An alert is triggered whenever a metric crosses a threshold:
29 - - Based on a standard `threshold`
30 - - Based on metric `variance`
31 - - Based on the `anomaly rate` of the metric
32 -
16 +### Alert Detection Method
17 +
18 +An alert is triggered whenever a metric crosses a threshold:
19
34 -- **Metrics Lookup, Filtering and Formula Section**
35 - <!--![Metrics Lookup, Filtering and Formula Section](https://github.com/netdata/netdata/assets/96257330/784c3f54-d7ce-45ea-9505-3f789d6d3ddb)-->
20 +- **Standard Threshold**: Triggered when a metric crosses a predefined value.
21 +- **Metric Variance**: Triggered based on the variance of the metric.
22 +- **Anomaly Rate**: Triggered based on the anomaly rate of the metric.
23
37 - - **Metrics Lookup**: This is the **Evaluate** line of fields in the modal and it defines the parameters for the database lookup that is needed to get the value that will be compared against the alert definition. It corresponds to the [`lookup`](https://github.com/netdata/netdata/blob/master/src/health/REFERENCE.md#alert-line-lookup) line of the Alert configuration file. The Alerts Configuration Manager provides a default selection for the lookup and can be modified to suit your requirements. The parameters that can be modified are:
38 - - METHOD (`avg`, `sum`, `min`, `max`, `cv`, `stddev`)
39 - - COMPUTATION (sum of all dimensions or individually for each dimension)
40 - - DIMENSIONS (All dimensions, or a selection of dimensions)
41 - - DURATION (the period in time to run the lookup)
42 - - OPTIONS (`absolute`, `unaligned`, `percentage`, `min2max`)
24 +### Metrics Lookup, Filtering and Formula Section
25
44 - - **Alert Filtering**: This functionality can be accessed through the **Show advanced** checkbox and it allows for filtering the alert health checks to be run only for specific components of the infrastructure. It helps in achieving a fine-grained configuration for any given alert.
45 - - `HOSTS` / `NODES` - By default all hosts are selected. You can pick nodes from the dropdown list, or enter a wildcard matching a list of hosts that you want the alert health check to run on. This field corresponds to the [`hosts`](https://github.com/netdata/netdata/blob/master/src/health/REFERENCE.md#alert-line-hosts) line of the Alert configuration file.
46 - - `INSTANCES` - All instances are selected by default. You can pick instances from the dropdown list, or enter a wildcard matching a list of instances that you want the alert health check to run on. This field corresponds to the [`charts`](https://github.com/netdata/netdata/blob/master/src/health/REFERENCE.md#alert-line-charts) line of the Alert configuration file.
47 - - `CHART LABELS` - All chart labels are selected by default. You can pick a chart label from the dropdown list or enter a wildcard matching a list of chart labels that you want the alert health check to run on. This field corresponds to the [`chart labels`](https://github.com/netdata/netdata/blob/master/src/health/REFERENCE.md#alert-line-chart-labels) line of the Alert configuration file.
48 - - `OS` - All Operating Systems are selected by default. You can choose which OS(s) an alert health check should run on. This field corresponds to the [`os`](https://github.com/netdata/netdata/blob/master/src/health/REFERENCE.md#alert-line-os) line of the Alert configuration file.
26 +You can read more about the different options in the [Alerts reference documentation](https://github.com/netdata/netdata/blob/master/src/health/REFERENCE.md)
27
50 - - **Formula / Calculation**: This field is available through the **Show advanced** checkbox and it is used to define a formula to be run on top of the `lookup` value. The result of the lookup is available in the `$this` variable, and after the formula is run, the result is also stored in `$this` and can be accessed while setting the alert thresholds. This field corresponds to the [`calc`](https://github.com/netdata/netdata/blob/master/src/health/REFERENCE.md#alert-line-calc) line of the Alert configuration file.
28 +- **Metrics Lookup**: Adjust the database lookup parameters directly in the UI, including method (`avg`, `sum`, `min`, `max`, etc.), computation style, dimensions, duration, and options like `absolute` or `percentage`.
29 +- **Alert Filtering**: The **show advanced** checkbox allows filtering of alert health checks for specific infrastructure components. Options include selecting hosts, nodes, instances, chart labels, and operating systems.
30 +- **Formula / Calculation**: The **show advanced** checkbox allows defining a formula for the metric value, which is then used to set alert thresholds.
31
52 -- **Alerting conditions**
53 - <!--![Alert Thresholds](https://github.com/netdata/netdata/assets/96257330/1545d22d-c729-46f5-84cd-f82654d2cb12)-->
54 - - **Warning and Critical Thresholds**: These fields are used to set the thresholds for the `Warning` and `Critical` alert states, while also having the option to set the condition for the alert to be raised if it is `above` or `below` the given threshold. If the advanced settings are selected, a **formula** option can also be used, to define a custom formula instead of a threshold. These fields correspond to the [`warn` and `crit`](https://github.com/netdata/netdata/blob/master/src/health/REFERENCE.md#alert-lines-warn-and-crit) lines of the Alert configuration file.
55 - - **Recovery Thresholds**: This field is available through the **Show advanced** checkbox, and it is used to set the threshold that the metric value needs to meet to de-escalate from a given severity status, like `Critical to Warning` and from `Warning to Clear`. The logic is appended to the `warn` and `crit` lines of the Alert configuration file and resembles a one-line `IF-THEN-ELSE` clause.
56 - - **Check Interval**: This field is used to define the frequency of the health check for the alert and corresponds to the [`every`](https://github.com/netdata/netdata/blob/master/src/health/REFERENCE.md#alert-line-every) line of the Alert configuration file.
57 - - **Delay Notifications**: This field is available through the **Show advanced** checkbox and it is used to set delay parameters on notifications for an alert severity `escalation` or `de-escalation`. It corresponds to the [`delay`](https://github.com/netdata/netdata/blob/master/src/health/REFERENCE.md#alert-line-delay) line of the Alert configuration file.
32 +### Alerting Conditions
33
59 - - **Agent Specific Options**: These options are only available on the `Netdata Agent` and not honored on `Netdata Cloud`. They can be accessed through the **Show advanced** checkbox.
60 - <!--![Agent Specific Options](https://github.com/netdata/netdata/assets/96257330/d2bab429-1e2e-40d0-a892-79ea83bb5f25)-->
61 - - **Repeat Notifications**: This field defines the repeat frequency for the alert notification when the alert is in either `warning` or `critical` status and corresponds to the [`repeat`](https://github.com/netdata/netdata/blob/master/src/health/REFERENCE.md#alert-line-repeat) line of the Alert configuration file.
62 - - **Send to**: This field is used to define a user role to which the alert notifications will be sent. If set to `silent`, then the alert won't be sent to any role. It corresponds to the [`to`](https://github.com/netdata/netdata/blob/master/src/health/REFERENCE.md#alert-line-to) line of the Alert configuration file.
63 - - **Custom Exec Script**: This field is used to define a custom script that will be executed when the alert is triggered (but needs to be carefully designed as it needs to call the `health_alarm_notify.sh` module) and corresponds to the [`exec`](https://github.com/netdata/netdata/blob/master/src/health/REFERENCE.md#alert-line-exec) line of the Alert configuration file.
34 +- **Thresholds**: Set thresholds for warning and critical alert states, specifying whether the alert should trigger above or below these thresholds. Advanced settings allow for custom formulas.
35 + - **Recovery Thresholds**: Set thresholds for downgrading the alert from critical to warning or from warning to clear.
36 +- **Check Interval**: Define how frequently the health check should run.
37 +- **Delay Notifications**: Manage notification delays for alert escalations or de-escalations.
38 +- **Agent Specific Options**: Options exclusive to the Netdata Agent, like repeat notification frequencies and notification recipients.
39 + - **Custom Exec Script**: Define custom scripts to execute when an alert triggers.
40
65 -- **Alert Name, Description and Summary Section**
66 - <!--![Alert Name, Description and Summary Section](https://github.com/netdata/netdata/assets/96257330/50680344-ccd9-439d-80f7-7f26f217a842)-->
41 +### Alert Name, Description and Summary Section
42
68 - - **Alert Template Name**: This field uniquely identifies an alert and corresponds to the [`template`](https://github.com/netdata/netdata/blob/master/src/health/REFERENCE.md#alert-line-alarm-or-template) field of the Alert configuration file.
69 - The Alerts Configuration Manager provides a default name for an Alert template but we recommend you modify this to have a meaningful name for your configured alert.
70 - - **Alert Template Description**: This field provides a brief explanation of the alert and corresponds to the [`info`](https://github.com/netdata/netdata/blob/master/src/health/REFERENCE.md#alert-line-info) line of the Alert configuration file.
71 - - **Alert Summary**: This field enables the users to create a custom title for the alert notification (via [Notification integrations](https://learn.netdata.cloud/docs/alerting/notifications/centralized-cloud-notifications)) and corresponds to the [`summary`](https://github.com/netdata/netdata/blob/master/src/health/REFERENCE.md#alert-line-summary) line of the Alert configuration file.
43 +- **Alert Template Name**: Provide a unique name for the alert.
44 +- **Alert Template Description**: Offer a brief explanation of what the alert monitors.
45 +- **Alert Summary**: Create a custom title for alert notifications, which can be integrated with centralized notification systems available [here](https://learn.netdata.cloud/docs/alerting/notifications/centralized-cloud-notifications).
docs/cloud/alerts-notifications/notifications.md
+26 -106
@@ -1,130 +1,56 @@
1 -# Cloud alert notifications
1 +# Centralized Cloud Notifications Reference
2
3 -import Callout from '@site/src/components/Callout'
3 +Netdata Cloud sends alert notifications for nodes in warning, critical, or unreachable states, ensuring alerts are managed centrally and efficiently.
4
5 -Netdata Cloud can send centralized alert notifications to your team whenever a node enters a warning, critical, or
6 -unreachable state. By enabling notifications, you ensure no alert, on any node in your infrastructure, goes unnoticed by
7 -you or your team.
5 +## Benefits of Centralized Notifications
6
9 -Having this information centralized helps you:
10 -* Have a clear view of the health across your infrastructure, seeing all alerts in one place.
11 -* Easily [set up your alert notification process](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/manage-notification-methods.md):
12 -methods to use and where to use them, filtering rules, etc.
13 -* Quickly troubleshoot using [Metric Correlations](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metric-correlations.md)
14 -or [Anomaly Advisor](https://github.com/netdata/netdata/blob/master/docs/dashboard/anomaly-advisor-tab.md)
7 +- Consolidate health status views across all infrastructure in one place.
8 +- Set up and [manage your alert notifications easily](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/manage-notification-methods.md).
9 +- Expedite troubleshooting with tools like [Metric Correlations](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metric-correlations.md) and the [Anomaly Advisor](https://github.com/netdata/netdata/blob/master/docs/dashboard/anomaly-advisor-tab.md).
10
16 -If a node is getting disconnected often or has many alerts, we protect you and your team from alert fatigue by sending
17 -you a flood protection notification. Getting one of these notifications is a good signal of health or performance issues
18 -on that node.
11 +To avoid notification overload, **flood protection** is triggered when a node frequently disconnects or sends excessive alerts, highlighting potential issues.
12
20 -Admins must enable alert notifications for their [Space(s)](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/manage-notification-methods.md#manage-space-notification-settings). All users in a
21 -Space can then personalize their notifications settings from within their [account
22 -menu](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/#manage-user-notification-settings).
13 +Admins must [enable alert notifications](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/manage-notification-methods.md#manage-space-notification-settings) for their Space(s). All users can then customize their notification preferences through their [account menu](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/#manage-user-notification-settings).
14
24 -<Callout type="notice">
15 +> **Note**
16 +>
17 +> Centralized alerts in Netdata Cloud are separate from the [Netdata Agent](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md) notifications. Alerts must be [configured individually](https://github.com/netdata/netdata/blob/master/src/health/REFERENCE.md) on each node.
18
26 -Centralized alert notifications from Netdata Cloud is a independent process from [notifications from
27 -Netdata](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md). You can enable one or the other, or both, based on your needs. However,
28 -the alerts you see in Netdata Cloud are based on those streamed from your Netdata-monitoring nodes. If you want to tweak
29 -or add new alert that you see in Netdata Cloud, and receive via centralized alert notifications, you must
30 -[configure](https://github.com/netdata/netdata/blob/master/src/health/REFERENCE.md) each node's alert watchdog.
19 +## Alert Notifications
20
32 -</Callout>
21 +Notifications can be sent via email or through third-party services like PagerDuty or Slack. Admins manage notification settings for the entire Space, while individual users can personalize settings in their profile.
22
34 -## Alert notifications
35 -
36 -Netdata Cloud can send centralized alert notifications to your team whenever a node enters a warning, critical, or unreachable state. By enabling notifications,
37 -you ensure no alert, on any node in your infrastructure, goes unnoticed by you or your team.
38 -
39 -If a node is getting disconnected often or has many alerts, we protect you and your team from alert fatigue by sending you a flood protection notification.
40 -Getting one of these notifications is a good signal of health or performance issues on that node.
41 -
42 -Alert notifications can be delivered through different methods, these can go from an Email sent from Netdata to the use of a 3rd party tool like PagerDuty.
43 -
44 -Notification methods are classified on two main attributes:
45 -* Service level: Personal or System
46 -* Service classification: Community or Business
47 -
48 -Only administrators are able to manage the space's alert notification settings.
49 -All users in a Space can personalize their notifications settings, for Personal service level notification methods, from within their profile menu.
50 -
51 -> ⚠️ Netdata Cloud supports different notification methods and their availability will depend on the plan you are at.
52 -> For more details check [Service classification](#service-classification) or [netdata.cloud/pricing](https://www.netdata.cloud/pricing).
53 -
54 -### Service level
23 +### Service Level
24
25 #### Personal
26
58 -The notifications methods classified as **Personal** are what we consider generic, meaning that these can't have specific rules for them set by the administrators.
59 -
60 -These notifications are sent to the destination of the channel which is a user-specific attribute, e.g. user's e-mail, and the users are the ones that will then be able to
61 -manage what specific configurations they want for the Space / Room(s) and the desired Notification level, they can achieve this from their User Profile page under
62 -**Notifications**.
63 -
64 -One example of such a notification method is the E-mail.
27 +Notifications are sent to user-specific destinations, such as email, which are managed by users under their profile settings.
28
29 #### System
30
68 -For **System** notification methods, the destination of the channel will be a target that usually isn't specific to a single user, e.g. slack channel.
69 -
70 -These notification methods allow for fine-grain rule settings to be done by administrators and more than one configuration can exist for them since. You can specify
71 -different targets depending on Rooms or Notification level settings.
72 -
73 -Some examples of such notification methods are: Webhook, PagerDuty, Slack.
31 +These notifications go to general targets like a Slack channel, with admins setting rules for notification targets based on workspace or alert level.
32
75 -### Service classification
33 +### Service Classification
34
35 #### Community
36
79 -Notification methods classified as Community can be used by everyone independent on the plan your space is at.
80 -These are: Email and discord
81 -
82 -#### Pro
83 -
84 -Notification methods classified as Pro are only available for **Pro** and **Business** plans
85 -These are: webhook
37 +Available to all plans, includes basic methods like Email and Discord.
38
39 #### Business
40
89 -Notification methods classified as Business are only available for **Business** plans
90 -These are: PagerDuty, Slack, Opsgenie
91 -
92 -## Silencing Alert notifications
93 -
94 -Netdata Cloud provides you a Silencing Rule engine which allows you to mute alert notifications. This muting action is specific to alert state transition notifications, it doesn't include node unreachable state transitions.
95 -
96 -The Silencing Rule engine is flexible and allows you to enter silence rules for the two main entities involved on alert notifications and can be set using different attributes. The main entities you can enter are **Nodes** and **Alerts** which can be used in combination or isolation to target specific needs - see some examples [here](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/manage-alert-notification-silencing-rules.md#silencing-rules-examples).
97 -
98 -### Scope definition for Nodes
99 -* **Space:** silencing the space, selecting `All Rooms`, silences all alert state transitions from any node claimed to the space.
100 -* **War Room:** silencing a specific room will silence all alert state transitions from any node in that room. Please note if the node belongs to
101 -another room which isn't silenced it can trigger alert notifications to the users with membership to that other room.
102 -* **Node:** silencing a specific node can be done for the entire space, selecting `All Rooms`, or for specific war room(s). The main difference is
103 -if the node should be silenced for the entire space or just for specific rooms (when specific rooms are selected only users with membership to that room won't receive notifications).
41 +Exclusive to [paid plans](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/plans.md), includes advanced services like PagerDuty and Slack.
42
105 -### Scope definition for Alerts
106 -* **Alert name:** silencing a specific alert name silences all alert state transitions for that specific alert.
107 -* **Alert context:** silencing a specific alert context will silence all alert state transitions for alerts targeting that chart context, for more details check [alert configuration docs](https://github.com/netdata/netdata/blob/master/src/health/REFERENCE.md#alert-line-on).
108 -* **Alert role:** silencing a specific alert role will silence all the alert state transitions for alerts that are configured to be specific role recipients, for more details check [alert configuration docs](https://github.com/netdata/netdata/blob/master/src/health/REFERENCE.md#alert-line-to).
43 +## Alert Notification Silencing Rules
44
110 -Beside the above two main entities there are another two important settings that you can define on a silencing rule:
111 -* Who does the rule affect? **All user** in the space or **Myself**
112 -* When does is to apply? **Immediately** or on a **Schedule** (when setting immediately you can set duration)
45 +Netdata Cloud offers a silencing rule engine to mute alert notifications based on specific conditions related to nodes or alert types. Learn how to manage these settings [here](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/manage-alert-notification-silencing-rules.md).
46
114 -For further help on setting alert notification silencing rules go to [Manage Alert Notification Silencing Rules](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/manage-alert-notification-silencing-rules.md).
47 +## Flood Protection
48
116 -> ⚠️ This feature is only available for [Netdata paid plans](https://github.com/netdata/netdata/edit/master/docs/cloud/manage/plans.md).
49 +If a node repeatedly changes state or fires alerts, flood protection limits notifications to prevent overload. You can still access node details through Netdata Cloud or directly via the local Agent dashboard.
50
118 -## Flood protection
51 +## Anatomy of an Email Alert Notification
52
120 -If a node has too many state changes like firing too many alerts or going from reachable to unreachable, Netdata Cloud
121 -enables flood protection. As long as a node is in flood protection mode, Netdata Cloud does not send notifications about
122 -this node. Even with flood protection active, it is possible to access the node directly, either via Netdata Cloud or
123 -the local Agent dashboard at `http://NODE:19999`.
124 -
125 -## Anatomy of an alert notification
126 -
127 -Email alert notifications show the following information:
53 +Email notifications provide comprehensive details:
54
55 - The Space's name
56 - The node's name
@@ -138,10 +64,4 @@ Email alert notifications show the following information:
64 - Threshold for triggering the given alert state
65 - Calculation or database lookups that Netdata uses to compute the value
66 - Source of the alert, including which file you can edit to configure this alert on an individual node
141 -
142 -Email notifications also feature a **Go to Node** button, which takes you directly to the offending chart for that node
143 -within Cloud's embedded dashboards.
144 -
145 -Here's an example email notification for the `ram_available` chart, which is in a critical state:
146 -
147 -![Screenshot of an alert notification email from Netdata Cloud](https://user-images.githubusercontent.com/1153921/87461878-e933c480-c5c3-11ea-870b-affdb0801854.png)
67 +- Direct link to the node’s chart in Cloud dashboards.
docs/cloud/insights/events-feed.md
+39 -40
@@ -10,55 +10,54 @@ At a high-level view, these are the domains from which the Events feed will prov
10 >
11 > Based on your space's plan, different allowances are defined to query past data.
12
13 -| **Domains of events** | **Community** | **Business** |
14 -| :-- | :-- | :-- |
15 -| **[Auditing events](#auditing-events)** - <br/>Events related to actions done on your Space, e.g. invite user, change user role or change plan.| 4 hours | 90 days |
16 -| **[Topology events](#topology-events)**<br/>Node state transition events, e.g. live or offline.| 4 hours | 14 days |
17 -| **[Alert events](#alert-events)**<br/>Alert state transition events, can be seen as an alert history log.| 4 hours | 90 days |
13 +| **Domains of events** | **Community** | **Homelab** | **Business** | **Enterprise On-Premise** |
14 +|:------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:------------|:-------------|:--------------------------|
15 +| **[Auditing events](#auditing-events)** <p>Events related to actions done on your Space, e.g. invite user, change user role or change plan.</p> | 4 hours | 90 days | 90 days | User dependent |
16 +| **[Topology events](#topology-events)** <p>Node state transition events, e.g. live or offline.</p> | 4 hours | 14 days | 14 days | User dependent |
17 +| **[Alert events](#alert-events)** <p>Alert state transition events, can be seen as an alert history log.</p> | 4 hours | 90 days | 90 days | User dependent |
18
19 ### Auditing events
20
21 -| **Event name** | **Description** | **Example** |
22 -| :-- | :-- | :-- |
23 -| Space Created | The space was created.| Space `Acme Space` was **created** |
24 -| Room Created | A room was created on the Space.| Room `DB Servers` was **created** by `John Doe` |
25 -| Room Deleted | A room was deleted from the Space. | Room `DB servers` was **deleted** by `John Doe` |
26 -| User Invited to Space | A user was invited to join the Space.| User `John Smith` was **invited** to this space by `Alan Doe` |
27 -| User Uninvited from Space | An invitation for a user to join the space was revoked.| User `John Smith` was **uninvited** from this space |
28 -| User Added to Space | A user was added to the Space from an invitation (user accepted the invitation).| User `John Smith` was **added** to this space by invite of `Alan Doe` |
29 -| User Removed from Space | A user was added to the Space from an invitation. | User `John Smith` was **removed** from this space by `Alan Doe` |
30 -| User Added to Room | A user was added to a room on the Space. | User `John Smith` was **added** to room `DB servers` |
31 -| User Removed from Room | A user was removed from a room on the Space. | User `John Smith` was **removed** from room `DB Servers` by `Alan Doe` |
32 -| User Space Properties Changed | The properties of a user on the Space have changed, e.g. change user role | User role for `John Smith` was **changed** to `troubleshooter` by `Alan Doe` |
33 -| Node Added To Room | The node was added to a room on the Space. | Node `ip-xyz.ec2.internal` was **added** to room `DB Servers` by `John Doe` |
34 -| Node Removed To Room | The node was removed from a room on the Space. | Node `ip-xyz.ec2.internal` was **removed** from room `DB Servers` by `John Doe` |
35 -| Silencing Rule Created | A new alert notification silencing rule was created on the Space. | Silencing rule `DB Servers schedule silencing` on rooms `All nodes` and `DB Servers` was **created** by `John Smith` |
36 -| Silencing Rule Changed | An existing alert notification silencing rule was modified on the Space. | Silencing rule `DB Servers schedule silencing` on rooms `All nodes` and `DB Servers` was **changed** by `John Doe` |
37 -| Silencing Rule Deleted | An existing alert notifications silencing rule was removed from the Space. | Silencing rule `DB Servers schedule silencing` on rooms `All nodes` and `DB Servers` was **changed** by `Alan Smith` |
38 -| Space Claiming Token Created | A Space Claiming Token was created. | Claiming Token was created by user `John Doe` |
39 -| Space Claiming Token Revoked | A Space Claiming Token was revoked. | Claiming Token `_OtF2ssjrv` was revoked by user `John Doe` |
21 +| **Event name** | **Description** | **Example** |
22 +|:------------------------------|:---------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------|
23 +| Space Created | The space was created. | Space `Acme Space` was **created** |
24 +| Room Created | A room was created on the Space. | Room `DB Servers` was **created** by `John Doe` |
25 +| Room Deleted | A room was deleted from the Space. | Room `DB servers` was **deleted** by `John Doe` |
26 +| User Invited to Space | A user was invited to join the Space. | User `John Smith` was **invited** to this space by `Alan Doe` |
27 +| User Uninvited from Space | An invitation for a user to join the space was revoked. | User `John Smith` was **uninvited** from this space |
28 +| User Added to Space | A user was added to the Space from an invitation (user accepted the invitation). | User `John Smith` was **added** to this space by invite of `Alan Doe` |
29 +| User Removed from Space | A user was added to the Space from an invitation. | User `John Smith` was **removed** from this space by `Alan Doe` |
30 +| User Added to Room | A user was added to a room on the Space. | User `John Smith` was **added** to room `DB servers` |
31 +| User Removed from Room | A user was removed from a room on the Space. | User `John Smith` was **removed** from room `DB Servers` by `Alan Doe` |
32 +| User Space Properties Changed | The properties of a user on the Space have changed, e.g. change user role | User role for `John Smith` was **changed** to `troubleshooter` by `Alan Doe` |
33 +| Node Added To Room | The node was added to a room on the Space. | Node `ip-xyz.ec2.internal` was **added** to room `DB Servers` by `John Doe` |
34 +| Node Removed To Room | The node was removed from a room on the Space. | Node `ip-xyz.ec2.internal` was **removed** from room `DB Servers` by `John Doe` |
35 +| Silencing Rule Created | A new alert notification silencing rule was created on the Space. | Silencing rule `DB Servers schedule silencing` on rooms `All nodes` and `DB Servers` was **created** by `John Smith` |
36 +| Silencing Rule Changed | An existing alert notification silencing rule was modified on the Space. | Silencing rule `DB Servers schedule silencing` on rooms `All nodes` and `DB Servers` was **changed** by `John Doe` |
37 +| Silencing Rule Deleted | An existing alert notifications silencing rule was removed from the Space. | Silencing rule `DB Servers schedule silencing` on rooms `All nodes` and `DB Servers` was **changed** by `Alan Smith` |
38 +| Space Claiming Token Created | A Space Claiming Token was created. | Claiming Token was created by user `John Doe` |
39 +| Space Claiming Token Revoked | A Space Claiming Token was revoked. | Claiming Token `_OtF2ssjrv` was revoked by user `John Doe` |
40
41 ### Topology events
42
43 -| **Event name** | **Description** | **Example** |
44 -| :-- | :-- | :-- |
45 -| Node Became Live | The node is collecting and streaming metrics to Cloud.| Node `netdata-k8s-state-xyz` was **live** |
46 -| Node Became Stale | The node is offline and not streaming metrics to Cloud. It can show historical data from a parent node. | Node `ip-xyz.ec2.internal` was **stale** |
47 -| Node Became Offline | The node is offline, not streaming metrics to Cloud and not available in any parent node.| Node `ip-xyz.ec2.internal` was **offline** |
48 -| Node Created | The node is created but it is still `Unseen` on Cloud, didn't establish a successful connection yet.| Node `ip-xyz.ec2.internal` was **created** |
49 -| Node Removed |The node was removed from the Space, for example by using the `Delete` action on the node. This is a soft delete in that the node gets marked as deleted, but retains the association with this space. If it becomes live again, it will be restored (see `Node Restored` below) and reappear in this space as before. | Node `ip-xyz.ec2.internal` was **deleted (soft)** |
50 -| Node Restored | The node was restored. See `Node Removed` above. | Node `ip-xyz.ec2.internal` was **restored** |
51 -| Node Deleted | The node was deleted from the Space. This is a hard delete and no information on the node is retained. | Node `ip-xyz.ec2.internal` was **deleted (hard)** |
52 -| Agent Connected | The agent connected to the Cloud MQTT server (Agent-Cloud Link established).<br/>These events can only be seen on _All nodes_ War Room. | Agent with claim ID `7d87bqs9-cv42-4823-8sd4-3614548850c7` has connected to Cloud. |
53 -| Agent Disconnected | The agent disconnected from the Cloud MQTT server (Agent-Cloud Link severed).<br/>These events can only be seen on _All nodes_ War Room. | Agent with claim ID `7d87bqs9-cv42-4823-8sd4-3614548850c7` has disconnected from Cloud: **Connection Timeout**. |
54 -| Space Statistics | Daily snapshot of space node statistics.<br/>These events can only be seen on _All nodes_ War Room. | Space statistics. Nodes: **22 live**, **21 stale**, **18 removed**, **61 total**. |
55 -
43 +| **Event name** | **Description** | **Example** |
44 +|:--------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------|
45 +| Node Became Live | The node is collecting and streaming metrics to Cloud. | Node `netdata-k8s-state-xyz` was **live** |
46 +| Node Became Stale | The node is offline and not streaming metrics to Cloud. It can show historical data from a parent node. | Node `ip-xyz.ec2.internal` was **stale** |
47 +| Node Became Offline | The node is offline, not streaming metrics to Cloud and not available in any parent node. | Node `ip-xyz.ec2.internal` was **offline** |
48 +| Node Created | The node is created but it is still `Unseen` on Cloud, didn't establish a successful connection yet. | Node `ip-xyz.ec2.internal` was **created** |
49 +| Node Removed | The node was removed from the Space, for example by using the `Delete` action on the node. This is a soft delete in that the node gets marked as deleted, but retains the association with this space. If it becomes live again, it will be restored (see `Node Restored` below) and reappear in this space as before. | Node `ip-xyz.ec2.internal` was **deleted (soft)** |
50 +| Node Restored | The node was restored. See `Node Removed` above. | Node `ip-xyz.ec2.internal` was **restored** |
51 +| Node Deleted | The node was deleted from the Space. This is a hard delete and no information on the node is retained. | Node `ip-xyz.ec2.internal` was **deleted (hard)** |
52 +| Agent Connected | The agent connected to the Cloud MQTT server (Agent-Cloud Link established).<br/>These events can only be seen on _All nodes_ War Room. | Agent with claim ID `7d87bqs9-cv42-4823-8sd4-3614548850c7` has connected to Cloud. |
53 +| Agent Disconnected | The agent disconnected from the Cloud MQTT server (Agent-Cloud Link severed).<br/>These events can only be seen on _All nodes_ War Room. | Agent with claim ID `7d87bqs9-cv42-4823-8sd4-3614548850c7` has disconnected from Cloud: **Connection Timeout**. |
54 +| Space Statistics | Daily snapshot of space node statistics.<br/>These events can only be seen on _All nodes_ War Room. | Space statistics. Nodes: **22 live**, **21 stale**, **18 removed**, **61 total**. |
55
56 ### Alert events
57
59 -| **Event name** | **Description** | **Example** |
60 -| :-- | :-- | :-- |
61 -| Node Alert State Changed | These are node alert state transition events and can be seen as an alert history log. You will be able to see transitions to or from any of these states: Cleared, Warning, Critical, Removed, Error or Unknown | Transition to Cleared:<br/>`httpcheck_web_service_bad_status` for `httpcheck_netdata_cloud.request_status` on `netdata-parent-xyz` recovered with value **8.33%**<br/><br/>Transition from Cleared to Warning or Critical:<br/>`httpcheck_web_service_bad_status` for `httpcheck_netdata_cloud.request_status` on `netdata-parent-xyz` was raised to **WARNING** with value **10%**<br/><br/>Transition from Warning to Critical:<br/>`httpcheck_web_service_bad_status` for `httpcheck_netdata_cloud.request_status` on `netdata-parent-xyz` escalated to **CRITICAL** with value **25%**<br/><br/>Transition from Critical to Warning:<br/>`httpcheck_web_service_bad_status` for `httpcheck_netdata_cloud.request_status` on `netdata-parent-xyz` was demoted to **WARNING** with value **10%**<br/><br/>Transition to Removed:<br/>Alert `httpcheck_web_service_bad_status` for `httpcheck_netdata_cloud.request_status` on `netdata-parent-xyz` is no longer available, state can't be assessed.<br/><br/>Transition to Error:<br/>For this alert `httpcheck_web_service_bad_status` related to `httpcheck_netdata_cloud.request_status` on `netdata-parent-xyz` we couldn't calculate the current value ⓘ|
58 +| **Event name** | **Description** | **Example** |
59 +|:-------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
60 +| Node Alert State Changed | These are node alert state transition events and can be seen as an alert history log. You will be able to see transitions to or from any of these states: Cleared, Warning, Critical, Removed, Error or Unknown | Transition to Cleared:<br/>`httpcheck_web_service_bad_status` for `httpcheck_netdata_cloud.request_status` on `netdata-parent-xyz` recovered with value **8.33%**<br/><br/>Transition from Cleared to Warning or Critical:<br/>`httpcheck_web_service_bad_status` for `httpcheck_netdata_cloud.request_status` on `netdata-parent-xyz` was raised to **WARNING** with value **10%**<br/><br/>Transition from Warning to Critical:<br/>`httpcheck_web_service_bad_status` for `httpcheck_netdata_cloud.request_status` on `netdata-parent-xyz` escalated to **CRITICAL** with value **25%**<br/><br/>Transition from Critical to Warning:<br/>`httpcheck_web_service_bad_status` for `httpcheck_netdata_cloud.request_status` on `netdata-parent-xyz` was demoted to **WARNING** with value **10%**<br/><br/>Transition to Removed:<br/>Alert `httpcheck_web_service_bad_status` for `httpcheck_netdata_cloud.request_status` on `netdata-parent-xyz` is no longer available, state can't be assessed.<br/><br/>Transition to Error:<br/>For this alert `httpcheck_web_service_bad_status` related to `httpcheck_netdata_cloud.request_status` on `netdata-parent-xyz` we couldn't calculate the current value ⓘ |
61
62 ## Who can access the events?
63
docs/cloud/manage/plans.md
+23 -104
@@ -1,123 +1,42 @@
1 -# Netdata Plans
1 +# Netdata Subscription Plans
2
3 -This page will guide you through the differences between the Community, Pro, Business and Enterprise plans.
3 +This page explains the Netdata subscription plan structure.
4
5 -At Netdata, we believe in providing free and unrestricted access to high-quality monitoring solutions, and our commitment to this principle will not change. We offer our free SaaS offering - what we call **Community plan** - and Open Source Agent, which features unlimited nodes and users, unlimited metrics, and retention, providing real-time, high-fidelity, out-of-the-box infrastructure monitoring for packaged applications, containers, and operating systems.
5 +## Overview
6
7 -We also provide paid subscriptions that designed to provide additional features and capabilities for businesses that need tighter and customizable integration of the free monitoring solution to their processes. These are divided into three different plans: **Pro**, **Business**, and **Enterprise**. Each plan will offers a different set of features and capabilities to meet the needs of businesses of different sizes and with different monitoring requirements.
7 +Netdata offers a **Community plan**, a free SaaS and Open Source Agent, while also it offers paid subscriptions — **Homelab**, **Business**, and **Enterprise On-Premise** — providing key business features and unlimited access to your dashboards.
8
9 -> ### Note
10 -> To not disrupt the existing space user's access rights we will keep them in the **Early Bird** plan. The reason for this is to allow users to
11 -> keep using the legacy **Member** role with the exact same permissions as it has currently.
12 ->
13 -> If you move from the **Early Bird** plan to a paid plan, you will not be able to return to the **Early Bird** plan again. The **Community** free plan will always be available to you, but it does not allow
14 -> you to invite or change users using the Member role. See more details on our [roles and plans](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/role-based-access.md#what-roles-are-available) documentation.
9 +For more info visit the [Netdata Cloud Pricing](https://netdata.cloud/pricing) page.
10
11 ### Plans
12
18 -The plan is an attribute that is directly attached to your space(s) and that dictates what capabilities and customizations you have on your space. If you have different spaces you can have different Netdata plans on them. This gives you flexibility to chose what is more adequate for your needs on each of your spaces.
19 -
20 -Netdata Cloud plans, with the exception of Community, work as subscriptions and overall consist of two pricing components:
21 -
22 -* A flat fee component, that is applied on yearly subscriptions for the [comitted-nodes](#committed-nodes) charte (space subscription fee has been waived off)
23 -* An on-demand metered component, that is related to your usage of Netdata which directly links to the [number of nodes you have running](#running-nodes-and-billing)
24 -
25 -Netdata provides two billing frequency options:
26 -
27 -* Monthly - Pay as you go, where we charge both the flat fee and the on-demand component every month
28 -* Yearly - Annual prepayment, where we charge upfront the flat fee and committed amount related to your estimated usage of Netdata (more details [here](#committed-nodes))
29 -
30 -For more details on the plans and subscription conditions please check <https://netdata.cloud/pricing>.
31 -
32 -#### Running nodes and billing
33 -
34 -The only dynamic variable we consider for billing is the number of concurrently running nodes or agents. We only charge you for your active running nodes, so we don't count:
35 -
36 -* offline nodes
37 -* stale nodes, nodes that are available to query through a Netdata parent agent but are not actively connecting metrics at the moment
38 -
39 -To ensure we don't overcharge you due to sporadic spikes throughout a month or even at a certain point in a day we are:
40 -
41 -* Calculate a daily P90 figure for your running nodes. To achieve that, we take a daily snapshot of your running nodes, and using the node state change events (live, offline) we guarantee that a daily P90 figure is calculated to remove any daily spikes
42 -* On top of the above, we do a running P90 calculation from the start to the end of your billing cycle. Even if you have an yearly billing frequency we keep a monthly subscription linked to that to identify any potential overage over your [committed nodes](#committed-nodes).
43 -
44 -#### Committed nodes
45 -
46 -When you subscribe to an Yearly plan you will need to specify the number of nodes that you will commit to. On these nodes, a discounted price of less 25% than the original cost per node of the plan is applied. This amount will be part of your annual prepayment.
47 -
48 -```
49 -Node plan discounted price x committed nodes x 12 months
50 -```
51 -
52 -If, for a given month, your usage is over these committed nodes we will charge the original cost per node for the nodes above the committed number.
53 -
54 -#### Plan changes and credit balance
13 +Each plan is linked to a Space, defining the capabilities and customizations available. Different Spaces can have different plans, offering flexibility based on your needs.
14
56 -It is ok to change your mind. We allow to change your plan, billing frequency or adjust the committed nodes, on yearly plans, at any time.
15 +Netdata Cloud plans (excluding Community) involve:
16
58 -To achieve this you can check the [Update plan](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/view-plan-billing.md#update-plan) section.
17 +- A yearly flat fee for [committed nodes](#committed-nodes)
18 +- An on-demand metered component based on the [number of running nodes](#running-nodes-and-billing)
19
60 -> ⚠️ On a downgrade (going to a new plan with less benefits) or cancellation of an active subscription, please note that you will have all your notification methods configurations active **for a period of 24 hours**.
61 -> After that, any notification methods unavailable in your new plan at that time will be automatically disabled. You can always re-enable them once you move to a paid plan that includes them.
20 +Billing options include monthly (pay-as-you-go) and yearly (annual prepayment). For more details, visit [Netdata Cloud Pricing](https://netdata.cloud/pricing).
21
63 -> ⚠️ Downgrade or cancellation may affect users in your Space. Please check what roles are available on the [each plans](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/plans.md#areas-impacted-by-plans). Users with unavailable roles on the new plan will immediately have restricted access to the Space.
22 +## Running Nodes and Billing
23
65 -> ⚠️ Any credit given to you will be available to use on future paid subscriptions with us. It will be available until the **end of the following year**.
24 +Billing is based on the number of active nodes. We do not charge for offline or stale nodes. We calculate daily and running P90 figures to ensure fair billing by smoothing out sporadic spikes in node activity.
25
67 -### Areas impacted by plans
26 +## Committed Nodes
27
69 -##### Role-Based Access model
28 +Yearly plans require specifying a number of committed nodes, which receive a discounted rate. Usage above these committed nodes incurs charges at the standard rate.
29
71 -Depending on the plan associated to your space you will have different roles available:
30 +## Plan Changes and Credit Balance
31
73 -| **Role** | **Community** | **Pro** | **Business** | **Early Bird** |
74 -| :-- | :--: | :--: | :--: | :--: |
75 -| **Administrators**<p>Users with this role can control Spaces, War Rooms, Nodes, Users and Billing.</p><p>They can also access any War Room in the Space.</p> | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
76 -| **Managers**<p>Users with this role can manage War Rooms and Users.</p><p>They can access any War Room in the Space.</p> | - | - | :heavy_check_mark: | - |
77 -| **Troubleshooters**<p>Users with this role can use Netdata to troubleshoot, not manage entities.</p><p>They can access any War Room in the Space.</p> | - | :heavy_check_mark: | :heavy_check_mark: | - |
78 -| **Observers**<p>Users with this role can only view data in specific War Rooms.</p>💡 Ideal for restricting your customer's access to their own dedicated rooms.<p></p> | - | - | :heavy_check_mark: | - |
79 -| **Billing**<p>Users with this role can handle billing options and invoices.</p> | - | - | :heavy_check_mark: | - |
80 -| **Member** ⚠️ Legacy role<p>Users with this role can create War Rooms and invite other Members.</p><p>They can only see the War Rooms they belong to and all Nodes in the All Nodes room.</p>| - | - | - | :heavy_check_mark: |
32 +You can change your plan, billing frequency, or committed nodes at any time. For guidance, see [updating your plan](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/view-plan-billing.md#update-a-subscription-plan).
33
82 -For more details check the documentation under [Role-Based Access model](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/role-based-access.md).
83 -
84 -##### Events feed
85 -
86 -The plan you have subscribed on your space will determine the amount of historical data you will be able to query:
87 -
88 -| **Type of events** | **Community** | **Pro** | **Business** |
89 -| :-- | :-- | :-- | :-- |
90 -| **Auditing events** - COMING SOON<p>Events related to actions done on your Space, e.g. invite user, change user role or create room.</p>| 4 hours | 7 days | 90 days |
91 -| **Topology events**<p>Node state transition events, e.g. live or offline.</p>| 4 hours | 7 days | 14 days |
92 -| **Alert events**<p>Alert state transition events, can be seen as an alert history log.</p>| 4 hours | 7 days | 90 days |
93 -
94 -For more details check the documentation under [Events feed](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/events-feed.md).
95 -
96 -##### Notification integrations
97 -
98 -The plan on your space will determine what type of notifications methods will be available to you:
99 -
100 -* **Community** - Email and Discord
101 -* **Pro** - Email, Discord and webhook
102 -* **Business** - Unlimited, this includes Slack, PagerDuty, Opsgenie etc.
103 -
104 -For more details check the documentation under [Alert Notifications](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.md#alert-notifications).
105 -
106 -##### Alert notification silencing rules
107 -
108 -The plan on your space will determine if you are able to add alert notification silencing rules since this feature will only be available for paid plans: **Pro** or **Business**.
109 -
110 -For more details check the documentation under [Alert Notifications](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.md#silencing-alert-notifications).
111 -
112 -### Related Topics
113 -
114 -#### **Related Concepts**
115 -
116 -* [Spaces](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/organize-your-infrastrucutre-invite-your-team.md#netdata-cloud-spaces)
117 -* [Alert Notifications](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.md)
118 -* [Events feed](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/events-feed.md)
119 -* [Role-Based Access model](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/role-based-access.md)
34 +> **Note**
35 +>
36 +> - Changes like downgrades or cancellations keep notification configurations active for 24 hours. After that, any methods not supported by the new plan are disabled.
37 +> - Changes may restrict user access in your Space. Review role availability under [each plan](#areas-that-change-upon-subscription).
38 +> - Any credits are valid until the end of the following year.
39
121 -#### Related Tasks
40 +## Areas That Change Upon Subscription
41
123 -* [View Plan & Billing](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/view-plan-billing.md)
42 +Please refer to the [Netdata Cloud Pricing](https://netdata.cloud/pricing) page for more information on what each plan provides.
docs/cloud/manage/role-based-access.md
+93 -97
@@ -7,18 +7,14 @@ Netdata Cloud's role-based-access mechanism allows you to control what functiona
7 With the advent of the paid plans we revamped the roles to cover needs expressed by Netdata users, like providing more limited access to their customers, or
8 being able to join any room. We also aligned the offered roles to the target audience of each plan. The end result is the following:
9
10 -| **Role** | **Community** | **Pro** | **Business** | **Early Bird** |
11 -| :-- | :--: | :--: | :--: | :--: |
12 -| **Administrators**<p>Users with this role can control Spaces, War Rooms, Nodes, Users and Billing.</p><p>They can also access any War Room in the Space.</p> | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
13 -| **Managers**<p>Users with this role can manage War Rooms and Users.</p><p>They can access any War Room in the Space.</p> | - | - | :heavy_check_mark: | - |
14 -| **Troubleshooters**<p>Users with this role can use Netdata to troubleshoot, not manage entities.</p><p>They can access any War Room in the Space.</p> | - | :heavy_check_mark: | :heavy_check_mark: | - |
15 -| **Observers**<p>Users with this role can only view data in specific War Rooms.</p>💡 Ideal for restricting your customer's access to their own dedicated rooms.<p></p> | - | - | :heavy_check_mark: | - |
16 -| **Billing**<p>Users with this role can handle billing options and invoices.</p> | - | - | :heavy_check_mark: | - |
17 -| **Member** ⚠️ Legacy role<p>Users with this role can create War Rooms and invite other Members.</p><p>They can only see the War Rooms they belong to and all Nodes in the All Nodes room.</p>| - | - | - | :heavy_check_mark: |
18 -
19 -## What happens to the previous Member role?
20 -
21 -We will maintain a Early Bird plan for existing users, which will continue to provide access to the Member role.
10 +| **Role** | **Community** | **Homelab** | **Business** | **Enterprise On-Premise** |
11 +|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------|:-------------------|:-------------------|:--------------------------|
12 +| **Admins**<p>Users with this role can control Spaces, War Rooms, Nodes, Users and Billing.</p><p>They can also access any War Room in the Space.</p> | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
13 +| **Managers**<p>Users with this role can manage War Rooms and Users.</p><p>They can access any War Room in the Space.</p> | - | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
14 +| **Troubleshooters**<p>Users with this role can use Netdata to troubleshoot, not manage entities.</p><p>They can access any War Room in the Space.</p> | - | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
15 +| **Observers**<p>Users with this role can only view data in specific War Rooms.</p>💡 Ideal for restricting your customer's access to their own dedicated rooms.<p></p> | - | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
16 +| **Billing**<p>Users with this role can handle billing options and invoices.</p> | - | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
17 +| **Member** ⚠️ Legacy role<p>Users with this role you can create War Rooms and invite other Members.</p><p>They can only see the War Rooms they belong to and all Nodes in the All Nodes room.</p> | - | - | - | - |
18
19 ## Which functionalities are available for each role?
20
@@ -26,91 +22,91 @@ In more detail, you can find on the following tables which functionalities are a
22
23 ### Space Management
24
29 -| **Functionality** | **Administrator** | **Manager** | **Troubleshooter** | **Observer** | **Billing** | **Member** |
30 -| :-- | :--: | :--: | :--: | :--: | :--: | :--: |
31 -| See Space | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
32 -| Leave Space | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
33 -| Delete Space | :heavy_check_mark: | - | - | - | - | - |
34 -| Change name | :heavy_check_mark: | - | - | - | - | - |
35 -| Change description | :heavy_check_mark: | - | - | - | - | - |
36 -| Change slug | :heavy_check_mark: | - | - | - | - | - |
37 -| Change preferred nodes | :heavy_check_mark: | - | - | - | - | - |
25 +| **Functionality** | **Admin** | **Manager** | **Troubleshooter** | **Observer** | **Billing** | **Member** |
26 +|:-----------------------|:------------------:|:------------------:|:------------------:|:------------------:|:------------------:|:------------------:|
27 +| See Space | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
28 +| Leave Space | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
29 +| Delete Space | :heavy_check_mark: | - | - | - | - | - |
30 +| Change name | :heavy_check_mark: | - | - | - | - | - |
31 +| Change description | :heavy_check_mark: | - | - | - | - | - |
32 +| Change slug | :heavy_check_mark: | - | - | - | - | - |
33 +| Change preferred nodes | :heavy_check_mark: | - | - | - | - | - |
34
35 ### Node Management
36
41 -| **Functionality** | **Administrator** | **Manager** | **Troubleshooter** | **Observer** | **Billing** | **Member** | Notes |
42 -| :-- | :--: | :--: | :--: | :--: | :--: | :--: | :-- |
43 -| See all Nodes in Space (_All Nodes_ room) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | - | :heavy_check_mark: | Members are always on the _All Nodes_ room |
44 -| Connect Node to Space | :heavy_check_mark: | - | - | - | - | - | - |
45 -| Delete Node from Space | :heavy_check_mark: | - | - | - | - | - | - |
37 +| **Functionality** | **Admin** | **Manager** | **Troubleshooter** | **Observer** | **Billing** | **Member** | Notes |
38 +|:------------------------------------------|:------------------:|:------------------:|:------------------:|:------------:|:-----------:|:------------------:|:-------------------------------------------|
39 +| See all Nodes in Space (_All Nodes_ room) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | - | :heavy_check_mark: | Members are always on the _All Nodes_ room |
40 +| Connect Node to Space | :heavy_check_mark: | - | - | - | - | - | - |
41 +| Delete Node from Space | :heavy_check_mark: | - | - | - | - | - | - |
42
43 ### User Management
44
49 -| **Functionality** | **Administrator** | **Manager** | **Troubleshooter** | **Observer** | **Billing** | **Member** | Notes |
50 -| :-- | :--: | :--: | :--: | :--: | :--: | :--: | :-- |
51 -| See all Users in Space | :heavy_check_mark: | :heavy_check_mark: | - | - | - | :heavy_check_mark: | |
52 -| Invite new User to Space | :heavy_check_mark: | :heavy_check_mark: | - | - | - | :heavy_check_mark: | You can't invite a user with a role you don't have permissions to appoint to (see below) |
53 -| Delete Pending Invitation to Space | :heavy_check_mark: | :heavy_check_mark: | - | - | - | :heavy_check_mark: | |
54 -| Delete User from Space | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - | You can't delete a user if he has a role you don't have permissions to appoint to (see below) |
55 -| Appoint Administrators | :heavy_check_mark: | - | - | - | - | - | |
56 -| Appoint Billing user | :heavy_check_mark: | - | - | - | - | - | |
57 -| Appoint Managers | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - | |
58 -| Appoint Troubleshooters | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - | |
59 -| Appoint Observer | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - | |
60 -| Appoint Member | :heavy_check_mark: | - | - | - | - | :heavy_check_mark: | Only available on Early Bird plans |
61 -| See all Users in a Room | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: | |
62 -| Invite existing user to Room | :heavy_check_mark: | :heavy_check_mark: | - | - | - | :heavy_check_mark: | User already invited to the Space |
63 -| Remove user from Room | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - | |
45 +| **Functionality** | **Admin** | **Manager** | **Troubleshooter** | **Observer** | **Billing** | **Member** | Notes |
46 +|:-----------------------------------|:------------------:|:------------------:|:------------------:|:------------------:|:-----------:|:------------------:|:----------------------------------------------------------------------------------------------|
47 +| See all Users in Space | :heavy_check_mark: | :heavy_check_mark: | - | - | - | :heavy_check_mark: | |
48 +| Invite new User to Space | :heavy_check_mark: | :heavy_check_mark: | - | - | - | :heavy_check_mark: | You can't invite a user with a role you don't have permissions to appoint to (see below) |
49 +| Delete Pending Invitation to Space | :heavy_check_mark: | :heavy_check_mark: | - | - | - | :heavy_check_mark: | |
50 +| Delete User from Space | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - | You can't delete a user if he has a role you don't have permissions to appoint to (see below) |
51 +| Appoint Administrators | :heavy_check_mark: | - | - | - | - | - | |
52 +| Appoint Billing user | :heavy_check_mark: | - | - | - | - | - | |
53 +| Appoint Managers | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - | |
54 +| Appoint Troubleshooters | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - | |
55 +| Appoint Observer | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - | |
56 +| Appoint Member | :heavy_check_mark: | - | - | - | - | :heavy_check_mark: | Only available on Early Bird plans |
57 +| See all Users in a Room | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: | |
58 +| Invite existing user to Room | :heavy_check_mark: | :heavy_check_mark: | - | - | - | :heavy_check_mark: | User already invited to the Space |
59 +| Remove user from Room | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - | |
60
61 ### Room Management
62
67 -| **Functionality** | **Administrator** | **Manager** | **Troubleshooter** | **Observer** | **Billing** | **Member** | Notes |
68 -| :-- | :--: | :--: | :--: | :--: | :--: | :--: | :-- |
69 -| See all Rooms in a Space | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | - | - | |
70 -| Join any Room in a Space | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | - | - | By joining a room you will be enabled to get notifications from nodes on that room |
71 -| Leave Room | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: | |
72 -| Create a new Room in a Space | :heavy_check_mark: | :heavy_check_mark: | - | - | - | :heavy_check_mark: | |
73 -| Delete Room | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - | |
74 -| Change Room name | :heavy_check_mark: | :heavy_check_mark: | - | - | - | :heavy_check_mark: | If not the _All Nodes_ room |
75 -| Change Room description | :heavy_check_mark: | :heavy_check_mark: | - | - | - | :heavy_check_mark: | |
76 -| Add existing Nodes to Room | :heavy_check_mark: | :heavy_check_mark: | - | - | - | :heavy_check_mark: | Node already connected to the Space |
77 -| Remove Nodes from Room | :heavy_check_mark: | :heavy_check_mark: | - | - | - | :heavy_check_mark: | |
63 +| **Functionality** | **Admin** | **Manager** | **Troubleshooter** | **Observer** | **Billing** | **Member** | Notes |
64 +|:-----------------------------|:------------------:|:------------------:|:------------------:|:------------------:|:-----------:|:------------------:|:-----------------------------------------------------------------------------------|
65 +| See all Rooms in a Space | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | - | - | |
66 +| Join any Room in a Space | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | - | - | By joining a room you will be enabled to get notifications from nodes on that room |
67 +| Leave Room | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: | |
68 +| Create a new Room in a Space | :heavy_check_mark: | :heavy_check_mark: | - | - | - | :heavy_check_mark: | |
69 +| Delete Room | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - | |
70 +| Change Room name | :heavy_check_mark: | :heavy_check_mark: | - | - | - | :heavy_check_mark: | If not the _All Nodes_ room |
71 +| Change Room description | :heavy_check_mark: | :heavy_check_mark: | - | - | - | :heavy_check_mark: | |
72 +| Add existing Nodes to Room | :heavy_check_mark: | :heavy_check_mark: | - | - | - | :heavy_check_mark: | Node already connected to the Space |
73 +| Remove Nodes from Room | :heavy_check_mark: | :heavy_check_mark: | - | - | - | :heavy_check_mark: | |
74
75 ### Notifications Management
76
81 -| **Functionality** | **Administrator** | **Manager** | **Troubleshooter** | **Observer** | **Billing** | **Member** | Notes |
82 -| :-- | :--: | :--: | :--: | :--: | :--: | :--: | :-- |
83 -| See all configured notifications on a Space | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: | |
84 -| Add new configuration | :heavy_check_mark: | - | - | - | - | - | |
85 -| Enable/Disable configuration | :heavy_check_mark: | - | - | - | - | - | |
86 -| Edit configuration | :heavy_check_mark: | - | - | - | - | - | Some exceptions apply depending on [service level](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/manage-notification-methods.md#available-actions-per-notification-methods-based-on-service-level) |
87 -| Delete configuration | :heavy_check_mark: | - | - | - | - | - | |
88 -| Edit personal level notification settings | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | [Manage user notification settings](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/manage-notification-methods.md#manage-user-notification-settings) |
89 -| See space alert notification silencing rules | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | - | - | |
90 -| Add new space alert notification silencing rule | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - | |
91 -| Enable/Disable space alert notification silencing rule | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - | |
92 -| Edit space alert notification silencing rule | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - | |
93 -| Delete space alert notification silencing rule | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - | |
94 -| See, add, edit or delete personal level alert notification silencing rule | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | - | |
95 -
96 -
97 -Notes:
98 -* Enable, Edit and Add actions over specific notification methods will only be allowed if your plan has access to those ([service classification](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.md#service-classification))
77 +| **Functionality** | **Admin** | **Manager** | **Troubleshooter** | **Observer** | **Billing** | **Member** | Notes |
78 +|:--------------------------------------------------------------------------|:------------------:|:------------------:|:------------------:|:------------------:|:------------------:|:------------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
79 +| See all configured notifications on a Space | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: | |
80 +| Add new configuration | :heavy_check_mark: | - | - | - | - | - | |
81 +| Enable/Disable configuration | :heavy_check_mark: | - | - | - | - | - | |
82 +| Edit configuration | :heavy_check_mark: | - | - | - | - | - | Some exceptions apply depending on [service level](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/manage-notification-methods.md#available-actions-per-notification-methods-based-on-service-level) |
83 +| Delete configuration | :heavy_check_mark: | - | - | - | - | - | |
84 +| Edit personal level notification settings | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | [Manage user notification settings](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/manage-notification-methods.md#manage-user-notification-settings) |
85 +| See space alert notification silencing rules | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | - | - | |
86 +| Add new space alert notification silencing rule | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - | |
87 +| Enable/Disable space alert notification silencing rule | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - | |
88 +| Edit space alert notification silencing rule | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - | |
89 +| Delete space alert notification silencing rule | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - | |
90 +| See, add, edit or delete personal level alert notification silencing rule | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | - | |
91 +
92 +> **Note**
93 +>
94 +> Enable, Edit and Add actions over specific notification methods will only be allowed if your plan has access to those ([service classification](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.md#service-classification))
95
96 ### Dashboards
97
102 -| **Functionality** | **Administrator** | **Manager** | **Troubleshooter** | **Observer** | **Billing** | **Member** |
103 -| :-- | :--: | :--: | :--: | :--: | :--: | :--: |
104 -| See all dashboards in Room | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: |
105 -| Add new dashboard to Room | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: |
106 -| Edit any dashboard in Room | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | - | :heavy_check_mark: |
107 -| Edit own dashboard in Room | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: |
108 -| Delete any dashboard in Room | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | - | :heavy_check_mark: |
109 -| Delete own dashboard in Room | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: |
98 +| **Functionality** | **Admin** | **Manager** | **Troubleshooter** | **Observer** | **Billing** | **Member** |
99 +|:-----------------------------|:------------------:|:------------------:|:------------------:|:------------------:|:-----------:|:------------------:|
100 +| See all dashboards in Room | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: |
101 +| Add new dashboard to Room | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: |
102 +| Edit any dashboard in Room | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | - | :heavy_check_mark: |
103 +| Edit own dashboard in Room | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: |
104 +| Delete any dashboard in Room | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | - | :heavy_check_mark: |
105 +| Delete own dashboard in Room | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: |
106
107 ### Functions
108
113 -| **Functionality** | **Administrator** | **Manager** | **Troubleshooter** | **Observer** | **Billing** | **Member** | Notes |
109 +| **Functionality** | **Admin** | **Manager** | **Troubleshooter** | **Observer** | **Billing** | **Member** | Notes |
110 | :-- | :--: | :--: | :--: | :--: | :--: | :--: | :-- |
111 | See all functions in Room | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: |
112 | Run any function in Room | :heavy_check_mark: | :heavy_check_mark: | - | - | - | - |
@@ -119,27 +115,27 @@ Notes:
115
116 ### Events feed
117
122 -| **Functionality** | **Administrator** | **Manager** | **Troubleshooter** | **Observer** | **Billing** | **Member** | Notes |
123 -| :-- | :--: | :--: | :--: | :--: | :--: | :--: | :-- |
124 -| See Alert or Topology events | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: | |
125 -| See Auditing events | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | - | These are coming soon, not currently available |
118 +| **Functionality** | **Admin** | **Manager** | **Troubleshooter** | **Observer** | **Billing** | **Member** | Notes |
119 +|:-----------------------------|:------------------:|:------------------:|:------------------:|:------------------:|:-----------:|:------------------:|:-----------------------------------------------|
120 +| See Alert or Topology events | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: | |
121 +| See Auditing events | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | - | These are coming soon, not currently available |
122
123 ### Billing
124
129 -| **Functionality** | **Administrator** | **Manager** | **Troubleshooter** | **Observer** | **Billing** | **Member** | Notes |
130 -| :-- | :--: | :--: | :--: | :--: | :--: | :--: | :-- |
131 -| See Plan & Billing details | :heavy_check_mark: | - | - | - | :heavy_check_mark: | - | Current plan and usage figures |
132 -| Update plans | :heavy_check_mark: | - | - | - | - | - | This includes cancelling current plan (going to Community plan) |
133 -| See invoices | :heavy_check_mark: | - | - | - | :heavy_check_mark: | - | |
134 -| Manage payment methods | :heavy_check_mark: | - | - | - | :heavy_check_mark: | - | |
135 -| Update billing email | :heavy_check_mark: | - | - | - | :heavy_check_mark: | - | |
125 +| **Functionality** | **Admin** | **Manager** | **Troubleshooter** | **Observer** | **Billing** | **Member** | Notes |
126 +|:---------------------------|:------------------:|:-----------:|:------------------:|:------------:|:------------------:|:----------:|:----------------------------------------------------------------|
127 +| See Plan & Billing details | :heavy_check_mark: | - | - | - | :heavy_check_mark: | - | Current plan and usage figures |
128 +| Update plans | :heavy_check_mark: | - | - | - | - | - | This includes cancelling current plan (going to Community plan) |
129 +| See invoices | :heavy_check_mark: | - | - | - | :heavy_check_mark: | - | |
130 +| Manage payment methods | :heavy_check_mark: | - | - | - | :heavy_check_mark: | - | |
131 +| Update billing email | :heavy_check_mark: | - | - | - | :heavy_check_mark: | - | |
132
133 ### Other permissions
134
139 -| **Functionality** | **Administrator** | **Manager** | **Troubleshooter** | **Observer** | **Billing** | **Member** |
140 -| :-- | :--: | :--: | :--: | :--: | :--: | :--: |
141 -| See Bookmarks in Space | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: |
142 -| Add Bookmark to Space | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | - | :heavy_check_mark: |
143 -| Delete Bookmark from Space | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | - | :heavy_check_mark: |
144 -| See Visited Nodes | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: |
145 -| Update Visited Nodes | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: |
135 +| **Functionality** | **Admin** | **Manager** | **Troubleshooter** | **Observer** | **Billing** | **Member** |
136 +|:---------------------------|:------------------:|:------------------:|:------------------:|:------------------:|:-----------:|:------------------:|
137 +| See Bookmarks in Space | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: |
138 +| Add Bookmark to Space | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | - | :heavy_check_mark: |
139 +| Delete Bookmark from Space | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | - | :heavy_check_mark: |
140 +| See Visited Nodes | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: |
141 +| Update Visited Nodes | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - | :heavy_check_mark: |
docs/cloud/manage/view-plan-billing.md
+50 -109
@@ -1,141 +1,82 @@
1 # View Plan & Billing
2
3 -From the Cloud interface, you can view and manage your space's plan and billing settings, and see the space's usage in terms of running nodes.
4 -
5 -To view and manage some specific settings, related to billing options and invoices, you'll be redirected to our billing provider Customer Portal.
3 +This section outlines how to view and manage your Space's plan, billing settings, and usage from the Netdata Cloud interface.
4
5 ## Prerequisites
6
9 -To see your plan and billing setting you need:
10 -
11 -- A Cloud account
12 -- Access to the space as an Administrator or Billing user
7 +- A Netdata Cloud account
8 +- Admin or Billing user access to the Space
9
10 ## Steps
11
16 -### View current plan and Billing options and Invoices
17 -
18 -1. Click on the **Space settings** cog (located above your profile icon)
19 -1. Click on the **Plan & Billing** tab
20 -1. On this page you will be presented with information on your current plan, billing settings, and usage information:
21 - 1. At the top of the page you will see:
22 - - **Credit** amount which refers to any amount you have available to use on future invoices or subscription changes ([Plan changes and credit balance](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/plans.md#plan-changes-and-credit-balance)) - this is displayed once you have had an active paid subscription with us
23 - - **Billing email** the email that was specified to be linked to tha plan subscription. This is where invoices, payment, and subscription-related notifications will be sent.
24 - - **Billing options and Invoices** is the link to our billing provider Customer Portal where you will be able to:
25 - - See the current subscription. There will always be 2 subscriptions active for the two pricing components mentioned on [Netdata Plans documentation page](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/plans.md#plans)
26 - - Change directly the payment method associated to current subscriptions
27 - - View, add, delete or change your default payment methods
28 - - View or change or Billing information:
29 - - Billing email
30 - - Address
31 - - Phone number
32 - - Tax ID
33 - - View your invoice history
34 - 1. At the middle, you'll see details on your current plan as well as means to:
35 - - Upgrade or cancel your plan
36 - - View **All Plans** details page
37 - 1. At the bottom, you will find your Usage chart that displays:
38 - - Daily count - The weighted 90th percentile of the live node count during the day, taking time as the weight. If you have 30 live nodes throughout the day
39 - except for a two hour peak of 44 live nodes, the daily value is 31.
40 - - Period count: The 90th percentile of the daily counts for this period up to the date. The last value for the period is used as the number of nodes for the bill for that period. See more details in [running nodes and billing](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/plans.md#running-nodes-and-billing) (only applicable if you are on a paid plan subscription)
41 - - Committed nodes: The number of nodes committed to in the yearly plan. In case the period count is higher than the number of committed nodes, the difference is billed as overage.
42 -
43 -
44 -### Update plan
45 -
46 -1. Click on the **Space settings** cog (located above your profile icon)
47 -1. Click on the **Plan & Billing** tab
48 -1. On this page you will be presented with information on your current plan, billing settings, and usage information
49 - 1. Depending on your plan there could be shortcuts to immediately take you to change, for example, the billing frequency to **Yearly**
50 - 1. Most actions will be available under the **Change plan** link that take you to the **All plans** details page where you can
51 - 1. Downgrade or upgrade your plan
52 - 1. Change the billing frequency
53 - 1. Change committed nodes, in case you are on a Yearly plan
54 - 1. Once you chose an action to update your plan a modal will pop-up on the right with
55 - 1. Billing frequency displayed on the top right-corner
56 - 1. Committed Nodes, when applicable
57 - 1. Current billing information:
58 - - Billing email
59 - - Default payment method
60 - - Business name and VAT number, when these are applicable
61 - - Billing Address
62 - Note: Any changes to these need to done through our billing provider Customer Portal prior to confirm the checkout. You can click on the link **Change billing info and payment method** to access it.
63 - 1. Promotion code, so you can review any applied promotion or enter one you may have
64 - 1. Detailed view on Node and Space charges
65 - 1. Breakdown of:
66 - - Subscription Total
67 - - Discount from promotion codes, if applicable
68 - - credit value for Unused time from current plan, if applicable
69 - - Credit amount used from balance, if applicable
70 - - Total Before Tax
71 - - VAT rate and amount, if applicable
72 - 1. Summary of:
73 - - Total payable amount
74 - - credit adjustment value for any Remaining Unused time from current plan, if applicable
75 - - Final credit balance
76 -
77 -Notes:
78 -* Since there is an active plan you won't be redirected to our billing provider, the checkout if performed as soon as you click on **Checkout**
79 -* The change to your plan will be applied as soon as the checkout process is completed successfully
80 -* Downgrade or cancellations may have impacts on some of notification method settings or user accesses to your space, for more details please check [Plan changes and credit balance](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/plans.md#plan-changes-and-credit-balance)
81 -
82 -## FAQ
83 -
84 -### 1. What Payment Methods are accepted?
85 -
86 -You can easily pay online via most major Credit/Debit Cards. More payment options are expected to become available in the near future.
12 +### View Current Plan, Billing Options, and Invoices
13
88 -### 2. What happens if a renewal payment fails?
14 +1. Navigate to **Space settings** (the cog above your profile icon).
15 +2. Select the **Plan & Billing** tab.
16 +3. You'll see:
17 + - **Credit** amount, if applicable, usable for future invoices or subscription changes. More on this at [Plan changes and credit balance](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/plans.md#plan-changes-and-credit-balance).
18 + - **Billing email** linked to your subscription, where all related notifications are sent.
19 + - A link to the **Billing options and Invoices** in our billing provider's Customer Portal, where you can:
20 + - Manage subscriptions and payment methods.
21 + - Update billing information such as email, address, phone number, and Tax ID.
22 + - View invoice history.
23 + - The **Change plan** button, showing details of your current plan with options to upgrade or cancel.
24 + - Your **Usage chart**, displaying daily and period counts of live nodes and how they relate to your billing.
25
90 -After an initial failed payment, we will attempt to process your payment every week for the next 15 days. After three failed attempts your Space will be moved to the **Community** plan (free forever).
26 +### Update a Subscription Plan
27
92 -For the next 24 hours, you will be able to use all your current notification method configurations. After 24 hours, any of the notification method configurations that aren't available on your space's plan will be automatically disabled.
28 +1. In the **Plan & Billing** tab, click **Change plan** to see:
29 + - Billing frequency and committed nodes (if applicable).
30 + - Current billing information, which must be updated through our billing provider's Customer Portal via **Change billing info and payment method** link.
31 + - Options to enter a promotion code and a breakdown of charges, including subscription total, applicable discounts, credit usage, tax details, and total payable amount.
32
94 -Cancellation might affect users in your Space. Please check what roles are available on the [Community plan](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/plans.md#areas-impacted-by-plans). Users with unavailable roles on the Community plan will immediately have restricted access to the Space.
33 +> **Note**
34 +>
35 +> - Checkout is performed directly if there's an active plan.
36 +> - Plan changes, including downgrades or cancellations, may impact notification settings or user access. More details at [Plan changes and credit balance](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/plans.md#plan-changes-and-credit-balance).
37
96 -### 3. Which currencies do you support?
97 -
98 -We currently accept payments only in US Dollars (USD). We currently have plans to also accept payments in Euros (EUR), but do not currently have an estimate for when such support will be available.
38 +## FAQ
39
100 -### 4. Can I get a refund? How?
40 +### What Payment Methods are Accepted?
41
102 -Payments for Netdata subscriptions are refundable **only** if you cancel your subscription within 14 days of purchase. The refund will be credited to the Credit/Debit Card used for making the purchase. To request a refund, please email us at [billing@netdata.cloud](mailto:billing@netdata.cloud).
42 +Netdata accepts most major Credit/Debit Cards and Bank payments through Stripe and AWS, with more options coming soon.
43
104 -### 5. How do I cancel my paid Plan?
44 +### What Happens if a Renewal Payment Fails?
45
106 -Your annual or monthly Netdata Subscription plan will automatically renew until you cancel it. You can cancel your paid plan at any time by clicking ‘Cancel Plan’ from the **Plan & Billing** section under settings. You can also cancel your paid Plan by clicking the _Select_ button under **Community** plan in the **Plan & Billing** Section under Settings.
46 +If payment fails, attempts will be made weekly for 15 days. After three unsuccessful attempts, your Space will switch to the **Community** plan. Notification methods not supported by the Community plan will be disabled after 24 hours.
47
108 -### 6. How can I access my Invoices/Receipts after I paid for a Plan?
48 +### Which Currencies Do You Support?
49
110 -You can visit the _Billing Options & Invoices_ in the **Plan & Billing** section under settings in your Netdata Space where you can find all your Invoicing history.
50 +Currently, we accept US Dollars (USD). Plans to accept Euros (EUR) are in the works but without a set timeline.
51
112 -### 7. Why do I see two separate Invoices?
52 +### Can I Get a Refund?
53
114 -Every time you purchase or renew a Plan, two separate Invoices are generated:
54 +Refunds are available if you cancel your subscription within 14 days of purchase. Request a refund via [billing@netdata.cloud](mailto:billing@netdata.cloud).
55
116 -- One Invoice includes the recurring fees of the Plan you have chosen
56 +### How Do I Cancel My Paid Plan?
57
118 - We have waived off the space subscription free ($0.00), so the only recurring fee will be on annual plans for the committed nodes.
58 +Cancel your plan anytime from the **Plan & Billing** section by selecting 'Cancel Plan' or switching to the **Community** plan.
59
120 -- The other Invoice includes your monthly “On Demand - Usage”.
60 +### How Can I Access My Invoices/Receipts?
61
122 - Right after the activation of your subscription, you will receive a zero value Invoice since you had no usage when you subscribed.
123 -
124 - On the following month you will receive an Invoice based on your monthly usage.
62 +Find all your invoicing history under _Billing Options & Invoices_ in the **Plan & Billing** section.
63
126 -You can find some further details on the [Netdata Plans page](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/plans.md#plans).
64 +### Why Do I See Two Separate Invoices?
65
128 -> ⚠️ We expect this to change to a single invoice in the future, but currently do not have a concrete timeline for when this change will happen.
66 +Two invoices are generated per plan purchase or renewal:
67
130 -### 8. How is the **Total Before Tax** value calculated on plan changes?
68 +- One for recurring fees of the chosen plan.
69 +- Another for monthly "On-Demand - Usage" based on actual usage.
70
132 -When you change your plan we will be calculating the residual before tax value you have from the _Unused time on your current plan_ in order to credit you with this value.
71 +### How is the **Total Before Tax** Value Calculated on Plan Changes?
72
134 -After that, we will be performing the following calculations:
73 +The total before tax is calculated by:
74
136 -1. Get the **Subscription total** (total amount to be paid for Nodes and Space)
137 -2. Deduct any Discount applicable from promotion codes
138 -3. If an amount remains, then we deduct the sum of the _Unused time on current plan_ then and the Credit amount from any existing credit balance.
139 -4. The result, if positive, is the Total Before Tax, if applicable, any sales tax (VAT or other) will apply.
75 +1. Calculating the residual value from unused time on your current plan.
76 +2. Deducting any applicable discounts.
77 +3. Subtracting credit from your balance, if necessary.
78 +4. Applying tax to the final amount, if positive. Negative results adjust your customer credit balance.
79
141 -If the calculation of step 3 returns a negative amount then this amount will be your new customer credit balance.
80 +> **Note**
81 +>
82 +> A move to single-invoice billing is expected in the future, although a specific timeline is not set.
docs/monitor/view-active-alerts.md
+4 -5
@@ -23,9 +23,9 @@ From this tab, you can also filter alerts with the right hand bar. More specific
23 - Host labels
24 - Filter based on the host labels that are configured for the nodes across the War Room (e.g. `_cloud_instance_region` to match `us-east-1`)
25 - Node status
26 - - Filter by node availability status (e.g. Live or Offline)
26 + - Filter by node availability status (e.g. Live or Offline)
27 - Netdata version
28 - - Filter by Netdata version (e.g. `v1.45.3`)
28 + - Filter by Netdata version (e.g. `v1.45.3`)
29 - Nodes
30 - Filter the alerts based on the nodes of your War Room.
31
@@ -35,7 +35,7 @@ By clicking on the name of an entry of the table you can access that alert's det
35
36 - Latest and Triggered time values
37 - The alert's description
38 -- A link to the Netdata Advisor's page about this alert
38 +- A link to the Netdata Advisor's page about this alert
39 - The chart at the time frame that the alert was triggered
40 - The alert's information: Node name, chart instance, type, component and class
41 - Configuration section
@@ -45,7 +45,7 @@ At the bottom of the panel you can click the green button "View alert page" to o
45
46 ### Silence an alert
47
48 -From this tab, the "Silencing" column shows if there is any rule present for each alert, and from the "Actions" column you can create a new [silencing rule](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.md#silencing-alert-notifications) for this alert, or get help and information about this alert from the [Netdata Assistant](https://github.com/netdata/netdata/blob/master/docs/cloud/netdata-assistant.md).
48 +From this tab, the "Silencing" column shows if there is any rule present for each alert, and from the "Actions" column you can create a new [silencing rule](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.md#alert-notifications-silencing-rules) for this alert, or get help and information about this alert from the [Netdata Assistant](https://github.com/netdata/netdata/blob/master/docs/cloud/netdata-assistant.md).
49
50 ## Alert Configurations tab
51
@@ -53,7 +53,6 @@ From this tab you can view all the configurations for all running alerts in your
53
54 By running alerts we mean alerts that are related to some metric that is or was collected. Netdata may have more alerts pre-configured that aren't applicable to your monitoring use-cases.
55
56 -
56 You can control which columns are visible by using the gear icon on the right-hand side.
57
58 Similarly to the previous tab, you can see the silencing status of an alert, while also being able to dig deeper and show the configuration for the alert and ask the [Netdata Assistant](https://github.com/netdata/netdata/blob/master/docs/cloud/netdata-assistant.md) for help.
integrations/cloud-authentication/metadata.yaml
+4 -4
@@ -19,8 +19,8 @@
19 ### Prerequisites
20 - An Okta account
21 - A Netdata Cloud account
22 - - Access to the Space as an administrator
23 - - Space needs to be on the Business plan or higher
22 + - Access to the Space as an **Admin**
23 + - Space needs to be on a paid plan
24
25 ### Setting up Okta
26 Steps needed to be done on Okta Admin Portal:
@@ -66,8 +66,8 @@
66 ### Prerequisites
67 - Authorization Server with OIDC protocol supported
68 - A Netdata Cloud account
69 - - Access to the Space as an administrator
70 - - Space needs to be on the Business plan or higher
69 + - Access to the Space as an **Admin**
70 + - Space needs to be on a paid plan
71
72 ### Setting up Authorization Server
73 Your server should follow the [full specification for OIDC](https://openid.net/specs/openid-connect-core-1_0.html).
integrations/cloud-notifications/metadata.yaml
+24 -24
@@ -26,7 +26,7 @@
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 Business Subscription**
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)
@@ -50,7 +50,7 @@
50 description: |
51 ### Prerequisites
52 - A Netdata Cloud account
53 - - Access to the Netdata Space as an **administrator**
53 + - Access to the Netdata Space as an **Admin**
54 - You need to have a Discord server able to receive webhooks integrations.
55
56 ### Discord Server Configuration
@@ -91,8 +91,8 @@
91 description: |
92 ### Prerequisites
93 - A Netdata Cloud account
94 - - Access to the Netdata Space as an **administrator**
95 - - The Netdata Space needs to be on **Business** plan or higher
94 + - Access to the Netdata Space as an **Admin**
95 + - The Netdata Space needs to be on a paid plan
96 - You need to have a PagerDuty service to receive events using webhooks.
97
98
@@ -135,8 +135,8 @@
135 ### Prerequisites
136
137 - A Netdata Cloud account
138 - - Access to the Netdata Space as an **administrator**
139 - - The Netdata Space needs to be on **Business** plan or higher
138 + - Access to the Netdata Space as an **Admin**
139 + - The Netdata 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
@@ -185,8 +185,8 @@
185 ### Prerequisites
186
187 - A Netdata Cloud account
188 - - Access to the Netdata Space as an **administrator**
189 - - The Netdata Space needs to be on **Business** plan or higher
188 + - Access to the Netdata Space as an **Admin**
189 + - The Netdata Space needs to be on a paid plan
190 - You need to have permissions on Opsgenie to add new integrations.
191
192 ### Opsgenie Server Configuration
@@ -228,8 +228,8 @@
228 ### Prerequisites
229
230 - A Netdata Cloud account
231 - - Access to the Netdata Space as an **administrator**
232 - - The Netdata Space needs to be on **Business** plan or higher
231 + - Access to the Netdata Space as an **Admin**
232 + - The Netdata Space needs to be on a paid plan
233 - 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.
235
@@ -279,8 +279,8 @@
279 ### Prerequisites
280
281 - A Netdata Cloud account
282 - - Access to the Netdata Space as an **administrator**
283 - - The Netdata Space needs to be on **Business** plan or higher
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
@@ -332,8 +332,8 @@
332 To add AWS SNS notification you need:
333
334 - A Netdata Cloud account
335 - - Access to the space as an **administrator**
336 - - Space needs to be on **Business** plan or higher
335 + - Access to the space as an **Admin**
336 + - 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)
338
339 ### Steps
@@ -381,8 +381,8 @@
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 **administrator**.
385 - - The Space to be on **Business** plan or higher.
384 + - Access to the Netdata Cloud space as an **Admin**.
385 + - The Space to be on a paid plan.
386 - A [Microsoft 365 for Business Account](https://www.microsoft.com/en-us/microsoft-365/business). Note that this is a **paid** account.
387
388 ### Settings on Microsoft Teams
@@ -430,8 +430,8 @@
430 To add Telegram notification you need:
431
432 - A Netdata Cloud account
433 - - Access to the space as an **administrator**
434 - - Space needs to be on **Business** plan or higher
433 + - Access to the space as an **Admin**
434 + - The Space needs to be on a paid plan
435 - The Telegram bot token and chat ID
436
437 ### Steps
@@ -475,8 +475,8 @@
475 To add Splunk notification you need:
476
477 - A Netdata Cloud account
478 - - Access to the space as an **administrator**
479 - - Space needs to be on **Business** plan or higher
478 + - Access to the space as an **Admin**
479 + - The Space needs to be on a paid plan
480 - 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.
481
482 ### Steps
@@ -515,8 +515,8 @@
515 To add Splunk VictorOps notification (also known as Splunk On-Call) you need:
516
517 - A Netdata Cloud account
518 - - Access to the space as an **administrator**
519 - - Space needs to be on **Business** plan or higher
518 + - Access to the space as an **Admin**
519 + - The Space needs to be on a paid plan
520 - 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.
521
522 ### Steps
@@ -551,8 +551,8 @@
551 ### Prerequisites
552
553 - A Netdata Cloud account
554 - - Access to the Netdata Space as an **administrator**
555 - - The Netdata Space needs to be on **Pro** plan or higher
554 + - Access to the Netdata Space as an **Admin**
555 + - The Netdata Space needs to be on a paid plan
556 - You need to have an app that allows you to receive webhooks following a predefined schema.
557
558 ### Netdata Configuration Steps