]> arthur.barton.de Git - netdata.git/blob - README.md
Update README.md to include release URL (#131)
[netdata.git] / README.md
1 # netdata
2
3 **Real-time performance monitoring, done right!**
4
5 ![netdata](https://cloud.githubusercontent.com/assets/2662304/14092712/93b039ea-f551-11e5-822c-beadbf2b2a2e.gif)
6
7 ---
8
9 ## Git sources
10
11 You are looking at a version of the sources extracted directly from git.
12 If you want a version of the source package where `configure` and any
13 documentation has been built for you, please get an official
14 [netdata package download](https://firehol.org/download/netdata/).
15 The `unsigned/master` folder tracks the head of the git tree and
16 released packages are also available.
17
18 ## Features
19
20 **netdata** is a highly optimized Linux daemon providing **real-time performance monitoring for Linux systems, Applications, SNMP devices, over the web**!
21
22 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.
23
24 This is what you get:
25
26 1. **Beautiful out of the box** bootstrap dashboards
27 2. **Custom dashboards** that can be built using simple HTML (no javascript necessary)
28 3. **Blazingly fast** and **super efficient**, written in C (for default installations, expect just 2% of a single core CPU usage and a few MB of RAM)
29 3. **Zero configuration** - you just install it and it autodetects everything
30 4. **Zero dependencies**, it is its own web server for its static web files and its web API
31 4. **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)
32 7. **Embeddable**, it can run anywhere a Linux kernel runs
33
34 ---
35
36 ## What does it monitor?
37
38 This is what it currently monitors (most with zero configuration):
39
40 1. **CPU usage, interrupts, softirqs and frequency** (total and per core)
41 2. **RAM, swap and kernel memory usage** (including KSM and kernel memory deduper)
42 3. **Disk I/O** (per disk: bandwidth, operations, backlog, utilization, etc)
43
44    ![sda](https://cloud.githubusercontent.com/assets/2662304/14093195/c882bbf4-f554-11e5-8863-1788d643d2c0.gif)
45
46 4. **Network interfaces** (per interface: bandwidth, packets, errors, drops, etc)
47
48    ![dsl0](https://cloud.githubusercontent.com/assets/2662304/14093128/4d566494-f554-11e5-8ee4-5392e0ac51f0.gif)
49
50 5. **IPv4 networking** (packets, errors, fragments, tcp: connections, packets, errors, handshake, udp: packets, errors, broadcast: bandwidth, packets, multicast: bandwidth, packets)
51 6. **netfilter / iptables Linux firewall** (connections, connection tracker events, errors, etc)
52 7. **Processes** (running, blocked, forks, active, etc)
53 8. **Entropy**
54 9. **NFS file servers**, v2, v3, v4 (I/O, cache, read ahead, RPC calls)
55 10. **Network QoS** (yes, the only tool that visualizes network `tc` classes in realtime)
56
57    ![qos-tc-classes](https://cloud.githubusercontent.com/assets/2662304/14093004/68966020-f553-11e5-98fe-ffee2086fafd.gif)
58
59
60 11. **Applications**, by grouping the process tree (CPU, memory, disk reads, disk writes, swap, threads, pipes, sockets, etc)
61
62    ![apps](https://cloud.githubusercontent.com/assets/2662304/14093565/67c4002c-f557-11e5-86bd-0154f5135def.gif)
63
64 12. **Apache web server** mod-status (v2.2, v2.4)
65 13. **Nginx web server** stub-status
66 14. **mySQL databases** (multiple servers, each showing: bandwidth, queries/s, handlers, locks, issues, tmp operations, connections, binlog metrics, threads, innodb metrics, etc)
67 15. **ISC Bind name server** (multiple servers, each showing: clients, requests, queries, updates, failures and several per view metrics)
68 16. **Postfix email server** message queue (entries, size)
69 17. **Squid proxy server** (clients bandwidth and requests, servers bandwidth and requests) 
70 18. **Hardware sensors** (temperature, voltage, fans, power, humidity, etc)
71 19. **NUT UPSes** (load, charge, battery voltage, temperature, utility metrics, output metrics)
72
73 Any number of **SNMP devices** can be monitored, although you will need to configure these.
74
75 And you can extend it, by writing plugins that collect data from any source, using any computer language.
76
77 ---
78
79 ## Still not convinced?
80
81 Read **[Why netdata?](https://github.com/firehol/netdata/wiki/Why-netdata%3F)**
82
83 ---
84
85 ## Installation
86
87 Use our **[automatic installer](https://github.com/firehol/netdata/wiki/Installation)** to build and install it on your system
88
89 It should run on any Linux system. We have tested it on:
90
91 - Gentoo
92 - ArchLinux
93 - Ubuntu / Debian
94 - CentOS
95 - Fedora
96
97 ---
98
99 ## Documentation
100
101 Check the **[netdata wiki](https://github.com/firehol/netdata/wiki)**.
102