Fix readme (#4631)
* updated after wiki move * updated docs * updated docs * updated docs * updated docs * updated docs
Costa Tsaousis committed
Nov 13, 2018 at 02:19 UTC
185f6b34bbd6c53278a6cfa69381df39066cc5e2
2 files changed
+59
-22
README.md
+58
-21
@@ -52,7 +52,7 @@ The following animated image, shows the top part of a typical netdata dashboard.
52
53
*A typical netdata dashboard, in 1:1 timing. Charts can be panned by dragging them, zoomed in/out with `SHIFT` + `mouse wheel`, an area can be selected for zoom-in with `SHIFT` + `mouse selection`. Netdata is highly interactive and **real-time**, optimized to get the work done!*
54
55
-> *We have a few online demos to check: [https://my-netdata.io](https://my-netdata.io)*
55
+> *We have a few online demos to experience it live: [https://my-netdata.io](https://my-netdata.io)*
56
57
## User base
58
@@ -69,7 +69,7 @@ We provide docker images for the most common architectures. These are statistics
69
[](https://hub.docker.com/r/netdata/netdata/) [](https://hub.docker.com/r/firehol/netdata/) [](https://hub.docker.com/r/titpetric/netdata/)
70
71
### Registry
72
-When you install multiple netdata, they are integrated into **one distributed application**, via a [netdata registry](https://github.com/netdata/netdata/wiki/mynetdata-menu-item). This is a web browser feature and it allows us to count the number of unique users and unique netdata servers installed. The following information comes from the global public netdata registry we run:
72
+When you install multiple netdata, they are integrated into **one distributed application**, via a [netdata registry](registry/#netdata-registry). This is a web browser feature and it allows us to count the number of unique users and unique netdata servers installed. The following information comes from the global public netdata registry we run:
73
74
[](https://registry.my-netdata.io/#menu_netdata_submenu_registry) [](https://registry.my-netdata.io/#menu_netdata_submenu_registry) [](https://registry.my-netdata.io/#menu_netdata_submenu_registry)
75
@@ -78,7 +78,7 @@ When you install multiple netdata, they are integrated into **one distributed ap
78
## Quick Start
79
80
You can quickly install netdata on a Linux box (physical, virtual, container, IoT) with the following command:
81
-
81
+
82
```sh
83
# make sure you run `bash` for your shell
84
bash
@@ -94,7 +94,22 @@ The above command will:
94
2. download netdata source to `/usr/src/netdata.git`
95
3. compile it, install it and start it
96
97
-More installation methods and additional options can be found at the [installation page](https://github.com/netdata/netdata/wiki/Installation).
97
+More installation methods and additional options can be found at the [installation page](installer/#installation).
98
+
99
+To try netdata in a docker container, run this:
100
+
101
+```
102
+docker run -d --name=netdata \
103
+ -p 19999:19999 \
104
+ -v /proc:/host/proc:ro \
105
+ -v /sys:/host/sys:ro \
106
+ -v /var/run/docker.sock:/var/run/docker.sock:ro \
107
+ --cap-add SYS_PTRACE \
108
+ --security-opt apparmor=unconfined \
109
+ netdata/netdata
110
+```
111
+
112
+For more information about running netdata in docker, check the [docker installation page](docker/).
113
114
115
@@ -164,12 +179,12 @@ This is how it works:
179
180
Function|Description|Documentation
181
:---:|:---|:---:
167
-**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](https://github.com/netdata/netdata/tree/master/collectors#data-collection-plugins)
168
-**Store**|Metrics are stored in RAM in a round robin database (ring buffer), using a custom made floating point number for minimal footprint.|[Database](https://github.com/netdata/netdata/tree/master/database#netdata-database)
169
-**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](https://github.com/netdata/netdata/tree/master/health#health-monitoring)
170
-**Stream**|An lockless independent worker is streaming metrics, in full detail and in real-time, to remote netdata servers, as soon as they are collected.|[Streaming](https://github.com/netdata/netdata/tree/master/streaming#metrics-streaming)
171
-**Archieve**|A lockless independent worker is down-sampling the metrics and pushes them to **backend** time-series databases.|[Backends](https://github.com/netdata/netdata/tree/master/backends)
172
-**Query**|Multiple independent workers are attached to the [internal web server](https://github.com/netdata/netdata/tree/master/web/server#netdata-web-server), servicing API requests, including [data queries](https://github.com/netdata/netdata/tree/master/web/api/queries#database-queries).|[API](https://github.com/netdata/netdata/tree/master/web/api#api)
182
+**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/#data-collection-plugins)
183
+**Store**|Metrics are stored in RAM in a round robin database (ring buffer), using a custom made floating point number for minimal footprint.|[`database`](database/#netdata-database)
184
+**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/#health-monitoring)
185
+**Stream**|An 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/#metrics-streaming)
186
+**Archieve**|A lockless independent worker is down-sampling the metrics and pushes them to **backend** time-series databases.|[`backends`](backends/)
187
+**Query**|Multiple independent workers are attached to the [internal web server](server/#netdata-web-server), servicing API requests, including [data queries](web/api/queries/#database-queries).|[`web/api`](web/api/#api)
188
189
The result is a highly efficient, low latency system, supporting multiple readers and one writer on each metric.
190
@@ -211,7 +226,7 @@ This is what you should expect from Netdata:
226
- **Stunning interactive dashboards** - mouse, touchpad and touch-screen friendly in 2 themes: `slate` (dark) and `white`.
227
- **Amazingly fast visualization** - responds to all queries in less than 1 ms per metric, even on low-end hardware.
228
- **Visual anomaly detection** - the dashboards are optimized for detecting anomalies visually.
214
-- **Embeddable** - its charts can be embedded on your web pages, wikis and blogs. You can even use [Atlassian's Confluence as a monitoring dashboard](https://github.com/netdata/netdata/wiki/Custom-Dashboard-with-Confluence).
229
+- **Embeddable** - its charts can be embedded on your web pages, wikis and blogs. You can even use [Atlassian's Confluence as a monitoring dashboard](web/gui/confluence/).
230
- **Customizable** - custom dashboards can be built using simple HTML (no javascript necessary).
231
232
### Positive and negative values
@@ -427,22 +442,44 @@ And you can extend it, by writing plugins that collect data from any source, usi
442
443
---
444
430
-## Documentation
431
-
432
-Check the **[netdata wiki](https://github.com/netdata/netdata/wiki)**.
445
+## Documentation
446
447
+The netdata documentation is inside the repo, so by just navigating the repo on github you can find all the documentation.
448
+
449
+Here is a quick list:
450
+
451
+Directory|Description
452
+:---|:---
453
+[`installer`](installer/)|Instructions to install netdata on your systems.
454
+[`docker`](docker/)|Instructions to install netdata using docker.
455
+[`daemon`](daemon/)|Information about the netdata daemon and its configuration.
456
+[`collectors`](collectors/)|Information about data collection plugins.
457
+[`health`](health/)|How netdata's health monitoring works, how to create your own alarms and how to configure alarm notification methods.
458
+[`streaming`](streaming/)|How to build hierarchies of netdata servers, by streaming metrics between them.
459
+[`backends`](backends/)|Long term archiving of metrics to industry standard time-series databases, like `prometheus`, `graphite`, `opentsdb`.
460
+[`web/api`](web/api/)|Learn how to query the netdata API and the queries it supports.
461
+[`web/api/badges`](web/api/badges/)|Learn how to generate badges (SVG images) from live data.
462
+[`web/gui/custom`](web/gui/custom/)|Learn how to create custom netdata dashboards.
463
+[`web/gui/confluence`](web/gui/confluence/)|Learn how to create netdata dashboards on Atlassian's Confluence.
464
+
465
+But you can also check all the other directories. Most of them have plenty of documentation.
466
467
## Community
468
437
-1. To report bugs, or get help, use [GitHub Issues](https://github.com/netdata/netdata/issues).
438
-2. Netdata has a [Facebook page](https://www.facebook.com/linuxnetdata/).
439
-3. Netdata has a [Twitter account](https://twitter.com/linuxnetdata).
440
-4. Netdata on [OpenHub](https://www.openhub.net/p/netdata).
441
-5. Netdata on [Repology](https://repology.org/metapackage/netdata/versions).
442
-6. Netdata on [StackShare](https://stackshare.io/netdata).
469
+We welcome contributions. So, feel free to join the team.
470
+
471
+To report bugs, or get help, use [GitHub Issues](https://github.com/netdata/netdata/issues).
472
+
473
+You can also find netdata on:
474
+
475
+- [Facebook](https://www.facebook.com/linuxnetdata/)
476
+- [Twitter](https://twitter.com/linuxnetdata)
477
+- [OpenHub](https://www.openhub.net/p/netdata)
478
+- [Repology](https://repology.org/metapackage/netdata/versions)
479
+- [StackShare](https://stackshare.io/netdata)
480
481
## License
482
483
netdata is [GPLv3+](LICENSE).
484
448
-Netdata re-distributes other open-source tools and libraries. Please check the [third party licenses](https://github.com/netdata/netdata/blob/master/REDISTRIBUTED.md).
485
+Netdata re-distributes other open-source tools and libraries. Please check the [third party licenses](REDISTRIBUTED.md).
docker/README.md
+1
-1
@@ -26,7 +26,7 @@ docker run -d --name=netdata \
26
-v /var/run/docker.sock:/var/run/docker.sock:ro \
27
--cap-add SYS_PTRACE \
28
--security-opt apparmor=unconfined \
29
- firehol/netdata
29
+ netdata/netdata
30
```
31
32
above can be converted to docker-compose file for ease of management: