@cryptotaxi247 / netdata-1 / commits / f4ababe9a

added more information to README.md

Costa Tsaousis (ktsaou) committed Mar 11, 2017 at 12:30 UTC f4ababe9a34986c596623b813422ab1c432a9d0f
1 file changed +43 -8
README.md
+43 -8
@@ -1,4 +1,4 @@
1 -# netdata [![Build Status](https://travis-ci.org/firehol/netdata.svg?branch=master)](https://travis-ci.org/firehol/netdata) [![Coverity Scan Build Status](https://scan.coverity.com/projects/9140/badge.svg)](https://scan.coverity.com/projects/firehol-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=firehol/netdata&utm_campaign=Badge_Grade) [![Code Climate](https://codeclimate.com/github/firehol/netdata/badges/gpa.svg)](https://codeclimate.com/github/firehol/netdata) [![Docker Pulls](https://img.shields.io/docker/pulls/titpetric/netdata.svg)](https://hub.docker.com/r/titpetric/netdata/) [![Twitter Follow](https://img.shields.io/twitter/follow/linuxnetdata.svg?style=social&label=netdata%20on%20twitter)](https://twitter.com/linuxnetdata)
1 +# netdata [![Build Status](https://travis-ci.org/firehol/netdata.svg?branch=master)](https://travis-ci.org/firehol/netdata) [![Coverity Scan Build Status](https://scan.coverity.com/projects/9140/badge.svg)](https://scan.coverity.com/projects/firehol-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=firehol/netdata&utm_campaign=Badge_Grade) [![Code Climate](https://codeclimate.com/github/firehol/netdata/badges/gpa.svg)](https://codeclimate.com/github/firehol/netdata)
2 > *New to netdata? Here is a live demo: [http://my-netdata.io](http://my-netdata.io)*
3
4 **netdata** is a system for **distributed real-time performance and health monitoring**.
@@ -10,12 +10,16 @@ _netdata is **fast** and **efficient**, designed to permanently run on all syste
10 (**physical** & **virtual** servers, **containers**, **IoT** devices), without
11 disrupting their core function._
12
13 +netdata runs on **Linux**, **FreeBSD**, and **MacOS**.
14 +
15 +[![Twitter Follow](https://img.shields.io/twitter/follow/linuxnetdata.svg?style=social&label=New%20-%20stay%20in%20touch%20-%20follow%20netdata%20on%20twitter)](https://twitter.com/linuxnetdata)
16 +
17 ---
18
19 ## User base
20
21 *Since May 16th 2016 (the date the [global public netdata registry](https://github.com/firehol/netdata/wiki/mynetdata-menu-item) was released):*<br/>
18 -[![User Base](https://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_entries&dimensions=persons&label=user%20base&units=null&value_color=blue&precision=0&v42)](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=null&value_color=orange&precision=0&v42)](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=null&value_color=yellowgreen&precision=0&v42)](https://registry.my-netdata.io/#menu_netdata_submenu_registry)
22 +[![User Base](https://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_entries&dimensions=persons&label=user%20base&units=null&value_color=blue&precision=0&v42)](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=null&value_color=orange&precision=0&v42)](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=null&value_color=yellowgreen&precision=0&v42)](https://registry.my-netdata.io/#menu_netdata_submenu_registry) [![Docker Pulls](https://img.shields.io/docker/pulls/titpetric/netdata.svg)](https://hub.docker.com/r/titpetric/netdata/)
23
24 *in the last 24 hours:*<br/>
25 [![New Users Today](http://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)
@@ -89,8 +93,12 @@ Netdata is featured at <b><a href="https://octoverse.github.com/" target="_blank
93 - **scales to infinity**<br/>
94 requiring minimal central resources
95
92 - - **back-ends supported**<br/>
93 - can archive its metrics on `graphite` or `opentsdb`, in the same or lower detail
96 + - **several operating modes**<br/>
97 + autonomous host monitoring, headless data collector, forwarding proxy, store and forward proxy, central multi-host monitoring, in all possible configurations.
98 + Each node may have different metrics retention policy and run with or without health monitoring.
99 +
100 + - **time-series back-ends supported**<br/>
101 + can archive its metrics on `graphite`, `opentsdb`, `prometheus`, json document DBs, in the same or lower detail
102 (lower: to prevent it from congesting these servers due to the amount of data collected)
103
104 ![netdata](https://cloud.githubusercontent.com/assets/2662304/14092712/93b039ea-f551-11e5-822c-beadbf2b2a2e.gif)
@@ -99,7 +107,7 @@ Netdata is featured at <b><a href="https://octoverse.github.com/" target="_blank
107
108 ## What does it monitor?
109
102 -netdata monitors several thousands of metrics per device.
110 +netdata collects several thousands of metrics per device.
111 All these metrics are collected and visualized in real-time.
112
113 > _Almost all metrics are auto-detected, without any configuration._
@@ -107,13 +115,13 @@ All these metrics are collected and visualized in real-time.
115 This is a list of what it currently monitors:
116
117 - **CPU**<br/>
110 - usage, interrupts, softirqs, frequency, total and per core
118 + usage, interrupts, softirqs, frequency, total and per core, CPU states
119
120 - **Memory**<br/>
121 RAM, swap and kernel memory usage, KSM (Kernel Samepage Merging), NUMA
122
123 - **Disks**<br/>
116 - per disk: I/O, operations, backlog, utilization, space
124 + per disk: I/O, operations, backlog, utilization, space, software RAID (md)
125
126 ![sda](https://cloud.githubusercontent.com/assets/2662304/14093195/c882bbf4-f554-11e5-8863-1788d643d2c0.gif)
127
@@ -189,6 +197,9 @@ This is a list of what it currently monitors:
197 - **Tomcat**<br/>
198 accesses, threads, free memory, volume
199
200 +- **web server log files**<br/>
201 + extracting in real-time, web server performance metrics and applying several health checks
202 +
203 - **mySQL databases**<br/>
204 multiple servers, each showing: bandwidth, queries/s, handlers, locks, issues,
205 tmp operations, connections, binlog metrics, threads, innodb metrics, and more
@@ -201,12 +212,21 @@ This is a list of what it currently monitors:
212 - **Redis databases**<br/>
213 multiple servers, each showing: operations, hit rate, memory, keys, clients, slaves
214
215 +- **mongodb**<br/>
216 + operations, clients, transactions, cursors, connections, asserts, locks, etc
217 +
218 - **memcached databases**<br/>
219 multiple servers, each showing: bandwidth, connections, items
220
221 +- **elasticsearch**<br/>
222 + search and index performance, latency, timings, cluster statistics, threads statistics, etc
223 +
224 - **ISC Bind name servers**<br/>
225 multiple servers, each showing: clients, requests, queries, updates, failures and several per view metrics
226
227 +- **NSD name servers**<br/>
228 + queries, zones, protocols, query types, transfers, etc.
229 +
230 - **Postfix email servers**<br/>
231 message queue (entries, size)
232
@@ -215,14 +235,26 @@ This is a list of what it currently monitors:
235
236 - **Dovecot** POP3/IMAP servers<br/>
237
238 +- **ISC dhcpd**<br/>
239 + pools utilization, leases, etc.
240 +
241 - **IPFS**<br/>
242 bandwidth, peers
243
244 - **Squid proxy servers**<br/>
245 multiple servers, each showing: clients bandwidth and requests, servers bandwidth and requests
246
247 +- **HAproxy**<br/>
248 + bandwidth, sessions, backends, etc
249 +
250 +- **varnish**<br/>
251 + threads, sessions, hits, objects, backends, etc
252 +
253 +- **OpenVPN**<br/>
254 + status per tunnel
255 +
256 - **Hardware sensors**<br/>
225 - temperature, voltage, fans, power, humidity
257 + `lm_sensors` and `IPMI`: temperature, voltage, fans, power, humidity
258
259 - **NUT and APC UPSes**<br/>
260 load, charge, battery voltage, temperature, utility metrics, output metrics
@@ -233,6 +265,9 @@ This is a list of what it currently monitors:
265 - **hddtemp**<br/>
266 disk temperatures
267
268 +- **smartd**<br/>
269 + disk S.M.A.R.T. values
270 +
271 - **SNMP devices**<br/>
272 can be monitored too (although you will need to configure these)
273