updated README.md
Costa Tsaousis (ktsaou) committed
Oct 19, 2016 at 01:41 UTC
06df357fc899716ab7bc48302cbc14157eb6cb96
1 file changed
+132
-49
README.md
+132
-49
@@ -2,9 +2,14 @@
2
3
> *New to netdata? Here is a live demo: [http://my-netdata.io](http://my-netdata.io)*
4
5
-**netdata** is an application for **real-time performance and health monitoring**. It provides **unparalleled insights, in real-time**, of everything happening on the system it runs (including key applications such as web and database servers), using **modern interactive web dashboards**.
5
+**netdata** is a system for **real-time performance and health monitoring**.
6
+It provides **unparalleled insights, in real-time**, of everything happening on the
7
+system it runs (including applications such as web and database servers), using
8
+**modern interactive web dashboards**.
9
7
-_netdata is **very fast** and **super efficient**, designed to permanently run on all systems (**physical** & **virtual** servers, **containers**, **IoT** devices), without disrupting their core function._
10
+_netdata is **fast** and **efficient**, designed to permanently run on all systems
11
+(**physical** & **virtual** servers, **containers**, **IoT** devices), without
12
+disrupting their core function._
13
14
---
15
@@ -26,10 +31,10 @@ _netdata is **very fast** and **super efficient**, designed to permanently run o
31
32
`Oct 4th, 2016` - **[netdata v1.4.0 released!](https://github.com/firehol/netdata/releases)**
33
29
- - the **fastest** netdata ever (with a better look too)!
30
- - improved **IoT** and **containers** support!
31
- - **alarms** improved in almost every way!
32
- - new plugins: softnet netdev, extended TCP metrics, UDPLite, NFS v2, v3 client (server was there already), NFS v4 server & client, APCUPSd, RetroShare
34
+ - the **fastest** netdata ever (with a better look too)
35
+ - improved **IoT** and **containers** support
36
+ - **alarms** improved in almost every way
37
+ - new plugins: softnet netdev, extended TCP metrics, UDPLite, NFS v2, v3 client (server was there already), NFS v4 server & client, APCUPSd, RetroShare
38
- improved plugins: mysql, cgroups, hddtemp, sensors, phpfm, tc (QoS)
39
40
---
@@ -40,17 +45,46 @@ _netdata is **very fast** and **super efficient**, designed to permanently run o
45
<img src="https://cloud.githubusercontent.com/assets/2662304/19168687/f6a567be-8c19-11e6-8561-ce8d589e8346.gif"/>
46
</p>
47
43
- - **Stunning interactive bootstrap dashboards**<br/>2 themes are provided: dark, light
44
- - **Blazingly fast visualization**<br/>responds to all queries in less than 0.5 ms per metric, even on low-end hardware
45
- - **Highly efficient data collection**<br/>collects thousands of metrics per server per second, with just 1% CPU utilization of a single core on modern hardware
46
- - **Sophisticated alarming**<br/>supports dynamic thresholds, hysteresis, templating, multiple notification methods
47
- - **Extensible**<br/>you can monitor anything you can get a metric for, using its Plugin API (anything can be a netdata plugin, BASH, python, perl, node.js, java, Go, etc)
48
- - **Zero configuration**<br/>auto-detects everything, out of the box it can collect up to 5000 metrics per server
49
- - **Zero dependencies**<br/>it is even its own web server, for its static web files and its web API
50
- - **Zero maintenance**<br/>you just run it, it does the rest
51
- - **Embeddable**<br/>it can run anywhere a Linux kernel runs (even IoT) and its charts can be embedded on your web pages too
52
- - **Custom dashboards**<br/>that can be built using simple HTML (no javascript necessary)
53
- - **scales to infinity**<br/>requiring minimal central resources!
48
+ - **Stunning interactive bootstrap dashboards**<br/>
49
+ 2 themes are provided: dark, light
50
+
51
+ - **Blazingly fast**<br/>
52
+ responds to all queries in less than 0.5 ms per metric,
53
+ even on low-end hardware
54
+
55
+ - **Highly efficient data collection**<br/>
56
+ collects thousands of metrics per server per second,
57
+ with just 1% CPU utilization of a single core,
58
+ on modern hardware
59
+
60
+ - **Sophisticated alarming**<br/>
61
+ supports dynamic thresholds, hysteresis, alarm templates,
62
+ multiple notification methods
63
+
64
+ - **Extensible**<br/>
65
+ you can monitor anything you can get a metric for,
66
+ using its Plugin API (anything can be a netdata plugin,
67
+ BASH, python, perl, node.js, java, Go, ruby, etc)
68
+
69
+ - **Embeddable**<br/>
70
+ it can run anywhere a Linux kernel runs (even IoT)
71
+ and its charts can be embedded on your web pages too
72
+
73
+ - **Zero configuration**<br/>
74
+ auto-detects everything, it can collect up to 5000 metrics
75
+ per server out of the box
76
+
77
+ - **Zero dependencies**<br/>
78
+ it is even its own web server, for its static web files and its web API
79
+
80
+ - **Zero maintenance**<br/>
81
+ you just run it, it does the rest
82
+
83
+ - **Custom dashboards**<br/>
84
+ that can be built using simple HTML (no javascript necessary)
85
+
86
+ - **scales to infinity**<br/>
87
+ requiring minimal central resources
88
89
90
@@ -58,77 +92,126 @@ _netdata is **very fast** and **super efficient**, designed to permanently run o
92
93
## What does it monitor?
94
61
-This is what it currently monitors (most with zero configuration):
95
+netdata monitors several thousands of metrics per device.
96
+All these metrics are collected and visualized in real-time.
97
63
-- **CPU usage, interrupts, softirqs and frequency** (total and per core)
98
+> _Almost all metrics are auto-detected, without any configuration._
99
65
-- **RAM, swap and kernel memory usage** (including KSM and kernel memory deduper)
100
+This is a list of what it currently monitors:
101
67
-- **Disks** (per disk: I/O, operations, backlog, utilization, space, etc)
102
+- **CPU**<br/>
103
+ usage, interrupts, softirqs, frequency, total and per core
104
+
105
+- **Memory**<br/>
106
+ RAM, swap and kernel memory usage, including KSM the kernel memory deduper
107
+
108
+- **Disks**<br/>
109
+ per disk: I/O, operations, backlog, utilization, space
110
111
112
71
-- **Network interfaces** (per interface: bandwidth, packets, errors, drops, etc)
113
+- **Network interfaces**<br/>
114
+ per interface: bandwidth, packets, errors, drops
115
116
117
75
-- **IPv4 networking** (bandwidth, packets, errors, fragments, tcp: connections, packets, errors, handshake, udp: packets, errors, broadcast: bandwidth, packets, multicast: bandwidth, packets)
118
+- **IPv4 networking**<br/>
119
+ bandwidth, packets, errors, fragments,
120
+ tcp: connections, packets, errors, handshake,
121
+ udp: packets, errors,
122
+ broadcast: bandwidth, packets,
123
+ multicast: bandwidth, packets
124
77
-- **IPv6 networking** (bandwidth, packets, errors, fragments, ECT, udp: packets, errors, udplite: packets, errors, broadcast: bandwidth, multicast: bandwidth, packets, icmp: messages, errors, echos, router, neighbor, MLDv2, group membership, break down by type)
125
+- **IPv6 networking**<br/>
126
+ bandwidth, packets, errors, fragments, ECT,
127
+ udp: packets, errors,
128
+ udplite: packets, errors,
129
+ broadcast: bandwidth,
130
+ multicast: bandwidth, packets,
131
+ icmp: messages, errors, echos, router, neighbor, MLDv2, group membership,
132
+ break down by type
133
79
-- **netfilter / iptables Linux firewall** (connections, connection tracker events, errors, etc)
134
+- **netfilter / iptables Linux firewall**<br/>
135
+ connections, connection tracker events, errors
136
81
-- **Linux DDoS protection** (SYNPROXY metrics)
137
+- **Linux DDoS protection**<br/>
138
+ SYNPROXY metrics
139
83
-- **Processes** (running, blocked, forks, active, etc)
140
+- **Processes**<br/>
141
+ running, blocked, forks, active
142
85
-- **Entropy** (random numbers pool, using in cryptography)
143
+- **Entropy**<br/>
144
+ random numbers pool, using in cryptography
145
87
-- **NFS file servers and clients**, v2, v3, v4 (I/O, cache, read ahead, RPC calls)
146
+- **NFS file servers and clients**<br/>
147
+ NFS v2, v3, v4: I/O, cache, read ahead, RPC calls
148
89
-- **Network QoS** (yes, the only tool that visualizes network `tc` classes in realtime)
149
+- **Network QoS**<br/>
150
+ the only tool that visualizes network `tc` classes in realtime
151
152
153
93
-- **Linux Control Groups** (containers), systemd, lxc, docker, etc
154
+- **Linux Control Groups**<br/>
155
+ containers: systemd, lxc, docker
156
95
-- **Applications**, by grouping the process tree (CPU, memory, disk reads, disk writes, swap, threads, pipes, sockets, etc)
157
+- **Applications**<br/>
158
+ by grouping the process tree and reporting CPU, memory, disk reads,
159
+ disk writes, swap, threads, pipes, sockets - per group
160
161
162
99
-- **Users and User Groups resource usage**, by summarizing the process tree per user and group (CPU, memory, disk reads, disk writes, swap, threads, pipes, sockets, etc)
163
+- **Users and User Groups resource usage**<br/>
164
+ by summarizing the process tree per user and group,
165
+ reporting: CPU, memory, disk reads, disk writes, swap, threads, pipes, sockets
166
101
-- **Apache web servers** mod-status (v2.2, v2.4) and cache log statistics (multiple servers - compatible with lighttpd too)
167
+- **Apache and lighttpd web servers**<br/>
168
+ `mod-status` (v2.2, v2.4) and cache log statistics, for multiple servers
169
103
-- **Nginx web servers** stub-status (multiple servers)
170
+- **Nginx web servers**<br/>
171
+ `stub-status`, for multiple servers
172
105
-- **mySQL databases** (multiple servers, each showing: bandwidth, queries/s, handlers, locks, issues, tmp operations, connections, binlog metrics, threads, innodb metrics, etc)
173
+- **Tomcat**<br/>
174
+ accesses, threads, free memory, volume
175
107
-- **Redis databases** (multiple servers, each showing: operations, hit rate, memory, keys, clients, slaves)
176
+- **mySQL databases**<br/>
177
+ multiple servers, each showing: bandwidth, queries/s, handlers, locks, issues,
178
+ tmp operations, connections, binlog metrics, threads, innodb metrics, and more
179
109
-- **memcached databases** (multiple servers, each showing: bandwidth, connections, items, etc)
180
+- **Redis databases**<br/>
181
+ multiple servers, each showing: operations, hit rate, memory, keys, clients, slaves
182
111
-- **ISC Bind name servers** (multiple servers, each showing: clients, requests, queries, updates, failures and several per view metrics)
183
+- **memcached databases**<br/>
184
+ multiple servers, each showing: bandwidth, connections, items
185
113
-- **Postfix email servers** message queue (entries, size)
186
+- **ISC Bind name servers**<br/>
187
+ multiple servers, each showing: clients, requests, queries, updates, failures and several per view metrics
188
115
-- **exim email servers** message queue (emails queued)
189
+- **Postfix email servers**<br/>
190
+ message queue (entries, size)
191
117
-- **IPFS** (Bandwidth, Peers)
192
+- **exim email servers**<br/>
193
+ message queue (emails queued)
194
119
-- **Squid proxy servers** (multiple servers, each showing: clients bandwidth and requests, servers bandwidth and requests)
195
+- **IPFS**<br/>
196
+ bandwidth, peers
197
121
-- **Hardware sensors** (temperature, voltage, fans, power, humidity, etc)
198
+- **Squid proxy servers**<br/>
199
+ multiple servers, each showing: clients bandwidth and requests, servers bandwidth and requests
200
123
-- **NUT and APC UPSes** (load, charge, battery voltage, temperature, utility metrics, output metrics)
201
+- **Hardware sensors**<br/>
202
+ temperature, voltage, fans, power, humidity
203
125
-- **Tomcat** (accesses, threads, free memory, volume)
204
+- **NUT and APC UPSes**<br/>
205
+ load, charge, battery voltage, temperature, utility metrics, output metrics
206
127
-- **PHP-FPM** (multiple instances, each reporting connections, requests, performance)
207
+- **PHP-FPM**<br/>
208
+ multiple instances, each reporting connections, requests, performance
209
129
-- **hddtemp** (disk temperatures)
210
+- **hddtemp**<br/>
211
+ disk temperatures
212
131
-- **SNMP devices** can be monitored too (although you will need to configure these)
213
+- **SNMP devices**<br/>
214
+ can be monitored too (although you will need to configure these)
215
216
And you can extend it, by writing plugins that collect data from any source, using any computer language.
217