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, with interactive web dashboards**, of everything happening on the system it runs, including key applications, such as web servers and database servers.
   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 functions._
   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 ## Features
  39
  40 <p align="center">
  41 <img src="https://cloud.githubusercontent.com/assets/2662304/19168687/f6a567be-8c19-11e6-8561-ce8d589e8346.gif"/>
  42 </p>
  43
  44  - **Stunning interactive bootstrap dashboards**<br/>2 themes are provided: dark, light
  45  - **Blazingly fast visualization**<br/>responds to all queries in less than 0.5 ms per metric, even on low-end hardware
  46  - **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
  47  - **Sophisticated alarming**<br/>supports dynamic thresholds, hysteresis, templating, multiple notification methods
  48  - **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)
  49  - **Zero configuration**<br/>auto-detects everything, out of the box it can detect up to 5000 metrics per server
  50  - **Zero dependencies**<br/>it is even its own web server, for its static web files and its web API
  51  - **Zero maintenance**<br/>you just run it, it does the rest
  52  - **Embeddable**<br/>it can run anywhere a Linux kernel runs (even IoT) and its charts can be embedded on your web pages too
  53  - **Custom dashboards**<br/>that can be built using simple HTML (no javascript necessary)
  54  - **scales to infinity**<br/>requiring minimal central resources!
  55
  56 ![netdata](https://cloud.githubusercontent.com/assets/2662304/14092712/93b039ea-f551-11e5-822c-beadbf2b2a2e.gif)
  57
  58 ---
  59
  60 ## What does it monitor?
  61
  62 This is what it currently monitors (most with zero configuration):
  63
  64 - **CPU usage, interrupts, softirqs and frequency** (total and per core)
  65
  66 - **RAM, swap and kernel memory usage** (including KSM and kernel memory deduper)
  67
  68 - **Disks** (per disk: I/O, operations, backlog, utilization, space, etc)
  69
  70    ![sda](https://cloud.githubusercontent.com/assets/2662304/14093195/c882bbf4-f554-11e5-8863-1788d643d2c0.gif)
  71
  72 - **Network interfaces** (per interface: bandwidth, packets, errors, drops, etc)
  73
  74    ![dsl0](https://cloud.githubusercontent.com/assets/2662304/14093128/4d566494-f554-11e5-8ee4-5392e0ac51f0.gif)
  75
  76 - **IPv4 networking** (bandwidth, packets, errors, fragments, tcp: connections, packets, errors, handshake, udp: packets, errors, broadcast: bandwidth, packets, multicast: bandwidth, packets)
  77
  78 - **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)
  79
  80 - **netfilter / iptables Linux firewall** (connections, connection tracker events, errors, etc)
  81
  82 - **Linux DDoS protection** (SYNPROXY metrics)
  83
  84 - **Processes** (running, blocked, forks, active, etc)
  85
  86 - **Entropy** (random numbers pool, using in cryptography)
  87
  88 - **NFS file servers and clients**, v2, v3, v4 (I/O, cache, read ahead, RPC calls)
  89
  90 - **Network QoS** (yes, the only tool that visualizes network `tc` classes in realtime)
  91
  92    ![qos-tc-classes](https://cloud.githubusercontent.com/assets/2662304/14093004/68966020-f553-11e5-98fe-ffee2086fafd.gif)
  93
  94 - **Linux Control Groups** (containers), systemd, lxc, docker, etc
  95
  96 - **Applications**, by grouping the process tree (CPU, memory, disk reads, disk writes, swap, threads, pipes, sockets, etc)
  97
  98    ![apps](https://cloud.githubusercontent.com/assets/2662304/14093565/67c4002c-f557-11e5-86bd-0154f5135def.gif)
  99
 100 - **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)
 101
 102 - **Apache web servers** mod-status (v2.2, v2.4) and cache log statistics (multiple servers - compatible with lighttpd too)
 103
 104 - **Nginx web servers** stub-status (multiple servers)
 105
 106 - **mySQL databases** (multiple servers, each showing: bandwidth, queries/s, handlers, locks, issues, tmp operations, connections, binlog metrics, threads, innodb metrics, etc)
 107
 108 - **Redis databases** (multiple servers, each showing: operations, hit rate, memory, keys, clients, slaves)
 109
 110 - **memcached databases** (multiple servers, each showing: bandwidth, connections, items, etc)
 111
 112 - **ISC Bind name servers** (multiple servers, each showing: clients, requests, queries, updates, failures and several per view metrics)
 113
 114 - **Postfix email servers** message queue (entries, size)
 115
 116 - **exim email servers** message queue (emails queued)
 117
 118 - **IPFS** (Bandwidth, Peers)
 119
 120 - **Squid proxy servers** (multiple servers, each showing: clients bandwidth and requests, servers bandwidth and requests)
 121
 122 - **Hardware sensors** (temperature, voltage, fans, power, humidity, etc)
 123
 124 - **NUT and APC UPSes** (load, charge, battery voltage, temperature, utility metrics, output metrics)
 125
 126 - **Tomcat** (accesses, threads, free memory, volume)
 127
 128 - **PHP-FPM** (multiple instances, each reporting connections, requests, performance)
 129
 130 - **hddtemp** (disk temperatures)
 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 ## Installation
 139
 140 Use our **[automatic installer](https://github.com/firehol/netdata/wiki/Installation)** to build and install it on your system.
 141
 142 It should run on **any Linux** system (including IoT). It has been tested on:
 143
 144 - Alpine
 145 - Arch Linux
 146 - CentOS
 147 - Debian
 148 - Fedora
 149 - Gentoo
 150 - OpenSuse
 151 - PLD Linux
 152 - RedHat Enterprise Linux
 153 - SUSE
 154 - Ubuntu
 155
 156 ---
 157
 158 ## Documentation
 159
 160 Check the **[netdata wiki](https://github.com/firehol/netdata/wiki)**.
 161
 162 ## License
 163
 164 netdata is GPLv3+.
 165
 166 It re-distributes other open-source tools and libraries. Please check its [License Statement](https://github.com/firehol/netdata/blob/master/LICENSE.md).