@cryptotaxi247 / netdata-1 / commits / ed0da165a

Docs: Linter fixes for main README (#7526)

* Linter fix pass * Fixing last emphasis

Joel Hans committed Jan 14, 2020 at 03:50 UTC ed0da165aa6152e2d0bf01707e0814bb2d620e65
1 file changed +258 -147
README.md
+258 -147
@@ -1,12 +1,25 @@
1 # Netdata [![Build Status](https://travis-ci.com/netdata/netdata.svg?branch=master)](https://travis-ci.com/netdata/netdata) [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/2231/badge)](https://bestpractices.coreinfrastructure.org/projects/2231) [![License: GPL v3+](https://img.shields.io/badge/License-GPL%20v3%2B-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Freadme&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)
2
3 -[![Code Climate](https://codeclimate.com/github/netdata/netdata/badges/gpa.svg)](https://codeclimate.com/github/netdata/netdata) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/a994873f30d045b9b4b83606c3eb3498)](https://www.codacy.com/app/netdata/netdata?utm_source=github.com&utm_medium=referral&utm_content=netdata/netdata&utm_campaign=Badge_Grade) [![LGTM C](https://img.shields.io/lgtm/grade/cpp/g/netdata/netdata.svg?logo=lgtm)](https://lgtm.com/projects/g/netdata/netdata/context:cpp) [![LGTM JS](https://img.shields.io/lgtm/grade/javascript/g/netdata/netdata.svg?logo=lgtm)](https://lgtm.com/projects/g/netdata/netdata/context:javascript) [![LGTM PYTHON](https://img.shields.io/lgtm/grade/python/g/netdata/netdata.svg?logo=lgtm)](https://lgtm.com/projects/g/netdata/netdata/context:python)
3 +[![Code
4 +Climate](https://codeclimate.com/github/netdata/netdata/badges/gpa.svg)](https://codeclimate.com/github/netdata/netdata)
5 +[![Codacy
6 +Badge](https://api.codacy.com/project/badge/Grade/a994873f30d045b9b4b83606c3eb3498)](https://www.codacy.com/app/netdata/netdata?utm_source=github.com&utm_medium=referral&utm_content=netdata/netdata&utm_campaign=Badge_Grade)
7 +[![LGTM
8 +C](https://img.shields.io/lgtm/grade/cpp/g/netdata/netdata.svg?logo=lgtm)](https://lgtm.com/projects/g/netdata/netdata/context:cpp)
9 +[![LGTM
10 +JS](https://img.shields.io/lgtm/grade/javascript/g/netdata/netdata.svg?logo=lgtm)](https://lgtm.com/projects/g/netdata/netdata/context:javascript)
11 +[![LGTM
12 +PYTHON](https://img.shields.io/lgtm/grade/python/g/netdata/netdata.svg?logo=lgtm)](https://lgtm.com/projects/g/netdata/netdata/context:python)
13
14 ---
15
7 -**Netdata** is **distributed, real-time, performance and health monitoring for systems and applications**. It is a highly-optimized monitoring agent you install on all your systems and containers.
16 +**Netdata** is **distributed, real-time, performance and health monitoring for systems and applications**. It is a
17 +highly-optimized monitoring agent you install on all your systems and containers.
18
9 -Netdata provides **unparalleled insights**, **in real-time**, of everything happening on the systems it runs (including web servers, databases, applications), using **highly interactive web dashboards**. It can run autonomously, without any third-party components, or it can be integrated to existing monitoring toolchains (Prometheus, Graphite, OpenTSDB, Kafka, Grafana, and more).
19 +Netdata provides **unparalleled insights**, **in real-time**, of everything happening on the systems it runs (including
20 +web servers, databases, applications), using **highly interactive web dashboards**. It can run autonomously, without any
21 +third-party components, or it can be integrated to existing monitoring toolchains (Prometheus, Graphite, OpenTSDB,
22 +Kafka, Grafana, and more).
23
24 Netdata is **fast** and **efficient**, designed to permanently run on all systems (**physical** & **virtual** servers,
25 **containers**, **IoT** devices), without disrupting their core function.
@@ -14,7 +27,8 @@ Netdata is **fast** and **efficient**, designed to permanently run on all system
27 Netdata is **free, open-source software** and it currently runs on **Linux**, **FreeBSD**, and **MacOS**, along with
28 other systems derived from them, such as **Kubernetes** and **Docker**.
29
17 -Netdata is not hosted by the CNCF but is the 3rd most starred open-source project in the [Cloud Native Computing Foundation (CNCF) landscape](https://landscape.cncf.io/format=card-mode&grouping=no&sort=stars).
30 +Netdata is not hosted by the CNCF but is the 3rd most starred open-source project in the [Cloud Native Computing
31 +Foundation (CNCF) landscape](https://landscape.cncf.io/format=card-mode&grouping=no&sort=stars).
32
33 ---
34
@@ -22,7 +36,8 @@ People get **addicted to Netdata**. Once you use it on your systems, **there is
36
37 ![image](https://user-images.githubusercontent.com/2662304/48305662-9de82980-e537-11e8-9f5b-aa1a60fbb82f.png)
38
25 -[![Tweet about Netdata!](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Tweet%20about%20netdata)](https://twitter.com/intent/tweet?text=Netdata,%20real-time%20performance%20and%20health%20monitoring,%20done%20right!&url=https://my-netdata.io/&via=linuxnetdata&hashtags=netdata,monitoring)
39 +[![Tweet about
40 +Netdata!](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Tweet%20about%20netdata)](https://twitter.com/intent/tweet?text=Netdata,%20real-time%20performance%20and%20health%20monitoring,%20done%20right!&url=https://my-netdata.io/&via=linuxnetdata&hashtags=netdata,monitoring)
41
42 ## Contents
43
@@ -46,42 +61,61 @@ People get **addicted to Netdata**. Once you use it on your systems, **there is
61
62 The following animated GIF shows the top part of a typical Netdata dashboard.
63
49 -![The Netdata dashboard in action](https://user-images.githubusercontent.com/1153921/70638670-85dd5080-1bf6-11ea-893e-94400f445574.gif)
64 +![The Netdata dashboard in
65 +action](https://user-images.githubusercontent.com/1153921/70638670-85dd5080-1bf6-11ea-893e-94400f445574.gif)
66
67 > A typical Netdata dashboard, in 1:1 timing. Charts can be panned by dragging them, zoomed in/out with `SHIFT` + `mouse
52 -> wheel`, an area can be selected for zoom-in with `SHIFT` + `mouse selection`. Netdata is highly interactive,
68 +> wheel`, an area can be selected for zoom-in with `SHIFT` + `mouse selection`. Netdata is highly interactive,
69 > **real-time**, and optimized to get the work done!
70
71 Want to see Netdata live? Check out any of our [live demos](https://www.netdata.cloud/#live-demo).
72
73 ## User base
74
59 -Netdata is used by hundreds of thousands of users all over the world.
60 -Check our [GitHub watchers list](https://github.com/netdata/netdata/watchers).
61 -You will find people working for **Amazon**, **Atos**, **Baidu**, **Cisco Systems**, **Citrix**, **Deutsche Telekom**, **DigitalOcean**,
62 -**Elastic**, **EPAM Systems**, **Ericsson**, **Google**, **Groupon**, **Hortonworks**, **HP**, **Huawei**,
63 -**IBM**, **Microsoft**, **NewRelic**, **Nvidia**, **Red Hat**, **SAP**, **Selectel**, **TicketMaster**,
64 -**Vimeo**, and many more!
75 +Netdata is used by hundreds of thousands of users all over the world. Check our [GitHub watchers
76 +list](https://github.com/netdata/netdata/watchers). You will find people working for **Amazon**, **Atos**, **Baidu**,
77 +**Cisco Systems**, **Citrix**, **Deutsche Telekom**, **DigitalOcean**, **Elastic**, **EPAM Systems**, **Ericsson**,
78 +**Google**, **Groupon**, **Hortonworks**, **HP**, **Huawei**, **IBM**, **Microsoft**, **NewRelic**, **Nvidia**, **Red
79 +Hat**, **SAP**, **Selectel**, **TicketMaster**, **Vimeo**, and many more!
80
81 ### Docker pulls
82
83 We provide Docker images for the most common architectures. These are statistics reported by Docker Hub:
84
70 -[![netdata/netdata (official)](https://img.shields.io/docker/pulls/netdata/netdata.svg?label=netdata/netdata+%28official%29)](https://hub.docker.com/r/netdata/netdata/) [![firehol/netdata (deprecated)](https://img.shields.io/docker/pulls/firehol/netdata.svg?label=firehol/netdata+%28deprecated%29)](https://hub.docker.com/r/firehol/netdata/) [![titpetric/netdata (donated)](https://img.shields.io/docker/pulls/titpetric/netdata.svg?label=titpetric/netdata+%28third+party%29)](https://hub.docker.com/r/titpetric/netdata/)
85 +[![netdata/netdata
86 +(official)](https://img.shields.io/docker/pulls/netdata/netdata.svg?label=netdata/netdata+%28official%29)](https://hub.docker.com/r/netdata/netdata/)
87 +[![firehol/netdata
88 +(deprecated)](https://img.shields.io/docker/pulls/firehol/netdata.svg?label=firehol/netdata+%28deprecated%29)](https://hub.docker.com/r/firehol/netdata/)
89 +[![titpetric/netdata
90 +(donated)](https://img.shields.io/docker/pulls/titpetric/netdata.svg?label=titpetric/netdata+%28third+party%29)](https://hub.docker.com/r/titpetric/netdata/)
91
92 ### Registry
93
74 -When you install multiple Netdata, they are integrated into **one distributed application**, via a [Netdata registry](registry/README.md). 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:
94 +When you install multiple Netdata, they are integrated into **one distributed application**, via a [Netdata
95 +registry](registry/README.md). This is a web browser feature and it allows us to count the number of unique users and
96 +unique Netdata servers installed. The following information comes from the global public Netdata registry we run:
97
76 -[![User Base](https://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_entries&dimensions=persons&label=user%20base&units=M&value_color=blue&precision=2&divide=1000000&v43)](https://registry.my-netdata.io/#menu_netdata_submenu_registry) [![Monitored Servers](https://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_entries&dimensions=machines&label=servers%20monitored&units=k&divide=1000&value_color=orange&precision=2&v43)](https://registry.my-netdata.io/#menu_netdata_submenu_registry) [![Sessions Served](https://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_sessions&label=sessions%20served&units=M&value_color=yellowgreen&precision=2&divide=1000000&v43)](https://registry.my-netdata.io/#menu_netdata_submenu_registry)
98 +[![User
99 +Base](https://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_entries&dimensions=persons&label=user%20base&units=M&value_color=blue&precision=2&divide=1000000&v43)](https://registry.my-netdata.io/#menu_netdata_submenu_registry)
100 +[![Monitored
101 +Servers](https://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_entries&dimensions=machines&label=servers%20monitored&units=k&divide=1000&value_color=orange&precision=2&v43)](https://registry.my-netdata.io/#menu_netdata_submenu_registry)
102 +[![Sessions
103 +Served](https://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_sessions&label=sessions%20served&units=M&value_color=yellowgreen&precision=2&divide=1000000&v43)](https://registry.my-netdata.io/#menu_netdata_submenu_registry)
104
78 -_In the last 24 hours:_<br/> [![New Users Today](https://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_entries&dimensions=persons&after=-86400&options=unaligned&group=incremental-sum&label=new%20users%20today&units=null&value_color=blue&precision=0&v42)](https://registry.my-netdata.io/#menu_netdata_submenu_registry) [![New Machines Today](https://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_entries&dimensions=machines&group=incremental-sum&after=-86400&options=unaligned&label=servers%20added%20today&units=null&value_color=orange&precision=0&v42)](https://registry.my-netdata.io/#menu_netdata_submenu_registry) [![Sessions Today](https://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_sessions&after=-86400&group=incremental-sum&options=unaligned&label=sessions%20served%20today&units=null&value_color=yellowgreen&precision=0&v42)](https://registry.my-netdata.io/#menu_netdata_submenu_registry)
105 +_In the last 24 hours:_<br/> [![New Users
106 +Today](https://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_entries&dimensions=persons&after=-86400&options=unaligned&group=incremental-sum&label=new%20users%20today&units=null&value_color=blue&precision=0&v42)](https://registry.my-netdata.io/#menu_netdata_submenu_registry)
107 +[![New Machines
108 +Today](https://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_entries&dimensions=machines&group=incremental-sum&after=-86400&options=unaligned&label=servers%20added%20today&units=null&value_color=orange&precision=0&v42)](https://registry.my-netdata.io/#menu_netdata_submenu_registry)
109 +[![Sessions
110 +Today](https://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_sessions&after=-86400&group=incremental-sum&options=unaligned&label=sessions%20served%20today&units=null&value_color=yellowgreen&precision=0&v42)](https://registry.my-netdata.io/#menu_netdata_submenu_registry)
111
112 ## Quickstart
113
82 -![](https://registry.my-netdata.io/api/v1/badge.svg?chart=web_log_nginx.requests_per_url&options=unaligned&dimensions=kickstart&group=sum&after=-3600&label=last+hour&units=installations&value_color=orange&precision=0) ![](https://registry.my-netdata.io/api/v1/badge.svg?chart=web_log_nginx.requests_per_url&options=unaligned&dimensions=kickstart&group=sum&after=-86400&label=today&units=installations&precision=0)
114 +![](https://registry.my-netdata.io/api/v1/badge.svg?chart=web_log_nginx.requests_per_url&options=unaligned&dimensions=kickstart&group=sum&after=-3600&label=last+hour&units=installations&value_color=orange&precision=0)
115 +![](https://registry.my-netdata.io/api/v1/badge.svg?chart=web_log_nginx.requests_per_url&options=unaligned&dimensions=kickstart&group=sum&after=-86400&label=today&units=installations&precision=0)
116
84 -To install Netdata from source on any Linux system (physical, virtual, container, IoT, edge) and keep it up to date with our **nightly releases** automatically, run the following:
117 +To install Netdata from source on any Linux system (physical, virtual, container, IoT, edge) and keep it up to date with
118 +our **nightly releases** automatically, run the following:
119
120 ```bash
121 # make sure you run `bash` for your shell
@@ -97,7 +131,7 @@ about the information collected, and learn how to-opt, on our [anonymous statist
131 The usage statistics are _vital_ for us, as we use them to discover bugs and priortize new features. We thank you for
132 _actively_ contributing to Netdata's future.
133
100 -To learn more about the pros and cons of using *nightly* vs. *stable* releases, see our [notice about the two options](packaging/installer/README.md#nightly-vs-stable-releases).
134 +To learn more about the pros and cons of using _nightly_ vs. _stable_ releases, see our [notice about the two options](packaging/installer/README.md#nightly-vs-stable-releases).
135
136 The above command will:
137
@@ -106,8 +140,6 @@ The above command will:
140
141 More installation methods and additional options can be found at the [installation page](packaging/installer/README.md).
142
109 ----
110 -
143 To try Netdata in a docker container, run this:
144
145 ```sh
@@ -127,7 +159,9 @@ For more information about running Netdata with Docker, check the [docker instal
159
160 ![image](https://user-images.githubusercontent.com/2662304/48304090-fd384080-e51b-11e8-80ae-eecb03118dda.png)
161
130 -From Netdata v1.12 and above, anonymous usage information is collected by default and sent to Google Analytics. To read more about the information collected and how to opt-out, check the [anonymous statistics page](docs/anonymous-statistics.md).
162 +From Netdata v1.12 and above, anonymous usage information is collected by default and sent to Google Analytics. To read
163 +more about the information collected and how to opt-out, check the [anonymous statistics
164 +page](docs/anonymous-statistics.md).
165
166 ## Why Netdata
167
@@ -146,16 +180,16 @@ All the above, are packaged together in a very flexible, extremely modular, dist
180
181 This is how Netdata compares to other monitoring solutions:
182
149 -|Netdata|others (open-source and commercial)|
150 -|:-----:|:---------------------------------:|
151 -|**High resolution metrics** (1s granularity)|Low resolution metrics (10s granularity at best)|
152 -|Monitors everything, **thousands of metrics per node**|Monitor just a few metrics|
153 -|UI is super fast, optimized for **anomaly detection**|UI is good for just an abstract view|
154 -|**Meaningful presentation**, to help you understand the metrics|You have to know the metrics before you start|
155 -|Install and get results **immediately**|Long preparation is required to get any useful results|
156 -|Use it for **troubleshooting** performance problems|Use them to get *statistics of past performance*|
157 -|**Kills the console** for tracing performance issues|The console is always required for troubleshooting|
158 -|Requires **zero dedicated resources**|Require large dedicated resources|
183 +| Netdata | others (open-source and commercial) |
184 +| :-------------------------------------------------------------- | :----------------------------------------------------- |
185 +| **High resolution metrics** (1s granularity) | Low resolution metrics (10s granularity at best) |
186 +| Monitors everything, **thousands of metrics per node** | Monitor just a few metrics |
187 +| UI is super fast, optimized for **anomaly detection** | UI is good for just an abstract view |
188 +| **Meaningful presentation**, to help you understand the metrics | You have to know the metrics before you start |
189 +| Install and get results **immediately** | Long preparation is required to get any useful results |
190 +| Use it for **troubleshooting** performance problems | Use them to get _statistics of past performance_ |
191 +| **Kills the console** for tracing performance issues | The console is always required for troubleshooting |
192 +| Requires **zero dedicated resources** | Require large dedicated resources |
193
194 Netdata is **open-source**, **free**, super **fast**, very **easy**, completely **open**, extremely **efficient**,
195 **flexible** and integrate-able.
@@ -212,27 +246,28 @@ page](https://github.com/netdata/netdata/releases).
246
247 ## How it works
248
215 -Netdata is a highly efficient, highly modular, metrics management engine. Its lockless design makes it ideal for concurrent operations on the metrics.
249 +Netdata is a highly efficient, highly modular, metrics management engine. Its lockless design makes it ideal for
250 +concurrent operations on the metrics.
251
252 ![image](https://user-images.githubusercontent.com/2662304/48323827-b4c17580-e636-11e8-842c-0ee72fcb4115.png)
253
254 This is how it works:
255
221 -|Function|Description|Documentation|
222 -|:------:|:----------|:-----------:|
223 -|**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)|
224 -|**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/#database)|
225 -|**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)|
226 -|**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/#streaming-and-replication)|
227 -|**Archive**|A lockless independent worker is down-sampling the metrics and pushes them to **backend** time-series databases.|[`backends`](backends/)|
228 -|**Query**|Multiple independent workers are attached to the [internal web server](web/server/#web-server), servicing API requests, including [data queries](web/api/queries/#database-queries).|[`web/api`](web/api/#api)|
256 +| Function | Description | Documentation |
257 +| :---------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------- |
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. | [`backends`](backends/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
267 ## Infographic
268
234 -This is a high level overview of Netdata feature set and architecture.
235 -Click it to to interact with it (it has direct links to our documentation).
269 +This is a high level overview of Netdata feature set and architecture. Click it to to interact with it (it has direct
270 +links to our documentation).
271
272 [![image](https://user-images.githubusercontent.com/43294513/60951037-8ba5d180-a2f8-11e9-906e-e27356f168bc.png)](https://my-netdata.io/infographic.html)
273
@@ -262,28 +297,50 @@ This is what you should expect from Netdata:
297
298 ### Health Monitoring & Alarms
299
265 -- **Sophisticated alerting** - Netdata comes with hundreds of alarms **out of the box**! It supports dynamic thresholds, hysteresis, alarm templates, multiple role-based notification methods, and more.
266 -- **Notifications**: [alerta.io](health/notifications/alerta/), [amazon sns](health/notifications/awssns/), [discordapp.com](health/notifications/discord/), [email](health/notifications/email/), [flock.com](health/notifications/flock/), [hangouts](health/notifications/hangouts/), [irc](health/notifications/irc/), [kavenegar.com](health/notifications/kavenegar/), [messagebird.com](health/notifications/messagebird/), [pagerduty.com](health/notifications/pagerduty/), [prowl](health/notifications/prowl/), [pushbullet.com](health/notifications/pushbullet/), [pushover.net](health/notifications/pushover/), [rocket.chat](health/notifications/rocketchat/), [slack.com](health/notifications/slack/), [smstools3](health/notifications/smstools3/), [syslog](health/notifications/syslog/), [telegram.org](health/notifications/telegram/), [twilio.com](health/notifications/twilio/), [web](health/notifications/web/) and [custom notifications](health/notifications/custom/).
300 +- **Sophisticated alerting** - Netdata comes with hundreds of alarms **out of the box**! It supports dynamic
301 + thresholds, hysteresis, alarm templates, multiple role-based notification methods, and more.
302 +- **Notifications**: [alerta.io](health/notifications/alerta/), [amazon sns](health/notifications/awssns/),
303 + [discordapp.com](health/notifications/discord/), [email](health/notifications/email/),
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/),
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
312 + notifications](health/notifications/custom/).
313
314 ### Integrations
315
270 -- **Time-series databases** - Netdata can archive its metrics to **Graphite**, **OpenTSDB**, **Prometheus**, **AWS Kinesis**, **MongoDB**, **JSON document DBs**, in the same or lower resolution (lower: to prevent it from congesting these servers due to the amount of data collected). Netdata also supports **Prometheus remote write API**, which allows storing metrics to **Elasticsearch**, **Gnocchi**, **InfluxDB**, **Kafka**, **PostgreSQL/TimescaleDB**, **Splunk**, **VictoriaMetrics** and a lot of other [storage providers](https://prometheus.io/docs/operating/integrations/#remote-endpoints-and-storage).
316 +- **Time-series databases** - Netdata can archive its metrics to **Graphite**, **OpenTSDB**, **Prometheus**, **AWS
317 + Kinesis**, **MongoDB**, **JSON document DBs**, in the same or lower resolution (lower: to prevent it from congesting
318 + these servers due to the amount of data collected). Netdata also supports **Prometheus remote write API**, which
319 + allows storing metrics to **Elasticsearch**, **Gnocchi**, **InfluxDB**, **Kafka**, **PostgreSQL/TimescaleDB**,
320 + **Splunk**, **VictoriaMetrics** and a lot of other [storage
321 + providers](https://prometheus.io/docs/operating/integrations/#remote-endpoints-and-storage).
322
323 ## Visualization
324
274 -- **Stunning interactive dashboards** - Our dashboard is mouse-, touchpad-, and touch-screen friendly in 2 themes: `slate` (dark) and `white`.
275 -- **Amazingly fast visualization** - Even on low-end hardware, the dashboard responds to all queries in less than 1 ms per metric.
276 -- **Visual anomaly detection** - Our UI/UX emphasizes the relationships between charts so you can better detect anomalies visually.
277 -- **Embeddable** - 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/).
325 +- **Stunning interactive dashboards** - Our dashboard is mouse-, touchpad-, and touch-screen friendly in 2 themes:
326 + `slate` (dark) and `white`.
327 +- **Amazingly fast visualization** - Even on low-end hardware, the dashboard responds to all queries in less than 1 ms
328 + per metric.
329 +- **Visual anomaly detection** - Our UI/UX emphasizes the relationships between charts so you can better detect
330 + anomalies visually.
331 +- **Embeddable** - Charts can be embedded on your web pages, wikis and blogs. You can even use [Atlassian's Confluence
332 + as a monitoring dashboard](web/gui/confluence/).
333 - **Customizable** - You can build custom dashboards using simple HTML. No JavaScript needed!
334
335 ### Positive and negative values
336
282 -To improve clarity on charts, Netdata dashboards present **positive** values for metrics representing `read`, `input`, `inbound`, `received` and **negative** values for metrics representing `write`, `output`, `outbound`, `sent`.
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 ![positive-and-negative-values](https://user-images.githubusercontent.com/2662304/48309090-7c5c6180-e57a-11e8-8e03-3a7538c14223.gif)
341
286 -_Netdata charts showing the bandwidth and packets of a network interface. `received` is positive and `sent` is negative._
342 +_Netdata charts showing the bandwidth and packets of a network interface. `received` is positive and `sent` is
343 +negative._
344
345 ### Autoscaled y-axis
346
@@ -291,43 +348,56 @@ Netdata charts automatically zoom vertically, to visualize the variation of each
348
349 ![non-zero-based](https://user-images.githubusercontent.com/2662304/48309139-3d2f1000-e57c-11e8-9a44-b91758134b00.gif)
350
294 -_A zero-based `stacked` chart, automatically switches to an auto-scaled `area` chart when a single dimension is selected._
351 +_A zero-based `stacked` chart, automatically switches to an auto-scaled `area` chart when a single dimension is
352 +selected._
353
354 ### Charts are synchronized
355
298 -Charts on Netdata dashboards are synchronized to each other. There is no master chart. Any chart can be panned or zoomed at any time, and all other charts will follow.
356 +Charts on Netdata dashboards are synchronized to each other. There is no master chart. Any chart can be panned or zoomed
357 +at any time, and all other charts will follow.
358
359 ![charts-are-synchronized](https://user-images.githubusercontent.com/2662304/48309003-b4fb3b80-e578-11e8-86f6-f505c7059c15.gif)
360
302 -_Charts are panned by dragging them with the mouse. Charts can be zoomed in/out with`SHIFT` + `mouse wheel` while the mouse pointer is over a chart._
361 +_Charts are panned by dragging them with the mouse. Charts can be zoomed in/out with`SHIFT` + `mouse wheel` while the
362 +mouse pointer is over a chart._
363
304 -> The visible time-frame (pan and zoom) is propagated from Netdata server to Netdata server when navigating via the [node menu](registry#registry).
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
308 -To improve visual anomaly detection across charts, the user can highlight a time-frame (by pressing `Alt` + `mouse selection`) on all charts.
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 ![highlighted-timeframe](https://user-images.githubusercontent.com/2662304/48311876-f9093300-e5ae-11e8-9c74-e3e291741990.gif)
373
312 -_A highlighted time-frame can be given by pressing `Alt` + `mouse selection` on any chart. Netdata will highlight the same range on all charts._
374 +_A highlighted time-frame can be given by pressing `Alt` + `mouse selection` on any chart. Netdata will highlight the
375 +same range on all charts._
376
314 -> Highlighted ranges are propagated from Netdata server to Netdata server, when navigating via the [node menu](registry#registry).
377 +> Highlighted ranges are propagated from Netdata server to Netdata server, when navigating via the [My nodes
378 +> menu](registry/README.md).
379
380 ## What does it monitor
381
318 -Netdata data collection is **extensible**. You can monitor anything you can get a metric for. Our [plugin API](collectors/plugins.d/) supports a variety of programming languages to make nearly anything a Netdata plugin: Go, Python, Node.js, Ruby, Java, Bash, Perl, and more!
382 +Netdata data collection is **extensible**. You can monitor anything you can get a metric for. Our [plugin
383 +API](collectors/plugins.d/) supports a variety of programming languages to make nearly anything a Netdata plugin: Go,
384 +Python, Node.js, Ruby, Java, Bash, Perl, and more!
385
320 -- For better performance, most system-related plugins (CPU, memory, disks, filesystems, networking, etc) have been written in C.
321 -- For faster development and easier contributions, most application related plugins (databases, web servers, etc) have been written in Go and Python.
386 +- For better performance, most system-related plugins (CPU, memory, disks, filesystems, networking, etc) have been
387 + written in C.
388 +- For faster development and easier contributions, most application related plugins (databases, web servers, etc) have
389 + been written in Go and Python.
390
323 -#### APM (Application Performance Monitoring)
391 +### APM (Application Performance Monitoring)
392
393 - **[statsd](collectors/statsd.plugin/)** - Netdata is a fully featured statsd server.
326 -- **[Go expvar](collectors/python.d.plugin/go_expvar/)** - collects metrics exposed by applications written in the Go programming language using the expvar package.
327 -- **[Spring Boot](collectors/python.d.plugin/springboot/)** - monitors running Java Spring Boot applications that expose their metrics with the use of the Spring Boot Actuator included in Spring Boot library.
394 +- **[Go expvar](collectors/python.d.plugin/go_expvar/)** - collects metrics exposed by applications written in the Go
395 + programming language using the expvar package.
396 +- **[Spring Boot](collectors/python.d.plugin/springboot/)** - monitors running Java Spring Boot applications that
397 + expose their metrics with the use of the Spring Boot Actuator included in Spring Boot library.
398 - **[uWSGI](collectors/python.d.plugin/uwsgi/)** - collects performance metrics from uWSGI applications.
399
330 -#### System Resources
400 +### System Resources
401
402 - **[CPU Utilization](collectors/proc.plugin/)** - total and per core CPU usage.
403 - **[Interrupts](collectors/proc.plugin/)** - total and per core CPU interrupts.
@@ -340,7 +410,7 @@ Netdata data collection is **extensible**. You can monitor anything you can get
410 - **[Entropy](collectors/proc.plugin/)** - random numbers pool, using in cryptography.
411 - **[Interprocess Communication - IPC](collectors/proc.plugin/)** - such as semaphores and semaphores arrays.
412
343 -#### Memory
413 +### Memory
414
415 - **[ram](collectors/proc.plugin/)** - collects info about RAM usage.
416 - **[swap](collectors/proc.plugin/)** - collects info about swap memory usage.
@@ -353,7 +423,7 @@ Netdata data collection is **extensible**. You can monitor anything you can get
423 - **[Numa](collectors/proc.plugin/)** - collects Numa info on systems that support it.
424 - **[slab](collectors/proc.plugin/)** - collects info about the Linux kernel memory usage.
425
356 -#### Disks
426 +### Disks
427
428 - **[block devices](collectors/proc.plugin/)** - per disk: I/O, operations, backlog, utilization, space, etc.
429 - **[BCACHE](collectors/proc.plugin/)** - detailed performance of SSD caching devices.
@@ -367,7 +437,7 @@ Netdata data collection is **extensible**. You can monitor anything you can get
437 - **[adaptec_raid](collectors/python.d.plugin/adaptec_raid/)** - logical and physical devices health metrics.
438 - **[ioping](collectors/ioping.plugin/)** - to measure disk read/write latency.
439
370 -#### Filesystems
440 +### Filesystems
441
442 - **[BTRFS](collectors/proc.plugin/)** - detailed disk space allocation and usage.
443 - **[Ceph](collectors/python.d.plugin/ceph/)** - OSD usage, Pool usage, number of objects, etc.
@@ -375,9 +445,11 @@ Netdata data collection is **extensible**. You can monitor anything you can get
445 - **[Samba](collectors/python.d.plugin/samba/)** - performance metrics of Samba SMB2 file sharing.
446 - **[ZFS](collectors/proc.plugin/)** - detailed performance and resource usage.
447
378 -#### Networking
448 +### Networking
449
380 -- **[Network Stack](collectors/proc.plugin/)** - everything about the networking stack (both IPv4 and IPv6 for all protocols: TCP, UDP, SCTP, UDPLite, ICMP, Multicast, Broadcast, etc), and all network interfaces (per interface: bandwidth, packets, errors, drops).
450 +- **[Network Stack](collectors/proc.plugin/)** - everything about the networking stack (both IPv4 and IPv6 for all
451 + protocols: TCP, UDP, SCTP, UDPLite, ICMP, Multicast, Broadcast, etc), and all network interfaces (per interface:
452 + bandwidth, packets, errors, drops).
453 - **[Netfilter](collectors/proc.plugin/)** - everything about the netfilter connection tracker.
454 - **[SynProxy](collectors/proc.plugin/)** - collects performance data about the linux SYNPROXY (DDoS).
455 - **[NFacct](collectors/nfacct.plugin/)** - collects accounting data from iptables.
@@ -385,94 +457,118 @@ Netdata data collection is **extensible**. You can monitor anything you can get
457 - **[FPing](collectors/fping.plugin/)** - to measure latency and packet loss between any number of hosts.
458 - **[ISC dhcpd](collectors/python.d.plugin/isc_dhcpd/)** - pools utilization, leases, etc.
459 - **[AP](collectors/charts.d.plugin/ap/)** - collects Linux access point performance data (`hostapd`).
388 -- **[SNMP](collectors/node.d.plugin/snmp/)** - SNMP devices can be monitored too (although you will need to configure these).
460 +- **[SNMP](collectors/node.d.plugin/snmp/)** - SNMP devices can be monitored too (although you will need to configure
461 + these).
462 - **[port_check](collectors/python.d.plugin/portcheck/)** - checks TCP ports for availability and response time.
463
391 -#### Virtual Private Networks
464 +### Virtual Private Networks
465
466 - **[OpenVPN](collectors/python.d.plugin/ovpn_status_log/)** - collects status per tunnel.
467 - **[LibreSwan](collectors/charts.d.plugin/libreswan/)** - collects metrics per IPSEC tunnel.
468 - **[Tor](collectors/python.d.plugin/tor/)** - collects Tor traffic statistics.
469
397 -#### Processes
470 +### Processes
471
472 - **[System Processes](collectors/proc.plugin/)** - running, blocked, forks, active.
400 -- **[Applications](collectors/apps.plugin/)** - by grouping the process tree and reporting CPU, memory, disk reads, disk writes, swap, threads, pipes, sockets - per process group.
473 +- **[Applications](collectors/apps.plugin/)** - by grouping the process tree and reporting CPU, memory, disk reads,
474 + disk writes, swap, threads, pipes, sockets - per process group.
475 - **[systemd](collectors/cgroups.plugin/)** - monitors systemd services using CGROUPS.
476
403 -#### Users
477 +### Users
478
405 -- **[Users and User Groups resource usage](collectors/apps.plugin/)** - by summarizing the process tree per user and group, reporting: CPU, memory, disk reads, disk writes, swap, threads, pipes, sockets.
479 +- **[Users and User Groups resource usage](collectors/apps.plugin/)** - by summarizing the process tree per user and
480 + group, reporting: CPU, memory, disk reads, disk writes, swap, threads, pipes, sockets.
481 - **[logind](collectors/python.d.plugin/logind/)** - collects sessions, users and seats connected.
482
408 -#### Containers and VMs
483 +### Containers and VMs
484
410 -- **[Containers](collectors/cgroups.plugin/)** - collects resource usage for all kinds of containers, using CGROUPS (systemd-nspawn, lxc, lxd, docker, kubernetes, etc).
485 +- **[Containers](collectors/cgroups.plugin/)** - collects resource usage for all kinds of containers, using CGROUPS
486 + (systemd-nspawn, lxc, lxd, docker, kubernetes, etc).
487 - **[libvirt VMs](collectors/cgroups.plugin/)** - collects resource usage for all kinds of VMs, using CGROUPS.
488 - **[dockerd](collectors/python.d.plugin/dockerd/)** - collects docker health metrics.
489
414 -#### Web Servers
490 +### Web Servers
491
416 -- **[Apache and lighttpd](collectors/python.d.plugin/apache/)** - `mod-status` (v2.2, v2.4) and cache log statistics, for multiple servers.
492 +- **[Apache and lighttpd](collectors/python.d.plugin/apache/)** - `mod-status` (v2.2, v2.4) and cache log statistics,
493 + for multiple servers.
494 - **[IPFS](collectors/python.d.plugin/ipfs/)** - bandwidth, peers.
495 - **[LiteSpeed](collectors/python.d.plugin/litespeed/)** - reads the litespeed rtreport files to collect metrics.
496 - **[Nginx](collectors/python.d.plugin/nginx/)** - `stub-status`, for multiple servers.
420 -- **[Nginx+](collectors/python.d.plugin/nginx_plus/)** - connects to multiple nginx_plus servers (local or remote) to collect real-time performance metrics.
421 -- **[PHP-FPM](collectors/python.d.plugin/phpfpm/)** - multiple instances, each reporting connections, requests, performance, etc.
497 +- **[Nginx+](collectors/python.d.plugin/nginx_plus/)** - connects to multiple nginx_plus servers (local or remote) to
498 + collect real-time performance metrics.
499 +- **[PHP-FPM](collectors/python.d.plugin/phpfpm/)** - multiple instances, each reporting connections, requests,
500 + performance, etc.
501 - **[Tomcat](collectors/python.d.plugin/tomcat/)** - accesses, threads, free memory, volume, etc.
423 -- **[web server `access.log` files](collectors/python.d.plugin/web_log/)** - extracting in real-time, web server and proxy performance metrics and applying several health checks, etc.
424 -- **[HTTP check](collectors/python.d.plugin/httpcheck/)** - checks one or more web servers for HTTP status code and returned content.
502 +- **[web server `access.log` files](collectors/python.d.plugin/web_log/)** - extracting in real-time, web server and
503 + proxy performance metrics and applying several health checks, etc.
504 +- **[HTTP check](collectors/python.d.plugin/httpcheck/)** - checks one or more web servers for HTTP status code and
505 + returned content.
506
426 -#### Proxies, Balancers, Accelerators
507 +### Proxies, Balancers, Accelerators
508
509 - **[HAproxy](collectors/python.d.plugin/haproxy/)** - bandwidth, sessions, backends, etc.
429 -- **[Squid](collectors/python.d.plugin/squid/)** - multiple servers, each showing: clients bandwidth and requests, servers bandwidth and requests.
430 -- **[Traefik](collectors/python.d.plugin/traefik/)** - connects to multiple traefik instances (local or remote) to collect API metrics (response status code, response time, average response time and server uptime).
510 +- **[Squid](collectors/python.d.plugin/squid/)** - multiple servers, each showing: clients bandwidth and requests,
511 + servers bandwidth and requests.
512 +- **[Traefik](collectors/python.d.plugin/traefik/)** - connects to multiple traefik instances (local or remote) to
513 + collect API metrics (response status code, response time, average response time and server uptime).
514 - **[Varnish](collectors/python.d.plugin/varnish/)** - threads, sessions, hits, objects, backends, etc.
515 - **[IPVS](collectors/proc.plugin/)** - collects metrics from the Linux IPVS load balancer.
516
434 -#### Database Servers
435 -
436 -- **[CouchDB](collectors/python.d.plugin/couchdb/)** - reads/writes, request methods, status codes, tasks, replication, per-db, etc.
437 -- **[MemCached](collectors/python.d.plugin/memcached/)** - multiple servers, each showing: bandwidth, connections, items, etc.
438 -- **[MongoDB](collectors/python.d.plugin/mongodb/)** - operations, clients, transactions, cursors, connections, asserts, locks, etc.
439 -- **[MySQL and mariadb](collectors/python.d.plugin/mysql/)** - multiple servers, each showing: bandwidth, queries/s, handlers, locks, issues, tmp operations, connections, binlog metrics, threads, innodb metrics, and more.
440 -- **[PostgreSQL](collectors/python.d.plugin/postgres/)** - multiple servers, each showing: per database statistics (connections, tuples read - written - returned, transactions, locks), backend processes, indexes, tables, write ahead, background writer and more.
517 +### Database Servers
518 +
519 +- **[CouchDB](collectors/python.d.plugin/couchdb/)** - reads/writes, request methods, status codes, tasks,
520 + replication, per-db, etc.
521 +- **[MemCached](collectors/python.d.plugin/memcached/)** - multiple servers, each showing: bandwidth, connections,
522 + items, etc.
523 +- **[MongoDB](collectors/python.d.plugin/mongodb/)** - operations, clients, transactions, cursors, connections,
524 + asserts, locks, etc.
525 +- **[MySQL and mariadb](collectors/python.d.plugin/mysql/)** - multiple servers, each showing: bandwidth, queries/s,
526 + handlers, locks, issues, tmp operations, connections, binlog metrics, threads, innodb metrics, and more.
527 +- **[PostgreSQL](collectors/python.d.plugin/postgres/)** - multiple servers, each showing: per database statistics
528 + (connections, tuples read - written - returned, transactions, locks), backend processes, indexes, tables, write
529 + ahead, background writer and more.
530 - **[Proxy SQL](collectors/python.d.plugin/proxysql/)** - collects Proxy SQL backend and frontend performance metrics.
442 -- **[Redis](collectors/python.d.plugin/redis/)** - multiple servers, each showing: operations, hit rate, memory, keys, clients, slaves.
443 -- **[RethinkDB](collectors/python.d.plugin/rethinkdbs/)** - connects to multiple rethinkdb servers (local or remote) to collect real-time metrics.
531 +- **[Redis](collectors/python.d.plugin/redis/)** - multiple servers, each showing: operations, hit rate, memory, keys,
532 + clients, slaves.
533 +- **[RethinkDB](collectors/python.d.plugin/rethinkdbs/)** - connects to multiple rethinkdb servers (local or remote)
534 + to collect real-time metrics.
535
445 -#### Message Brokers
536 +### Message Brokers
537
538 - **[beanstalkd](collectors/python.d.plugin/beanstalk/)** - global and per tube monitoring.
539 - **[RabbitMQ](collectors/python.d.plugin/rabbitmq/)** - performance and health metrics.
540
450 -#### Search and Indexing
541 +### Search and Indexing
542
452 -- **[ElasticSearch](collectors/python.d.plugin/elasticsearch/)** - search and index performance, latency, timings, cluster statistics, threads statistics, etc.
543 +- **[ElasticSearch](collectors/python.d.plugin/elasticsearch/)** - search and index performance, latency, timings,
544 + cluster statistics, threads statistics, etc.
545
454 -#### DNS Servers
546 +### DNS Servers
547
456 -- **[bind_rndc](collectors/python.d.plugin/bind_rndc/)** - parses `named.stats` dump file to collect real-time performance metrics. All versions of bind after 9.6 are supported.
548 +- **[bind_rndc](collectors/python.d.plugin/bind_rndc/)** - parses `named.stats` dump file to collect real-time
549 + performance metrics. All versions of bind after 9.6 are supported.
550 - **[dnsdist](collectors/python.d.plugin/dnsdist/)** - performance and health metrics.
458 -- **[ISC Bind (named)](collectors/node.d.plugin/named/)** - multiple servers, each showing: clients, requests, queries, updates, failures and several per view metrics. All versions of bind after 9.9.10 are supported.
551 +- **[ISC Bind (named)](collectors/node.d.plugin/named/)** - multiple servers, each showing: clients, requests,
552 + queries, updates, failures and several per view metrics. All versions of bind after 9.9.10 are supported.
553 - **[NSD](collectors/python.d.plugin/nsd/)** - queries, zones, protocols, query types, transfers, etc.
554 - **[PowerDNS](collectors/python.d.plugin/powerdns/)** - queries, answers, cache, latency, etc.
555 - **[unbound](collectors/python.d.plugin/unbound/)** - performance and resource usage metrics.
556 - **[dns_query_time](collectors/python.d.plugin/dns_query_time/)** - DNS query time statistics.
557
464 -#### Time Servers
558 +### Time Servers
559
466 -- **[chrony](collectors/python.d.plugin/chrony/)** - uses the `chronyc` command to collect chrony statistics (Frequency, Last offset, RMS offset, Residual freq, Root delay, Root dispersion, Skew, System time).
467 -- **[ntpd](collectors/python.d.plugin/ntpd/)** - connects to multiple ntpd servers (local or remote) to provide statistics of system variables and optional also peer variables.
560 +- **[chrony](collectors/python.d.plugin/chrony/)** - uses the `chronyc` command to collect chrony statistics
561 + (Frequency, Last offset, RMS offset, Residual freq, Root delay, Root dispersion, Skew, System time).
562 +- **[ntpd](collectors/python.d.plugin/ntpd/)** - connects to multiple ntpd servers (local or remote) to provide
563 + statistics of system variables and optional also peer variables.
564
469 -#### Mail Servers
565 +### Mail Servers
566
567 - **[Dovecot](collectors/python.d.plugin/dovecot/)** - POP3/IMAP servers.
568 - **[Exim](collectors/python.d.plugin/exim/)** - message queue (emails queued).
569 - **[Postfix](collectors/python.d.plugin/postfix/)** - message queue (entries, size).
570
475 -#### Hardware Sensors
571 +### Hardware Sensors
572
573 - **[IPMI](collectors/freeipmi.plugin/)** - enterprise hardware sensors and events.
574 - **[lm-sensors](collectors/python.d.plugin/sensors/)** - temperature, voltage, fans, power, humidity, etc.
@@ -480,53 +576,66 @@ Netdata data collection is **extensible**. You can monitor anything you can get
576 - **[RPi](collectors/charts.d.plugin/sensors/)** - Raspberry Pi temperature sensors.
577 - **[w1sensor](collectors/python.d.plugin/w1sensor/)** - collects data from connected 1-Wire sensors.
578
483 -#### UPSes
579 +### UPSes
580
485 -- **[apcupsd](collectors/charts.d.plugin/apcupsd/)** - load, charge, battery voltage, temperature, utility metrics, output metrics.
486 -- **[NUT](collectors/charts.d.plugin/nut/)** - load, charge, battery voltage, temperature, utility metrics, output metrics.
581 +- **[apcupsd](collectors/charts.d.plugin/apcupsd/)** - load, charge, battery voltage, temperature, utility metrics,
582 + output metrics.
583 +- **[NUT](collectors/charts.d.plugin/nut/)** - load, charge, battery voltage, temperature, utility metrics, output
584 + metrics.
585 - **[Linux Power Supply](collectors/proc.plugin/)** - collects metrics reported by power supply drivers on Linux.
586
489 -#### Social Sharing Servers
587 +### Social Sharing Servers
588
491 -- **[RetroShare](collectors/python.d.plugin/retroshare/)** - connects to multiple retroshare servers (local or remote) to collect real-time performance metrics.
589 +- **[RetroShare](collectors/python.d.plugin/retroshare/)** - connects to multiple retroshare servers (local or remote)
590 + to collect real-time performance metrics.
591
493 -#### Security
592 +### Security
593
495 -- **[Fail2Ban](collectors/python.d.plugin/fail2ban/)** - monitors the fail2ban log file to check all bans for all active jails.
594 +- **[Fail2Ban](collectors/python.d.plugin/fail2ban/)** - monitors the fail2ban log file to check all bans for all
595 + active jails.
596
497 -#### Authentication, Authorization, Accounting (AAA, RADIUS, LDAP) Servers
597 +### Authentication, Authorization, Accounting (AAA, RADIUS, LDAP) Servers
598
499 -- **[FreeRadius](collectors/python.d.plugin/freeradius/)** - uses the `radclient` command to provide freeradius statistics (authentication, accounting, proxy-authentication, proxy-accounting).
599 +- **[FreeRadius](collectors/python.d.plugin/freeradius/)** - uses the `radclient` command to provide freeradius
600 + statistics (authentication, accounting, proxy-authentication, proxy-accounting).
601
501 -#### Telephony Servers
602 +### Telephony Servers
603
503 -- **[opensips](collectors/charts.d.plugin/opensips/)** - connects to an opensips server (localhost only) to collect real-time performance metrics.
604 +- **[opensips](collectors/charts.d.plugin/opensips/)** - connects to an opensips server (localhost only) to collect
605 + real-time performance metrics.
606
505 -#### Household Appliances
607 +### Household Appliances
608
507 -- **[SMA webbox](collectors/node.d.plugin/sma_webbox/)** - connects to multiple remote SMA webboxes to collect real-time performance metrics of the photovoltaic (solar) power generation.
508 -- **[Fronius](collectors/node.d.plugin/fronius/)** - connects to multiple remote Fronius Symo servers to collect real-time performance metrics of the photovoltaic (solar) power generation.
509 -- **[StiebelEltron](collectors/node.d.plugin/stiebeleltron/)** - collects the temperatures and other metrics from your Stiebel Eltron heating system using their Internet Service Gateway (ISG web).
609 +- **[SMA webbox](collectors/node.d.plugin/sma_webbox/)** - connects to multiple remote SMA webboxes to collect
610 + real-time performance metrics of the photovoltaic (solar) power generation.
611 +- **[Fronius](collectors/node.d.plugin/fronius/)** - connects to multiple remote Fronius Symo servers to collect
612 + real-time performance metrics of the photovoltaic (solar) power generation.
613 +- **[StiebelEltron](collectors/node.d.plugin/stiebeleltron/)** - collects the temperatures and other metrics from your
614 + Stiebel Eltron heating system using their Internet Service Gateway (ISG web).
615
511 -#### Game Servers
616 +### Game Servers
617
513 -- **[SpigotMC](collectors/python.d.plugin/spigotmc/)** - monitors Spigot Minecraft server ticks per second and number of online players using the Minecraft remote console.
618 +- **[SpigotMC](collectors/python.d.plugin/spigotmc/)** - monitors Spigot Minecraft server ticks per second and number
619 + of online players using the Minecraft remote console.
620
515 -#### Distributed Computing
621 +### Distributed Computing
622
517 -- **[BOINC](collectors/python.d.plugin/boinc/)** - monitors task states for local and remote BOINC client software using the remote GUI RPC interface. Also provides alarms for a handful of error conditions.
623 +- **[BOINC](collectors/python.d.plugin/boinc/)** - monitors task states for local and remote BOINC client software
624 + using the remote GUI RPC interface. Also provides alarms for a handful of error conditions.
625
519 -#### Media Streaming Servers
626 +### Media Streaming Servers
627
628 - **[IceCast](collectors/python.d.plugin/icecast/)** - collects the number of listeners for active sources.
629
630 ### Monitoring Systems
631
525 -- **[Monit](collectors/python.d.plugin/monit/)** - collects metrics about monit targets (filesystems, applications, networks).
632 +- **[Monit](collectors/python.d.plugin/monit/)** - collects metrics about monit targets (filesystems, applications,
633 + networks).
634
527 -#### Provisioning Systems
635 +### Provisioning Systems
636
529 -- **[Puppet](collectors/python.d.plugin/puppet/)** - connects to multiple Puppet Server and Puppet DB instances (local or remote) to collect real-time status metrics.
637 +- **[Puppet](collectors/python.d.plugin/puppet/)** - connects to multiple Puppet Server and Puppet DB instances (local
638 + or remote) to collect real-time status metrics.
639
640 You can easily extend Netdata, by writing plugins that collect data from any source, using any computer language.
641
@@ -539,19 +648,19 @@ repository itself in Markdown (`.md`) files. You can find all our documentation
648
649 Here is a quick list of notable documents:
650
542 -|Directory|Description|
543 -|:--------|:----------|
544 -|[`installer`](packaging/installer/)|Instructions to install Netdata on your systems.|
545 -|[`docker`](packaging/docker/)|Instructions to install Netdata using docker.|
546 -|[`daemon`](daemon/)|Information about the Netdata daemon and its configuration.|
547 -|[`collectors`](collectors/)|Information about data collection plugins.|
548 -|[`health`](health/)|How Netdata's health monitoring works, how to create your own alarms and how to configure alarm notification methods.|
549 -|[`streaming`](streaming/)|How to build hierarchies of Netdata servers, by streaming metrics between them.|
550 -|[`backends`](backends/)|Long term archiving of metrics to industry-standard time-series databases, like `prometheus`, `graphite`, `opentsdb`.|
551 -|[`web/api`](web/api/)|Learn how to query the Netdata API and the queries it supports.|
552 -|[`web/api/badges`](web/api/badges/)|Learn how to generate badges (SVG images) from live data.|
553 -|[`web/gui/custom`](web/gui/custom/)|Learn how to create custom Netdata dashboards.|
554 -|[`web/gui/confluence`](web/gui/confluence/)|Learn how to create Netdata dashboards on Atlassian's Confluence.|
651 +| Directory | Description |
652 +| :------------------------------------------ | :-------------------------------------------------------------------------------------------------------------------- |
653 +| [`installer`](packaging/installer/) | Instructions to install Netdata on your systems. |
654 +| [`docker`](packaging/docker/) | Instructions to install Netdata using docker. |
655 +| [`daemon`](daemon/) | Information about the Netdata daemon and its configuration. |
656 +| [`collectors`](collectors/) | Information about data collection plugins. |
657 +| [`health`](health/) | How Netdata's health monitoring works, how to create your own alarms and how to configure alarm notification methods. |
658 +| [`streaming`](streaming/) | How to build hierarchies of Netdata servers, by streaming metrics between them. |
659 +| [`backends`](backends/) | Long term archiving of metrics to industry-standard time-series databases, like `prometheus`, `graphite`, `opentsdb`. |
660 +| [`web/api`](web/api/) | Learn how to query the Netdata API and the queries it supports. |
661 +| [`web/api/badges`](web/api/badges/) | Learn how to generate badges (SVG images) from live data. |
662 +| [`web/gui/custom`](web/gui/custom/) | Learn how to create custom Netdata dashboards. |
663 +| [`web/gui/confluence`](web/gui/confluence/) | Learn how to create Netdata dashboards on Atlassian's Confluence. |
664
665 You can also check all the other directories. Most of them have plenty of documentation.
666
@@ -580,9 +689,11 @@ Netdata re-distributes other open-source tools and libraries. Please check the [
689
690 Yes.
691
583 -_When people first hear about a new product, they frequently ask if it is any good. A Hacker News user [remarked](https://news.ycombinator.com/item?id=3067434):_
692 +_When people first hear about a new product, they frequently ask if it is any good. A Hacker News user
693 +[remarked](https://news.ycombinator.com/item?id=3067434):_
694
585 -> Note to self: Starting immediately, all raganwald projects will have a “Is it any good?” section in the readme, and the answer shall be “yes.".
695 +> Note to self: Starting immediately, all raganwald projects will have a “Is it any good?” section in the readme, and
696 +> the answer shall be “yes.".
697
698 So, we follow the tradition...
699