@cryptotaxi247 / netdata-1 / commits / 562f7ca44

New readme (#4596)

* updated readme * updated readme * updated readme * updated readme * updated readme * updated readme * updated readme * updated readme * updated readme

Costa Tsaousis committed Nov 10, 2018 at 05:50 UTC 562f7ca449e1fe8b1fff62a75bdb16c30da3d3a1
1 file changed +382 -378
README.md
+382 -378
@@ -1,393 +1,397 @@
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)
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)
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)
4
3 -[![Code Climate](https://codeclimate.com/github/netdata/netdata/badges/gpa.svg)](https://codeclimate.com/github/netdata/netdata)
4 -[![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)
5 -[![LGTM C](https://img.shields.io/lgtm/grade/cpp/g/netdata/netdata.svg?logo=lgtm)](https://lgtm.com/projects/g/netdata/netdata/context:cpp)
6 -[![LGTM JS](https://img.shields.io/lgtm/grade/javascript/g/netdata/netdata.svg?logo=lgtm)](https://lgtm.com/projects/g/netdata/netdata/context:javascript)
7 -[![LGTM PYTHON](https://img.shields.io/lgtm/grade/python/g/netdata/netdata.svg?logo=lgtm)](https://lgtm.com/projects/g/netdata/netdata/context:python)
5 +> *New to Netdata? Here is a live demo: [http://my-netdata.io](http://my-netdata.io)*
6
9 -> *New to netdata? Here is a live demo: [http://my-netdata.io](http://my-netdata.io)*
7 +**Netdata** is a system for **distributed real-time performance and health monitoring**.
8 +
9 +It provides **unparalleled insights**, **in real-time**, of everything happening on the systems it runs (including containers and applications such as web and database servers), using **modern interactive web dashboards**.
10
11 -**netdata** is a system for **distributed real-time performance and health monitoring**.
11 +_Netdata is **fast** and **efficient**, designed to permanently run on all systems (**physical** & **virtual** servers, **containers**, **IoT** devices), without disrupting their core function._
12 +
13 +Netdata currently runs on **Linux**, **FreeBSD**, and **MacOS**.
14
13 -It provides **unparalleled insights**, **in real-time**, of everything happening on the systems it runs (including containers and applications such as web and database servers), using **modern interactive web dashboards**.
14 -
15 -### netdata core values
16 -
17 -we value |netdata...
18 -:--------------------------:|:----
19 -high resolution metrics |collects all metrics **every single second**
20 -unlimited metrics |collects **thousands of metrics** per monitored node
21 -real-time visualization |dashboards run with **sub-second latency**, collection to visualization
22 -powerful anomaly detection |has a **distributed watchdog** embedded in it, running on all monitored nodes
23 -visual anomaly detection |dashboards are optimized for **spotting anomalies**, across all metrics
24 -meaningful presentation |dashboards present **all metrics in a structured, easy to understand, way**
25 -zero configuration |**auto-detects** all metrics and comes with dozens of alarms
26 -resource utilization |core is **optimized C code**, using <1% utilization of single CPU core
27 -
28 -netdata also supports:
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) [![analytics](http://www.google-analytics.com/collect?v=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)]()
16
30 - - monitoring **ephemeral nodes** and **auto-scaled containers**,
31 - - **integration** with existing monitoring infrastructure (time-series databases like `prometheus`, `graphite`, `opentsdb`) and third-party event notification methods
32 -(like `slack`, `pagerduty`, `pushover`, and dozens more),
33 - - building hierarchies of monitored nodes via **real-time metrics streaming** between them,
34 - - embedding charts and dashboards on third party web sites and applications, such as [Atlassian's Confluence](https://github.com/netdata/netdata/wiki/Custom-Dashboard-with-Confluence).
35 -
36 -_netdata is **fast** and **efficient**, designed to permanently run on all systems
37 -(**physical** & **virtual** servers, **containers**, **IoT** devices), without
38 -disrupting their core function._
39 -
40 -netdata currently runs on **Linux**, **FreeBSD**, and **MacOS**.
41 -
42 -[![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)
43 -[![analytics](http://www.google-analytics.com/collect?v=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)]()
44 -
45 ----
46 -
47 -## User base
48 -*Docker pulls*<br/>
49 -[![netdata/netdata (official)](https://img.shields.io/docker/pulls/netdata/netdata.svg?label=netdata/netdata+%28official%29)](https://hub.docker.com/r/netdata/netdata/)
50 -[![firehol/netdata (deprecated)](https://img.shields.io/docker/pulls/firehol/netdata.svg?label=firehol/netdata+%28deprecated%29)](https://hub.docker.com/r/firehol/netdata/)
51 -[![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/)
52 -
53 -*Since May 16th 2016 (the date the [global public netdata registry](https://github.com/netdata/netdata/wiki/mynetdata-menu-item) was released):*<br/>
54 -[![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)
55 -[![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)
56 -[![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)
57 -
58 -*in the last 24 hours:*<br/>
59 -[![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)
60 -[![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)
61 -[![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)
62 -
63 ----
64 -
65 -## News
66 -
67 -`Nov 6th, 2018` - **[netdata v1.11.0 released!](https://github.com/netdata/netdata/releases)**
68 -
69 - - New query engine, supporting statistical functions.
70 - - Fixed security issues identified by Red4Sec.com and Synacktiv.
71 - - New Data Collection Modules: `rethinkdbs`, `proxysql`, `litespeed`, `uwsgi`, `unbound`, `powerdns`, `dockerd`, `puppet`, `logind`, `adaptec_raid`, `megacli`, `spigotmc`, `boinc`, `w1sensor`, `monit`, `linux_power_supplies`.
72 - - Improved Data Collection Modules: `statsd.plugin`, `apps.plugin`, `freeipmi.plugin`, `proc.plugin`, `diskspace.plugin`, `freebsd.plugin`, `python.d.plugin`, `web_log`, `nginx_plus`, `ipfs`, `fail2ban`, `ceph`, `elasticsearch`, `nginx_plus`, `redis`,
73 - `beanstalk`, `mysql`, `varnish`, `couchdb`, `phpfpm`, `apache`, `icecast`, `mongodb`, `postgress`, `elasticsearch`, `mdstat`, `openvpn_log`, `snmp`, `nut`.
74 -
75 - - Added alarms for detecting abnormally high load average, `TCP` `SYN` and `TCP` accept queue overflows, network interfaces congestion and alarms for `bcache`, `mdstat`, `apcupsd`, `mysql`.
76 - - system alarms are now enabled on FreeBSD.
77 - - New notification methods: **rocket.chat**, **Microsoft Teams**, **syslog**, **fleep.io**, **Amazon SNS**.
78 -
79 - - and dozens more improvements, enhancements, features and compatibility fixes
80 -
81 ----
82 -
83 -`Sep 18, 2018` - **netdata has its own organization**
84 -
85 -Netdata used to be a [firehol.org](https://firehol.org) project, accessible as `firehol/netdata`.
86 -
87 -Netdata now has its own github organization `netdata`, so all github URLs are now `netdata/netdata`. The old github URLs, repo clones, forks, etc redirect automatically to the new repo.
88 -
89 ----
90 -
91 -![cncf](https://www.cncf.io/wp-content/uploads/2016/09/logo_cncf.png)
92 -
93 -`Jun 16, 2018` - **netdata in CNCF**
94 -
95 -Netdata is now at the [Cloud Native Computing Foundation (CNCF) landscape](https://landscape.cncf.io/grouping=no&sort=stars).
96 -
97 -Read the [netdata presentation](https://docs.google.com/presentation/d/18C8bCTbtgKDWqPa57GXIjB2PbjjpjsUNkLtZEz6YK8s/edit?usp=sharing) we gave at CNCF TOC on Sep 18, 2018.
98 -
99 ----
100 -
101 -## Features
102 -
103 -<p align="center">
104 -<img src="https://cloud.githubusercontent.com/assets/2662304/19168687/f6a567be-8c19-11e6-8561-ce8d589e8346.gif"/>
105 -</p>
106 -
107 - - **Stunning interactive bootstrap dashboards**<br/>
108 - mouse and touch friendly, in 2 themes: dark, light
109 -
110 - - **Amazingly fast**<br/>
111 - responds to all queries in less than 0.5 ms per metric,
112 - even on low-end hardware
113 -
114 - - **Highly efficient**<br/>
115 - collects thousands of metrics per server per second,
116 - with just 1% CPU utilization of a single core, a few MB of RAM and no disk I/O at all
117 -
118 - - **Sophisticated alerting**<br/>
119 - hundreds of alarms, **out of the box**!<br/>
120 - supports dynamic thresholds, hysteresis, alarm templates,
121 - multiple role-based notification methods (such as email, slack.com, flock.com,
122 - pushover.net, pushbullet.com, telegram.org, twilio.com, messagebird.com, kavenegar.com)
123 -
124 - - **Extensible**<br/>
125 - you can monitor anything you can get a metric for,
126 - using its Plugin API (anything can be a netdata plugin,
127 - BASH, python, perl, node.js, java, Go, ruby, etc)
128 -
129 - - **Embeddable**<br/>
130 - it can run anywhere a Linux kernel runs (even IoT)
131 - and its charts can be embedded on your web pages too
132 -
133 - - **Customizable**<br/>
134 - custom dashboards can be built using simple HTML (no javascript necessary)
135 -
136 - - **Zero configuration**<br/>
137 - auto-detects everything, it can collect up to 5000 metrics
138 - per server out of the box
139 -
140 - - **Zero dependencies**<br/>
141 - it is even its own web server, for its static web files and its web API
142 -
143 - - **Zero maintenance**<br/>
144 - you just run it, it does the rest
145 -
146 - - **scales to infinity**<br/>
147 - requiring minimal central resources
148 -
149 - - **several operating modes**<br/>
150 - autonomous host monitoring, headless data collector, forwarding proxy, store and forward proxy, central multi-host monitoring, in all possible configurations.
151 - Each node may have different metrics retention policy and run with or without health monitoring.
152 -
153 - - **time-series back-ends supported**<br/>
154 - can archive its metrics on `graphite`, `opentsdb`, `prometheus`, json document DBs, in the same or lower detail
155 - (lower: to prevent it from congesting these servers due to the amount of data collected)
156 -
157 -![netdata](https://cloud.githubusercontent.com/assets/2662304/14092712/93b039ea-f551-11e5-822c-beadbf2b2a2e.gif)
158 -
159 ----
160 -
161 -## What does it monitor?
162 -
163 -netdata collects several thousands of metrics per device.
164 -All these metrics are collected and visualized in real-time.
165 -
166 -> _Almost all metrics are auto-detected, without any configuration._
167 -
168 -This is a list of what it currently monitors:
169 -
170 -- **CPU**<br/>
171 - usage, interrupts, softirqs, frequency, total and per core, CPU states
172 -
173 -- **Memory**<br/>
174 - RAM, swap and kernel memory usage, KSM (Kernel Samepage Merging), NUMA
175 -
176 -- **Disks**<br/>
177 - per disk: I/O, operations, backlog, utilization, space, software RAID (md)
178 -
179 - ![sda](https://cloud.githubusercontent.com/assets/2662304/14093195/c882bbf4-f554-11e5-8863-1788d643d2c0.gif)
180 -
181 -- **Network interfaces**<br/>
182 - per interface: bandwidth, packets, errors, drops
183 -
184 - ![dsl0](https://cloud.githubusercontent.com/assets/2662304/14093128/4d566494-f554-11e5-8ee4-5392e0ac51f0.gif)
185 -
186 -- **IPv4 networking**<br/>
187 - bandwidth, packets, errors, fragments,
188 - tcp: connections, packets, errors, handshake,
189 - udp: packets, errors,
190 - broadcast: bandwidth, packets,
191 - multicast: bandwidth, packets
192 -
193 -- **IPv6 networking**<br/>
194 - bandwidth, packets, errors, fragments, ECT,
195 - udp: packets, errors,
196 - udplite: packets, errors,
197 - broadcast: bandwidth,
198 - multicast: bandwidth, packets,
199 - icmp: messages, errors, echos, router, neighbor, MLDv2, group membership,
200 - break down by type
201 -
202 -- **Interprocess Communication - IPC**<br/>
203 - such as semaphores and semaphores arrays
204 -
205 -- **netfilter / iptables Linux firewall**<br/>
206 - connections, connection tracker events, errors
17 +## Why use Netdata?
18
208 -- **Linux DDoS protection**<br/>
209 - SYNPROXY metrics
19 +Netdata is a monitoring agent you install on all your systems.
20
211 -- **fping** latencies</br>
212 - for any number of hosts, showing latency, packets and packet loss
21 +It is:
22
214 - ![image](https://cloud.githubusercontent.com/assets/2662304/20464811/9517d2b4-af57-11e6-8361-f6cc57541cd7.png)
23 +- a **metrics collector** - for system and application metrics (including web servers, databases, containers, etc)
24 +- a **time-series database** - all stored in memory (does not touch the disks while it runs)
25 +- a **metrics visualizer** - super fast, interactive, modern, optimized for anomaly detection
26 +- an **alarms notification engine** - an advanced watchdog for detecting performance and availability issues
27
28 +All packaged together in a very flexible, extremely modular, distributed application.
29
217 -- **Processes**<br/>
218 - running, blocked, forks, active
30 +This is how netdata compares to other monitoring solutions:
31
220 -- **Entropy**<br/>
221 - random numbers pool, using in cryptography
32 +netdata|others (open-source and commercial)
33 +:---:|:---:
34 +**High resolution metrics** (1s granularity)|Low resolution metrics (10s granularity at best)
35 +Monitors everything, **thousands of metrics per node**|Monitor just a few metrics
36 +UI is super fast, optimized for **anomaly detection**|UI is good for just an abstract view
37 +**Meaningful presentation** for all metrics (educational)|You have to know the metrics before you start
38 +Install and get results **immediately**|A long preparation is required to get any useful results
39 +Use it to **troubleshooting** performance problems|Use them to get statistics of past performance
40 +**Kills the console** for tracing performance issues|The console is required for troubleshooting
41 +Requires **zero dedicated resources**|Require dedicated resources
42
223 -- **NFS file servers and clients**<br/>
224 - NFS v2, v3, v4: I/O, cache, read ahead, RPC calls
43 +Netdata is **free**, super **fast**, very **easy**, completely **open**, **flexible** and integrate-able.
44 +It has been designed by **SysAdmins**, **DevOps** and **Developers** for troubleshooting performance problems, not just
45 +visualizing metrics.
46
226 -- **Network QoS**<br/>
227 - the only tool that visualizes network `tc` classes in realtime
47 +## Quick Start
48
229 - ![qos-tc-classes](https://cloud.githubusercontent.com/assets/2662304/14093004/68966020-f553-11e5-98fe-ffee2086fafd.gif)
49 +> **WARNING**:<br/>
50 +> People get adicted to **netdata**!
51 +> Once you install it and use it for a few minutes, **there is no going back**!
52
231 -- **Linux Control Groups**<br/>
232 - containers: systemd, lxc, docker
233 -
234 -- **Applications**<br/>
235 - by grouping the process tree and reporting CPU, memory, disk reads,
236 - disk writes, swap, threads, pipes, sockets - per group
237 -
238 - ![apps](https://cloud.githubusercontent.com/assets/2662304/14093565/67c4002c-f557-11e5-86bd-0154f5135def.gif)
239 -
240 -- **Users and User Groups resource usage**<br/>
241 - by summarizing the process tree per user and group,
242 - reporting: CPU, memory, disk reads, disk writes, swap, threads, pipes, sockets
243 -
244 -- **Apache and lighttpd web servers**<br/>
245 - `mod-status` (v2.2, v2.4) and cache log statistics, for multiple servers
246 -
247 -- **Nginx web servers**<br/>
248 - `stub-status`, for multiple servers
249 -
250 -- **Tomcat**<br/>
251 - accesses, threads, free memory, volume
252 -
253 -- **web server log files**<br/>
254 - extracting in real-time, web server performance metrics and applying several health checks
255 -
256 -- **mySQL databases**<br/>
257 - multiple servers, each showing: bandwidth, queries/s, handlers, locks, issues,
258 - tmp operations, connections, binlog metrics, threads, innodb metrics, and more
259 -
260 -- **Postgres databases**<br/>
261 - multiple servers, each showing: per database statistics (connections, tuples
262 - read - written - returned, transactions, locks), backend processes, indexes,
263 - tables, write ahead, background writer and more
264 -
265 -- **Redis databases**<br/>
266 - multiple servers, each showing: operations, hit rate, memory, keys, clients, slaves
267 -
268 -- **couchdb**<br/>
269 - reads/writes, request methods, status codes, tasks, replication, per-db, etc
270 -
271 -- **mongodb**<br/>
272 - operations, clients, transactions, cursors, connections, asserts, locks, etc
273 -
274 -- **memcached databases**<br/>
275 - multiple servers, each showing: bandwidth, connections, items
276 -
277 -- **elasticsearch**<br/>
278 - search and index performance, latency, timings, cluster statistics, threads statistics, etc
279 -
280 -- **ISC Bind name servers**<br/>
281 - multiple servers, each showing: clients, requests, queries, updates, failures and several per view metrics
282 -
283 -- **NSD name servers**<br/>
284 - queries, zones, protocols, query types, transfers, etc.
285 -
286 -- **PowerDNS**</br>
287 - queries, answers, cache, latency, etc.
288 -
289 -- **Postfix email servers**<br/>
290 - message queue (entries, size)
291 -
292 -- **exim email servers**<br/>
293 - message queue (emails queued)
294 -
295 -- **Dovecot** POP3/IMAP servers<br/>
296 -
297 -- **ISC dhcpd**<br/>
298 - pools utilization, leases, etc.
299 -
300 -- **IPFS**<br/>
301 - bandwidth, peers
302 -
303 -- **Squid proxy servers**<br/>
304 - multiple servers, each showing: clients bandwidth and requests, servers bandwidth and requests
305 -
306 -- **HAproxy**<br/>
307 - bandwidth, sessions, backends, etc
308 -
309 -- **varnish**<br/>
310 - threads, sessions, hits, objects, backends, etc
311 -
312 -- **OpenVPN**<br/>
313 - status per tunnel
314 -
315 -- **Hardware sensors**<br/>
316 - `lm_sensors` and `IPMI`: temperature, voltage, fans, power, humidity
317 -
318 -- **NUT and APC UPSes**<br/>
319 - load, charge, battery voltage, temperature, utility metrics, output metrics
320 -
321 -- **PHP-FPM**<br/>
322 - multiple instances, each reporting connections, requests, performance
323 -
324 -- **hddtemp**<br/>
325 - disk temperatures
326 -
327 -- **smartd**<br/>
328 - disk S.M.A.R.T. values
329 -
330 -- **SNMP devices**<br/>
331 - can be monitored too (although you will need to configure these)
332 -
333 -- **chrony**</br>
334 - frequencies, offsets, delays, etc.
335 -
336 -- **beanstalkd**</br>
337 - global and per tube monitoring
338 -
339 -- **statsd**<br/>
340 - [netdata is a fully featured statsd server](https://github.com/netdata/netdata/wiki/statsd)
341 -
342 -- **ceph**<br/>
343 - OSD usage, Pool usage, number of objects, etc.
344 -
345 -And you can extend it, by writing plugins that collect data from any source, using any computer language.
346 -
347 ----
348 -
349 -## netdata infographic
350 -
351 -This is a high level overview of netdata feature set and architecture.
352 -Click it to to interact with it (it has direct links to documentation).
353 -
354 -[![image](https://user-images.githubusercontent.com/2662304/47672043-a47eb480-dbb9-11e8-92a4-fa422d053309.png)](https://my-netdata.io/infographic.html)
355 -
356 ----
357 -
358 -## Installation
359 -
360 -Use our **[automatic installer](https://github.com/netdata/netdata/wiki/Installation)** to build and install it on your system.
361 -
362 -It should run on **any Linux** system (including IoT). It has been tested on:
363 -
364 -- Alpine
365 -- Arch Linux
366 -- CentOS
367 -- Debian
368 -- Fedora
369 -- Gentoo
370 -- openSUSE
371 -- PLD Linux
372 -- RedHat Enterprise Linux
373 -- SUSE
374 -- Ubuntu
375 -
376 ----
377 -
378 -## Interaction with netdata
379 -
380 -After installation, you can interact with netdata using **[CLI](https://github.com/netdata/netdata/wiki/Command-Line-Options)** and web dashboards.
381 -The default port of dashboard is 19999. To access the web dashboard on localhost, use: http://localhost:19999
382 -
383 ----
384 -
385 -## Documentation
386 -
387 -Check the **[netdata wiki](https://github.com/netdata/netdata/wiki)**.
388 -
389 -## License
390 -
391 -netdata is [GPLv3+](LICENSE).
392 -
393 -Netdata re-distributes other open-source tools and libraries. Please check the [third party licenses](https://github.com/netdata/netdata/blob/master/REDISTRIBUTED.md).
53 +You can quickly install netdata on a Linux server with the following:<br/>
54 +![](http://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) ![](http://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)
55 +
56 +```sh
57 +# make sure you run `bash` for your shell
58 +bash
59 +
60 +# install netdata, directly from github source
61 +bash <(curl -Ss https://my-netdata.io/kickstart.sh)
62 +```
63 +
64 +More installation methods can be found at the [installation page](https://github.com/netdata/netdata/wiki/Installation).
65 +
66 +Once the installation is complete, use your web browser to navigate to: `http://IP:19999/`, where `IP` is the IP of the server you installed Netdata.
67 +
68 +> **IMPORTANT:**<br/>
69 +> There is no need to bookmark your servers at your browser.
70 +> Check the `my-netdata` menu at the top left of the dashboard.
71 +> **It learns your servers automatically**, so that all your netdata become **one distributed application**!
72 +
73 +## User base
74 +*Docker pulls*<br/> [![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/)
75 +
76 +*Since May 16th 2016 (the date the [global public netdata registry](https://github.com/netdata/netdata/wiki/mynetdata-menu-item) was released):*<br/>[![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)
77 +
78 +*in the last 24 hours:*<br/> [![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)
79 +
80 +## News
81 +
82 +`Nov 6th, 2018` - **[netdata v1.11.0 released!](https://github.com/netdata/netdata/releases)**
83 +
84 + - New query engine, supporting statistical functions.
85 + - Fixed security issues identified by Red4Sec.com and Synacktiv.
86 + - New Data Collection Modules: `rethinkdbs`, `proxysql`, `litespeed`, `uwsgi`, `unbound`, `powerdns`, `dockerd`, `puppet`, `logind`, `adaptec_raid`, `megacli`, `spigotmc`, `boinc`, `w1sensor`, `monit`, `linux_power_supplies`.
87 + - Improved Data Collection Modules: `statsd.plugin`, `apps.plugin`, `freeipmi.plugin`, `proc.plugin`, `diskspace.plugin`, `freebsd.plugin`, `python.d.plugin`, `web_log`, `nginx_plus`, `ipfs`, `fail2ban`, `ceph`, `elasticsearch`, `nginx_plus`, `redis`,
88 + `beanstalk`, `mysql`, `varnish`, `couchdb`, `phpfpm`, `apache`, `icecast`, `mongodb`, `postgress`, `elasticsearch`, `mdstat`, `openvpn_log`, `snmp`, `nut`.
89 +
90 + - Added alarms for detecting abnormally high load average, `TCP` `SYN` and `TCP` accept queue overflows, network interfaces congestion and alarms for `bcache`, `mdstat`, `apcupsd`, `mysql`.
91 + - system alarms are now enabled on FreeBSD.
92 + - New notification methods: **rocket.chat**, **Microsoft Teams**, **syslog**, **fleep.io**, **Amazon SNS**.
93 +
94 + - and dozens more improvements, enhancements, features and compatibility fixes
95 +
96 +---
97 +
98 +`Sep 18, 2018` - **netdata has its own organization**
99 +
100 +Netdata used to be a [firehol.org](https://firehol.org) project, accessible as `firehol/netdata`.
101 +
102 +Netdata now has its own github organization `netdata`, so all github URLs are now `netdata/netdata`. The old github URLs, repo clones, forks, etc redirect automatically to the new repo.
103 +
104 +---
105 +
106 +![cncf](https://www.cncf.io/wp-content/uploads/2016/09/logo_cncf.png)
107 +
108 +`Jun 16, 2018` - **netdata in CNCF**
109 +
110 +Netdata is now at the [Cloud Native Computing Foundation (CNCF) landscape](https://landscape.cncf.io/grouping=no&sort=stars).
111 +
112 +Read the [netdata presentation](https://docs.google.com/presentation/d/18C8bCTbtgKDWqPa57GXIjB2PbjjpjsUNkLtZEz6YK8s/edit?usp=sharing) we gave at CNCF TOC on Sep 18, 2018.
113 +
114 +## Features
115 +
116 +<p align="center">
117 +<img src="https://cloud.githubusercontent.com/assets/2662304/19168687/f6a567be-8c19-11e6-8561-ce8d589e8346.gif"/>
118 +</p>
119 +
120 + - **Stunning interactive bootstrap dashboards**<br/>
121 + mouse and touch friendly, in 2 themes: dark, light
122 +
123 + - **Amazingly fast**<br/>
124 + responds to all queries in less than 0.5 ms per metric,
125 + even on low-end hardware
126 +
127 + - **Highly efficient**<br/>
128 + collects thousands of metrics per server per second,
129 + with just 1% CPU utilization of a single core, a few MB of RAM and no disk I/O at all
130 +
131 + - **Sophisticated alerting**<br/>
132 + hundreds of alarms, **out of the box**!<br/>
133 + supports dynamic thresholds, hysteresis, alarm templates,
134 + multiple role-based notification methods (such as email, slack.com, flock.com,
135 + pushover.net, pushbullet.com, telegram.org, twilio.com, messagebird.com, kavenegar.com)
136 +
137 + - **Extensible**<br/>
138 + you can monitor anything you can get a metric for,
139 + using its Plugin API (anything can be a netdata plugin,
140 + BASH, python, perl, node.js, java, Go, ruby, etc)
141 +
142 + - **Embeddable**<br/>
143 + it can run anywhere a Linux kernel runs (even IoT)
144 + and its charts can be embedded on your web pages too
145 +
146 + - **Customizable**<br/>
147 + custom dashboards can be built using simple HTML (no javascript necessary)
148 +
149 + - **Zero configuration**<br/>
150 + auto-detects everything, it can collect up to 5000 metrics
151 + per server out of the box
152 +
153 + - **Zero dependencies**<br/>
154 + it is even its own web server, for its static web files and its web API
155 +
156 + - **Zero maintenance**<br/>
157 + you just run it, it does the rest
158 +
159 + - **scales to infinity**<br/>
160 + requiring minimal central resources
161 +
162 + - **several operating modes**<br/>
163 + autonomous host monitoring, headless data collector, forwarding proxy, store and forward proxy, central multi-host monitoring, in all possible configurations.
164 + Each node may have different metrics retention policy and run with or without health monitoring.
165 +
166 + - **time-series back-ends supported**<br/>
167 + can archive its metrics on `graphite`, `opentsdb`, `prometheus`, json document DBs, in the same or lower detail
168 + (lower: to prevent it from congesting these servers due to the amount of data collected)
169 +
170 +![netdata](https://cloud.githubusercontent.com/assets/2662304/14092712/93b039ea-f551-11e5-822c-beadbf2b2a2e.gif)
171 +
172 +---
173 +
174 +## What does it monitor?
175 +
176 +netdata collects several thousands of metrics per device.
177 +All these metrics are collected and visualized in real-time.
178 +
179 +> _Almost all metrics are auto-detected, without any configuration._
180 +
181 +This is a list of what it currently monitors:
182 +
183 +- **CPU**<br/>
184 + usage, interrupts, softirqs, frequency, total and per core, CPU states
185 +
186 +- **Memory**<br/>
187 + RAM, swap and kernel memory usage, KSM (Kernel Samepage Merging), NUMA
188 +
189 +- **Disks**<br/>
190 + per disk: I/O, operations, backlog, utilization, space, software RAID (md)
191 +
192 + ![sda](https://cloud.githubusercontent.com/assets/2662304/14093195/c882bbf4-f554-11e5-8863-1788d643d2c0.gif)
193 +
194 +- **Network interfaces**<br/>
195 + per interface: bandwidth, packets, errors, drops
196 +
197 + ![dsl0](https://cloud.githubusercontent.com/assets/2662304/14093128/4d566494-f554-11e5-8ee4-5392e0ac51f0.gif)
198 +
199 +- **IPv4 networking**<br/>
200 + bandwidth, packets, errors, fragments,
201 + tcp: connections, packets, errors, handshake,
202 + udp: packets, errors,
203 + broadcast: bandwidth, packets,
204 + multicast: bandwidth, packets
205 +
206 +- **IPv6 networking**<br/>
207 + bandwidth, packets, errors, fragments, ECT,
208 + udp: packets, errors,
209 + udplite: packets, errors,
210 + broadcast: bandwidth,
211 + multicast: bandwidth, packets,
212 + icmp: messages, errors, echos, router, neighbor, MLDv2, group membership,
213 + break down by type
214 +
215 +- **Interprocess Communication - IPC**<br/>
216 + such as semaphores and semaphores arrays
217 +
218 +- **netfilter / iptables Linux firewall**<br/>
219 + connections, connection tracker events, errors
220 +
221 +- **Linux DDoS protection**<br/>
222 + SYNPROXY metrics
223 +
224 +- **fping** latencies</br>
225 + for any number of hosts, showing latency, packets and packet loss
226 +
227 + ![image](https://cloud.githubusercontent.com/assets/2662304/20464811/9517d2b4-af57-11e6-8361-f6cc57541cd7.png)
228 +
229 +
230 +- **Processes**<br/>
231 + running, blocked, forks, active
232 +
233 +- **Entropy**<br/>
234 + random numbers pool, using in cryptography
235 +
236 +- **NFS file servers and clients**<br/>
237 + NFS v2, v3, v4: I/O, cache, read ahead, RPC calls
238 +
239 +- **Network QoS**<br/>
240 + the only tool that visualizes network `tc` classes in realtime
241 +
242 + ![qos-tc-classes](https://cloud.githubusercontent.com/assets/2662304/14093004/68966020-f553-11e5-98fe-ffee2086fafd.gif)
243 +
244 +- **Linux Control Groups**<br/>
245 + containers: systemd, lxc, docker
246 +
247 +- **Applications**<br/>
248 + by grouping the process tree and reporting CPU, memory, disk reads,
249 + disk writes, swap, threads, pipes, sockets - per group
250 +
251 + ![apps](https://cloud.githubusercontent.com/assets/2662304/14093565/67c4002c-f557-11e5-86bd-0154f5135def.gif)
252 +
253 +- **Users and User Groups resource usage**<br/>
254 + by summarizing the process tree per user and group,
255 + reporting: CPU, memory, disk reads, disk writes, swap, threads, pipes, sockets
256 +
257 +- **Apache and lighttpd web servers**<br/>
258 + `mod-status` (v2.2, v2.4) and cache log statistics, for multiple servers
259 +
260 +- **Nginx web servers**<br/>
261 + `stub-status`, for multiple servers
262 +
263 +- **Tomcat**<br/>
264 + accesses, threads, free memory, volume
265 +
266 +- **web server log files**<br/>
267 + extracting in real-time, web server performance metrics and applying several health checks
268 +
269 +- **mySQL databases**<br/>
270 + multiple servers, each showing: bandwidth, queries/s, handlers, locks, issues,
271 + tmp operations, connections, binlog metrics, threads, innodb metrics, and more
272 +
273 +- **Postgres databases**<br/>
274 + multiple servers, each showing: per database statistics (connections, tuples
275 + read - written - returned, transactions, locks), backend processes, indexes,
276 + tables, write ahead, background writer and more
277 +
278 +- **Redis databases**<br/>
279 + multiple servers, each showing: operations, hit rate, memory, keys, clients, slaves
280 +
281 +- **couchdb**<br/>
282 + reads/writes, request methods, status codes, tasks, replication, per-db, etc
283 +
284 +- **mongodb**<br/>
285 + operations, clients, transactions, cursors, connections, asserts, locks, etc
286 +
287 +- **memcached databases**<br/>
288 + multiple servers, each showing: bandwidth, connections, items
289 +
290 +- **elasticsearch**<br/>
291 + search and index performance, latency, timings, cluster statistics, threads statistics, etc
292 +
293 +- **ISC Bind name servers**<br/>
294 + multiple servers, each showing: clients, requests, queries, updates, failures and several per view metrics
295 +
296 +- **NSD name servers**<br/>
297 + queries, zones, protocols, query types, transfers, etc.
298 +
299 +- **PowerDNS**</br>
300 + queries, answers, cache, latency, etc.
301 +
302 +- **Postfix email servers**<br/>
303 + message queue (entries, size)
304 +
305 +- **exim email servers**<br/>
306 + message queue (emails queued)
307 +
308 +- **Dovecot** POP3/IMAP servers<br/>
309 +
310 +- **ISC dhcpd**<br/>
311 + pools utilization, leases, etc.
312 +
313 +- **IPFS**<br/>
314 + bandwidth, peers
315 +
316 +- **Squid proxy servers**<br/>
317 + multiple servers, each showing: clients bandwidth and requests, servers bandwidth and requests
318 +
319 +- **HAproxy**<br/>
320 + bandwidth, sessions, backends, etc
321 +
322 +- **varnish**<br/>
323 + threads, sessions, hits, objects, backends, etc
324 +
325 +- **OpenVPN**<br/>
326 + status per tunnel
327 +
328 +- **Hardware sensors**<br/>
329 + `lm_sensors` and `IPMI`: temperature, voltage, fans, power, humidity
330 +
331 +- **NUT and APC UPSes**<br/>
332 + load, charge, battery voltage, temperature, utility metrics, output metrics
333 +
334 +- **PHP-FPM**<br/>
335 + multiple instances, each reporting connections, requests, performance
336 +
337 +- **hddtemp**<br/>
338 + disk temperatures
339 +
340 +- **smartd**<br/>
341 + disk S.M.A.R.T. values
342 +
343 +- **SNMP devices**<br/>
344 + can be monitored too (although you will need to configure these)
345 +
346 +- **chrony**</br>
347 + frequencies, offsets, delays, etc.
348 +
349 +- **beanstalkd**</br>
350 + global and per tube monitoring
351 +
352 +- **statsd**<br/>
353 + [netdata is a fully featured statsd server](https://github.com/netdata/netdata/wiki/statsd)
354 +
355 +- **ceph**<br/>
356 + OSD usage, Pool usage, number of objects, etc.
357 +
358 +And you can extend it, by writing plugins that collect data from any source, using any computer language.
359 +
360 +## netdata infographic
361 +
362 +This is a high level overview of netdata feature set and architecture.
363 +Click it to to interact with it (it has direct links to documentation).
364 +
365 +[![image](https://user-images.githubusercontent.com/2662304/47672043-a47eb480-dbb9-11e8-92a4-fa422d053309.png)](https://my-netdata.io/infographic.html)
366 +
367 +---
368 +
369 +## Installation
370 +
371 +Use our **[automatic installer](https://github.com/netdata/netdata/wiki/Installation)** to build and install it on your system.
372 +
373 +It should run on **any Linux** system (including IoT). It has been tested on:
374 +
375 +- Alpine
376 +- Arch Linux
377 +- CentOS
378 +- Debian
379 +- Fedora
380 +- Gentoo
381 +- openSUSE
382 +- PLD Linux
383 +- RedHat Enterprise Linux
384 +- SUSE
385 +- Ubuntu
386 +
387 +---
388 +
389 +## Documentation
390 +
391 +Check the **[netdata wiki](https://github.com/netdata/netdata/wiki)**.
392 +
393 +## License
394 +
395 +netdata is [GPLv3+](LICENSE).
396 +
397 +Netdata re-distributes other open-source tools and libraries. Please check the [third party licenses](https://github.com/netdata/netdata/blob/master/REDISTRIBUTED.md).
\ No newline at end of file