Cleanup of main README and registry doc (#9265)
* Cleanup README and remove old link * Additional cleanup * One more alignment
Joel Hans committed
Jun 4, 2020 at 07:12 UTC
78ca668e50d88670f8aaf4d2434e325f705f975c
3 files changed
+31
-39
README.md
+10
-9
@@ -37,7 +37,7 @@ Netdata is **fast** and **efficient**, designed to permanently run on all system
37
Netdata is **free, open-source software** and it currently runs on **Linux**, **FreeBSD**, and **macOS**, along with
38
other systems derived from them, such as **Kubernetes** and **Docker**.
39
40
-Netdata is not hosted by the CNCF but is the 3rd most starred open-source project in the [Cloud Native Computing
40
+Netdata is not hosted by the CNCF but is the fourth most starred open-source project in the [Cloud Native Computing
41
Foundation (CNCF) landscape](https://landscape.cncf.io/format=card-mode&grouping=no&sort=stars).
42
43
---
@@ -78,7 +78,8 @@ action](https://user-images.githubusercontent.com/1153921/80827388-b9fee100-8b98
78
> wheel`, an area can be selected for zoom-in with `SHIFT` + `mouse selection`. Netdata is highly interactive,
79
> **real-time**, and optimized to get the work done!
80
81
-Want to see Netdata live? Check out any of our [live demos](https://www.netdata.cloud/#live-demo).
81
+Want to try Netdata before you install? See our [live
82
+demo](https://london.my-netdata.io/default.html#menu_system_submenu_cpu;theme=slate;help=true).
83
84
## User base
85
@@ -254,12 +255,12 @@ This is how it works:
255
256
| Function | Description | Documentation |
257
| :---------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------- |
257
-| **Collect** | Multiple independent data collection workers are collecting metrics from their sources using the optimal protocol for each application and push the metrics to the database. Each data collection worker has lockless write access to the metrics it collects. | [`collectors`](/collectors/README.md) |
258
-| **Store** | Metrics are first stored in RAM in a custom database engine that then "spills" historical metrics to disk for efficient long-term metrics storage. | [`database`](/database/README.md) |
259
-| **Check** | A lockless independent watchdog is evaluating **health checks** on the collected metrics, triggers alarms, maintains a health transaction log and dispatches alarm notifications. | [`health`](/health/README.md) |
260
-| **Stream** | A lockless independent worker is streaming metrics, in full detail and in real-time, to remote Netdata servers, as soon as they are collected. | [`streaming`](/streaming/README.md) |
261
-| **Archive** | A lockless independent worker is down-sampling the metrics and pushes them to **backend** time-series databases. | [`backends`](/backends/README.md) |
262
-| **Query** | Multiple independent workers are attached to the [internal web server](/web/server/README.md), servicing API requests, including [data queries](/web/api/queries/README.md). | [`web/api`](/web/api/README.md) |
258
+| **Collect** | Multiple independent data collection workers are collecting metrics from their sources using the optimal protocol for each application and push the metrics to the database. Each data collection worker has lockless write access to the metrics it collects. | [`collectors`](/collectors/README.md) |
259
+| **Store** | Metrics are first stored in RAM in a custom database engine that then "spills" historical metrics to disk for efficient long-term metrics storage. | [`database`](/database/README.md) |
260
+| **Check** | A lockless independent watchdog is evaluating **health checks** on the collected metrics, triggers alarms, maintains a health transaction log and dispatches alarm notifications. | [`health`](/health/README.md) |
261
+| **Stream** | A lockless independent worker is streaming metrics, in full detail and in real-time, to remote Netdata servers, as soon as they are collected. | [`streaming`](/streaming/README.md) |
262
+| **Archive** | A lockless independent worker is down-sampling the metrics and pushes them to **backend** time-series databases. | [`exporting`](/docs/export/README.md) |
263
+| **Query** | Multiple independent workers are attached to the [internal web server](/web/server/README.md), servicing API requests, including [data queries](/web/api/queries/README.md). | [`web/api`](/web/api/README.md) |
264
265
The result is a highly efficient, low-latency system, supporting multiple readers and one writer on each metric.
266
@@ -405,7 +406,7 @@ Here is a quick list of notable documents:
406
| [`collectors`](/collectors/README.md) | Information about data collection plugins. |
407
| [`health`](/health/README.md) | How Netdata's health monitoring works, how to create your own alarms and how to configure alarm notification methods. |
408
| [`streaming`](/streaming/README.md) | How to build hierarchies of Netdata servers, by streaming metrics between them. |
408
-| [`backends`](/backends/README.md) | Long term archiving of metrics to industry-standard time-series databases, like `prometheus`, `graphite`, `opentsdb`. |
409
+| [`exporting`](/docs/export/README.md) | Long term archiving of metrics to industry-standard time-series databases, like `prometheus`, `graphite`, `opentsdb`. |
410
| [`web/api`](/web/api/README.md) | Learn how to query the Netdata API and the queries it supports. |
411
| [`web/api/badges`](/web/api/badges/README.md) | Learn how to generate badges (SVG images) from live data. |
412
| [`web/gui/custom`](/web/gui/custom/README.md) | Learn how to create custom Netdata dashboards. |
docs/what-is-netdata.md
+19
-15
@@ -37,7 +37,7 @@ Netdata is **fast** and **efficient**, designed to permanently run on all system
37
Netdata is **free, open-source software** and it currently runs on **Linux**, **FreeBSD**, and **macOS**, along with
38
other systems derived from them, such as **Kubernetes** and **Docker**.
39
40
-Netdata is not hosted by the CNCF but is the 3rd most starred open-source project in the [Cloud Native Computing
40
+Netdata is not hosted by the CNCF but is the fourth most starred open-source project in the [Cloud Native Computing
41
Foundation (CNCF) landscape](https://landscape.cncf.io/format=card-mode&grouping=no&sort=stars).
42
43
---
@@ -77,7 +77,8 @@ action](https://user-images.githubusercontent.com/1153921/80827388-b9fee100-8b98
77
> wheel`, an area can be selected for zoom-in with `SHIFT` + `mouse selection`. Netdata is highly interactive,
78
> **real-time**, and optimized to get the work done!
79
80
-Want to see Netdata live? Check out any of our [live demos](https://www.netdata.cloud/#live-demo).
80
+Want to try Netdata before you install? See our [live
81
+demo](https://london.my-netdata.io/default.html#menu_system_submenu_cpu;theme=slate;help=true).
82
83
## User base
84
@@ -155,11 +156,14 @@ To try Netdata in a Docker container, run this:
156
```sh
157
docker run -d --name=netdata \
158
-p 19999:19999 \
159
+ -v netdatalib:/var/lib/netdata \
160
+ -v netdatacache:/var/cache/netdata \
161
-v /etc/passwd:/host/etc/passwd:ro \
162
-v /etc/group:/host/etc/group:ro \
163
-v /proc:/host/proc:ro \
164
-v /sys:/host/sys:ro \
162
- -v /var/run/docker.sock:/var/run/docker.sock:ro \
165
+ -v /etc/os-release:/host/etc/os-release:ro \
166
+ --restart unless-stopped \
167
--cap-add SYS_PTRACE \
168
--security-opt apparmor=unconfined \
169
netdata/netdata
@@ -219,12 +223,12 @@ This is how it works:
223
224
| Function | Description | Documentation |
225
| :---------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------- |
222
-| **Collect** | Multiple independent data collection workers are collecting metrics from their sources using the optimal protocol for each application and push the metrics to the database. Each data collection worker has lockless write access to the metrics it collects. | [`collectors`](/collectors/README.md) |
223
-| **Store** | Metrics are first stored in RAM in a custom database engine that then "spills" historical metrics to disk for efficient long-term metrics storage. | [`database`](/database/README.md) |
224
-| **Check** | A lockless independent watchdog is evaluating **health checks** on the collected metrics, triggers alarms, maintains a health transaction log and dispatches alarm notifications. | [`health`](/health/README.md) |
225
-| **Stream** | A lockless independent worker is streaming metrics, in full detail and in real-time, to remote Netdata servers, as soon as they are collected. | [`streaming`](/streaming/README.md) |
226
-| **Archive** | A lockless independent worker is down-sampling the metrics and pushes them to external time-series databases. | [`exporting`](/exporting/README.md) |
227
-| **Query** | Multiple independent workers are attached to the [internal web server](/web/server/README.md), servicing API requests, including [data queries](/web/api/queries/README.md). | [`web/api`](/web/api/README.md) |
226
+| **Collect** | Multiple independent data collection workers are collecting metrics from their sources using the optimal protocol for each application and push the metrics to the database. Each data collection worker has lockless write access to the metrics it collects. | [`collectors`](/collectors/README.md) |
227
+| **Store** | Metrics are first stored in RAM in a custom database engine that then "spills" historical metrics to disk for efficient long-term metrics storage. | [`database`](/database/README.md) |
228
+| **Check** | A lockless independent watchdog is evaluating **health checks** on the collected metrics, triggers alarms, maintains a health transaction log and dispatches alarm notifications. | [`health`](/health/README.md) |
229
+| **Stream** | A lockless independent worker is streaming metrics, in full detail and in real-time, to remote Netdata servers, as soon as they are collected. | [`streaming`](/streaming/README.md) |
230
+| **Archive** | A lockless independent worker is down-sampling the metrics and pushes them to **backend** time-series databases. | [`exporting`](/docs/export/README.md) |
231
+| **Query** | Multiple independent workers are attached to the [internal web server](/web/server/README.md), servicing API requests, including [data queries](/web/api/queries/README.md). | [`web/api`](/web/api/README.md) |
232
233
The result is a highly efficient, low-latency system, supporting multiple readers and one writer on each metric.
234
@@ -279,10 +283,10 @@ This is what you should expect from Netdata:
283
### Integrations
284
285
- **Time-series databases** - Netdata can archive its metrics to **Graphite**, **OpenTSDB**, **Prometheus**, **AWS
282
- Kinesis**, **Google Cloud Pub/Sub**, **MongoDB**, **JSON document DBs**, in the same or lower resolution (lower: to
283
- prevent it from congesting these servers due to the amount of data collected). Netdata also supports **Prometheus
284
- remote write API**, which allows storing metrics to **Elasticsearch**, **Gnocchi**, **InfluxDB**, **Kafka**,
285
- **PostgreSQL/TimescaleDB**, **Splunk**, **VictoriaMetrics** and a lot of other [storage
286
+ Kinesis**, **MongoDB**, **JSON document DBs**, in the same or lower resolution (lower: to prevent it from congesting
287
+ these servers due to the amount of data collected). Netdata also supports **Prometheus remote write API**, which
288
+ allows storing metrics to **Elasticsearch**, **Gnocchi**, **InfluxDB**, **Kafka**, **PostgreSQL/TimescaleDB**,
289
+ **Splunk**, **VictoriaMetrics** and a lot of other [storage
290
providers](https://prometheus.io/docs/operating/integrations/#remote-endpoints-and-storage).
291
292
## Visualization
@@ -303,7 +307,7 @@ To improve clarity on charts, Netdata dashboards present **positive** values for
307
`inbound`, `received` and **negative** values for metrics representing `write`, `output`, `outbound`, `sent`.
308
309
310
+values](https://user-images.githubusercontent.com/1153921/81870401-9d649080-952a-11ea-80e3-4a7b480252ee.gif)
311
312
_Netdata charts showing the bandwidth and packets of a network interface. `received` is positive and `sent` is
313
negative._
@@ -370,7 +374,7 @@ Here is a quick list of notable documents:
374
| [`collectors`](/collectors/README.md) | Information about data collection plugins. |
375
| [`health`](/health/README.md) | How Netdata's health monitoring works, how to create your own alarms and how to configure alarm notification methods. |
376
| [`streaming`](/streaming/README.md) | How to build hierarchies of Netdata servers, by streaming metrics between them. |
373
-| [`exporting`](/exporting/README.md) | Long term archiving of metrics to industry-standard time-series databases, like `prometheus`, `graphite`, `opentsdb`. |
377
+| [`exporting`](/docs/export/README.md) | Long term archiving of metrics to industry-standard time-series databases, like `prometheus`, `graphite`, `opentsdb`. |
378
| [`web/api`](/web/api/README.md) | Learn how to query the Netdata API and the queries it supports. |
379
| [`web/api/badges`](/web/api/badges/README.md) | Learn how to generate badges (SVG images) from live data. |
380
| [`web/gui/custom`](/web/gui/custom/README.md) | Learn how to create custom Netdata dashboards. |
registry/README.md
+2
-15
@@ -7,16 +7,6 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/registry/README.
7
8
# Registry
9
10
-The Netdata registry implements the node menu on the top left corner of the Netdata dashboards and enables the Netdata
11
-cloud features, such as the node view. The node menu lists the Netdata servers you have visited. The node view offers a
12
-lot of additional features on top of the menu, [with many more to
13
-come](https://blog.netdata.cloud/posts/netdata-cloud-announcement/). To enable the global Netdata registry and the cloud
14
-features, you need to Sign In to Netdata cloud. By signing in, you opt in to let the registry receive and store the
15
-information described [here](#what-data-does-the-registry-store). You can still get the node menu, but not the cloud
16
-features, if you [run your own registry](#run-your-own-registry).
17
-
18
-## Why?
19
-
10
Netdata provides distributed monitoring.
11
12
Traditional monitoring solutions centralize all the data to provide unified dashboards across all servers. Before
@@ -48,9 +38,7 @@ have installed**, i.e. the URLs our Netdata servers are listening.
38
To solve this, Netdata utilizes a **central registry**. This registry, together with certain browser features, allow
39
Netdata to provide unified cross-server dashboards. For example, when you jump from server to server using the node
40
menu, several session settings (like the currently viewed charts, the current zoom and pan operations on the charts,
51
-etc.) are propagated to the new server, so that the new dashboard will come with exactly the same view. Netdata cloud
52
-has a roadmap to [offer many more features](https://blog.netdata.cloud/posts/netdata-cloud-announcement/) over and above
53
-the simple node menu.
41
+etc.) are propagated to the new server, so that the new dashboard will come with exactly the same view.
42
43
## What data does the registry store?
44
@@ -90,8 +78,7 @@ Your Netdata servers do not talk to the registry. This is a UML diagram of its o
78
## Which is the default registry?
79
80
`https://registry.my-netdata.io`, which is currently served by `https://london.my-netdata.io`. This registry listens to
93
-both HTTP and HTTPS requests but the default is HTTPS. `https://netdata.cloud` is the additional registry endpoint, that
94
-enables [the cloud features](https://blog.netdata.cloud/posts/netdata-cloud-announcement/). It only accepts HTTPS.
81
+both HTTP and HTTPS requests but the default is HTTPS.
82
83
### Can this registry handle the global load of Netdata installations?
84