Skip to content

Commit b26d023

Browse files
authored
Netdata Cloud documentation (netdata#6476)
* Added Netdata Cloud docs and added to yaml * Addressing Chris' comments and making fixes * More improvements and standardization to style guide * Link to Cloud docs from DOCUMENTATION.md and other small fixes
1 parent 0ab6708 commit b26d023

5 files changed

Lines changed: 430 additions & 0 deletions

File tree

DOCUMENTATION.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ Welcome! You've arrived at the documentation for Netdata. Use the links below to
2626

2727
</div>
2828

29+
**Netdata Cloud**: Use [Netdata Cloud](docs/netdata-cloud/) and the [Nodes View](docs/netdata-cloud/nodes-view.md) to view real-time, distributed health monitoring and performance troubleshooting data for all your systems in one place. Add as many nodes as you'd like!
30+
2931
**Advanced users**: For those who already understand how to access a Netdata dashboard and perform basic configuration, feel free to see what's behind any of these other doors.
3032

3133
- [Netdata Behind Nginx](docs/Running-behind-nginx.md): Use an Nginx web server instead of Netdata's built-in server to enable TLS, HTTPS, and basic authentication.

docs/generator/buildyaml.sh

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,13 @@ echo -ne " - 'docs/Performance.md'
175175
- 'docs/high-performance-netdata.md'
176176
"
177177

178+
navpart 1 . netdata-cloud "Netdata Cloud"
179+
echo -ne "
180+
- 'docs/netdata-cloud/README.md'
181+
- 'docs/netdata-cloud/signing-in.md'
182+
- 'docs/netdata-cloud/nodes-view.md'
183+
"
184+
178185
navpart 1 collectors "" "Data collection" 1
179186
echo -ne " - 'docs/Add-more-charts-to-netdata.md'
180187
- Internal plugins:

docs/netdata-cloud/README.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Netdata Cloud
2+
3+
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.
4+
5+
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).
6+
7+
Learn more about the future of Netdata Cloud on our [announcement post](https://blog.netdata.cloud/posts/netdata-cloud-announcement/).
8+
9+
10+
## Registering for or signing in to Netdata Cloud
11+
12+
**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](signing-in.md) for details.**
13+
14+
!!! attention "Private registries and Netdata Cloud"
15+
If you're running a private registry and are interested in trying out Netdata Cloud as a replacement for your private registry, read [our notice](signing-in.md#private-registries-and-netdata-cloud) about transitioning from a private registry to our Netdata Cloud registry.
16+
17+
18+
## Netdata Cloud features
19+
20+
Netdata Cloud currently enables two features: the **My nodes** in the top-left corner of the Netdata dashboard, and the [**Nodes View**](nodes-view.md).
21+
22+
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).
23+
24+
25+
### Planned enterprise features (paid)
26+
27+
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.
28+
29+
A few of these planned features include:
30+
31+
- Long-term storage of Netdata UI snapshots
32+
- Active Directory integration for single sign-on
33+
- Private service status pages
34+
- Extended retention of alarms timelines
35+
- Incident response toolkits
36+
- Additional enterprise plugins and integrations
37+
- Extended retention of chat messages
38+
39+
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.
40+
41+
42+
## Running Netdata without Netdata Cloud
43+
44+
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](nodes-view.md) and other upcoming features.
45+
46+
47+
## Running Netdata Cloud on-premises or as a hosted instance
48+
49+
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).

docs/netdata-cloud/nodes-view.md

