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