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