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