]> arthur.barton.de Git - netdata.git/blob - README.md
update README.md
[netdata.git] / README.md
1 # netdata
2
3 #### 180.000+ views, 50.000+ visitors, 15.000+ downloads, 8.000+ github stars, 400+ forks, 7 days!
4
5 And it still runs with 1.000+ 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
36
37 - **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)
38
39 - **Zero configuration** - you just install it and it autodetects everything
40
41 - **Zero dependencies**, it is its own web server for its static web files and its web API
42
43 - **Zero maintenance**, you just run it, it does the rest
44
45 - **Custom dashboards** that can be built using simple HTML (no javascript necessary)
46
47 - **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)
48
49 - **Embeddable**, it can run anywhere a Linux kernel runs and its charts can be embedded on your web pages too
50
51 ---
52
53 ## What does it monitor?
54
55 This is what it currently monitors (most with zero configuration):
56
57 - **CPU usage, interrupts, softirqs and frequency** (total and per core)
58
59 - **RAM, swap and kernel memory usage** (including KSM and kernel memory deduper)
60
61 - **Disks** (per disk: I/O, operations, backlog, utilization, etc)
62
63    ![sda](https://cloud.githubusercontent.com/assets/2662304/14093195/c882bbf4-f554-11e5-8863-1788d643d2c0.gif)
64
65 - **Network interfaces** (per interface: bandwidth, packets, errors, drops, etc)
66
67    ![dsl0](https://cloud.githubusercontent.com/assets/2662304/14093128/4d566494-f554-11e5-8ee4-5392e0ac51f0.gif)
68
69 - **IPv4 networking** (bandwidth, packets, errors, fragments, tcp: connections, packets, errors, handshake, udp: packets, errors, broadcast: bandwidth, packets, multicast: bandwidth, packets)
70
71 - **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)
72
73 - **netfilter / iptables Linux firewall** (connections, connection tracker events, errors, etc)
74
75 - **Linux anti-DDoS protection** (SYNPROXY metrics)
76
77 - **Processes** (running, blocked, forks, active, etc)
78
79 - **Entropy** (random numbers pool, using in cryptography)
80
81 - **NFS file servers**, v2, v3, v4 (I/O, cache, read ahead, RPC calls)
82
83 - **Network QoS** (yes, the only tool that visualizes network `tc` classes in realtime)
84
85    ![qos-tc-classes](https://cloud.githubusercontent.com/assets/2662304/14093004/68966020-f553-11e5-98fe-ffee2086fafd.gif)
86
87 - **Applications**, by grouping the process tree (CPU, memory, disk reads, disk writes, swap, threads, pipes, sockets, etc)
88
89    ![apps](https://cloud.githubusercontent.com/assets/2662304/14093565/67c4002c-f557-11e5-86bd-0154f5135def.gif)
90
91 - **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)
92
93 - **Apache web server** mod-status (v2.2, v2.4)
94
95 - **Nginx web server** stub-status
96
97 - **mySQL databases** (multiple servers, each showing: bandwidth, queries/s, handlers, locks, issues, tmp operations, connections, binlog metrics, threads, innodb metrics, etc)
98
99 - **ISC Bind name server** (multiple servers, each showing: clients, requests, queries, updates, failures and several per view metrics)
100
101 - **Postfix email server** message queue (entries, size)
102
103 - **Squid proxy server** (clients bandwidth and requests, servers bandwidth and requests) 
104
105 - **Hardware sensors** (temperature, voltage, fans, power, humidity, etc)
106
107 - **NUT UPSes** (load, charge, battery voltage, temperature, utility metrics, output metrics)
108
109 Any number of **SNMP devices** can be monitored, although you will need to configure these.
110
111 And you can extend it, by writing plugins that collect data from any source, using any computer language.
112
113 ---
114
115 ## Still not convinced?
116
117 Read **[Why netdata?](https://github.com/firehol/netdata/wiki/Why-netdata%3F)**
118
119 ---
120
121 ## Installation
122
123 Use our **[automatic installer](https://github.com/firehol/netdata/wiki/Installation)** to build and install it on your system
124
125 It should run on any Linux system. We have tested it on:
126
127 - Gentoo
128 - ArchLinux
129 - Ubuntu / Debian
130 - CentOS
131 - Fedora
132
133 ---
134
135 ## Documentation
136
137 Check the **[netdata wiki](https://github.com/firehol/netdata/wiki)**.
138
139
140 ## Git sources
141
142 You are looking at a version of the sources extracted directly from git.
143 If you want a version of the source package where `configure` and any
144 documentation has been built for you, please get an official
145 [netdata package download](https://firehol.org/download/netdata/).
146 The `unsigned/master` folder tracks the head of the git tree and
147 released packages are also available.
148