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 **distributed 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, or 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    mouse and touch friendly, in 2 themes: 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 (such as a raspberry pi 1)
  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, a few MB or RAM and no disk I/O at all
  58
  59  - **Sophisticated alarming**<br/>
  60    supports dynamic thresholds, hysteresis, alarm templates,
  61    multiple role-based notification methods (such as slack.com, pushover.net, telegram.org, email)
  62
  63  - **Extensible**<br/>
  64    you can monitor anything you can get a metric for,
  65    using its Plugin API (anything can be a netdata plugin,
  66    BASH, python, perl, node.js, java, Go, ruby, etc)
  67
  68  - **Embeddable**<br/>
  69    it can run anywhere a Linux kernel runs (even IoT)
  70    and its charts can be embedded on your web pages too
  71
  72  - **Zero configuration**<br/>
  73    auto-detects everything, it can collect up to 5000 metrics
  74    per server out of the box
  75
  76  - **Zero dependencies**<br/>
  77    it is even its own web server, for its static web files and its web API
  78
  79  - **Zero maintenance**<br/>
  80    you just run it, it does the rest
  81
  82  - **Custom dashboards**<br/>
  83    that can be built using simple HTML (no javascript necessary)
  84
  85  - **scales to infinity**<br/>
  86    requiring minimal central resources
  87
  88 ![netdata](https://cloud.githubusercontent.com/assets/2662304/14092712/93b039ea-f551-11e5-822c-beadbf2b2a2e.gif)
  89
  90 ---
  91
  92 ## What does it monitor?
  93
  94 netdata monitors several thousands of metrics per device.
  95 All these metrics are collected and visualized in real-time.
  96
  97 > _Almost all metrics are auto-detected, without any configuration._
  98
  99 This is a list of what it currently monitors:
 100
 101 - **CPU**<br/>
 102   usage, interrupts, softirqs, frequency, total and per core
 103
 104 - **Memory**<br/>
 105   RAM, swap and kernel memory usage, including KSM the kernel memory deduper
 106
 107 - **Disks**<br/>
 108   per disk: I/O, operations, backlog, utilization, space
 109
 110    ![sda](https://cloud.githubusercontent.com/assets/2662304/14093195/c882bbf4-f554-11e5-8863-1788d643d2c0.gif)
 111
 112 - **Network interfaces**<br/>
 113   per interface: bandwidth, packets, errors, drops
 114
 115    ![dsl0](https://cloud.githubusercontent.com/assets/2662304/14093128/4d566494-f554-11e5-8ee4-5392e0ac51f0.gif)
 116
 117 - **IPv4 networking**<br/>
 118   bandwidth, packets, errors, fragments,
 119   tcp: connections, packets, errors, handshake,
 120   udp: packets, errors,
 121   broadcast: bandwidth, packets,
 122   multicast: bandwidth, packets
 123
 124 - **IPv6 networking**<br/>
 125   bandwidth, packets, errors, fragments, ECT,
 126   udp: packets, errors,
 127   udplite: packets, errors,
 128   broadcast: bandwidth,
 129   multicast: bandwidth, packets,
 130   icmp: messages, errors, echos, router, neighbor, MLDv2, group membership,
 131   break down by type
 132
 133 - **netfilter / iptables Linux firewall**<br/>
 134   connections, connection tracker events, errors
 135
 136 - **Linux DDoS protection**<br/>
 137   SYNPROXY metrics
 138
 139 - **Processes**<br/>
 140   running, blocked, forks, active
 141
 142 - **Entropy**<br/>
 143   random numbers pool, using in cryptography
 144
 145 - **NFS file servers and clients**<br/>
 146   NFS v2, v3, v4: I/O, cache, read ahead, RPC calls
 147
 148 - **Network QoS**<br/>
 149   the only tool that visualizes network `tc` classes in realtime
 150
 151    ![qos-tc-classes](https://cloud.githubusercontent.com/assets/2662304/14093004/68966020-f553-11e5-98fe-ffee2086fafd.gif)
 152
 153 - **Linux Control Groups**<br/>
 154   containers: systemd, lxc, docker
 155
 156 - **Applications**<br/>
 157   by grouping the process tree and reporting CPU, memory, disk reads,
 158   disk writes, swap, threads, pipes, sockets - per group
 159
 160    ![apps](https://cloud.githubusercontent.com/assets/2662304/14093565/67c4002c-f557-11e5-86bd-0154f5135def.gif)
 161
 162 - **Users and User Groups resource usage**<br/>
 163   by summarizing the process tree per user and group,
 164   reporting: CPU, memory, disk reads, disk writes, swap, threads, pipes, sockets
 165
 166 - **Apache and lighttpd web servers**<br/>
 167    `mod-status` (v2.2, v2.4) and cache log statistics, for multiple servers
 168
 169 - **Nginx web servers**<br/>
 170   `stub-status`, for multiple servers
 171
 172 - **Tomcat**<br/>
 173   accesses, threads, free memory, volume
 174
 175 - **mySQL databases**<br/>
 176   multiple servers, each showing: bandwidth, queries/s, handlers, locks, issues,
 177   tmp operations, connections, binlog metrics, threads, innodb metrics, and more
 178
 179 - **Redis databases**<br/>
 180   multiple servers, each showing: operations, hit rate, memory, keys, clients, slaves
 181
 182 - **memcached databases**<br/>
 183   multiple servers, each showing: bandwidth, connections, items
 184
 185 - **ISC Bind name servers**<br/>
 186   multiple servers, each showing: clients, requests, queries, updates, failures and several per view metrics
 187
 188 - **Postfix email servers**<br/>
 189   message queue (entries, size)
 190
 191 - **exim email servers**<br/>
 192   message queue (emails queued)
 193
 194 - **IPFS**<br/>
 195   bandwidth, peers
 196
 197 - **Squid proxy servers**<br/>
 198   multiple servers, each showing: clients bandwidth and requests, servers bandwidth and requests
 199
 200 - **Hardware sensors**<br/>
 201   temperature, voltage, fans, power, humidity
 202
 203 - **NUT and APC UPSes**<br/>
 204   load, charge, battery voltage, temperature, utility metrics, output metrics
 205
 206 - **PHP-FPM**<br/>
 207   multiple instances, each reporting connections, requests, performance
 208
 209 - **hddtemp**<br/>
 210   disk temperatures
 211
 212 - **SNMP devices**<br/>
 213   can be monitored too (although you will need to configure these)
 214
 215 And you can extend it, by writing plugins that collect data from any source, using any computer language.
 216
 217 ---
 218
 219 ## Installation
 220
 221 Use our **[automatic installer](https://github.com/firehol/netdata/wiki/Installation)** to build and install it on your system.
 222
 223 It should run on **any Linux** system (including IoT). It has been tested on:
 224
 225 - Alpine
 226 - Arch Linux
 227 - CentOS
 228 - Debian
 229 - Fedora
 230 - Gentoo
 231 - OpenSuse
 232 - PLD Linux
 233 - RedHat Enterprise Linux
 234 - SUSE
 235 - Ubuntu
 236
 237 ---
 238
 239 ## Documentation
 240
 241 Check the **[netdata wiki](https://github.com/firehol/netdata/wiki)**.
 242
 243 ## License
 244
 245 netdata is GPLv3+.
 246
 247 It re-distributes other open-source tools and libraries. Please check its [License Statement](https://github.com/firehol/netdata/blob/master/LICENSE.md).