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