]> arthur.barton.de Git - netdata.git/blob - README.md
Merge remote-tracking branch 'upstream/master' into registry
[netdata.git] / README.md
1 # netdata
2
3 ##### 320.000+ views, 92.000+ visitors, 28.500+ downloads, 11.000+ github stars, 700+ forks, 1 month!
4
5 And it still runs with 600+ git downloads... per day!
6
7 **[Check what our users say about netdata](https://github.com/firehol/netdata/issues/148)**.
8
9 Thank you!
10
11 ---
12
13 **Real-time performance monitoring, done right!**
14
15 This is the default dashboard of **netdata**:
16
17  - real-time, per second updates, snappy refreshes!
18  - 300+ charts out of the box, 2000+ metrics monitored!
19  - zero configuration, zero maintenance, zero dependencies!
20
21 Live demo: [http://netdata.firehol.org](http://netdata.firehol.org)
22
23 ![netdata](https://cloud.githubusercontent.com/assets/2662304/14092712/93b039ea-f551-11e5-822c-beadbf2b2a2e.gif)
24
25 ---
26
27 ## Features
28
29 **netdata** is a highly optimized Linux daemon providing **real-time performance monitoring for Linux systems, Applications, SNMP devices, over the web**!
30
31 It tries to visualize the **truth of now**, in its **greatest detail**, so that you can get insights of what is happening now and what just happened, on your systems and applications.
32
33 This is what you get:
34
35 - **Stunning bootstrap dashboards**, out of the box (themable: dark, light)
36 - **Blazingly fast** and **super efficient**, mostly written in C (for default installations, expect just 2% of a single core CPU usage and a few MB of RAM)
37 - **Zero configuration** - you just install it and it autodetects everything
38 - **Zero dependencies**, it is its own web server for its static web files and its web API
39 - **Zero maintenance**, you just run it, it does the rest
40 - **Custom dashboards** that can be built using simple HTML (no javascript necessary)
41 - **Extensible**, you can monitor anything you can get a metric for, using its Plugin API (anything can be a netdata plugin - from BASH to node.js, so you can easily monitor any application, any API)
42 - **Embeddable**, it can run anywhere a Linux kernel runs and its charts can be embedded on your web pages too
43
44 ---
45
46 ## What does it monitor?
47
48 This is what it currently monitors (most with zero configuration):
49
50 - **CPU usage, interrupts, softirqs and frequency** (total and per core)
51
52 - **RAM, swap and kernel memory usage** (including KSM and kernel memory deduper)
53
54 - **Disks** (per disk: I/O, operations, backlog, utilization, etc)
55
56    ![sda](https://cloud.githubusercontent.com/assets/2662304/14093195/c882bbf4-f554-11e5-8863-1788d643d2c0.gif)
57
58 - **Network interfaces** (per interface: bandwidth, packets, errors, drops, etc)
59
60    ![dsl0](https://cloud.githubusercontent.com/assets/2662304/14093128/4d566494-f554-11e5-8ee4-5392e0ac51f0.gif)
61
62 - **IPv4 networking** (bandwidth, packets, errors, fragments, tcp: connections, packets, errors, handshake, udp: packets, errors, broadcast: bandwidth, packets, multicast: bandwidth, packets)
63
64 - **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)
65
66 - **netfilter / iptables Linux firewall** (connections, connection tracker events, errors, etc)
67
68 - **Linux DDoS protection** (SYNPROXY metrics)
69
70 - **Processes** (running, blocked, forks, active, etc)
71
72 - **Entropy** (random numbers pool, using in cryptography)
73
74 - **NFS file servers**, v2, v3, v4 (I/O, cache, read ahead, RPC calls)
75
76 - **Network QoS** (yes, the only tool that visualizes network `tc` classes in realtime)
77
78    ![qos-tc-classes](https://cloud.githubusercontent.com/assets/2662304/14093004/68966020-f553-11e5-98fe-ffee2086fafd.gif)
79
80 - **Linux Control Groups** (containers), systemd, lxc, docker, etc
81
82 - **Applications**, by grouping the process tree (CPU, memory, disk reads, disk writes, swap, threads, pipes, sockets, etc)
83
84    ![apps](https://cloud.githubusercontent.com/assets/2662304/14093565/67c4002c-f557-11e5-86bd-0154f5135def.gif)
85
86 - **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)
87
88 - **Apache web server** mod-status (v2.2, v2.4)
89
90 - **Nginx web server** stub-status
91
92 - **mySQL databases** (multiple servers, each showing: bandwidth, queries/s, handlers, locks, issues, tmp operations, connections, binlog metrics, threads, innodb metrics, etc)
93
94 - **ISC Bind name server** (multiple servers, each showing: clients, requests, queries, updates, failures and several per view metrics)
95
96 - **Postfix email server** message queue (entries, size)
97
98 - **Squid proxy server** (clients bandwidth and requests, servers bandwidth and requests) 
99
100 - **Hardware sensors** (temperature, voltage, fans, power, humidity, etc)
101
102 - **NUT UPSes** (load, charge, battery voltage, temperature, utility metrics, output metrics)
103
104 - **Tomcat** (accesses, threads, free memory, volume)
105
106 - **PHP-FPM** (multiple instances, each reporting connections, requests, performance)
107
108 - **SNMP devices** can be monitored too (although you will need to configure these)
109
110 And you can extend it, by writing plugins that collect data from any source, using any computer language.
111
112 ---
113
114 ## Still not convinced?
115
116 Read **[Why netdata?](https://github.com/firehol/netdata/wiki/Why-netdata%3F)**
117
118 ---
119
120 ## Installation
121
122 Use our **[automatic installer](https://github.com/firehol/netdata/wiki/Installation)** to build and install it on your system
123
124 It should run on **any Linux** system. It has been tested on:
125
126 - Gentoo
127 - Arch Linux
128 - Ubuntu / Debian
129 - CentOS
130 - Fedora
131 - RedHat Enterprise Linux
132 - SUSE
133 - Alpine Linux
134 - PLD Linux
135
136 ---
137
138 ## Documentation
139
140 Check the **[netdata wiki](https://github.com/firehol/netdata/wiki)**.
141
142
143 [![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/firehol/netdata/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
144