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