First batch of adding descriptions to the documentation (#14825)
* first batch of adding descriptions to the documentation, and fixing inconsistencies inside the files * Apply suggestions from code review Co-authored-by: Chris Akritidis <43294513+cakrit@users.noreply.github.com> * Update docs/cloud/visualize/overview.md * Replace view with tab in overview.md --------- Co-authored-by: Chris Akritidis <43294513+cakrit@users.noreply.github.com>
Fotis Voutsas committed
Mar 29, 2023 at 22:15 UTC
5c3084911c5df62320e284b2db777a817a6e2fe2
17 files changed
+151
-167
claim/README.md
+3
-1
@@ -1,5 +1,7 @@
1
# Connect Agent to Cloud
2
3
+This page will guide you through connecting a Netdata Agent to Netdata Cloud securely, via the encrypted Agent-Cloud link (ACLK).
4
+
5
You can securely connect a Netdata Agent, running on a distributed node, to Netdata Cloud. A Space's
6
administrator creates a **claiming token**, which is used to add an Agent to their Space via the [Agent-Cloud link
7
(ACLK)](https://github.com/netdata/netdata/blob/master/aclk/README.md).
@@ -564,7 +566,7 @@ using the [ACLK](https://github.com/netdata/netdata/blob/master/aclk/README.md).
566
567
| setting | default | info |
568
|:-------------- |:------------------------- |:-------------------------------------------------------------------------------------------------------------------------------------- |
567
-| cloud base url | https://api.netdata.cloud | The URL for the Netdata Cloud web application. You should not change this. If you want to disable Cloud, change the `enabled` setting. |
569
+| cloud base url | <https://api.netdata.cloud> | The URL for the Netdata Cloud web application. You should not change this. If you want to disable Cloud, change the `enabled` setting. |
570
| enabled | yes | The runtime option to disable the [Agent-Cloud link](https://github.com/netdata/netdata/blob/master/aclk/README.md) and prevent your Agent from connecting to Netdata Cloud. |
571
572
### Claiming script
docs/cloud/manage/invite-your-team.md
+2
@@ -1,5 +1,7 @@
1
# Invite your team
2
3
+Invite your entire SRE, DevOPs, or ITOps team to Netdata Cloud, to give everyone insights into your infrastructure from a single pane of glass.
4
+
5
Invite new users to your Space by clicking on **Invite Users** in
6
the [Space](https://github.com/netdata/netdata/blob/master/docs/cloud/spaces.md) management area.
7
docs/cloud/manage/plans.md
+20
-22
@@ -1,22 +1,13 @@
1
-<!--
2
-title: "Netdata Plans"
3
-sidebar_label: "Netdata Plans"
4
-custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/manage/plans.md"
5
-sidebar_position: "1000"
6
-learn_status: "Published"
7
-learn_topic_type: "Concepts"
8
-learn_rel_path: "Concepts"
9
-learn_docs_purpose: "Explain what are Netdata Plans"
10
--->
11
-
1
# Netdata Plans
2
3
+This page will guide you through the differences between the Community, Pro, Business and Enterprise plans.
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.
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.
8
9
:::note
19
-To not disrupt current users space's access rights we will be keeping their current plan as the **Early Bird** plan. The reason for this is to allow users to
10
+To not disrupt current users space's access rights we will be keeping their current plan as 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
@@ -29,22 +20,26 @@ you to invite or change users using the Member role. See more details on our [ro
20
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.
21
22
Netdata Cloud plans, with the exception of Community, work as subscriptions and overall consist of two pricing components:
23
+
24
* A flat fee component, that is a price per space, and
25
* 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)
26
27
Netdata provides two billing frequency options:
28
+
29
* Monthly - Pay as you go, where we charge both the flat fee and the on-demand component every month
30
* 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))
31
39
-For more details on the plans and subscription conditions please check https://netdata.cloud/pricing.
32
+For more details on the plans and subscription conditions please check <https://netdata.cloud/pricing>.
33
34
#### Running nodes and billing
35
36
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:
37
+
38
* offline nodes
39
* stale nodes, nodes that are available to query through a Netdata parent agent but are not actively connecting metrics at the moment
40
41
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:
42
+
43
* 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
44
* 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).
45
@@ -63,13 +58,14 @@ If, for a given month, your usage is over these committed nodes we will charge t
58
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.
59
60
To achieve this you will need to:
61
+
62
* Move to the Community plan, where we will cancel the current subscription and:
67
- * Issue a credit to you for the unused period, in case you are on a **yearly plan**
68
- * Charge you only for the current used period and issue a credit for the unused period related to the flat fee, in case you are on a **monthly plan**
63
+ * Issue a credit to you for the unused period, in case you are on a **yearly plan**
64
+ * Charge you only for the current used period and issue a credit for the unused period related to the flat fee, in case you are on a **monthly plan**
65
* Select the new subscription with the change that you want
66
67
> ⚠️ On a move to Community (cancellation of an active subscription), please note that you will have all your notification methods configurations active **for a period of 24 hours**.
72
-> 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.
68
+> 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.
69
70
> ⚠️ Any credit given to you will be available to use on future paid subscriptions with us. It will be available until the the **end of the following year**.
71
@@ -86,7 +82,7 @@ Depending on the plan associated to your space you will have different roles ava
82
| **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: | - |
83
| **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: | - |
84
| **Billing**<p>Users with this role can handle billing options and invoices.</p> | - | - | :heavy_check_mark: | - |
89
-| **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: |
85
+| **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: |
86
87
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).
88
@@ -105,6 +101,7 @@ For more details check the documentation under [Events feed](https://github.com/
101
##### Notification integrations
102
103
The plan on your space will determine what type of notifications methods will be available to you:
104
+
105
* **Community** - Email and Discord
106
* **Pro** - Email, Discord and webhook
107
* **Business** - Unlimited, this includes Slack, PagerDuty, etc.
@@ -114,11 +111,12 @@ For mode details check the documentation under [Alert Notifications](https://git
111
### Related Topics
112
113
#### **Related Concepts**
117
-- [Spaces](https://github.com/netdata/netdata/blob/master/docs/cloud/spaces.md)
118
-- [Alert Notifications](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.md)
119
-- [Events feed](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/events-feed.md)
120
-- [Role-Based Access model](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/role-based-access.md)
114
115
+* [Spaces](https://github.com/netdata/netdata/blob/master/docs/cloud/spaces.md)
116
+* [Alert Notifications](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/notifications.md)
117
+* [Events feed](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/events-feed.md)
118
+* [Role-Based Access model](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/role-based-access.md)
119
120
#### Related Tasks
124
-- [View Plan & Billing](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/view-plan-billing.md)
121
+
122
+* [View Plan & Billing](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/view-plan-billing.md)
docs/cloud/manage/sign-in.md
+10
-9
@@ -1,4 +1,6 @@
1
-# Sign in with email, Google, or GitHub
1
+# Sign in to Netdata
2
+
3
+This page explains how to sign in to Netdata with your email, Google account, or GitHub account, and provides some tips if you're having trouble signing in.
4
5
You can [sign in to Netdata](https://app.netdata.cloud/sign-in?cloudRoute=spaces?utm_source=docs&utm_content=sign_in_button_first_section) through one of three methods: email, Google, or GitHub. Email uses a
6
time-sensitive link that authenticates your browser, and Google/GitHub both use OAuth to associate your email address
@@ -7,7 +9,6 @@ with a Netdata Cloud account.
9
No matter the method, your Netdata Cloud account is based around your email address. Netdata Cloud does not store
10
passwords.
11
10
-
12
## Email
13
14
To sign in with email, visit [Netdata Cloud](https://app.netdata.cloud/sign-in?cloudRoute=spaces?utm_source=docs&utm_content=sign_in_button_email_section), enter your email address, and click
@@ -31,22 +32,22 @@ quickstart](https://github.com/netdata/netdata/blob/master/packaging/installer/R
32
33
### Troubleshooting
34
34
-You should receive your sign in email in less than a minute. The subject is **Verify your email!** for new sign-ups, **Sign in to Netdata** for sign ins.
35
+You should receive your sign in email in less than a minute. The subject is **Verify your email!** for new sign-ups, **Sign in to Netdata** for sign ins.
36
The sender is `no-reply@netdata.cloud` via `sendgrid.net`.
37
38
If you don't see the email, try the following:
39
39
-- Check your spam folder.
40
-- In Gmail, check the **Updates** category.
41
-- Check [Netdata Cloud status](https://status.netdata.cloud) for ongoing issues with our infrastructure.
42
-- Request another sign in email via the [sign in page](https://app.netdata.cloud/sign-in?cloudRoute=spaces?utm_source=docs&utm_content=sign_in_button_troubleshooting_section).
40
+- Check your spam folder.
41
+- In Gmail, check the **Updates** category.
42
+- Check [Netdata Cloud status](https://status.netdata.cloud) for ongoing issues with our infrastructure.
43
+- Request another sign in email via the [sign in page](https://app.netdata.cloud/sign-in?cloudRoute=spaces?utm_source=docs&utm_content=sign_in_button_troubleshooting_section).
44
45
You may also want to add `no-reply@netdata.cloud` to your address book or contacts list, especially if you're using
46
a public email service, such as Gmail. You may also want to whitelist/allowlist either the specific email or the entire
47
`netdata.cloud` domain.
48
49
In some cases, temporary issues with your mail server or email account may result in your email address being added to a Bounce list by Sendgrid.
49
-If you are added to that list, no Netdata cloud email can reach you, including alarm notifications. Let us know in Discord that you have trouble receiving
50
+If you are added to that list, no Netdata cloud email can reach you, including alarm notifications. Let us know in Discord that you have trouble receiving
51
any email from us and someone will ask you to provide your email address privately, so we can check if you are on the Bounce list.
52
53
## Google and GitHub OAuth
@@ -56,7 +57,7 @@ receives via OAuth.
57
58
To sign in with Google or GitHub OAuth, visit [Netdata Cloud](https://app.netdata.cloud/sign-in?cloudRoute=spaces?utm_source=docs&utm_content=sign_in_button_google_github_section) and click the
59
**Continue with Google/GitHub** or button. Enter your Google/GitHub username and your password. Complete two-factor
59
-authentication if you or your organization has it enabled.
60
+authentication if you or your organization has it enabled.
61
62
You are then signed in to Netdata Cloud or directed to the new-user onboarding if you have not signed up previously.
63
docs/cloud/manage/view-plan-billing.md
+34
-37
@@ -1,79 +1,81 @@
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.
6
6
-#### Prerequisites
7
+## Prerequisites
8
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
13
13
-#### Steps
14
+## Steps
15
16
1. Click on the **Space settings** cog (located above your profile icon)
17
1. Click on the **Plan & Billing** tab
18
1. On this page you will be presented with information on your current plan, billing settings, and usage information:
19
1. At the top of the page you will see:
19
- * **Credit** amount which refers to any amount you have available to use on future invoices or subscription changes (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
20
- * **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.
21
- * **Billing options and Invoices** is the link to our billing provider Customer Portal where you will be able to:
22
- * 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)
23
- * Change directly the payment method associated to current subscriptions
24
- * View, add, delete or change your default payment methods
25
- * View or change or Billing information:
26
- * Billing email
27
- * Address
28
- * Phone number
29
- * Tax ID
30
- * View your invoice history
20
+ - **Credit** amount which refers to any amount you have available to use on future invoices or subscription changes (<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
21
+ - **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.
22
+ - **Billing options and Invoices** is the link to our billing provider Customer Portal where you will be able to:
23
+ - 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)
24
+ - Change directly the payment method associated to current subscriptions
25
+ - View, add, delete or change your default payment methods
26
+ - View or change or Billing information:
27
+ - Billing email
28
+ - Address
29
+ - Phone number
30
+ - Tax ID
31
+ - View your invoice history
32
1. At the middle, you'll see details on your current plan as well as means to:
32
- * Upgrade or cancel your plan
33
- * View full plan details page
33
+ - Upgrade or cancel your plan
34
+ - View full plan details page
35
1. At the bottom, you will find your Usage chart that displays:
35
- * 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
36
+ - 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
37
except for a two hour peak of 44 live nodes, the daily value is 31.
37
- * 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)
38
- * 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.
38
+ - 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)
39
+ - 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.
40
41
> ⚠️ At the moment, any changes to an active paid plan, upgrades, change billing frequency or committed nodes, will be a manual two-setup flow:
42
+>
43
> 1. cancel your current subscription - move you to the Community plan
44
> 2. chose the plan with the intended changes
45
>
46
> This is a temporary process that we aim to sort out soon so that it will effortless for you to do any of these actions.
47
46
-### FAQ
48
+## FAQ
49
48
-#### 1. What Payment Methods are accepted?
50
+### 1. What Payment Methods are accepted?
51
50
-You can easily pay online via most major Credit/Debit Cards. More payment options are expected to become available in the near future.
52
+You can easily pay online via most major Credit/Debit Cards. More payment options are expected to become available in the near future.
53
52
-#### 2. What happens if a renewal payment fails?
54
+### 2. What happens if a renewal payment fails?
55
54
-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).
56
+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).
57
58
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.
59
60
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.
61
60
- #### 3. Which currencies do you support?
62
+### 3. Which currencies do you support?
63
64
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.
65
64
-#### 4. Can I get a refund? How?
66
+### 4. Can I get a refund? How?
67
68
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).
67
-
68
-#### 5. How do I cancel my paid Plan?
69
70
-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.
70
+### 5. How do I cancel my paid Plan?
71
+
72
+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.
73
72
-#### 6. How can I access my Invoices/Receipts after I paid for a Plan?
74
+### 6. How can I access my Invoices/Receipts after I paid for a Plan?
75
76
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.
77
76
-#### 7. Why do I see two separate Invoices?
78
+### 7. Why do I see two separate Invoices?
79
80
Every time you purchase or renew a Plan, two separate Invoices are generated:
81
@@ -81,15 +83,10 @@ Every time you purchase or renew a Plan, two separate Invoices are generated:
83
84
- The other Invoice includes your monthly “On Demand - Usage”.
85
84
- Right after the activation of your subscription, you will receive a zero value Invoice since you had no usage when you subscribed.
86
+ Right after the activation of your subscription, you will receive a zero value Invoice since you had no usage when you subscribed.
87
88
On the following month you will receive an Invoice based on your monthly usage.
89
90
You can find some further details on the [Netdata Plans page](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/plans.md#plans).
91
92
> ⚠️ 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.
91
-
92
-
93
-#### Related topics
94
-
95
-- [Netdata Plans](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/plans.md)
docs/cloud/spaces.md
+3
-6
@@ -1,4 +1,6 @@
1
-# Spaces
1
+# Netdata Cloud Spaces
2
+
3
+Organize your multi-organization infrastructure monitoring on Netdata Cloud by creating Spaces to completely isolate access to your Agent-monitored nodes.
4
5
A Space is a high-level container. It's a collaboration space where you can organize team members, access levels and the
6
nodes you want to monitor.
@@ -74,8 +76,3 @@ Netdata admin users now have the ability to remove obsolete nodes from a space.
76
- If the obsoleted nodes eventually become live or online once more they will be automatically re-added to the space
77
78
77
-
78
-## What's next?
79
-
80
-Once you configured your Spaces, it's time to set up
81
-your [War Rooms](https://github.com/netdata/netdata/blob/master/docs/cloud/war-rooms.md).
docs/cloud/visualize/interact-new-charts.md
+2
@@ -1,5 +1,7 @@
1
# Interact with charts
2
3
+Learn how to use Netdata's powerful charts to troubleshoot with real-time, per-second metric data.
4
+
5
Netdata excels in collecting, storing, and organizing metrics in out-of-the-box dashboards.
6
To make sense of all the metrics, Netdata offers an enhanced version of charts that update every second.
7
docs/cloud/visualize/node-filter.md
+2
-6
@@ -1,16 +1,12 @@
1
# Node filter
2
3
-The node filter allows you to quickly filter the nodes visualized in a War Room's views.
4
-It appears on all views, except on single-node dashboards.
3
+The node filter allows you to quickly filter the nodes visualized in a War Room's views. It appears on all views, except on single-node dashboards.
4
5
Inside the filter, the nodes get categorized into three groups:
6
7
- Live nodes
8
Nodes that are currently online, collecting and streaming metrics to Cloud.
10
- - Live nodes display
11
- raised [Alert](https://github.com/netdata/netdata/blob/master/docs/monitor/view-active-alarms.md) counters,
12
- [Machine Learning](https://github.com/netdata/netdata/blob/master/ml/README.md) availability,
13
- and [Functions](https://github.com/netdata/netdata/blob/master/docs/cloud/netdata-functions.md) availability
9
+ - Live nodes display raised [Alert](https://github.com/netdata/netdata/blob/master/docs/monitor/view-active-alarms.md) counters, [Machine Learning](https://github.com/netdata/netdata/blob/master/ml/README.md) availability, and [Functions](https://github.com/netdata/netdata/blob/master/docs/cloud/netdata-functions.md) availability
10
- Stale nodes
11
Nodes that are offline and not streaming metrics to Cloud. Only historical data can be presented from a parent node.
12
- For these nodes you can only see their ML status, as they are not online to provide more information
docs/cloud/visualize/overview.md
+14
-20
@@ -1,4 +1,6 @@
1
-# Home, overview and single node views
1
+# Home, overview and single node tabs
2
+
3
+Learn how to use the Home, Overview, and Single Node tabs in Netdata Cloud, to explore your infrastructure and troubleshoot issues.
4
5
## Home
6
@@ -7,7 +9,7 @@ The Home tab provides a predefined dashboard of relevant information about entit
9
This tab will automatically present summarized information in an easily digestible display. You can see information about your
10
nodes, data collection and retention stats, alerts, users and dashboards.
11
10
-## Overview and single node view
12
+## Overview and single node tab
13
14
The Overview tab is another great way to monitor infrastructure using Netdata Cloud. While the interface might look
15
similar to local dashboards served by an Agent Overview uses **composite charts**.
@@ -16,8 +18,7 @@ These charts display real-time aggregated metrics from all the nodes (or a filte
18
When you [interact with composite charts](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md)
19
you can see your infrastructure from a single pane of glass, discover trends or anomalies, and perform root cause analysis.
20
19
-The Single Node view dashboard is exactly the same as the Overview, but with a hard-coded filter to only show
20
-a single node.
21
+The Single Node tab dashboard is exactly the same as the Overview, but with a hard-coded filter to only show a single node.
22
23
### Chart navigation Menu
24
@@ -30,25 +31,18 @@ monitor an Apache web server, the **Apache** section still appears and displays
31
One difference between the Netdata Cloud menu and those found in local Agent dashboards is that
32
the Overview condenses multiple services, families, or instances into single sections, sub-menus, and associated charts.
33
33
-For services, let's say you have two concurrent jobs with the
34
-[web_log collector](https://github.com/netdata/go.d.plugin/blob/master/modules/weblog/README.md), one for Apache and
35
-another for Nginx. A single-node or
36
-local dashboard shows two section, **web_log apache** and **web_log nginx**, whereas the Overview condenses these into a
34
+For services, let's say you have two concurrent jobs with the [web_log collector](https://github.com/netdata/go.d.plugin/blob/master/modules/weblog/README.md), one for Apache and another for Nginx.
35
+A single-node or local dashboard shows two section, **web_log apache** and **web_log nginx**, whereas the Overview condenses these into a
36
single **web_log** section containing composite charts from both jobs.
37
39
-The Cloud also condenses multiple families or multiple instances into a single **all** sub-menu and associated
40
-charts. For example, if Node A has 5 disks, and Node B has 3, each disk contributes to a single `disk.io` composite
41
-chart. The utility bar should show that there are 8 charts from 2 nodes contributing to that chart. The aggregation applies
42
-to disks, network devices, and other metric types that involve multiple instances of a piece of hardware or software.
38
+The Cloud also condenses multiple families or multiple instances into a single **all** sub-menu and associated charts.
39
+For example, if Node A has 5 disks, and Node B has 3, each disk contributes to a single `disk.io` composite chart.
40
+The utility bar should show that there are 8 charts from 2 nodes contributing to that chart.
41
+The aggregation applies to disks, network devices, and other metric types that involve multiple instances of a piece of hardware or software.
42
43
## Persistence of composite chart settings
44
46
-Of course you can
47
-[change the filtering or grouping](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md)
48
-of metrics in the composite charts that aggregate all these instances, to see only the information you are interested in,
49
-and save that view in a custom dashboard.
50
-
51
-When you change a composite chart via its definition bar, Netdata Cloud persists these settings in a query string
52
-attached to the URL in your browser. You can "save" these settings by bookmarking this particular URL, or share it with
53
-colleagues by having them copy-paste it into their browser.
45
+Of course you can [change the filtering or grouping](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md) of metrics in the composite charts that aggregate all these instances, to see only the information you are interested in, and save that tab in a custom dashboard.
46
47
+When you change a composite chart via its definition bar, Netdata Cloud persists these settings in a query string attached to the URL in your browser.
48
+You can "save" these settings by bookmarking this particular URL, or share it with colleagues by having them copy-paste it into their browser.
docs/cloud/war-rooms.md
+2
-3
@@ -1,7 +1,6 @@
1
-# War rooms
1
+# Netdata Cloud War rooms
2
3
-War Rooms organize your connected nodes and provide infrastructure-wide dashboards using real-time metrics and
4
-visualizations.
3
+Netdata Cloud uses War Rooms to organize your connected nodes and provide infrastructure-wide dashboards using real-time metrics and visualizations.
4
5
Once you add nodes to a Space, all of your nodes will be visible in the **All nodes** War Room. This is a special War Room
6
which gives you an overview of all of your nodes in this particular Space. Then you can create functional separations of
docs/dashboard/visualization-date-and-time-controls.md
+4
-2
@@ -1,5 +1,9 @@
1
# Visualization date and time controls
2
3
+Netdata's dashboard features powerful date visualization controls that include a time control, a timezone selector and a rich date and timeframe selector.
4
+
5
+The controls come with useful defaults and rich customization, to help you narrow your focus when troubleshooting issues or anomalies.
6
+
7
## Time controls
8
9
The time control provides you the following options: **Play**, **Pause** and **Force Play**.
@@ -17,7 +21,6 @@ Main use cases for **Force Play**:
21
22
23
20
-
24
## Date and time selector
25
26
The date and time selector allows you to change the visible timeframe and change the timezone used in the interface.
@@ -78,7 +81,6 @@ beyond stored historical metrics, you'll see this message:
81
82
83
81
-
84
At any time, [configure the internal TSDB's storage capacity](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md) to expand your
85
depth of historical metrics.
86
docs/getting-started/introduction.md
+30
-29
@@ -1,4 +1,6 @@
1
-# Getting started
1
+# Getting started with Netdata
2
+
3
+Learn how Netdata can get you monitoring your infrastructure in minutes.
4
5
## What is Netdata ?
6
@@ -12,34 +14,34 @@ Netdata is:
14
15
### Simple to deploy
16
15
-- **One-line deployment** for Linux distributions, plus support for Kubernetes/Docker infrastructures.
16
-- **Zero configuration and maintenance** required to collect thousands of metrics, every second, from the underlying
17
+- **One-line deployment** for Linux distributions, plus support for Kubernetes/Docker infrastructures.
18
+- **Zero configuration and maintenance** required to collect thousands of metrics, every second, from the underlying
19
OS and running applications.
18
-- **Prebuilt charts and alarms** alert you to common anomalies and performance issues without manual configuration.
19
-- **Distributed storage** to simplify the cost and complexity of storing metrics data from any number of nodes.
20
+- **Prebuilt charts and alarms** alert you to common anomalies and performance issues without manual configuration.
21
+- **Distributed storage** to simplify the cost and complexity of storing metrics data from any number of nodes.
22
23
### Powerful and scalable
24
23
-- **1% CPU utilization, a few MB of RAM, and minimal disk I/O** to run the monitoring Agent on bare metal, virtual
25
+- **1% CPU utilization, a few MB of RAM, and minimal disk I/O** to run the monitoring Agent on bare metal, virtual
26
machines, containers, and even IoT devices.
25
-- **Per-second granularity** for an unlimited number of metrics based on the hardware and applications you're running
27
+- **Per-second granularity** for an unlimited number of metrics based on the hardware and applications you're running
28
on your nodes.
27
-- **Interoperable exporters** let you connect Netdata's per-second metrics with an existing monitoring stack and other
29
+- **Interoperable exporters** let you connect Netdata's per-second metrics with an existing monitoring stack and other
30
time-series databases.
31
32
### Optimized for troubleshooting
33
32
-- **Visual anomaly detection** with a UI/UX that emphasizes the relationships between charts.
33
-- **Customizable dashboards** to pinpoint correlated metrics, respond to incidents, and help you streamline your
34
+- **Visual anomaly detection** with a UI/UX that emphasizes the relationships between charts.
35
+- **Customizable dashboards** to pinpoint correlated metrics, respond to incidents, and help you streamline your
36
workflows.
35
-- **Distributed metrics in a centralized interface** to assist users or teams trace complex issues between distributed
37
+- **Distributed metrics in a centralized interface** to assist users or teams trace complex issues between distributed
38
nodes.
39
40
### Secure by design
41
40
-- **Distributed data architecture** so fast and efficient, there’s no limit to the number of metrics you can follow.
41
-- Because your data is **stored at the edge**, security is ensured.
42
--
42
+- **Distributed data architecture** so fast and efficient, there’s no limit to the number of metrics you can follow.
43
+- Because your data is **stored at the edge**, security is ensured.
44
+
45
### Comparison with other monitoring solutions
46
47
Netdata offers many benefits over the existing monitoring landscape, whether they're expensive SaaS products or other
@@ -57,21 +59,19 @@ open-source tools.
59
| **Kills the console** for tracing performance issues | The console is always required for troubleshooting |
60
| Requires **zero dedicated resources** | Require large dedicated resources |
61
60
-
62
Netdata works with tons of applications, notifications platforms, and other time-series databases:
63
63
-- **300+ system, container, and application endpoints**: Collectors autodetect metrics from default endpoints and
64
+- **300+ system, container, and application endpoints**: Collectors autodetect metrics from default endpoints and
65
immediately visualize them into meaningful charts designed for troubleshooting. See [everything we
66
support](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md).
66
-- **20+ notification platforms**: Netdata's health watchdog sends warning and critical alarms to your [favorite
67
+- **20+ notification platforms**: Netdata's health watchdog sends warning and critical alarms to your [favorite
68
platform](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md) to inform you of anomalies just seconds
69
after they affect your node.
69
-- **30+ external time-series databases**: Export resampled metrics as they're collected to other [local- and
70
+- **30+ external time-series databases**: Export resampled metrics as they're collected to other [local- and
71
Cloud-based databases](https://github.com/netdata/netdata/blob/master/docs/export/external-databases.md) for best-in-class
72
interoperability.
73
73
-
74
-## How it works
74
+## How it works
75
76
Netdata is a highly efficient, highly modular, metrics management engine. Its lockless design makes it ideal for concurrent operations on the metrics.
77
@@ -84,7 +84,7 @@ And a higher level diagram in this one.
84
86
87
-You can even visit this slightly dated [interactive infographic](https://my-netdata.io/infographic.html) and get lost in a rabbit hole.
87
+You can even visit this slightly dated [interactive infographic](https://my-netdata.io/infographic.html) and get lost in a rabbit hole.
88
89
But the best way to get under the hood or in the steering wheel of our highly efficient, low-latency system (supporting multiple readers and one writer on each metric) is to read the rest of our docs, or just to jump in and [get started](https://github.com/netdata/netdata/blob/master/packaging/installer/README.md). But here's a good breakdown:
90
@@ -95,6 +95,7 @@ Netdata's distributed monitoring Agent collects thousands of metrics from system
95
You can install Netdata on most Linux distributions (Ubuntu, Debian, CentOS, and more), container/microservice platforms (Kubernetes clusters, Docker), and many other operating systems (FreeBSD, macOS), with no sudo required.
96
97
### Netdata Cloud
98
+
99
Netdata Cloud is a web application that gives you real-time visibility for your entire infrastructure. With Netdata Cloud, you can view key metrics, insightful charts, and active alarms from all your nodes in a single web interface. When an anomaly strikes, seamlessly navigate to any node to troubleshoot and discover the root cause with the familiar Netdata dashboard.
100
101
Netdata Cloud is free! You can add an entire infrastructure of nodes, invite all your colleagues, and visualize any number of metrics, charts, and alarms entirely for free.
@@ -154,14 +155,14 @@ ask questions, find resources, and engage with passionate professionals. The tea
155
156
You can also find Netdata on:
157
157
-- [Twitter](https://twitter.com/linuxnetdata)
158
-- [YouTube](https://www.youtube.com/c/Netdata)
159
-- [Reddit](https://www.reddit.com/r/netdata/)
160
-- [LinkedIn](https://www.linkedin.com/company/netdata-cloud/)
161
-- [StackShare](https://stackshare.io/netdata)
162
-- [Product Hunt](https://www.producthunt.com/posts/netdata-monitoring-agent/)
163
-- [Repology](https://repology.org/metapackage/netdata/versions)
164
-- [Facebook](https://www.facebook.com/linuxnetdata/)
158
+- [Twitter](https://twitter.com/linuxnetdata)
159
+- [YouTube](https://www.youtube.com/c/Netdata)
160
+- [Reddit](https://www.reddit.com/r/netdata/)
161
+- [LinkedIn](https://www.linkedin.com/company/netdata-cloud/)
162
+- [StackShare](https://stackshare.io/netdata)
163
+- [Product Hunt](https://www.producthunt.com/posts/netdata-monitoring-agent/)
164
+- [Repology](https://repology.org/metapackage/netdata/versions)
165
+- [Facebook](https://www.facebook.com/linuxnetdata/)
166
167
## Contribute
168
docs/guides/troubleshoot/troubleshooting-agent-with-cloud-connection.md
+2
-10
@@ -1,15 +1,7 @@
1
-<!--
2
-title: "Troubleshoot Agent-Cloud connectivity issues"
3
-sidebar_label: "Troubleshoot Agent-Cloud connectivity issues"
4
-description: "A simple guide to troubleshoot occurrences where the Agent is showing as offline after claiming."
5
-custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/troubleshoot/troubleshooting-agent-with-cloud-connection.md
6
-learn_status: "Published"
7
-learn_topic_type: "Tasks"
8
-learn_rel_path: "Operations"
9
--->
10
-
1
# Troubleshoot Agent-Cloud connectivity issues
2
3
+Learn how to troubleshoot the Netdata Agent showing as offline after claiming, so you can connect the Agent to Netdata Cloud.
4
+
5
When you are claiming a node, you might not be able to immediately see it online in Netdata Cloud.
6
This could be due to an error in the claiming process or a temporary outage of some services.
7
docs/monitor/view-active-alarms.md
+3
-3
@@ -1,13 +1,13 @@
1
# View active alerts
2
3
-Netdata comes with hundreds of pre-configured health alerts designed to notify you when an anomaly or performance issue affects your node or the applications it runs.
3
+Netdata comes with hundreds of pre-configured health alerts designed to notify you when an anomaly or performance issue affects your node or its applications.
4
5
From the Alerts tab you can see all the active alerts in your War Room. You will be presented with a table having information about each alert that is in warning and critical state.
6
You can always sort the table by a certain column by clicking on the name of that column, and use the gear icon on the top right to control which columns are visible at any given time.
7
8
9
10
-### Filter alerts
10
+## Filter alerts
11
12
From this view, you can also filter alerts with the right hand bar. More specifically you can filter:
13
@@ -22,7 +22,7 @@ From this view, you can also filter alerts with the right hand bar. More specifi
22
- Nodes
23
- Filter the alerts based on the nodes that are online, next to each node's name you can see how many alerts the node has, "critical" colored in red and "warning" colored in yellow
24
25
-### View alert details
25
+## View alert details
26
27
By clicking on the name of an entry of the table you can access that alert's details page, providing you with:
28
docs/quickstart/infrastructure.md
+6
-4
@@ -1,8 +1,10 @@
1
-# Monitor your infrastructure
2
-
1
import { Grid, Box, BoxList, BoxListItemRegexLink } from '@site/src/components/Grid/'
2
import { RiExternalLinkLine } from 'react-icons/ri'
3
4
+# Monitor your infrastructure
5
+
6
+Learn how to view key metrics, insightful charts, and active alarms from all your nodes, with Netdata Cloud's real-time infrastructure monitoring.
7
+
8
[Netdata Cloud](https://app.netdata.cloud) provides scalable infrastructure monitoring for any number of distributed
9
nodes running the Netdata Agent. A node is any system in your infrastructure that you want to monitor, whether it's a
10
physical or virtual machine (VM), container, cloud deployment, or edge/IoT device.
@@ -10,7 +12,7 @@ physical or virtual machine (VM), container, cloud deployment, or edge/IoT devic
12
The Netdata Agent uses zero-configuration collectors to gather metrics from every application and container instantly,
13
and uses Netdata's [distributed data architecture](https://github.com/netdata/netdata/blob/master/docs/store/distributed-data-architecture.md) to store metrics
14
locally. Without a slow and troublesome centralized data lake for your infrastructure's metrics, you reduce the
13
-resources you need to invest in, and the complexity of, monitoring your infrastructure.
15
+resources you need to invest in, and the complexity of, monitoring your infrastructure.
16
17
Netdata Cloud unifies infrastructure monitoring by _centralizing the interface_ you use to query and visualize your
18
nodes' metrics, not the data. By streaming metrics values to your browser, with Netdata Cloud acting as the secure proxy
@@ -22,7 +24,7 @@ composite charts, and alarm viewing. You'll then learn about the most critical w
24
your nodes to maximize the value you get from Netdata.
25
26
This quickstart assumes you've [installed Netdata](https://github.com/netdata/netdata/edit/master/packaging/installer/README.md)
25
-on more than one node in your infrastructure, and connected those nodes to your Space in Netdata Cloud.
27
+on more than one node in your infrastructure, and connected those nodes to your Space in Netdata Cloud.
28
29
## Set up your Netdata Cloud experience
30
docs/store/distributed-data-architecture.md
+3
-4
@@ -1,6 +1,8 @@
1
# Distributed data architecture
2
3
-Netdata uses a distributed data architecture to help you collect and store per-second metrics from any number of nodes.
3
+Learn how Netdata's distributed data architecture enables us to store metrics on the edge nodes for security, high performance and scalability.
4
+
5
+This way, it helps you collect and store per-second metrics from any number of nodes.
6
Every node in your infrastructure, whether it's one or a thousand, stores the metrics it collects.
7
8
Netdata Cloud bridges the gap between many distributed databases by _centralizing the interface_ you use to query and
@@ -71,6 +73,3 @@ or [filtering by hostname/service](https://github.com/netdata/netdata/blob/maste
73
store configured alarms, their status, and a list of active collectors.
74
75
Netdata does not and never will sell your personal data or data about your deployment.
74
-
75
-
76
-
packaging/installer/README.md
+11
-11
@@ -1,10 +1,12 @@
1
-# Install Netdata
2
-
1
import { OneLineInstallWget, OneLineInstallCurl } from '@site/src/components/OneLineInstall/'
2
import { InstallRegexLink, InstallBoxRegexLink } from '@site/src/components/InstallRegexLink/'
3
import Tabs from '@theme/Tabs';
4
import TabItem from '@theme/TabItem';
5
6
+# Install Netdata
7
+
8
+This document will guide you through installing the open-source Netdata monitoring Agent on Linux, Docker, Kubernetes, and many others, often with one command.
9
+
10
## Get started
11
12
Netdata is a free and open-source (FOSS) monitoring agent that collects thousands of hardware and software metrics from
@@ -19,7 +21,7 @@ Docker), and many other operating systems (FreeBSD, macOS), with no `sudo` requi
21
22
To install Netdata in minutes on your platform:
23
22
-1. Sign up to https://app.netdata.cloud/
24
+1. Sign up to <https://app.netdata.cloud/>
25
2. You will be presented with an empty space, and a prompt to "Connect Nodes" with the install command for each platform
26
3. Select the platform you want to install Netdata to, copy and paste the script into your node's terminal, and run it
27
@@ -184,16 +186,16 @@ the community helps fix any bugs that might have been introduced in previous rel
186
187
**Pros of using nightly releases:**
188
187
-- Get the latest features and bug fixes as soon as they're available
188
-- Receive security-related fixes immediately
189
-- Use stable, fully-tested code that's always improving
190
-- Leverage the same Netdata experience our community is using
189
+- Get the latest features and bug fixes as soon as they're available
190
+- Receive security-related fixes immediately
191
+- Use stable, fully-tested code that's always improving
192
+- Leverage the same Netdata experience our community is using
193
194
**Pros of using stable releases:**
195
194
-- Protect yourself from the rare instance when major bugs slip through our testing and negatively affect a Netdata
196
+- Protect yourself from the rare instance when major bugs slip through our testing and negatively affect a Netdata
197
installation
196
-- Retain more control over the Netdata version you use
198
+- Retain more control over the Netdata version you use
199
200
### Anonymous statistics
201
@@ -256,5 +258,3 @@ both.
258
Our current build process has some issues when using certain configurations of the `clang` C compiler on Linux. See [the
259
section on `nonrepresentable section on output`
260
errors](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/manual.md#nonrepresentable-section-on-output-errors) for a workaround.
259
-
260
-