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