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