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