Lines changed: 212 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,212 @@
1+
# Using the Nodes View
2+
3+
4+
## Introduction
5+
6+
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**.
7+
8+
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.
9+
10+
!!! attention "Nodes View is beta software!"
11+
The Nodes View is currently in beta, so all typical warnings about beta software apply. You may come across bugs or inconsistencies.
12+
13+
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.
14+
15+
16+
## The Nodes View
17+
18+
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.
19+
20+
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.
21+
22+
![Annotated screenshot showing where to access Nodes View](https://user-images.githubusercontent.com/1153921/60359236-4fd04b00-998d-11e9-9e4c-f35ad2551a54.png)
23+
24+
25+
### Nodes
26+
27+
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.
28+
29+
![A screenshot of the Netdata Cloud web interface](https://user-images.githubusercontent.com/1153921/59883580-657cb980-936a-11e9-8651-a51832a5f41e.png)
30+
31+
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:
32+
33+
![Annotated screenshot of the icons visible in the node entries](https://user-images.githubusercontent.com/1153921/60219761-9eb0a000-9828-11e9-9f77-b492dad016f9.png)
34+
35+
The background color of each Node entry is an indication of its health status:
36+
37+
| Health status | Background color |
38+
| ------------- | ------------------------------------------------------------------------------------------------- |
39+
| **White** | Normal status, no alarms |
40+
| **Yellow** | 1 or more active warnings |
41+
| **Red** | 1 or more active critical alerts |
42+
| **Grey** | Node is unreachable (server unreachable [due to network conditions], server down, or changed URL) |
43+
44+
45+
### Node overview
46+
47+
When you click on any of the Nodes, an overview sidebar will appear on the right-hand side of the Nodes View.
48+
49+
This overview contains the following:
50+
51+
- An icon (`1`) representing the operating system installed on that machine
52+
- The hostname (`2`) of the machine
53+
- A link (`3`) to the URL at which the web dashboard is available
54+
- Three tabs (`4`) for **System** metrics, **Services** metrics, and **Alarms**
55+
- A number of selectors (`5`) to choose which metrics/alarms are shown in the overview
56+
- **System** tab: *Overview*, *Disks*, and *Network* selectors
57+
- **Services** tab: *Databases*, *Web*, and *Messaging* selectors
58+
- **Alarms** tab: *Critical* and *Warning* selectors
59+
- The visualizations and/or alarms (`6`) supported under the chosen tab and selector
60+
- Any other available URLS (`7`) associated with that node under the **Node URLs** header.
61+
62+
![A screenshot of the system overview area in the Netdata Cloud web interface](https://user-images.githubusercontent.com/1153921/60361418-f834de00-9992-11e9-9998-ab3da4b8b559.png)
63+
64+
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.
65+
66+
**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.
67+
68+
#### System tab
69+
70+
The **System** tab has three sections: *Overview*, *Disks*, and *Network*.
71+
72+
*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.
73+
74+
*Disks* displays visualizations for `Disk Utilization Time`, and `Disk Space Usage` for every available disk.
75+
76+
*Network* displays visualizations for `Bandwidth` for every available networking device.
77+
78+
#### Services tab
79+
80+
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.
81+
82+
#### Alarms tab
83+
84+
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.
85+
86+
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.
87+
88+
![A screenshot of the alarms area in the Netdata Cloud web interface](https://user-images.githubusercontent.com/1153921/59883273-55180f00-9369-11e9-8895-f74f6c66e038.png)
89+
90+
91+
### Filtering field
92+
93+
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.
94+
95+
The filtering field will offer you autocomplete suggestions. For example, the options available after typing `ng` into the filtering field:
96+
97+
![A screenshot of the filtering field in the Netdata Cloud web interface](https://user-images.githubusercontent.com/1153921/59883296-6234fe00-9369-11e9-9950-4bd3986ce887.png)
98+
99+
If you select multiple filters, results will display according to an `OR` operator.
100+
101+
102+
### View modes
103+
104+
To the right of the filtering field is three functions that will help you organize your Visited Nodes according to your preferences.
105+
106+
![Screenshot of the view mode, sorting, and grouping options](https://user-images.githubusercontent.com/1153921/59885999-2a7e8400-9372-11e9-8dae-022ba85e2b69.png)
107+
108+
The view mode button lets you switch between three view modes:
109+
110+
- **Full** mode, which displays the following information in a large squares for each connected Node:
111+
- Operating system
112+
- Critical/warning alerts in two separate indicators
113+
- Hostname
114+
- Icons for [supported services](#services-available-in-the-nodes-view)
115+
116+
![Annotated screenshot of the full view mode](https://user-images.githubusercontent.com/1153921/60219885-15e63400-9829-11e9-8654-b49f119efb9a.png)
117+
118+
- **Compact** mode, which displays the following information in small squares for each connected Node:
119+
- Operating system
120+
121+
![Annotated screenshot of the compact view mode](https://user-images.githubusercontent.com/1153921/60220570-547cee00-982b-11e9-9caf-9dd449184f3a.png)
122+
123+
- **Detailed** mode, which displays the following information in large horizontal rectangles for each connected Node:
124+
- Operating system
125+
- Critical/warning alerts in two separate indicators
126+
- Hostname
127+
- Icons for [supported services](#services-available-in-the-nodes-view)
128+
129+
![Annotated screenshot of the detailed view mode](https://user-images.githubusercontent.com/1153921/60220574-56df4800-982b-11e9-8300-aa9190bbf09f.png)
130+
131+
## Sorting, and grouping
132+
133+
The **Sort by** dropdown allows you to choose between sorting *alphabetically by hostname*, most *recently-viewed* nodes, and most *frequently-view* nodes.
134+
135+
The **Group by** dropdown lets you switch between *alarm status*, *running services*, or *online status*.
136+
137+
For example, the following screenshot represents the Nodes list with the following options: *detailed list*, *frequently visited*, and *alarm status*.
138+
139+
![A screenshot of sorting, grouping, and view modes in the Netdata Cloud web interface](https://user-images.githubusercontent.com/1153921/59883300-68c37580-9369-11e9-8d6e-ce0a8147fc1d.png)
140+
141+
Play around with the options until you find a setup that works for you.
142+
143+
144+
## Adding more agents to the Nodes View
145+
146+
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).
147+
148+
!!! note ""
149+
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.
150+
151+
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.
152+
153+
154+
## Services available in the Nodes View
155+
156+
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
157+
158+
### Databases
159+
160+
These services will appear under the *Databases* selector beneath the *Services* tab.
161+
162+
| Service | Collectors | Context #1 | Context #2 | Context #3 |
163+
|--- |--- |--- |--- |--- |
164+
| MySQL | `python.d.plugin:mysql`, `go.d.plugin:mysql` | `mysql.queries` | `mysql.net` | `mysql.connections` |
165+
| MariaDB | `python.d.plugin:mysql`, `go.d.plugin:mysql` | `mysql.queries` | `mysql.net` | `mysql.connections` |
166+
| Oracle Database | `python.d.plugin:oracledb` | `oracledb.session_count` | `oracledb.physical_disk_read_writes ` | `oracledb.tablespace_usage_in_percent` |
167+
| PostgreSQL | `python.d.plugin:postgres` | `postgres.checkpointer` | `postgres.archive_wal` | `postgres.db_size` |
168+
| MongoDB | `python.d.plugin:mongodb` | `mongodb.active_clients` | `mongodb.read_operations` | `mongodb.write_operations` |
169+
| ElasticSearch | `python.d.plugin:elasticsearch` | `elastic.search_performance_total` | `elastic.index_performance_total` | `elastic.index_segments_memory` |
170+
| CouchDB | `python.d.plugin:couchdb` | `couchdb.activity` | `couchdb.response_codes` | |
171+
| Proxy SQL | `python.d.plugin:proxysql` | `proxysql.questions` | `proxysql.pool_status` | `proxysql.pool_overall_net` |
172+
| Redis | `python.d.plugin:redis` | `redis.operations` | `redis.net` | `redis.connections` |
173+
| MemCached | `python.d.plugin:memcached` | `memcached.cache` | `memcached.net` | `memcached.connections` |
174+
| RethinkDB | `python.d.plugin:rethinkdbs` | `rethinkdb.cluster_queries` | `rethinkdb.cluster_clients_active` | `rethinkdb.cluster_connected_servers` |
175+
| Solr | `go.d.plugin:solr` | `solr.search_requests` | `solr.update_requests` | |
176+
177+
### Web services
178+
179+
These services will appear under the *Web* selector beneath the *Services* tab. These also include proxies, load balancers (LB), and streaming services.
180+
181+
| Service | Collectors | Context #1 | Context #2 | Context #3 |
182+
|--- |--- |--- |--- |--- |
183+
| Apache | `python.d.plugin:apache`, `go.d.plugin:apache` | `apache.requests` | `apache.connections` | `apache.net ` |
184+
| nginx | `python.d.plugin:nginx`, `go.d.plugin:nginx` | `nginx.requests` | `nginx.connections` | |
185+
| nginx+ | `python.d.plugin:nginx_plus` | `nginx_plus.requests_total` | `nginx_plus.connections_statistics` | |
186+
| lighthttpd | `python.d.plugin:lighttpd`, `go.d.plugin:lighttpd` | `lighttpd.requests` | `lighttpd.net` | |
187+
| lighthttpd2 | `go.d.plugin:lighttpd2` | `lighttpd2.requests` | `lighttpd2.traffic` | |
188+
| LiteSpeed | `python.d.plugin:litespeed` | `litespeed.requests` | `litespeed.requests_processing` | |
189+
| Tomcat | `python.d.plugin:tomcat` | `tomcat.accesses` | `tomcat.processing_time` | `tomcat.bandwidth` |
190+
| PHP FPM | `python.d.plugin:phpfm` | `phpfpm.performance` | `phpfpm.requests` | `phpfpm.connections` |
191+
| HAproxy | `python.d.plugin:haproxy` | `haproxy_f.scur` | `haproxy_f.bin` | `haproxy_f.bout` |
192+
| Squid | `python.d.plugin:squid` | `squid.clients_requests` | `squid.clients_net` | |
193+
| Traefik | `python.d.plugin:traefik` | `traefik.response_codes` | | |
194+
| Varnish | `python.d.plugin:varnish` | `varnish.session_connection` | `varnish.client_requests` | |
195+
| IPVS | `proc.plugin:/proc/net/ip_vs_stats` | `ipvs.sockets` | `ipvs.packets` | |
196+
| Web Log | `python.d.plugin:web_log`, `go.d.plugin:web_log` | `web_log.response_codes` | `web_log.bandwidth` | |
197+
| IPFS | `python.d.plugin:ipfs` | `ipfs.bandwidth` | `ipfs.peers` | |
198+
| IceCast Media Streaming | `python.d.plugin:icecast` | `icecast.listeners` | | |
199+
| RetroShare | `python.d.plugin:retroshare` | `retroshare.bandwidth` | `retroshare.peers` | |
200+
| HTTP Check | `python.d.plugin:httpcheck`, `go.d.plugin:httpcheck` | `httpcheck.responsetime` | `httpcheck.status` | |
201+
| x509 Check | `go.d.plugin:x509check` | `x509check.time_until_expiration` | | |
202+
203+
### Messaging
204+
205+
These services will appear under the *Messaging* selector beneath the *Services* tab.
206+
207+
| Service | Collectors | Context #1 | Context #2 | Context #3 |
208+
| --- | --- | --- | --- | --- |
209+
| RabbitMQ | `python.d.plugin:rabbitmq`, `go.d.plugin:rabbitmq` | `rabbitmq.queued_messages` | `rabbitmq.erlang_run_queue` |
210+
| Beanstalkd | `python.d.plugin:beanstalk` | `beanstalk.total_jobs_rate` | `beanstalk.connections_rate` | `beanstalk.current_tubes` |
211+
212+

0 commit comments

Comments
 (0)