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