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