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