Docs: Remove old Cloud/dashboard and replace with new Cloud/dashboard (#8874)
* Add options to daemon, clean up claiming * Caught one more old conf * Remove cloud docs * I did a lot of things * Rewrite tutorial step 3 * Remove my nodes menu, sync what-is-netdata * Restore ACLK/claim/daemon docs to be handled by docs-go-live * Fix up what-is-netdata * More cleanup of README/what-is-netdata * Restore daemon/config/README.md * Fix frontmatter * Change title, fix broken link * Copyediting fixes * Remove symbols * Add a few more GIFs * Fix hash * Fix other hash * Fix wording in web gui * Address Andrew's and Jacek's comments
Joel Hans committed
May 14, 2020 at 06:50 UTC
9d712b513566f1f90f6031f16c25953c5d836891
16 files changed
+279
-851
DOCUMENTATION.md
deleted
-87
@@ -1,87 +0,0 @@
1
-# Netdata Documentation
2
-
3
-**Netdata is real-time health monitoring and performance troubleshooting for systems and applications.** It helps you
4
-instantly diagnose slowdowns and anomalies in your infrastructure with thousands of metrics, interactive visualizations,
5
-and insightful health alarms. Plus, long-term storage comes ready out-of-the-box, so can collect, monitor, and maintain
6
-your metrics in one insightful place.
7
-
8
-## Navigating the Netdata documentation
9
-
10
-Welcome! You've arrived at the documentation for Netdata. Use the links below to find answers to the most common
11
-questions about Netdata, such as how to install it, getting started guides, basic configuration, and adding more charts.
12
-Or, explore all of Netdata's documentation using the table of contents to your left.
13
-
14
-<div class="homepage-nav">
15
- <a class="nav-page" href="packaging/installer/">
16
- <div class="button-header">
17
- <h3>Installation guide</h3>
18
- <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 448 512" height="1em" width="1em" xmlns="http://www.w3.org/2000/svg"><path d="M224.3 273l-136 136c-9.4 9.4-24.6 9.4-33.9 0l-22.6-22.6c-9.4-9.4-9.4-24.6 0-33.9l96.4-96.4-96.4-96.4c-9.4-9.4-9.4-24.6 0-33.9L54.3 103c9.4-9.4 24.6-9.4 33.9 0l136 136c9.5 9.4 9.5 24.6.1 34zm192-34l-136-136c-9.4-9.4-24.6-9.4-33.9 0l-22.6 22.6c-9.4 9.4-9.4 24.6 0 33.9l96.4 96.4-96.4 96.4c-9.4 9.4-9.4 24.6 0 33.9l22.6 22.6c9.4 9.4 24.6 9.4 33.9 0l136-136c9.4-9.2 9.4-24.4 0-33.8z"></path></svg>
19
- </div>
20
- <div class="button-text">
21
- <p>Use our automated one-line installation script to install Netdata on Linux systems or find detailed instructions for binary packages, Kubernetes, Docker, macOS, and more.</p>
22
- </div>
23
- </a>
24
- <a class="nav-page" href="docs/step-by-step/step-00/">
25
- <div class="button-header">
26
- <h3>Step-by-step tutorial</h3>
27
- <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 448 512" height="1em" width="1em" xmlns="http://www.w3.org/2000/svg"><path d="M224.3 273l-136 136c-9.4 9.4-24.6 9.4-33.9 0l-22.6-22.6c-9.4-9.4-9.4-24.6 0-33.9l96.4-96.4-96.4-96.4c-9.4-9.4-9.4-24.6 0-33.9L54.3 103c9.4-9.4 24.6-9.4 33.9 0l136 136c9.5 9.4 9.5 24.6.1 34zm192-34l-136-136c-9.4-9.4-24.6-9.4-33.9 0l-22.6 22.6c-9.4 9.4-9.4 24.6 0 33.9l96.4 96.4-96.4 96.4c-9.4 9.4-9.4 24.6 0 33.9l22.6 22.6c9.4 9.4 24.6 9.4 33.9 0l136-136c9.4-9.2 9.4-24.4 0-33.8z"></path></svg>
28
- </div>
29
- <div class="button-text">
30
- <p>Take a guided tour through each of Netdata's core features—perfect for beginners. Follow detailed instructions to monitor your systems and apps, and start your journey into performance troubleshooting.</p>
31
- </div>
32
- </a>
33
- <a class="nav-page" href="docs/getting-started/">
34
- <div class="button-header">
35
- <h3>Getting started guide</h3>
36
- <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 448 512" height="1em" width="1em" xmlns="http://www.w3.org/2000/svg"><path d="M224.3 273l-136 136c-9.4 9.4-24.6 9.4-33.9 0l-22.6-22.6c-9.4-9.4-9.4-24.6 0-33.9l96.4-96.4-96.4-96.4c-9.4-9.4-9.4-24.6 0-33.9L54.3 103c9.4-9.4 24.6-9.4 33.9 0l136 136c9.5 9.4 9.5 24.6.1 34zm192-34l-136-136c-9.4-9.4-24.6-9.4-33.9 0l-22.6 22.6c-9.4 9.4-9.4 24.6 0 33.9l96.4 96.4-96.4 96.4c-9.4 9.4-9.4 24.6 0 33.9l22.6 22.6c9.4 9.4 24.6 9.4 33.9 0l136-136c9.4-9.2 9.4-24.4 0-33.8z"></path></svg>
37
- </div>
38
- <div class="button-text">
39
- <p>Have some monitoring and system administration experience? Dive right into configuring Netdata, accessing the dashboard, working with the daemon, and changing how Netdata stores metrics.</p>
40
- </div>
41
- </a>
42
- <a class="nav-page" href="docs/configuration-guide/">
43
- <div class="button-header">
44
- <h3>Configuration guide</h3>
45
- <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 448 512" height="1em" width="1em" xmlns="http://www.w3.org/2000/svg"><path d="M224.3 273l-136 136c-9.4 9.4-24.6 9.4-33.9 0l-22.6-22.6c-9.4-9.4-9.4-24.6 0-33.9l96.4-96.4-96.4-96.4c-9.4-9.4-9.4-24.6 0-33.9L54.3 103c9.4-9.4 24.6-9.4 33.9 0l136 136c9.5 9.4 9.5 24.6.1 34zm192-34l-136-136c-9.4-9.4-24.6-9.4-33.9 0l-22.6 22.6c-9.4 9.4-9.4 24.6 0 33.9l96.4 96.4-96.4 96.4c-9.4 9.4-9.4 24.6 0 33.9l22.6 22.6c9.4 9.4 24.6 9.4 33.9 0l136-136c9.4-9.2 9.4-24.4 0-33.8z"></path></svg>
46
- </div>
47
- <div class="button-text">
48
- <p>Take your configuration options from the <em>getting started guide</em> to the next level. Increase metrics retention, modify how charts are displayed, disable collectors, and modify alarms.</p>
49
- </div>
50
- </a>
51
-</div>
52
-
53
-**Netdata Cloud**: Use [Netdata Cloud](docs/netdata-cloud/) and the [Nodes View](docs/netdata-cloud/nodes-view.md) to
54
-view real-time, distributed health monitoring and performance troubleshooting data for all your systems in one place.
55
-Add as many nodes as you'd like!
56
-
57
-**Advanced users**: For those who already understand how to access a Netdata dashboard and perform basic configuration,
58
-feel free to see what's behind any of these other doors.
59
-
60
-- [Tutorial: Change how long Netdata stores metrics](docs/tutorials/longer-metrics-storage.md): Extend Netdata's
61
- long-term metrics storage database by allowing Netdata to use more of your system's RAM and disk.
62
-- [Netdata Behind Nginx](docs/Running-behind-nginx.md): Use an Nginx web server instead of Netdata's built-in server
63
- to enable TLS, HTTPS, and basic authentication.
64
-- [Collect more metrics](collectors/README.md) from other services and applications: Enable new internal
65
- or external plugins and understand when auto-detection works.
66
-- [Performance](docs/Performance.md): Tips on running Netdata on devices with limited CPU and RAM resources, such as
67
- embedded devices, IoT, and edge devices.
68
-- [Streaming](streaming/): Information for those who want to centralize Netdata metrics from any number of distributed
69
- agents.
70
-- [Backends](backends/): Learn how to archive Netdata's real-time metrics to a time series database (like Prometheus)
71
- for long-term archiving.
72
-
73
-Visit the [contributing guide](CONTRIBUTING.md), [contributing to documentation
74
-guide](docs/contributing/contributing-documentation.md), and [documentation style
75
-guide](docs/contributing/style-guide.md) to learn more about our community and how you can get started contributing to
76
-Netdata.
77
-
78
-**Want to get news, how-tos, and heaps of monitoring savvy straight from Netdata? Subscribe to our newsletter to monitor
79
-our team of monitoring pros.**
80
-
81
-<script charset="utf-8" type="text/javascript" src="//js.hsforms.net/forms/shell.js"></script>
82
-<script>
83
- hbspt.forms.create({
84
- portalId: "4567453",
85
- formId: "6a20deb5-a1e6-4312-9c4d-f6862f947fe0"
86
- });
87
-</script>
README.md
+13
-15
@@ -1,7 +1,7 @@
1
<!--
2
---
3
title: "Netdata"
4
-date: 2020-04-06
4
+date: 2020-05-01
5
custom_edit_url: https://github.com/netdata/netdata/edit/master/README.md
6
---
7
-->
@@ -72,7 +72,7 @@ Netdata!](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&la
72
The following animated GIF shows the top part of a typical Netdata dashboard.
73
74
75
+action](https://user-images.githubusercontent.com/1153921/80827388-b9fee100-8b98-11ea-8f60-0d7824667cd3.gif)
76
77
> A typical Netdata dashboard, in 1:1 timing. Charts can be panned by dragging them, zoomed in/out with `SHIFT` + `mouse
78
> wheel`, an area can be selected for zoom-in with `SHIFT` + `mouse selection`. Netdata is highly interactive,
@@ -175,7 +175,7 @@ For more information about running Netdata in Docker, check the [docker installa
175
176
From Netdata v1.12 and above, anonymous usage information is collected by default and sent to Google Analytics. To read
177
more about the information collected and how to opt-out, check the [anonymous statistics
178
-page](docs/anonymous-statistics.md).
178
+page](/docs/anonymous-statistics.md).
179
180
## Why Netdata
181
@@ -304,8 +304,8 @@ This is what you should expect from Netdata:
304
[flock.com](/health/notifications/flock/), [hangouts](/health/notifications/hangouts/),
305
[irc](/health/notifications/irc/), [kavenegar.com](/health/notifications/kavenegar/),
306
[messagebird.com](/health/notifications/messagebird/), [pagerduty.com](/health/notifications/pagerduty/),
307
- [prowl](health/notifications/prowl/), [pushbullet.com](/health/notifications/pushbullet/),
308
- [pushover.net](health/notifications/pushover/), [rocket.chat](/health/notifications/rocketchat/),
307
+ [prowl](/health/notifications/prowl/), [pushbullet.com](/health/notifications/pushbullet/),
308
+ [pushover.net](/health/notifications/pushover/), [rocket.chat](/health/notifications/rocketchat/),
309
[slack.com](/health/notifications/slack/), [smstools3](/health/notifications/smstools3/),
310
[syslog](/health/notifications/syslog/), [telegram.org](/health/notifications/telegram/),
311
[twilio.com](/health/notifications/twilio/), [web](/health/notifications/web/) and [custom
@@ -337,7 +337,8 @@ This is what you should expect from Netdata:
337
To improve clarity on charts, Netdata dashboards present **positive** values for metrics representing `read`, `input`,
338
`inbound`, `received` and **negative** values for metrics representing `write`, `output`, `outbound`, `sent`.
339
340
-
340
+
342
343
_Netdata charts showing the bandwidth and packets of a network interface. `received` is positive and `sent` is
344
negative._
@@ -346,7 +347,8 @@ negative._
347
348
Netdata charts automatically zoom vertically, to visualize the variation of each metric within the visible time-frame.
349
349
-
350
+
352
353
_A zero-based `stacked` chart, automatically switches to an auto-scaled `area` chart when a single dimension is
354
selected._
@@ -356,27 +358,23 @@ selected._
358
Charts on Netdata dashboards are synchronized to each other. There is no master chart. Any chart can be panned or zoomed
359
at any time, and all other charts will follow.
360
359
-
361
+
363
364
_Charts are panned by dragging them with the mouse. Charts can be zoomed in/out with`SHIFT` + `mouse wheel` while the
365
mouse pointer is over a chart._
366
364
-> The visible time-frame (pan and zoom) is propagated from Netdata server to Netdata server when navigating via the
365
-> [My nodes menu](/registry/README.md).
366
-
367
### Highlighted time-frame
368
369
To improve visual anomaly detection across charts, the user can highlight a time-frame (by pressing `Alt` + `mouse
370
selection`) on all charts.
371
372
-
372
+
374
375
_A highlighted time-frame can be given by pressing `Alt` + `mouse selection` on any chart. Netdata will highlight the
376
same range on all charts._
377
377
-> Highlighted ranges are propagated from Netdata server to Netdata server, when navigating via the [My nodes
378
-> menu](/registry/README.md).
379
-
378
## What Netdata monitors
379
380
Netdata can collect metrics from 200+ popular services and applications, on top of dozens of system-related metrics
daemon/config/README.md
+2
-2
@@ -161,7 +161,7 @@ In this area of `netdata.conf` you can find configuration options for individual
161
following the pattern `[NAME]`.
162
163
Using the settings and values under these sections, you can control all aspects of a specific chart. You can change its
164
-title, make it appear higher in Netdata's [menu](/web/gui/README.md#menus), tweak its dimensions, and much more.
164
+title, make it appear higher in Netdata's [menu](/web/gui/README.md#metrics-menus), tweak its dimensions, and much more.
165
166
To find the name of a given chart, and thus the name of its section in `netdata.conf`, look at the top-left corner of a
167
chart:
@@ -178,7 +178,7 @@ that is information about lines that begin with `dim`, which affect a chart's di
178
| `enabled` | A boolean (`yes` or `no`) that explicitly enables or disables the chart in question. |
179
| `cache directory` | The directory where cache files for this plugin, if needed, are stored. |
180
| `chart type` | Defines what type of chart to display. It can be `line`, `area`, or `stacked`. If empty or missing, `line` will be used. |
181
-| `type` | Uniquely identify which [menu](/web/gui/README.md#menus) on the Netdata dashboard this chart should appear under. Some examples include `system` (**System**), `disk` (**Disks**), `net` (**Network Interfaces**), and `netdata` (**Netdata Monitoring**). |
181
+| `type` | Uniquely identify which [metrics menu](/web/gui/README.md#metrics-menus) on the Netdata dashboard this chart should appear under. Some examples include `system` (**System**), `disk` (**Disks**), `net` (**Network Interfaces**), and `netdata` (**Netdata Monitoring**). |
182
| `family` | Change the chart's [family](/web/README.md#families) from its default. For example, you could force a disk space chart to collect metrics for family `sdb` instead of family `sda`. |
183
| `units` | Text for the label of the vertical axis of the chart. This means all dimensions should have the same unit of measurement. |
184
| `context` | Change the default [context](/web/README.md#contexts) of the chart. Changing this setting will affect what metrics and metrics the chart displays, and which alarms are attached to it. |
docs/agent-cloud.md
new
+79
@@ -0,0 +1,79 @@
1
+<!--
2
+---
3
+title: "Use the Agent with Netdata Cloud"
4
+date: 2020-05-04
5
+custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/agent-cloud.md
6
+---
7
+-->
8
+
9
+# Use the Agent with Netdata Cloud
10
+
11
+While the Netdata Agent is an enormously powerful _distributed_ health monitoring and performance troubleshooting tool,
12
+many of its users need to monitor dozens or hundreds of systems at the same time. That's why we built Netdata Cloud, a
13
+hosted web interface that gives you real-time visibility into your entire infrastructure.
14
+
15
+There are two main ways to use your Agent(s) with Netdata Cloud. You can use both these methods simultaneously, or just
16
+one, based on your needs:
17
+
18
+- Use Netdata Cloud's web interface for monitoring an entire infrastructure, with any number of Agents, in one
19
+ centralized dashboard.
20
+- Use **Visited nodes** to quickly navigate between the dashboards of nodes you've recently visited.
21
+
22
+## Monitor an infrastructure with Netdata Cloud
23
+
24
+We designed Netdata Cloud to help you see health and performance metrics, plus active alarms, in a single interface.
25
+Here's what a small infrastructure might look like:
26
+
27
+
29
+
30
+[Read more about Netdata Cloud](https://learn.netdata.cloud/docs/cloud/) to better understand how it gives you real-time
31
+visibility into your entire infrastructure, and why you might consider using it.
32
+
33
+Next, [get started in 5 minutes](https://learn.netdata.cloud/docs/cloud/get-started/), or read our [claiming
34
+reference](/claim/README.md) for a complete investigation of Cloud's security and encryption features, plus instructions
35
+for Docker containers.
36
+
37
+## Navigate between dashboards with Visited nodes
38
+
39
+If you don't want to use Netdata Cloud's web interface, you can still connect multiple nodes through the **Visited
40
+nodes** menu, which appears on the left-hand side of the dashboard.
41
+
42
+You can use the Visited nodes menu to navigate between the dashboards of many different Agent-monitored systems quickly.
43
+
44
+To add nodes to your Visited nodes menu, you first need to navigate to that node's dashboard, then click the **Sign in**
45
+button at the top of the dashboard. On the screen that appears, which states your node is requesting access to your
46
+Netdata Cloud account, sign in with your preferred method.
47
+
48
+Cloud redirects you back to your node's dashboard, which is now connected to your Netdata Cloud account. You can now see
49
+the Visited nodes menu, which is populated by a single node.
50
+
51
+
53
+
54
+If you previously went through the Cloud onboarding process to create a Space and War Room, you will also see these in
55
+the Visited Nodes menu. You can click on your Space or any of your War Rooms to navigate to Netdata Cloud and continue
56
+monitoring your infrastructure from there.
57
+
58
+
60
+
61
+To add more Agents to your Visited nodes menu, visit them and sign in again. This process connects that node to your
62
+Cloud account and further populates the menu.
63
+
64
+Once you've added more than one node, you can use the menu to switch between various dashboards without remembering IP
65
+addresses or hostnames or saving bookmarks for every node you want to monitor.
66
+
67
+
69
+
70
+## What's next?
71
+
72
+The Agent-Cloud integration is highly adaptable to the needs of any infrastructure or user. If you want to learn more
73
+about how you might want to use or configure Cloud, we recommend the following:
74
+
75
+- Get an overview of Cloud's features by reading [Cloud documentation](https://learn.netdata.cloud/docs/cloud/).
76
+- Follow the 5-minute [get started with Cloud](https://learn.netdata.cloud/docs/cloud/get-started/) guide to finish
77
+ onboarding and claim your first nodes.
78
+- Better understand how agents connect securely to the Cloud with [claiming](/claim/README.md) and [Agent-Cloud
79
+ link](/aclk/README.md) documentation.
\ No newline at end of file
docs/getting-started.md
+32
-30
@@ -1,17 +1,17 @@
1
<!--
2
---
3
-title: "Getting started guide"
4
-date: 2020-04-06
3
+title: "Get started guide"
4
+date: 2020-05-04
5
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/getting-started.md
6
---
7
-->
8
9
-# Getting started guide
9
+# Get started guide
10
11
-Thanks for trying Netdata! In this getting started guide, we'll quickly walk you through the first steps you should take
12
-after getting Netdata installed.
11
+Thanks for trying the Netdata Agent! In this getting started guide, we'll quickly walk you through the first steps you
12
+should take after installing the Agent.
13
14
-Netdata can collect thousands of metrics in real-time and use its database for long-term metrics storage without any
14
+The Agent can collect thousands of metrics in real-time and use its database for long-term metrics storage without any
15
configuration, but there are some valuable things to know to get the most out of Netdata based on your needs.
16
17
We'll skip right into some technical details, so if you're brand-new to monitoring the health and performance of systems
@@ -22,14 +22,11 @@ and applications, our [**step-by-step tutorial**](/docs/step-by-step/step-00.md)
22
23
## Access the dashboard
24
25
-Open up your web browser of choice and navigate to `http://YOUR-HOST:19999`. Welcome to Netdata!
25
+Open up your web browser of choice and navigate to `http://NODE:19999`, replacing `NODE` with the IP address or hostname
26
+of your Agent. Hit **Enter**. Welcome to Netdata!
27
28
29
-
30
-<details markdown="1"><summary>Want to see the dashboard and its features in action? Check out our video.</summary>
31
-<iframe width="720" height="405" src="https://www.youtube.com/embed/Ob6-Wkb6ZBA" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
32
-</details>
29
+dashboard](https://user-images.githubusercontent.com/1153921/80825153-abaec600-8b94-11ea-8b17-1b770a2abaa9.gif)
30
31
**What's next?**:
32
@@ -97,9 +94,9 @@ Some modules, like `chrony`, are disabled by default and must be enabled manuall
94
95
Once Netdata detects a valid source of data, it will continue trying to collect data from it. For example, if
96
Netdata is collecting data from an Nginx web server, and you shut Nginx down, Netdata will collect new data as soon as
100
-you start the web server back up—no restart necessary.
97
+you start the web server back up—no restart necessary.
98
102
-### Configuring plugins
99
+### Configure plugins
100
101
Even if Netdata auto-detects your service/application, you might want to configure what, or how often, Netdata is
102
collecting data.
@@ -192,29 +189,33 @@ Find the `SEND_EMAIL="YES"` line and change it to `SEND_EMAIL="NO"`.
189
- See all the alarm options via the [health configuration reference](/health/REFERENCE.md).
190
- Add a new notification method, like [Slack](/health/notifications/slack/).
191
195
-## Monitoring multiple systems with Netdata
192
+## Monitor multiple systems with Netdata Cloud
193
+
194
+If you have the Agent installed on multiple nodes, you can use Netdata Cloud in two ways: Monitor the health and
195
+performance of an entire infrastructure via the Cloud web interface, or use the Visited Nodes menu that's built into
196
+every dashboard.
197
197
-If you have Netdata installed on multiple systems, you can have them all appear in the **My nodes** menu at the top-left
198
-corner of the dashboard.
198
+For example, a small infrastructure monitored via Netdata Cloud:
199
200
-To show all your servers in that menu, you need to [register for or sign in](/docs/netdata-cloud/signing-in.md) to
201
-[Netdata Cloud](/docs/netdata-cloud/README.md) from each system. Each system will then appear in the **My nodes** menu, which you
202
-can use to navigate between your systems quickly.
200
+
202
204
-
203
+And the process of using the Visited nodes menu to move between Agent dashboards running on various systems, both local
204
+and remote:
205
207
-Whenever you pan, zoom, highlight, select, or pause a chart, Netdata will synchronize those settings with any other
208
-agent you visit via the My nodes menu. Even your scroll position is synchronized, so you'll see the same charts and
209
-respective data for easy comparisons or root cause analysis.
206
+
208
211
-You can now seamlessly track performance anomalies across your entire infrastructure!
209
+You can use these features together or separately—the decision is up to you and the needs of your infrastructure.
210
211
**What's next?**:
212
215
-- Read up on how the [Netdata Cloud registry works](/registry/), and what kind of data it stores and sends to
216
- your web browser.
217
-- Familiarize yourself with the [Nodes View](/docs/netdata-cloud/nodes-view.md)
213
+- Read about the [Agent-Cloud integration]().
214
+- Get an overview of Cloud's features by reading [Cloud documentation](https://learn.netdata.cloud/docs/cloud/).
215
+- Follow the 5-minute [get started with Cloud](https://learn.netdata.cloud/docs/cloud/get-started/) guide to finish
216
+ onboarding and claim your first nodes.
217
+- Better understand how agents connect securely to the Cloud with [claiming](/claim/README.md) and [Agent-Cloud
218
+ link](/aclk/README.md) documentation.
219
220
## Start, stop, and restart Netdata
221
@@ -235,7 +236,8 @@ and `init.d`:
236
## What's next?
237
238
Even after you've configured `netdata.conf`, tweaked alarms, learned the basics of performance troubleshooting, and
238
-added all your systems to the **My nodes** menu, you've just gotten started with Netdata.
239
+claimed all your systems in Netdata Cloud or added them to the Visited nodes menu, you've just gotten started with
240
+Netdata.
241
242
Take a look at some more advanced features and configurations:
243
docs/netdata-cloud/README.md
deleted
-55
@@ -1,55 +0,0 @@
1
-<!--
2
----
3
-title: "Netdata Cloud"
4
-custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/netdata-cloud/README.md
5
----
6
--->
7
-
8
-# Netdata Cloud
9
-
10
-Netdata Cloud is core to our ongoing mission to provide real-time, distributed health monitoring and performance troubleshooting. It's the foundation of an ecosystem of tools that will help you build more extraordinary infrastructures.
11
-
12
-Netdata Cloud is also the next iteration of our global Netdata registry. For technical information about how our registries work, what information they store, and how your web browser "talks" to both, visit our [registry documentation](/registry/README.md).
13
-
14
-Learn more about the future of Netdata Cloud on our [announcement post](https://blog.netdata.cloud/posts/netdata-cloud-announcement/).
15
-
16
-## Registering for or signing in to Netdata Cloud
17
-
18
-**If you're ready to register for a new Netdata Cloud account, or sign in to your existing Netdata Cloud account, visit our [signing in guide](/docs/netdata-cloud/signing-in.md) for details.**
19
-
20
-> If you're running a private registry and are interested in trying out Netdata Cloud as a replacement for your private
21
-> registry, read [our notice](/docs/netdata-cloud/signing-in.md#private-registries-and-netdata-cloud) about
22
-> transitioning from a private registry to our Netdata Cloud registry.
23
-
24
-## Netdata Cloud features
25
-
26
-Netdata Cloud currently enables two features: the **My nodes** in the top-left corner of the Netdata dashboard, and the
27
-[**Nodes View**](/docs/netdata-cloud/nodes-view.md).
28
-
29
-We have an aggressive roadmap of new features, such as Workspaces for different parts of your infrastructure, Rooms to collaborate with colleagues, and the ability to receive alarms from any number of distributed Netdata agents in a single place. Read more about our proposed features [here](https://blog.netdata.cloud/posts/netdata-cloud-announcement/#what-features-will-netdata-cloud-offer).
30
-
31
-### Planned enterprise features (paid)
32
-
33
-Large enterprises have unique real-time monitoring needs. They have thousands of servers and applications running concurrently, and are willing to pay for the complex features that help them make smarter, faster decisions about their infrastructure. We expect to create a paid tier of Netdata Cloud with a recurring, per-user pricing model that will unlock enterprise-focused features.
34
-
35
-A few of these planned features include:
36
-
37
-- Long-term storage of Netdata UI snapshots
38
-- Active Directory integration for single sign-on
39
-- Private service status pages
40
-- Extended retention of alarms timelines
41
-- Incident response toolkits
42
-- Additional enterprise plugins and integrations
43
-- Extended retention of chat messages
44
-
45
-Again, we expect that the vast majority of Netdata's users won't need these features. Creating these two tiers will help us further fund the company's efforts to deploy Netdata's open-source agent on a massive scale and entirely for free.
46
-
47
-## Running Netdata without Netdata Cloud
48
-
49
-Netdata Cloud is entirely optional. The application will never force you to create a Netdata Cloud account or associate nodes with the public registries. But, if you choose not to use Netdata Cloud, you will be missing out on the [Nodes View](/docs/netdata-cloud/nodes-view.md) and other upcoming features.
50
-
51
-## Running Netdata Cloud on-premises or as a hosted instance
52
-
53
-We plan on making both on-premises and hosted instances of Netdata Cloud available to enterprises. Until then, we are creating a list of people and businesses interested in either of these options. To add yourself or your organization to this list, email us at [info@netdata.cloud](mailto:info@netdata.cloud).
54
-
55
-[](<>)
docs/netdata-cloud/nodes-view.md
deleted
-215
@@ -1,215 +0,0 @@
1
-<!--
2
----
3
-title: "Using the Nodes View"
4
-custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/netdata-cloud/nodes-view.md
5
----
6
--->
7
-
8
-# Using the Nodes View
9
-
10
-## Introduction
11
-
12
-As of v1.15.0 of Netdata, and in conjunction with our announcement post about the [future of Netdata](https://blog.netdata.cloud/posts/netdata-cloud-announcement/), we have enabled an entirely new way to view your infrastructure using the open-source Netdata agent in conjunction with Netdata Cloud: the **Nodes View**.
13
-
14
-This view, powered by Netdata Cloud, provides an aggregated view of the Netdata agents that you have associated with your Netdata Cloud account. The main benefit of Nodes View is seeing the health of your infrastructure from a single interface, especially if you have many systems running Netdata. With Nodes View, you can monitor the health status of your nodes via active alarms and view a subset of real-time performance metrics the agent is collecting every second.
15
-
16
-!!! attention "Nodes View is beta software!"
17
- The Nodes View is currently in beta, so all typical warnings about beta software apply. You may come across bugs or inconsistencies.
18
-
19
-```
20
-The current version of Nodes uses the API available on each Netdata agent to check for new alarms and the machine's overall health/availability. In the future, we will offer both polling via the API and real-time streaming of health status/metrics.
21
-```
22
-
23
-## The Nodes View
24
-
25
-To access the Nodes View, you must first be signed in to Netdata Cloud. To register for an account, or sign in to an existing account, visit our [signing in guide](signing-in.md) for details.
26
-
27
-Once you're signed in to Netdata Cloud, clicking on any of the **Nodes Beta** buttons in the node's web dashboard will lead you to the Nodes View. Find one (`1`) in the dropdown menu in the upper-right corner, a second (`2`) in the top navigation bar, and a third (`3`) in the dropdown menu in the top-left corner of the Netdata dashboard.
28
-
29
-
30
-
31
-### Nodes
32
-
33
-The primary component of the Nodes View is a list of all the nodes with Netdata agents you have associated with your Netdata Cloud account via the Netdata Cloud registry.
34
-
35
-
36
-
37
-Depending on which [view mode](#view-modes) you're using, Nodes View will present you with information about that node, such as its hostname, operating system, warnings/critical alerts, and any [supported services](#Services-available-in-the-Nodes-View) that are running on that node. Here is an example of the **full** view mode:
38
-
39
-
40
-
41
-The background color of each Node entry is an indication of its health status:
42
-
43
-| Health status | Background color |
44
-| ------------- | ------------------------------------------------------------------------------------------------- |
45
-| **White** | Normal status, no alarms |
46
-| **Yellow** | 1 or more active warnings |
47
-| **Red** | 1 or more active critical alerts |
48
-| **Grey** | Node is unreachable (server unreachable [due to network conditions], server down, or changed URL) |
49
-
50
-### Node overview
51
-
52
-When you click on any of the Nodes, an overview sidebar will appear on the right-hand side of the Nodes View.
53
-
54
-This overview contains the following:
55
-
56
-- An icon (`1`) representing the operating system installed on that machine
57
-- The hostname (`2`) of the machine
58
-- A link (`3`) to the URL at which the web dashboard is available
59
-- Three tabs (`4`) for **System** metrics, **Services** metrics, and **Alarms**
60
-- A number of selectors (`5`) to choose which metrics/alarms are shown in the overview
61
- - **System** tab: _Overview_, _Disks_, and _Network_ selectors
62
- - **Services** tab: _Databases_, _Web_, and _Messaging_ selectors
63
- - **Alarms** tab: _Critical_ and _Warning_ selectors
64
-- The visualizations and/or alarms (`6`) supported under the chosen tab and selector
65
-- Any other available URLS (`7`) associated with that node under the **Node URLs** header.
66
-
67
-
68
-
69
-By default, clicking on a Node will display the sidebar with the **System** tab enabled. If there are warnings or alarms active for that Node, the **Alarms** tab will be displayed by default.
70
-
71
-**The visualizations in the overview sidebar are live!** As with all of Netdata's visualizations, you can scrub forward and backward in time, zoom, pause, and pinpoint anomalies down to the second.
72
-
73
-#### System tab
74
-
75
-The **System** tab has three sections: *Overview*, *Disks*, and *Network*.
76
-
77
-_Overview_ displays visualizations for `CPU`, `System Load Average` `Disk I/O`, `System RAM`, `System Swap`, `Physical Network Interfaces Aggregated Bandwidth`, and the URL of the node.
78
-
79
-_Disks_ displays visualizations for `Disk Utilization Time`, and `Disk Space Usage` for every available disk.
80
-
81
-_Network_ displays visualizations for `Bandwidth` for every available networking device.
82
-
83
-#### Services tab
84
-
85
-The **Services** tab will show visualizations for any [supported services](#Services-available-in-the-Nodes-View) that are running on that node. Three selectors are available: _Databases_, _Web_, and _Messaging_. If there are no services under any of these categories, the selector will not be clickable.
86
-
87
-#### Alarms tab
88
-
89
-The **Alarms** tab contains two selectors: _Critical_ and _Warning_. If there are no alarms under either of these categories, the selector will not be clickable.
90
-
91
-Both of these tabs will display alarms information when available, along with the relevant visualization with metrics from your Netdata agent. The `view` link redirects you to the web dashboard for the selected node and automatically shows the appropriate visualization and timeframe.
92
-
93
-
94
-
95
-### Filtering field
96
-
97
-The search field will be useful for Netdata Cloud users with dozens or hundreds of Nodes. You can filter for the hostname of the Node you're interested in, the operating system it's running, or even for the services installed.
98
-
99
-The filtering field will offer you autocomplete suggestions. For example, the options available after typing `ng` into the filtering field:
100
-
101
-
102
-
103
-If you select multiple filters, results will display according to an `OR` operator.
104
-
105
-### View modes
106
-
107
-To the right of the filtering field is three functions that will help you organize your Visited Nodes according to your preferences.
108
-
109
-
110
-
111
-The view mode button lets you switch between three view modes:
112
-
113
-- **Full** mode, which displays the following information in a large squares for each connected Node:
114
- - Operating system
115
- - Critical/warning alerts in two separate indicators
116
- - Hostname
117
- - Icons for [supported services](#services-available-in-the-nodes-view)
118
-
119
-
120
-
121
-- **Compact** mode, which displays the following information in small squares for each connected Node:
122
- - Operating system
123
-
124
-
125
-
126
-- **Detailed** mode, which displays the following information in large horizontal rectangles for each connected Node:
127
- - Operating system
128
- - Critical/warning alerts in two separate indicators
129
- - Hostname
130
- - Icons for [supported services](#services-available-in-the-nodes-view)
131
-
132
-
133
-
134
-## Sorting, and grouping
135
-
136
-The **Sort by** dropdown allows you to choose between sorting _alphabetically by hostname_, most _recently-viewed_ nodes, and most _frequently-view_ nodes.
137
-
138
-The **Group by** dropdown lets you switch between _alarm status_, _running services_, or _online status_.
139
-
140
-For example, the following screenshot represents the Nodes list with the following options: _detailed list_, _frequently visited_, and _alarm status_.
141
-
142
-
143
-
144
-Play around with the options until you find a setup that works for you.
145
-
146
-## Adding more agents to the Nodes View
147
-
148
-There is currently only one way to associate additional Netdata nodes with your Netdata Cloud account. You must visit the web dashboard for each node and click the **Sign in** button and complete the [sign in process](signing-in.md#signing-in-to-your-netdata-cloud-account).
149
-
150
-!!! note ""
151
- We are aware that the process of registering each node individually is cumbersome for those who want to implement Netdata Cloud's features across a large infrastructure.
152
-
153
-```
154
-Please view [this comment on issue #6318](https://github.com/netdata/netdata/issues/6318#issuecomment-504106329) for how we plan on improving the process for adding additional nodes to your Netdata Cloud account.
155
-```
156
-
157
-## Services available in the Nodes View
158
-
159
-The following tables elaborate on which services will appear in the Nodes View. Alerts from [other collectors](/collectors/README.md), when entered an alarm status, will show up in the _Alarms_ tab despite not appearing in the
160
-
161
-### Databases
162
-
163
-These services will appear under the _Databases_ selector beneath the _Services_ tab.
164
-
165
-| Service | Collectors | Context #1 | Context #2 | Context #3 |
166
-|--- |--- |--- |--- |--- |
167
-| MySQL | `python.d.plugin:mysql`, `go.d.plugin:mysql` | `mysql.queries` | `mysql.net` | `mysql.connections` |
168
-| MariaDB | `python.d.plugin:mysql`, `go.d.plugin:mysql` | `mysql.queries` | `mysql.net` | `mysql.connections` |
169
-| Oracle Database | `python.d.plugin:oracledb` | `oracledb.session_count` | `oracledb.physical_disk_read_writes ` | `oracledb.tablespace_usage_in_percent` |
170
-| PostgreSQL | `python.d.plugin:postgres` | `postgres.checkpointer` | `postgres.archive_wal` | `postgres.db_size` |
171
-| MongoDB | `python.d.plugin:mongodb` | `mongodb.active_clients` | `mongodb.read_operations` | `mongodb.write_operations` |
172
-| ElasticSearch | `python.d.plugin:elasticsearch` | `elastic.search_performance_total` | `elastic.index_performance_total` | `elastic.index_segments_memory` |
173
-| CouchDB | `python.d.plugin:couchdb` | `couchdb.activity` | `couchdb.response_codes` | |
174
-| Proxy SQL | `python.d.plugin:proxysql` | `proxysql.questions` | `proxysql.pool_status` | `proxysql.pool_overall_net` |
175
-| Redis | `python.d.plugin:redis` | `redis.operations` | `redis.net` | `redis.connections` |
176
-| MemCached | `python.d.plugin:memcached` | `memcached.cache` | `memcached.net` | `memcached.connections` |
177
-| RethinkDB | `python.d.plugin:rethinkdbs` | `rethinkdb.cluster_queries` | `rethinkdb.cluster_clients_active` | `rethinkdb.cluster_connected_servers` |
178
-| Solr | `go.d.plugin:solr` | `solr.search_requests` | `solr.update_requests` | |
179
-
180
-### Web services
181
-
182
-These services will appear under the _Web_ selector beneath the _Services_ tab. These also include proxies, load balancers (LB), and streaming services.
183
-
184
-| Service | Collectors | Context #1 | Context #2 | Context #3 |
185
-|--- |--- |--- |--- |--- |
186
-| Apache | `python.d.plugin:apache`, `go.d.plugin:apache` | `apache.requests` | `apache.connections` | `apache.net ` |
187
-| nginx | `python.d.plugin:nginx`, `go.d.plugin:nginx` | `nginx.requests` | `nginx.connections` | |
188
-| nginx+ | `python.d.plugin:nginx_plus` | `nginx_plus.requests_total` | `nginx_plus.connections_statistics` | |
189
-| lighthttpd | `python.d.plugin:lighttpd`, `go.d.plugin:lighttpd` | `lighttpd.requests` | `lighttpd.net` | |
190
-| lighthttpd2 | `go.d.plugin:lighttpd2` | `lighttpd2.requests` | `lighttpd2.traffic` | |
191
-| LiteSpeed | `python.d.plugin:litespeed` | `litespeed.requests` | `litespeed.requests_processing` | |
192
-| Tomcat | `python.d.plugin:tomcat` | `tomcat.accesses` | `tomcat.processing_time` | `tomcat.bandwidth` |
193
-| PHP FPM | `python.d.plugin:phpfm` | `phpfpm.performance` | `phpfpm.requests` | `phpfpm.connections` |
194
-| HAproxy | `python.d.plugin:haproxy` | `haproxy_f.scur` | `haproxy_f.bin` | `haproxy_f.bout` |
195
-| Squid | `python.d.plugin:squid` | `squid.clients_requests` | `squid.clients_net` | |
196
-| Traefik | `python.d.plugin:traefik` | `traefik.response_codes` | | |
197
-| Varnish | `python.d.plugin:varnish` | `varnish.session_connection` | `varnish.client_requests` | |
198
-| IPVS | `proc.plugin:/proc/net/ip_vs_stats` | `ipvs.sockets` | `ipvs.packets` | |
199
-| Web Log | `python.d.plugin:web_log`, `go.d.plugin:web_log` | `web_log.response_codes` | `web_log.bandwidth` | |
200
-| IPFS | `python.d.plugin:ipfs` | `ipfs.bandwidth` | `ipfs.peers` | |
201
-| IceCast Media Streaming | `python.d.plugin:icecast` | `icecast.listeners` | | |
202
-| RetroShare | `python.d.plugin:retroshare` | `retroshare.bandwidth` | `retroshare.peers` | |
203
-| HTTP Check | `python.d.plugin:httpcheck`, `go.d.plugin:httpcheck` | `httpcheck.responsetime` | `httpcheck.status` | |
204
-| x509 Check | `go.d.plugin:x509check` | `x509check.time_until_expiration` | | |
205
-
206
-### Messaging
207
-
208
-These services will appear under the _Messaging_ selector beneath the _Services_ tab.
209
-
210
-| Service | Collectors | Context #1 | Context #2 | Context #3 |
211
-| --- | --- | --- | --- | --- |
212
-| RabbitMQ | `python.d.plugin:rabbitmq`, `go.d.plugin:rabbitmq` | `rabbitmq.queued_messages` | `rabbitmq.erlang_run_queue` |
213
-| Beanstalkd | `python.d.plugin:beanstalk` | `beanstalk.total_jobs_rate` | `beanstalk.connections_rate` | `beanstalk.current_tubes` |
214
-
215
-[](<>)
docs/netdata-cloud/signing-in.md
deleted
-175
@@ -1,175 +0,0 @@
1
-<!--
2
----
3
-title: "Registration and signing in"
4
-custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/netdata-cloud/signing-in.md
5
----
6
--->
7
-
8
-# Registration and signing in
9
-
10
-To use the features of [Netdata Cloud](/docs/netdata-cloud/README.md), you must first register an account with Netdata
11
-Cloud and associate your first Netdata node with the Netdata Cloud [registry](/registry/README.md). **Netdata Cloud is
12
-entirely free for all Netdata users**, and does not store any metrics created by your machines. You keep your
13
-data—Netdata Cloud just connects it all together.
14
-
15
-> By [signing in](/docs/netdata-cloud/signing-in.md) to Netdata Cloud, you opt-in to let Netdata Cloud receive and store
16
-> the information described [here](/registry/README.md#what-data-does-the-registry-store). We never store the metrics
17
-> collected by Netdata agents, just machine GUIDs, person GUID, URLs, and account information.
18
-
19
-## Registering a Netdata Cloud account
20
-
21
-There is only one prerequisite to using Netdata Cloud: A working Netdata agent. If you don't have a running Netdata
22
-agent yet, check out the [installation guides](/packaging/installer/README.md) for more information.
23
-
24
-To begin, visit the web dashboard of your Netdata agent by navigating your browser of choice to `http://SERVER-IP:19999`. You’ll see a dashboard much like this:
25
-
26
-
27
-
28
-From here, you need to register for a Netdata Cloud account. Click on the **Sign in** button on the top-right corner of the dashboard's view.
29
-
30
-
31
-
32
-??? note "Alternative registration routes"
33
- While we recommend the **Sign in** button, the Netdata dashboard has one other direct route registering for or signing in to a Netdata Cloud account.
34
-
35
-
36
-The text **Please sign in to netdata.cloud to view your nodes!** contains a link to access Netdata Cloud.
37
-
38
-
39
-
40
-Two other routes exist, but they are more directly related to accessing the Nodes View. They will, however, require either registration or sign in and thus are valid routes to access Netdata Cloud.
41
-
42
-One route can be found in the **Nodes Beta** button the left side of the navigation menu:
43
-
44
-
45
-
46
-A second route can be found in the Nodes List—the drop-down menu in the top-left corner of the Netdata dashboard:
47
-
48
- 
49
-
50
-
51
-??? note "Registration route when using a private registry"
52
- If you're using a private registry, clicking the **Sign in** button will display a modal window warning you about the process of migrating away from your private registry and to Netdata Cloud's registry.
53
-
54
-
55
-
56
-
57
-If you agree to use Netdata Cloud over your private registry, and opt-in to let Netdata Cloud receive and store the information described [here](/registry/README.md#what-data-does-the-registry-store), you should click the **Sign in** button again. If not, click the **Cancel** button to continue using your private registry.
58
-
59
-
60
-### Choosing your registration or sign in method
61
-
62
-After clicking the **Sign in** button, you'll be directed to the Netdata Cloud registration/sign in page. Choose to authorize with your Google account, GitHub account, or email.
63
-
64
-!!! attention
65
- Be consistent with the sign in method you use, whether GitHub, Google, or email. If you sign in via different methods, the system will create multiple Netdata Cloud accounts, one for each sign-in method used. We plan to offer multiple authentication methods for the same account in the future.
66
-
67
-
68
-
69
-### Registration via Google
70
-
71
-Click the **Authorize with Google** button to begin registration. You will be redirected to a Google authentication form where you confirm you will "share your name, email address, language preference, and profile picture with netdata.cloud."
72
-
73
-
74
-
75
-Click on the account you would like to connect to Netdata Cloud to continue and then skip down to [Visiting Netdata Cloud for the first time](#visiting-the-nodes-view-for-the-first-time) for further instructions.
76
-
77
-### Registration via GitHub
78
-
79
-Click the **Authorize with GitHub** button to begin registration. You will be redirected to a GitHub authentication form where you confirm to share your email address with Netdata Cloud to create your account.
80
-
81
-
82
-
83
-Click the **Authorize Netdata** button to continue and then skip down to [Visiting Netdata Cloud for the first time](#visiting-the-nodes-view-for-the-first-time) for further instructions.
84
-
85
-### Registration via email
86
-
87
-Enter your preferred email into the field and click the **Authorize** button.
88
-
89
-Open your email account and check for the verification email—it should arrive in less than a minute. If it doesn't show up, check your spam folder or click the **Resend email** button in the Netdata Cloud interface.
90
-
91
-When the email arrives, open it and click on the green **Sign in** button and then skip down to [Visiting Netdata Cloud for the first time](#visiting-the-nodes-view-for-the-first-time) for further instructions.
92
-
93
-
94
-
95
-## Visiting the Nodes View for the first time
96
-
97
-Regardless of which sign in method you used, you'll now be redirected back to your Netdata agent's dashboard. This node has now been associated with your Netdata Cloud account. Netdata Cloud uses a list of nodes associated with your account to populate the Nodes List dropdown in the dashboard and the Nodes View feature of Netdata Cloud.
98
-
99
-**For more information on how to use the Nodes View, visit the [Nodes View guide](nodes-view.md).**
100
-
101
-## Signing in to your Netdata Cloud account
102
-
103
-The process of signing in to an existing Netdata Cloud account the same as [registering for a new account](#registering-a-netdata-cloud-account). The recommended method is to use the **Sign in** button at the top-right corner of a Netdata nodes's dashboard. Choose the method you used to register for your Netdata Cloud account and complete the process.
104
-
105
-
106
-
107
-## Adding additional nodes to your Netdata Cloud account
108
-
109
-There is currently only one way to associate additional Netdata nodes with your Netdata Cloud account: You must visit the web dashboard for each node and click the **Sign in** button and complete the [sign in process](#signing-in-to-your-netdata-cloud-account).
110
-
111
-!!! note ""
112
- We are aware that the process of registering each node individually is cumbersome for those who want to implement Netdata Cloud's features across a large infrastructure.
113
-
114
-```
115
-Please view [this comment on issue #6318](https://github.com/netdata/netdata/issues/6318#issuecomment-504106329) for how we plan on improving the process for adding additional nodes to your Netdata Cloud account.
116
-```
117
-
118
-## Private registries and Netdata Cloud
119
-
120
-If you use a [private registry](/registry/README.md#run-your-own-registry), and sign in to Netdata Cloud, you'll be using the Netdata Cloud registry in addition to your private registry.
121
-
122
-Clicking the **Sign in** button on the Netdata dashboard will display a modal window warning you about the synchronization of your private registry's entries to the Netdata Cloud's registry.
123
-
124
-
125
-
126
-If your company's data policies don't allow storing information about your nodes on the Netdata Cloud registry, you
127
-should click the **Cancel** button and continue using your private registry. You'll be able to access the Nodes List in
128
-the top-left corner of a Netdata dashboard, but you won't be able to use the [Nodes View](nodes-view.md) feature within
129
-Netdata Cloud, or any of the [additional
130
-features](https://blog.netdata.cloud/posts/netdata-cloud-announcement/#what-features-will-netdata-cloud-offer) on our
131
-roadmap. You can also sign up for the waiting list for the [hosted and/or on-premises versions of Netdata
132
-Cloud](/docs/netdata-cloud/README.md#running-netdata-cloud-on-premises-or-as-a-hosted-instance) that we're working on.
133
-
134
-If you agree to use Netdata Cloud over your private registry, and opt-in to let Netdata Cloud receive and store the information described [here](/registry/README.md#what-data-does-the-registry-store), you should click the **Sign in** button again to continue the registration/sign in process.
135
-
136
-### Returning to your private registry
137
-
138
-If you register for or sign in to Netdata Cloud from a node previously associated with a private registry, you can easily return to your private registry by signing out.
139
-
140
-You can sign out in two ways:
141
-
142
-1. **From a node's dashboard**: In the top-right corner you will find a dropdown menu with your email address. Click that and then click the **Sign Out** button.
143
-2. **From Netdata Cloud**: Click on your profile picture in the top-right corner and then click on the **Sign Out** button.
144
-
145
-Signing out from Netdata Cloud and returning to your private registry *does not remove* the [information stored](/registry/README.md#what-data-does-the-registry-store) about your nodes or account details.
146
-
147
-But, upon signout, your Nodes List on all dashboards will once more be populated by your private registry and not Netdata Cloud.
148
-
149
-<!-- ## The 'Synchronize with Netdata Cloud' button
150
-
151
-Once signed in to Netdata Cloud, the Nodes List dropdown will now show a button labeled `Synchronize with netdata.cloud`.
152
-
153
-The `Synchronize with Netdata Cloud` button is a migration (or import) tool for Netdata Cloud. If either the public or your private registry contains a list of nodes associated with your `person_guid`, it will import them into Netdata Cloud and associate them with the `accounts` information in the Netdata Cloud registry.
154
-
155
-When you click the `Synchronize with netdata.cloud` button, you will receive one of two popup messages based on whether you were using the public registry (at `registry.my-netdata.io`) or a private registry.
156
-
157
-**Public registry**:
158
-
159
-
160
-
161
-**Private registry**:
162
-
163
-
164
-
165
-If you do not want to synchronize your registry of choice with Netdata Cloud, click `Cancel`.
166
-
167
-If you do, click `Synchronize`. This will push GUIDs, hostnames, and URLs to Netdata Cloud's registry.
168
-
169
-Now, when you visit the Nodes View, you will be able to see all the nodes that were once associated with the public/private registry you were using previously. -->
170
-
171
-## What's next?
172
-
173
-Learn how to use the [Nodes View](nodes-view.md) to monitor many nodes concurrently.
174
-
175
-[](<>)
docs/step-by-step/step-02.md
+29
-44
@@ -1,7 +1,7 @@
1
<!--
2
---
3
title: "Step 2. Get to know Netdata's dashboard"
4
-date: 2020-03-11
4
+date: 2020-05-04
5
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/step-by-step/step-02.md
6
---
7
-->
@@ -28,30 +28,19 @@ In this step of the Netdata guide, you'll learn how to:
28
29
Let's get started!
30
31
-<details markdown="1"><summary>Like shortcuts? Watch our six-minute quickstart video for Netdata's dashboard.</summary>
32
-<iframe width="720" height="405" src="https://www.youtube.com/embed/Ob6-Wkb6ZBA" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
33
-<p>Once you've finished, <a href="#whats-next">skip ahead</a> or scroll down for the text-based dashboard quickstart.</p>
34
-</details>
35
-
31
## Visit and explore the dashboard
32
33
Netdata's dashboard is where you interact with your system's metrics. Time to open it up and start exploring. Open up
34
your browser of choice.
35
41
-If you installed Netdata on the same system you're using to open your browser, navigate to `http://localhost:19999/`.
42
-
43
-If you installed Netdata on a remote system, navigate to `http://HOST:19999/` after replacing `HOST` with the IP address
44
-of that system. To connect to a virtual private server (VPS), for example, you might navigate to
45
-`http://203.0.113.0:19999`. We'll learn more on monitoring remote systems and [multiple systems](step-03.md)
46
-later on.
47
-
48
-> From here on out in this tutorial, we'll refer to the address you use to view your dashboard as `HOST`. Be sure to
49
-> replace it with either `localhost` or the IP address as needed.
50
-
51
-Hit `Enter`. Welcome to Netdata!
36
+Open up your web browser of choice and navigate to `http://NODE:19999`, replacing `NODE` with the IP address or hostname
37
+of your Agent. If you're unsure, try `http://localhost:19999` first. Hit **Enter**. Welcome to Netdata!
38
39
40
+dashboard](https://user-images.githubusercontent.com/1153921/80825153-abaec600-8b94-11ea-8b17-1b770a2abaa9.gif)
41
+
42
+> From here on out in this tutorial, we'll refer to the address you use to view your dashboard as `NODE`. Be sure to
43
+> replace it with either `localhost`, the IP address, or the hostname of your system.
44
45
## Explore available charts using menus
46
@@ -59,7 +48,7 @@ dashboard](https://user-images.githubusercontent.com/1153921/63463901-fcb9c800-c
48
charts you're interested in.
49
50
51
+submenus](https://user-images.githubusercontent.com/1153921/80832425-7c528600-8ba1-11ea-8140-d0a17a62009b.gif)
52
53
Netdata shows all its charts on a single page, so you can also scroll up and down using the mouse wheel, your
54
touchscreen/touchpad, or the scrollbar.
@@ -69,7 +58,7 @@ what it's collecting. If you run Netdata on many different systems using differe
58
menus and submenus may look a little different for each one.
59
60
To learn more about menus, see our documentation about [navigating the standard
72
-dashboard](/web/gui/README.md#menus).
61
+dashboard](/web/gui/README.md#metrics-menus).
62
63
> ❗ By default, Netdata only creates and displays charts if the metrics are _not zero_. So, you may be missing some
64
> charts, menus, and submenus if those charts have zero metrics. You can change this by changing the **Which dimensions
@@ -128,11 +117,10 @@ We built Netdata to be a big sandbox for learning more about your systems and ap
117
Netdata's charts are fully interactive. You can pan through historical metrics, zoom in and out, select specific
118
timeframes for further analysis, resize charts, and more.
119
131
-Best of all, Whenever you use a chart in this way, Netdata synchronizes all the other charts to match it. This even
132
-applies across different Netdata agents if you connect them using the [**My nodes** menu](/registry/README.md)!
120
+Best of all, Whenever you use a chart in this way, Netdata synchronizes all the other charts to match it.
121
134
-
122
+
124
125
### Pan, zoom, highlight, and reset charts
126
@@ -149,9 +137,6 @@ You can change how charts show their metrics in a few different ways, each of wh
137
These interactions can also be triggered using the icons on the bottom-right corner of every chart. They are,
138
respectively, `Pan Left`, `Reset`, `Pan Right`, `Zoom In`, and `Zoom Out`.
139
152
-
154
-
140
### Show and hide dimensions
141
142
Each dimension can be hidden by clicking on it. Hiding dimensions simplifies the chart and can help you better discover
@@ -163,40 +148,40 @@ Additionally, resize charts by clicking-and-dragging the icon on the bottom-righ
148
chart to its original height, double-click the same icon.
149
150
151
+height](https://user-images.githubusercontent.com/1153921/80842459-7d41e280-8bb6-11ea-9488-1bc29f94d7f2.gif)
152
153
To learn more about other options and chart interactivity, read our [dashboard documentation](/web/README.md).
154
155
## See raised alarms and the alarm log
156
172
-Aside from performance troubleshooting, Netdata is designed to help you monitor the health of your systems and
173
-applications. That's why every Netdata installation comes with dozens of pre-configured alarms that trigger alerts when
174
-your system starts acting strangely.
157
+Aside from performance troubleshooting, the Agent helps you monitor the health of your systems and applications. That's
158
+why every Netdata installation comes with dozens of pre-configured alarms that trigger alerts when your system starts
159
+acting strangely.
160
161
Find the **Alarms** button in the top navigation bring up a modal that shows currently raised alarms, all running
162
alarms, and the alarms log.
163
179
-Here is an example of raised `disk_space._` and `disk_space._home` alarms, followed by the full list and alarm log:
164
+Here is an example of a raised `system.cpu` alarm, followed by the full list and alarm log:
165
166
167
+log](https://user-images.githubusercontent.com/1153921/80842482-8c289500-8bb6-11ea-9791-600cfdbe82ce.gif)
168
184
-Let's look at one of those raised alarms a little more in-depth. Here is a static screenshot:
169
+And a static screenshot of the raised CPU alarm:
170
186
-
171
+
172
189
-The alarm itself is named **disk - /**, and its context is `disk_space._`. Beneath that is an auto-updating badge that
190
-shows the latest metric: 28.4% disk space usage.
173
+The alarm itself is named *system - cpu**, and its context is `system.cpu`. Beneath that is an auto-updating badge that
174
+shows the latest value the chart that triggered the alarm.
175
192
-With the three icons beneath that and the **role** designation, you can **1)** scroll to the chart associated with this
193
-raised alarm, **2)** copy a link to the badge to your clipboard, and **3)** copy the code to embed the badge onto
194
-another web page using an `<embed>` element.
176
+With the three icons beneath that and the **role** designation, you can:
177
196
-The table on the right-hand side displays information about the alarm's configuration.
178
+1. Scroll to the chart associated with this raised alarm.
179
+2. Copy a link to the badge to your clipboard.
180
+3. Copy the code to embed the badge onto another web page using an `<embed>` element.
181
198
-In this example, Netdata triggers a warning alarm when any disk on the system is more than 20% full. Netdata triggers a
199
-critical alarm when the disk is more than 30% full.
182
+The table on the right-hand side displays information about the alarm's configuration. In above example, Netdata
183
+triggers a warning alarm when CPU usage is between 75 and 85%, and a critical alarm when above 85%. It's a _little_ more
184
+complicated than that, but we'll get into more complex health entity configurations in a later step.
185
186
The `calculation` field is the equation used to calculate those percentages, and the `check every` field specifies how
187
often Netdata should be calculating these metrics to see if the alarm should remain triggered.
docs/step-by-step/step-03.md
+44
-125
@@ -1,6 +1,7 @@
1
<!--
2
---
3
title: "Step 3. Monitor more than one system with Netdata"
4
+date: 2020-05-01
5
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/step-by-step/step-03.md
6
---
7
-->
@@ -15,158 +16,76 @@ You might be thinking, "So, now I have to remember all these IP addresses, and t
16
manually, to move from one system to another? Maybe I should just make a bunch of bookmarks. What's a few more tabs
17
on top of the hundred I have already?"
18
18
-We get it. That's why we built [Netdata Cloud](/docs/netdata-cloud/README.md), which connects many distributed agents
19
-together for a seamless experience when monitoring multiple systems.
19
+We get it. That's why we built [Netdata Cloud](https://learn.netdata.cloud/docs/cloud/), which connects many distributed
20
+agents for a seamless experience when monitoring an entire infrastructure of Netdata-monitored nodes.
21
21
-All without remembering IPs or making a bunch of bookmarks.
22
-
23
-> If you're interested in streaming the metrics from one Netdata agent to another, that's unfortunately not part of this
24
-> tutorial. You'll want to reference our [streaming documentation](/streaming/README.md) when you're finished with
25
-> these steps.
26
-
27
-Even if you don't have multiple systems right now, keep reading. The instructions to follow will show you how to test
28
-out these features with Netdata demo servers. That way, you'll be able to experience one of Netdata's defining features
29
-right away.
22
+
24
25
## What you'll learn in this step
26
33
-In this step of the Netdata guid, we'll talk about the following:
27
+In this step of the Netdata guide, we'll talk about the following:
28
29
- [Why you should use Netdata Cloud](#why-use-netdata-cloud)
36
-- [Add nodes to your Netdata Cloud account](#add-nodes-to-your-netdata-cloud-account)
37
-- [Navigate between your nodes via the **My nodes** menu](#navigate-between-your-nodes-via-the-my-nodes-menu)
38
-- [Try out the Nodes View](#try-out-the-nodes-view)
30
+- [Get started with Netdata Cloud](#get-started-with-netdata-cloud)
31
+- [Navigate between dashboards with Visited Nodes](#navigate-between-dashboards-with-visited-nodes)
32
33
## Why use Netdata Cloud?
34
42
-We built Netdata Cloud to give users a way to bridge the gap between many distributed agents running concurrently, all
43
-without creating a centralized database for all your systems' metrics.
44
-
45
-Netdata Cloud gives you a better way to observe and take action on slowdowns, anomalies, or outages in your systems and
46
-applications. It connects all your Netdata agents through your _web browser_, allowing you to move between different
47
-nodes quickly and use the Nodes View to see a handful or hundreds of Netdata-monitored nodes on a single screen.
48
-
49
-If you're keeping tabs on multiple systems with Netdata, Netdata Cloud gives you all the benefits of a centralized
50
-monitoring solution while distributing the workload to each agent.
51
-
52
-That makes Netdata Cloud both comprehensive and lightweight. The best of both worlds!
53
-
54
-And, better yet, Netdata Cloud doesn't store any of your system's metrics. It stores _metadata_ about the system's IP,
55
-hostname, and a randomly-created GUID, and nothing else. Metrics are streamed from your systems directly to your _web
56
-browser_.
57
-
58
-Essentially, your web browser hosts a SaaS application with all of Netdata Cloud's features embedded right into the
59
-dashboard itself.
60
-
61
-## Add nodes to your Netdata Cloud account
62
-
63
-The best way to add nodes to your Netdata Cloud account is to click on the **Sign in** button on the top-right corner of
64
-your Netdata dashboard.
65
-
66
-That button will open a new tab in for Netdata Cloud, and will prompt you to log-in using email or authentication via
67
-Google or GitHub.
68
-
69
-If you chose email, Netdata Cloud will send you a "magic link" via email. Once you click on the link, that node will be
70
-connected to your Netdata Cloud account and you'll be redirected back to your dashboard. If you chose Google or GitHub,
71
-you'll be redirected back to your dashboard as soon as authentication is finished.
72
-
73
-Here's what authentication via Google looks like:
74
-
75
-
77
-
78
-Depending on your authentication method, your email address or name will appear in the top right of your dashboard
79
-instead of the **Sign in** button.
80
-
81
-At this point, you've successfully added a single Netdata agent to your Netdata Cloud account. _What about the rest?_
82
-
83
-Well, all you have to do is visit another node and repeat the sign-in process.
84
-
85
-Let's use a demo system as an example.
86
-
87
-Visit the [Netdata website](https://www.netdata.cloud/#live-demo) and click on any of the gauge charts displayed
88
-underneath the **Live Demo** header.
89
-
90
-Once the dashboard loads, repeat the Netdata Cloud sign-in process. The demo server is now associated with your Netdata
91
-Cloud account, and will appear in your **My nodes** menu.
92
-
93
-Here's how the process looks in action:
94
-
95
-
97
-
98
-## Navigate between your nodes via the My nodes menu
99
-
100
-Once you have multiple nodes added to Netdata Cloud, they will populate your **My nodes** menu. You can use this menu to
101
-navigate between your systems quickly.
102
-
103
-
105
-
106
-Whenever you pan, zoom, highlight, select, or pause a chart, Netdata will synchronize those settings with any other
107
-agent you visit via the My nodes menu. Even your scroll position is synchronized, so you'll see the same charts and
108
-respective data for easy comparisons or root cause analysis.
109
-
110
-You can now seamlessly track performance anomalies across your entire infrastructure!
111
-
112
-## Try out the Nodes View
113
-
114
-Next, let's try out the Nodes View.
115
-
116
-Nodes View is a feature built in to Netdata Cloud that offers a different interface for viewing the health status of
117
-multiple nodes.
35
+Our [Cloud documentation](https://learn.netdata.cloud/docs/cloud/) does a good job (we think!) of explaining why Cloud
36
+gives you a ton of value at no cost:
37
119
-> Learn more about all the features within Nodes View and what charts/metrics are represented there in our
120
-> [documentation](/docs/netdata-cloud/nodes-view.md).
38
+> Netdata Cloud gives you real-time visibility for your entire infrastructure. With Netdata Cloud, you can run all your
39
+> distributed Agents in headless mode _and_ access the real-time metrics and insightful charts from their dashboards.
40
+> View key metrics and active alarms at-a-glance, and then seamlessly dive into any of your distributed dashboards
41
+> without leaving Cloud's centralized interface.
42
122
-You can visit Nodes View by navigating to `https://netdata.cloud/console` in your browser. Or, you can click on the
123
-**Nodes View** button in any Netdata dashboard. If you're not logged in to Netdata Cloud yet, you'll be asked to log in
124
-first.
43
+You can as made nodes and team members as you need, and as our free and open source Agent gets better with more
44
+features, new collectors for more applications, and improved UI, so will Cloud.
45
126
-
46
+## Get started with Netdata Cloud
47
129
-The Nodes View shows an aggregated list of the nodes you connected to Netdata Cloud, and shows at-a-glance health status
130
-for each.
48
+Signing in, onboarding, and claiming your first nodes only takes a few minutes, and we have a [Get started with
49
+Cloud](https://learn.netdata.cloud/docs/cloud/get-started) guide to help you walk through every step.
50
132
-Click on any of the boxes representing your nodes to see real-time, per-second charts of essential metrics in the **Node
133
-overview** sidebar.
51
+Or, if you're feeling confident, dive right in.
52
135
-
53
+<p><a href="https://app.netdata.cloud" className="button button--lg">Sign in to Cloud</a></p>
54
138
-You can also view raised alarms and see real-time metrics from a [select number of
139
-services/applications](/docs/netdata-cloud/nodes-view.md#services-available-in-the-nodes-view) using the various tabs
140
-available in the node overview sidebar.
55
+When you finish that guide, circle back to this step in the tutorial to learn how to use the Visited Nodes feature on
56
+top of Cloud's centralized web interface.
57
142
-If you add a large number of nodes to the Nodes View, you may want to look into the different view and sorting options.
143
-You can choose between **full**, **compact**, and **detailed** view modes.
58
+## Navigate between dashboards with Visited Nodes
59
145
-
60
+To add nodes to your visited nodes, you first need to navigate to that node's dashboard, then click the **Sign in**
61
+button at the top of the dashboard. On the screen that appears, which states your node is requesting access to your
62
+Netdata Cloud account, sign in with your preferred method.
63
148
-You can also sort between grouping nodes by hostname, recently viewed, or most frequestly visited. Or, group them by
149
-alarm status, their services, or whether they're online or unreachable.
64
+Cloud redirects you back to your node's dashboard, which is now connected to your Netdata Cloud account. You can now see the menu populated by a single visited node.
65
151
-
66
+
68
154
-Play around until you find the right settings for you and your infrastructure.
69
+If you previously went through the Cloud onboarding process to create a Space and War Room, you will also see these
70
+alongside your visited nodes. You can click on your Space or any of your War Rooms to navigate to Netdata Cloud and
71
+continue monitoring your infrastructure from there.
72
156
-### Remove a node from Nodes View
73
+
75
158
-If you want to clean up your Nodes View a bit, you can remove them from your Netdata Cloud account.
76
+To add other visited nodes, navigate to their dashboard and sign in to Cloud by clicking on the **Sign in** button. This
77
+process connects that node to your Cloud account and further populates the menu.
78
160
-Click on the node in question, and then scroll to the bottom of the Node overiew sidebar. You'll see a URL under the
161
-**Node URLs** heading. Hover over the URL and click on the garbage bin icon. Click **Confirm** on the modal window.
162
-Then, click the **Forget** button that appears in the sidebar, and hit **Confirm** once again.
79
+Once you've added more than one node, you can use the menu to switch between various dashboards without remembering IP
80
+addresses or hostnames or saving bookmarks for every node you want to monitor.
81
164
-
82
+
84
85
## What's next?
86
168
-Now that you know how to add multiple nodes to your Netdata Cloud agent and navigate between them, it's time to learn
169
-more about how you can configure Netdata to your liking. From there, you'll be able to customize your Netdata experience
170
-to your exact infrastructure and the information you need.
87
+Now that you have a Netdata Cloud account with a claimed node (or a few!) and can navigate between your dashboards with
88
+Visited nodes, it's time to learn more about how you can configure Netdata to your liking. From there, you'll be able to
89
+customize your Netdata experience to your exact infrastructure and the information you need.
90
91
[Next: The basics of configuring Netdata →](step-04.md)
docs/step-by-step/step-04.md
+4
-4
@@ -108,10 +108,10 @@ Here's the process in GIF form!
108
110
111
-Now, let's make a slightly more substantial edit to `netdata.conf`—change the agent's name.
111
+Now, let's make a slightly more substantial edit to `netdata.conf`: change the Agent's name.
112
113
-If you edit the value of the `hostname` option, you can change the name of your Netdata agent on the dashboard and a
114
-handful of other places, like the **My nodes** menu.
113
+If you edit the value of the `hostname` option, you can change the name of your Netdata Agent on the dashboard and a
114
+handful of other places, like the Visited nodes menu _and_ Netdata Cloud.
115
116
Use `edit-config` to change the `hostname` option to a name like `hello-world`. Be sure to uncomment it!
117
@@ -123,7 +123,7 @@ Use `edit-config` to change the `hostname` option to a name like `hello-world`.
123
Once you're done, restart Netdata and refresh the dashboard. Say hello to your renamed agent!
124
125
126
+netdata.conf](https://user-images.githubusercontent.com/1153921/80994808-1c065300-8df2-11ea-81af-d28dc3ba27c8.gif)
127
128
Netdata has dozens upon dozens of options you can change. To see them all, read our [daemon
129
configuration](/daemon/config/README.md), or hop into our popular tutorial on [increasing long-term metrics
docs/step-by-step/step-07.md
+5
-10
@@ -1,6 +1,7 @@
1
<!--
2
---
3
title: "Step 7. Netdata's dashboard in depth"
4
+date: 2020-05-04
5
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/step-by-step/step-07.md
6
---
7
-->
@@ -31,14 +32,9 @@ operation of your Netdata server/daemon. They take effect immediately and are pe
32
You can see the **Performance**, **Synchronization**, **Visual**, and **Locale** tabs on the dashboard settings modal.
33
34
35
+modal](https://user-images.githubusercontent.com/1153921/80841197-c93f5800-8bb3-11ea-907d-85bfe23565e1.gif)
36
36
-To change any setting, click on the toggle button.
37
-
38
-
40
-
41
-We recommend you spend some time reading the descriptions for each setting to understand them before making changes.
37
+To change any setting, click on the toggle button. We recommend you spend some time reading the descriptions for each setting to understand them before making changes.
38
39
Pay particular attention to the following settings, as they have dramatic impacts on the performance and appearance of
40
your Netdata dashboard:
@@ -55,8 +51,7 @@ Some settings are applied immediately, and others are only reflected after you r
51
52
You can always check if there is an update available from the **Update** area of your Netdata dashboard.
53
58
-
54
+
55
56
If an update is available, you'll see a modal similar to the one above.
57
@@ -84,7 +79,7 @@ snapshot, and send it to a colleague for further analysis.
79
To export a snapshot, click on the **export** icon.
80
81
82
+modal](https://user-images.githubusercontent.com/1153921/80993197-82d63d00-8def-11ea-88fa-98827814e930.gif)
83
84
Edit the snapshot file name and select your desired compression method. Click on **Export**.
85
docs/what-is-netdata.md
+23
-26
@@ -1,7 +1,7 @@
1
<!--
2
---
3
title: "What is Netdata?"
4
-date: 2020-04-07
4
+date: 2020-05-01
5
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/what-is-netdata.md
6
---
7
-->
@@ -59,7 +59,7 @@ Netdata!](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&la
59
6. [Infographic](#infographic) - Everything about Netdata in a single graphic
60
7. [Features](#features) - How you'll use Netdata on your systems
61
8. [Visualization](#visualization) - Learn about visual anomaly detection
62
-9. [What Netdata monitors](#what-netdata-monitors) - See which apps/services Netdata auto-detects
62
+9. [What Netdata monitors](#what-netdata-monitors) - See which apps/services Netdata auto-detects
63
10. [Documentation](#documentation) - Read the documentation
64
11. [Community](#community) - Discuss Netdata with others and get support
65
12. [License](#license) - Check Netdata's licencing
@@ -71,7 +71,7 @@ Netdata!](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&la
71
The following animated GIF shows the top part of a typical Netdata dashboard.
72
73
74
+action](https://user-images.githubusercontent.com/1153921/80827388-b9fee100-8b98-11ea-8f60-0d7824667cd3.gif)
75
76
> A typical Netdata dashboard, in 1:1 timing. Charts can be panned by dragging them, zoomed in/out with `SHIFT` + `mouse
77
> wheel`, an area can be selected for zoom-in with `SHIFT` + `mouse selection`. Netdata is highly interactive,
@@ -264,18 +264,17 @@ This is what you should expect from Netdata:
264
265
- **Sophisticated alerting** - Netdata comes with hundreds of alarms **out of the box**! It supports dynamic
266
thresholds, hysteresis, alarm templates, multiple role-based notification methods, and more.
267
-- **Notifications**: [alerta.io](/health/notifications/alerta/README.md), [amazon
268
- sns](/health/notifications/awssns/README.md), [discordapp.com](/health/notifications/discord/README.md),
269
- [email](/health/notifications/email/README.md), [flock.com](/health/notifications/flock/README.md),
270
- [hangouts](/health/notifications/hangouts/README.md), [irc](/health/notifications/irc/README.md),
271
- [kavenegar.com](/health/notifications/kavenegar/README.md), [messagebird.com](/health/notifications/messagebird/),
272
- [pagerduty.com](/health/notifications/pagerduty/README.md), [prowl](/health/notifications/prowl/README.md),
273
- [pushbullet.com](/health/notifications/pushbullet/README.md),
274
- [pushover.net](/health/notifications/pushover/README.md), [rocket.chat](/health/notifications/rocketchat/README.md),
275
- [slack.com](/health/notifications/slack/README.md), [smstools3](/health/notifications/smstools3/README.md),
276
- [syslog](/health/notifications/syslog/README.md), [telegram.org](/health/notifications/telegram/README.md),
277
- [twilio.com](/health/notifications/twilio/README.md), [web](/health/notifications/web/README.md) and [custom
278
- notifications](/health/notifications/custom/README.md).
267
+- **Notifications**: [alerta.io](/health/notifications/alerta/), [amazon sns](/health/notifications/awssns/),
268
+ [discordapp.com](/health/notifications/discord/), [email](/health/notifications/email/),
269
+ [flock.com](/health/notifications/flock/), [hangouts](/health/notifications/hangouts/),
270
+ [irc](/health/notifications/irc/), [kavenegar.com](/health/notifications/kavenegar/),
271
+ [messagebird.com](/health/notifications/messagebird/), [pagerduty.com](/health/notifications/pagerduty/),
272
+ [prowl](/health/notifications/prowl/), [pushbullet.com](/health/notifications/pushbullet/),
273
+ [pushover.net](/health/notifications/pushover/), [rocket.chat](/health/notifications/rocketchat/),
274
+ [slack.com](/health/notifications/slack/), [smstools3](/health/notifications/smstools3/),
275
+ [syslog](/health/notifications/syslog/), [telegram.org](/health/notifications/telegram/),
276
+ [twilio.com](/health/notifications/twilio/), [web](/health/notifications/web/) and [custom
277
+ notifications](/health/notifications/custom/).
278
279
### Integrations
280
@@ -303,7 +302,8 @@ This is what you should expect from Netdata:
302
To improve clarity on charts, Netdata dashboards present **positive** values for metrics representing `read`, `input`,
303
`inbound`, `received` and **negative** values for metrics representing `write`, `output`, `outbound`, `sent`.
304
306
-
305
+
307
308
_Netdata charts showing the bandwidth and packets of a network interface. `received` is positive and `sent` is
309
negative._
@@ -312,7 +312,8 @@ negative._
312
313
Netdata charts automatically zoom vertically, to visualize the variation of each metric within the visible time-frame.
314
315
-
315
+
317
318
_A zero-based `stacked` chart, automatically switches to an auto-scaled `area` chart when a single dimension is
319
selected._
@@ -322,27 +323,23 @@ selected._
323
Charts on Netdata dashboards are synchronized to each other. There is no master chart. Any chart can be panned or zoomed
324
at any time, and all other charts will follow.
325
325
-
326
+
328
329
_Charts are panned by dragging them with the mouse. Charts can be zoomed in/out with`SHIFT` + `mouse wheel` while the
330
mouse pointer is over a chart._
331
330
-> The visible time-frame (pan and zoom) is propagated from Netdata server to Netdata server when navigating via the
331
-> [My nodes menu](/registry/README.md).
332
-
332
### Highlighted time-frame
333
334
To improve visual anomaly detection across charts, the user can highlight a time-frame (by pressing `Alt` + `mouse
335
selection`) on all charts.
336
338
-
337
+
339
340
_A highlighted time-frame can be given by pressing `Alt` + `mouse selection` on any chart. Netdata will highlight the
341
same range on all charts._
342
343
-> Highlighted ranges are propagated from Netdata server to Netdata server, when navigating via the [My nodes
344
-> menu](/registry/README.md).
345
-
343
## What Netdata monitors
344
345
Netdata can collect metrics from 200+ popular services and applications, on top of dozens of system-related metrics
@@ -397,7 +394,7 @@ You can also find Netdata on:
394
395
## License
396
400
-Netdata is GPLv3+.
397
+Netdata is [GPLv3+](/LICENSE).
398
399
Netdata re-distributes other open-source tools and libraries. Please check the [third party licenses](/REDISTRIBUTED.md).
400
packaging/installer/UPDATE.md
+1
-2
@@ -17,8 +17,7 @@ Before you update Netdata using one of the methods below, check to see if your N
17
opening the update modal in the dashboard. Click the **Update** button in the top navigation to open it. The modal tells
18
you whether your agent is up-to-date or not.
19
20
-
20
+
21
22
If your agent can be updated, use one of the methods below. **The method you chose for updating Netdata depends on how
23
you installed it.** Choose from the following list to see the appropriate update instructions for your system.
web/README.md
+13
-7
@@ -50,8 +50,7 @@ forward or backward in time, or selecting a specific timeframe for more in-depth
50
analysis.
51
52
Whenever you use a chart in this way, Netdata synchronizes all the other charts
53
-to match it. Chart synchronization even works between separate Netdata agents if you connect
54
-them using the [**My nodes** menu](/registry/README.md)!
53
+to match it.
54
55
You can change how charts show their metrics in a few different ways, each of
56
which have a few methods:
@@ -66,14 +65,19 @@ which have a few methods:
65
66
Here's how chart synchronization looks while zooming and panning:
67
69
-
68
+
70
71
You can also perform all these actions using the small
72
rewind/play/fast-forward/zoom-in/zoom-out buttons that appear in the
73
bottom-right corner of each chart.
74
75
+Additionally, resize charts by clicking-and-dragging the icon on the bottom-right corner of any chart. To restore the
76
+chart to its original height, double-click the same icon.
77
+
78
+
80
+
81
## Charts, contexts, families
82
83
Before customizing the standard web dashboard, creating a custom dashboard,
@@ -191,7 +195,8 @@ To improve clarity on charts, Netdata dashboards present **positive** values for
195
metrics representing `read`, `input`, `inbound`, `received` and **negative**
196
values for metrics representing `write`, `output`, `outbound`, `sent`.
197
194
-
198
+
200
201
_Netdata charts showing the bandwidth and packets of a network interface.
202
`received` is positive and `sent` is negative._
@@ -201,7 +206,8 @@ _Netdata charts showing the bandwidth and packets of a network interface.
206
Netdata charts automatically zoom vertically, to visualize the variation of each
207
metric within the visible timeframe.
208
204
-
209
+
211
212
_A zero-based `stacked` chart, automatically switches to an auto-scaled `area`
213
chart when a single dimension is selected._
web/gui/README.md
+34
-54
@@ -1,25 +1,30 @@
1
<!--
2
---
3
title: "The standard web dashboard"
4
-date: 2020-03-11
4
+date: 2020-05-04
5
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/gui/README.md
6
---
7
-->
8
9
# The standard web dashboard
10
11
-The standard web dashboard is the heart of Netdata's performance troubleshooting
12
-toolkit. You've probably seen it before:
11
+The standard web dashboard is the heart of Netdata's performance troubleshooting toolkit. You've probably seen it
12
+before:
13
14
-
14
+
16
17
Learn more about how dashboards work and how they're populated using the
18
`dashboards.js` file in our [web dashboards overview](/web/README.md).
19
20
-By default, Netdata starts a web server for its dashboard at port `19999`. Open
21
-up your web browser of choice and navigate to `http://SERVER-IP:19999`, or
22
-`http://localhost:19999` on `localhost`.
20
+By default, Netdata starts a web server for its dashboard at port `19999`. Open up your web browser of choice and
21
+navigate to `http://NODE:19999`, replacing `NODE` with the IP address or hostname of your Agent. If you're unsure, try
22
+`http://localhost:19999` first.
23
+
24
+> In v1.21 of the Agent, we replaced the legacy dashboard with a refactored dashboard written in React. By using React,
25
+> we simplify our code and give our engineers better tools to add new features and fix bugs. The only UI change with
26
+> this dashboard is the top navigation and left-hand navigation for [Cloud integration](/docs/agent-cloud.md). The old
27
+> dashboard is still accessible at the `http://NODE:19999/old` subfolder.
28
29
Netdata uses an [internal, static-threaded web server](/web/server/README.md) to host the
30
HTML, CSS, and JavaScript files that make up the standard dashboard. You don't
@@ -27,26 +32,16 @@ have to configure anything to access it, although you can adjust [your
32
settings](/web/server/README.md#other-netdataconf-web-section-options) in the
33
`netdata.conf` file, or run Netdata behind an Nginx proxy, and so on.
34
30
-<details markdown="1"><summary>Want to see the dashboard and its features in action? Check out our video.</summary>
31
-<iframe width="720" height="405" src="https://www.youtube.com/embed/Ob6-Wkb6ZBA" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
32
-</details>
33
-
34
-## New React Dashboard
35
-
36
-We've been working on refactoring the standard dashboard code to simplify the process of adding new features and fixing bugs.
37
-
38
-The new dashboard is added to the codebase, but the old version is still here. If you want to use it, run `/usr/libexec/netdata/netdata-switch-dashboard.sh classic`. To switch back, do `netdata-switch-dashboard.sh react`. Currently, the refactored dashboard doesn't include any noticeable changes in UI.
39
-
35
## Navigating the standard dashboard
36
37
Beyond charts, the standard dashboard can be broken down into three key areas:
38
39
1. [**Sections**](#sections)
45
-2. [**Menus/submenus**](#menus)
46
-3. [**Nodes menu**](#nodes-menu)
40
+2. [**Metrics menus/submenus**](#metrics-menus)
41
+3. [**Cloud menus: Spaces, War Rooms, and Visited nodes)**](#cloud-menus-spaces-war-rooms-and-visited-nodes)
42
43
44
+dashboard](https://user-images.githubusercontent.com/1153921/80834497-ac9c2380-8ba5-11ea-83c4-b323dd89557f.png)
45
46
### Sections
47
@@ -58,56 +53,41 @@ broken down into [contexts](/web/README.md#contexts) and
53
An example of the **Memory** section on a Linux desktop system.
54
55
56
+dashboard](https://user-images.githubusercontent.com/1153921/80834530-bcb40300-8ba5-11ea-9219-cd554577844e.png)
57
58
All sections and their associated charts appear on a single "page," so all you
59
need to do to view different sections is scroll up and down the page. But it's
65
-usually quicker to use the [menus](#menus).
60
+usually quicker to use the [menus](#metrics-menus).
61
67
-### Menus
62
+### Metrics menus
63
69
-**Menus** appears on the right-hand side of the standard dashboard. Netdata
70
-generates a menu for each section, and menus link to the section they're
71
-associated with.
64
+**Metrics menus** appears on the right-hand side of the standard dashboard. Netdata generates a menu for each section,
65
+and menus link to the section they're associated with.
66
73
-
67
+
68
76
-Most menu items will contain several **submenu** entries, which represent any
69
+Most metrics menu items will contain several **submenu** entries, which represent any
70
[families](/web/README.md#families) from that section. Netdata automatically
71
generates these submenu entries.
72
73
Here's a **Disks** menu with several submenu entries for each disk drive and
74
partition Netdata recognizes.
75
83
-
85
-
86
-### Nodes menu
87
-
88
-The nodes menu appears in the top-left corner of the standard dashboard and is
89
-labeled with the hostname of the system Netdata is monitoring.
90
-
91
-Clicking on it will display a drop-down menu of any nodes you might have
92
-connected via the [Netdata registry](/registry/README.md). By default, you'll find
93
-nothing under the **My nodes** heading, but you can try out any of the demo
94
-Netdata nodes to see how the nodes menu works.
95
-
96
-
76
+
78
99
-Once you add nodes via [Netdata Cloud](/docs/netdata-cloud/README.md) or a [private
100
-registry](/registry/README.md#run-your-own-registry), you will see them appear under
101
-the **My nodes** heading.
79
+### Cloud menus (Spaces, War Rooms, and Visited nodes)
80
103
-
81
+The dashboard also features a menu related to Cloud functionality. You can view your existing Spaces or create new ones
82
+via the vertical column of boxes. This menu also displays the name of your current Space, shows a list of any War Rooms
83
+you've added you your Space, and lists your Visited nodes. If you click on a War Room's name, the dashboard redirects
84
+you to the Netdata Cloud web interface.
85
106
-The nodes menu will also show the master netdata node and all slave nodes
107
-streaming to that master, if you have [configured streaming](/streaming/README.md).
86
+
88
109
-
89
+If you want to know more about how Cloud populates this menu, and the Agent-Cloud integration at a high level, see our
90
+document on [using the Agent with Netdata Cloud](/docs/agent-cloud.md).
91
92
## Customizing the standard dashboard
93