README.md

   1 [![Build Status](https://travis-ci.org/firehol/netdata.svg?branch=master)](https://travis-ci.org/firehol/netdata)
   2 <a href="https://scan.coverity.com/projects/firehol-netdata"><img alt="Coverity Scan Build Status" src="https://scan.coverity.com/projects/9140/badge.svg"/></a>
   3 [![Docker Pulls](https://img.shields.io/docker/pulls/titpetric/netdata.svg)](https://hub.docker.com/r/titpetric/netdata/)
   4
   5 [![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)
   6 [![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)
   7 [![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)
   8
   9 [![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)
  10 [![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)
  11 [![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)
  12
  13
  14 # netdata
  15
  16 > Oct 4th, 2016
  17 >
  18 > [netdata v1.4.0 released!](https://github.com/firehol/netdata/releases)
  19 >
  20 > - the fastest netdata ever (with a better look too)!
  21 > - improved IoT and containers support!
  22 > - alarms improved in almost every way!
  23 > - new plugins:  softnet netdev, extended TCP metrics, UDPLite, NFS v2, v3 client (server was there already), NFS v4 server & client, APCUPSd, RetroShare
  24 > - improved plugins: mysql, cgroups, hddtemp, sensors, phpfm, tc (QoS)
  25
  26 ---
  27
  28 > Aug 28th, 2016
  29 >
  30 > [netdata v1.3.0 released!](https://github.com/firehol/netdata/releases)
  31 >
  32 > - netdata has **[health monitoring / alarms](https://github.com/firehol/netdata/wiki/health-monitoring)**!
  33 > - netdata **[generates badges](https://github.com/firehol/netdata/wiki/Generating-Badges)** that can be embeded anywhere!
  34 > - netdata plugins are now written in python!
  35 > - new plugins: redis, memcached, nginx_log, ipfs, apache_cache
  36
  37 ---
  38
  39 **Real-time performance and health monitoring, done right!**
  40
  41 This is the default dashboard of **netdata**:
  42
  43  - real-time, per second updates, snappy refreshes!
  44  - 300+ charts out of the box, 2000+ metrics monitored!
  45  - zero configuration, zero maintenance, zero dependencies!
  46  - dozens of health monitoring alarms, out of the box!
  47
  48 Live demo: [http://my-netdata.io](http://my-netdata.io)
  49
  50 ![netdata](https://cloud.githubusercontent.com/assets/2662304/14092712/93b039ea-f551-11e5-822c-beadbf2b2a2e.gif)
  51
  52 ---
  53
  54 ## Features
  55
  56 **netdata** is a highly optimized Linux daemon providing **real-time performance monitoring for Linux systems, Applications, SNMP devices, over the web**!
  57
  58 It tries to visualize the **truth of now**, in its **greatest detail**, so that you can get insights of what is happening now and what just happened, on your systems and applications.
  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 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
  71 ---
  72
  73 ## What does it monitor?
  74
  75 This is what it currently monitors (most with zero configuration):
  76
  77 - **CPU usage, interrupts, softirqs and frequency** (total and per core)
  78
  79 - **RAM, swap and kernel memory usage** (including KSM and kernel memory deduper)
  80
  81 - **Disks** (per disk: I/O, operations, backlog, utilization, space, etc)
  82
  83    ![sda](https://cloud.githubusercontent.com/assets/2662304/14093195/c882bbf4-f554-11e5-8863-1788d643d2c0.gif)
  84
  85 - **Network interfaces** (per interface: bandwidth, packets, errors, drops, etc)
  86
  87    ![dsl0](https://cloud.githubusercontent.com/assets/2662304/14093128/4d566494-f554-11e5-8ee4-5392e0ac51f0.gif)
  88
  89 - **IPv4 networking** (bandwidth, packets, errors, fragments, tcp: connections, packets, errors, handshake, udp: packets, errors, broadcast: bandwidth, packets, multicast: bandwidth, packets)
  90
  91 - **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)
  92
  93 - **netfilter / iptables Linux firewall** (connections, connection tracker events, errors, etc)
  94
  95 - **Linux DDoS protection** (SYNPROXY metrics)
  96
  97 - **Processes** (running, blocked, forks, active, etc)
  98
  99 - **Entropy** (random numbers pool, using in cryptography)
 100
 101 - **NFS file servers and clients**, v2, v3, v4 (I/O, cache, read ahead, RPC calls)
 102
 103 - **Network QoS** (yes, the only tool that visualizes network `tc` classes in realtime)
 104
 105    ![qos-tc-classes](https://cloud.githubusercontent.com/assets/2662304/14093004/68966020-f553-11e5-98fe-ffee2086fafd.gif)
 106
 107 - **Linux Control Groups** (containers), systemd, lxc, docker, etc
 108
 109 - **Applications**, by grouping the process tree (CPU, memory, disk reads, disk writes, swap, threads, pipes, sockets, etc)
 110
 111    ![apps](https://cloud.githubusercontent.com/assets/2662304/14093565/67c4002c-f557-11e5-86bd-0154f5135def.gif)
 112
 113 - **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)
 114
 115 - **Apache web servers** mod-status (v2.2, v2.4) and cache log statistics (multiple servers - compatible with lighttpd too)
 116
 117 - **Nginx web servers** stub-status (multiple servers)
 118
 119 - **mySQL databases** (multiple servers, each showing: bandwidth, queries/s, handlers, locks, issues, tmp operations, connections, binlog metrics, threads, innodb metrics, etc)
 120
 121 - **Redis databases** (multiple servers, each showing: operations, hit rate, memory, keys, clients, slaves)
 122
 123 - **memcached databases** (multiple servers, each showing: bandwidth, connections, items, etc)
 124
 125 - **ISC Bind name servers** (multiple servers, each showing: clients, requests, queries, updates, failures and several per view metrics)
 126
 127 - **Postfix email servers** message queue (entries, size)
 128
 129 - **exim email servers** message queue (emails queued)
 130
 131 - **IPFS** (Bandwidth, Peers)
 132
 133 - **Squid proxy servers** (multiple servers, each showing: clients bandwidth and requests, servers bandwidth and requests)
 134
 135 - **Hardware sensors** (temperature, voltage, fans, power, humidity, etc)
 136
 137 - **NUT and APC UPSes** (load, charge, battery voltage, temperature, utility metrics, output metrics)
 138
 139 - **Tomcat** (accesses, threads, free memory, volume)
 140
 141 - **PHP-FPM** (multiple instances, each reporting connections, requests, performance)
 142
 143 - **hddtemp** (disk temperatures)
 144
 145 - **SNMP devices** can be monitored too (although you will need to configure these)
 146
 147 And you can extend it, by writing plugins that collect data from any source, using any computer language.
 148
 149 ---
 150
 151 ## Installation
 152
 153 Use our **[automatic installer](https://github.com/firehol/netdata/wiki/Installation)** to build and install it on your system
 154
 155 It should run on **any Linux** system. It has been tested on:
 156
 157 - Gentoo
 158 - Arch Linux
 159 - Ubuntu / Debian
 160 - CentOS
 161 - Fedora
 162 - RedHat Enterprise Linux
 163 - SUSE
 164 - Alpine Linux
 165 - PLD Linux
 166
 167 ---
 168
 169 ## Documentation
 170
 171 Check the **[netdata wiki](https://github.com/firehol/netdata/wiki)**.