README.md

   1 # netdata [![Build Status](https://travis-ci.org/firehol/netdata.svg?branch=master)](https://travis-ci.org/firehol/netdata) [![Coverity Scan Build Status](https://scan.coverity.com/projects/9140/badge.svg)](https://scan.coverity.com/projects/firehol-netdata) [![Docker Pulls](https://img.shields.io/docker/pulls/titpetric/netdata.svg)](https://hub.docker.com/r/titpetric/netdata/)
   2
   3 > *New to netdata? Here is a live demo: [http://my-netdata.io](http://my-netdata.io)*
   4
   5 **netdata** is a system for **real-time performance and health monitoring**! It provides **unparalleled insights, in real-time, with interactive web dashboards**, of everything happening on the system it runs, including supported applications.
   6
   7 _netdata is designed to permanently run on all systems (**physical** & **virtual** servers, **containers**, **IoT** devices), without disrupting the applications running on them._
   8
   9 ---
  10
  11
  12 ## User base
  13
  14 netdata was publicly announced publicly on March 31st, 2016.
  15
  16 *Since May 16th 2016 (the time the [global public netdata registry](https://github.com/firehol/netdata/wiki/mynetdata-menu-item) was released):*
  17
  18 [![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/#menu_netdata_submenu_registry) [![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/#menu_netdata_submenu_registry) [![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/#menu_netdata_submenu_registry)
  19
  20 *in the last 24 hours:*
  21
  22 [![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/#menu_netdata_submenu_registry) [![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/#menu_netdata_submenu_registry) [![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/#menu_netdata_submenu_registry)
  23
  24 ---
  25
  26 ## News
  27
  28 <p align="center">
  29 <a href="https://octoverse.github.com/" target="_blank"><img src="https://cloud.githubusercontent.com/assets/2662304/18795170/ec321f32-81cb-11e6-92a8-d03492f0b00d.png"/></a>
  30 </p>
  31
  32 > `Oct 4th, 2016` - **[netdata v1.4.0 released!](https://github.com/firehol/netdata/releases)**
  33 >
  34 > - the **fastest** netdata ever (with a better look too)!
  35 > - improved **IoT** and **containers** support!
  36 > - **alarms** improved in almost every way!
  37 > - new plugins:  softnet netdev, extended TCP metrics, UDPLite, NFS v2, v3 client (server was there already), NFS v4 server & client, APCUPSd, RetroShare
  38 > - improved plugins: mysql, cgroups, hddtemp, sensors, phpfm, tc (QoS)
  39
  40 ---
  41
  42 ## At a glance
  43
  44 netdata:
  45 <p align="center">
  46 <img src="https://cloud.githubusercontent.com/assets/2662304/19168687/f6a567be-8c19-11e6-8561-ce8d589e8346.gif"/>
  47 </p>
  48
  49  - is **blazingly performance data visualization** - it responds to all queries in less than 0.5 ms per metric, even on low-end hardware!
  50  - is **highly efficient performance data collector** - it collects thousands of metrics per server per second, with just 1% CPU utilization of a single core on modern hardware!
  51  - has a **sophisticated alarming engine** - supporting dynamic thresholds, hysteresis, templating, multiple notification methods!
  52  - out of the box collects **2000+ metrics**!
  53  - needs **no configuration** - it auto-detects everything!
  54  - needs **zero maintenance**!
  55  - has **zero dependencies** - it is even its own web server!
  56  - **scales to infinity**, requiring minimal central resources!
  57
  58 ![netdata](https://cloud.githubusercontent.com/assets/2662304/14092712/93b039ea-f551-11e5-822c-beadbf2b2a2e.gif)
  59
  60 ---
  61
  62 ## Features
  63
  64 This is what you get:
  65
  66 - **Stunning bootstrap dashboards**, out of the box (theme-able: dark, light)
  67 - **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)
  68 - **Zero configuration** - you just install it and it auto-detects everything
  69 - **Zero dependencies**, it is even its own web server for its static web files and its web API
  70 - **Zero maintenance**, you just run it, it does the rest
  71 - **Custom dashboards** that can be built using simple HTML (no javascript necessary)
  72 - **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)
  73 - **Embeddable**, it can run anywhere a Linux kernel runs (even IoT) and its charts can be embedded on your web pages too
  74 - **Powerful alarms and notifications**, it can send alarms as email, slack.com messages, pushover.net mobile push notifications, telegram.org messages, and more.
  75
  76 ---
  77
  78 ## What does it monitor?
  79
  80 This is what it currently monitors (most with zero configuration):
  81
  82 - **CPU usage, interrupts, softirqs and frequency** (total and per core)
  83
  84 - **RAM, swap and kernel memory usage** (including KSM and kernel memory deduper)
  85
  86 - **Disks** (per disk: I/O, operations, backlog, utilization, space, etc)
  87
  88    ![sda](https://cloud.githubusercontent.com/assets/2662304/14093195/c882bbf4-f554-11e5-8863-1788d643d2c0.gif)
  89
  90 - **Network interfaces** (per interface: bandwidth, packets, errors, drops, etc)
  91
  92    ![dsl0](https://cloud.githubusercontent.com/assets/2662304/14093128/4d566494-f554-11e5-8ee4-5392e0ac51f0.gif)
  93
  94 - **IPv4 networking** (bandwidth, packets, errors, fragments, tcp: connections, packets, errors, handshake, udp: packets, errors, broadcast: bandwidth, packets, multicast: bandwidth, packets)
  95
  96 - **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)
  97
  98 - **netfilter / iptables Linux firewall** (connections, connection tracker events, errors, etc)
  99
 100 - **Linux DDoS protection** (SYNPROXY metrics)
 101
 102 - **Processes** (running, blocked, forks, active, etc)
 103
 104 - **Entropy** (random numbers pool, using in cryptography)
 105
 106 - **NFS file servers and clients**, v2, v3, v4 (I/O, cache, read ahead, RPC calls)
 107
 108 - **Network QoS** (yes, the only tool that visualizes network `tc` classes in realtime)
 109
 110    ![qos-tc-classes](https://cloud.githubusercontent.com/assets/2662304/14093004/68966020-f553-11e5-98fe-ffee2086fafd.gif)
 111
 112 - **Linux Control Groups** (containers), systemd, lxc, docker, etc
 113
 114 - **Applications**, by grouping the process tree (CPU, memory, disk reads, disk writes, swap, threads, pipes, sockets, etc)
 115
 116    ![apps](https://cloud.githubusercontent.com/assets/2662304/14093565/67c4002c-f557-11e5-86bd-0154f5135def.gif)
 117
 118 - **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)
 119
 120 - **Apache web servers** mod-status (v2.2, v2.4) and cache log statistics (multiple servers - compatible with lighttpd too)
 121
 122 - **Nginx web servers** stub-status (multiple servers)
 123
 124 - **mySQL databases** (multiple servers, each showing: bandwidth, queries/s, handlers, locks, issues, tmp operations, connections, binlog metrics, threads, innodb metrics, etc)
 125
 126 - **Redis databases** (multiple servers, each showing: operations, hit rate, memory, keys, clients, slaves)
 127
 128 - **memcached databases** (multiple servers, each showing: bandwidth, connections, items, etc)
 129
 130 - **ISC Bind name servers** (multiple servers, each showing: clients, requests, queries, updates, failures and several per view metrics)
 131
 132 - **Postfix email servers** message queue (entries, size)
 133
 134 - **exim email servers** message queue (emails queued)
 135
 136 - **IPFS** (Bandwidth, Peers)
 137
 138 - **Squid proxy servers** (multiple servers, each showing: clients bandwidth and requests, servers bandwidth and requests)
 139
 140 - **Hardware sensors** (temperature, voltage, fans, power, humidity, etc)
 141
 142 - **NUT and APC UPSes** (load, charge, battery voltage, temperature, utility metrics, output metrics)
 143
 144 - **Tomcat** (accesses, threads, free memory, volume)
 145
 146 - **PHP-FPM** (multiple instances, each reporting connections, requests, performance)
 147
 148 - **hddtemp** (disk temperatures)
 149
 150 - **SNMP devices** can be monitored too (although you will need to configure these)
 151
 152 And you can extend it, by writing plugins that collect data from any source, using any computer language.
 153
 154 ---
 155
 156 ## Installation
 157
 158 Use our **[automatic installer](https://github.com/firehol/netdata/wiki/Installation)** to build and install it on your system.
 159
 160 It should run on **any Linux** system (including IoT). It has been tested on:
 161
 162 - Alpine
 163 - Arch Linux
 164 - CentOS
 165 - Debian
 166 - Fedora
 167 - Gentoo
 168 - OpenSuse
 169 - PLD Linux
 170 - RedHat Enterprise Linux
 171 - SUSE
 172 - Ubuntu
 173
 174 ---
 175
 176 ## Documentation
 177
 178 Check the **[netdata wiki](https://github.com/firehol/netdata/wiki)**.
 179
 180 ## License
 181
 182 netdata is GPLv3+.
 183
 184 It re-distributes other open-source tools and libraries. Please check its [License Statement](https://github.com/firehol/netdata/blob/master/LICENSE.md).