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