README.md

   1 netdata
   2 =======
   3
   4 [Live Demo Site](http://netdata.firehol.org)
   5
   6
   7 ### Realtime time data collection and charts!
   8
   9 **Netdata** is a daemon that collects data in realtime (per second) and presents a web site to view and analyze them.
  10 The presentation is full of charts that precisely render all system values, in realtime.
  11
  12 It has been designed to be installed **on every system**, without desrupting it:
  13
  14 1. It will just use some spare CPU cycles.
  15
  16     Although it is very light weight, on slow processors you can futher control its CPU consumption by lowering its data collection frequency.
  17     By default it is running with the lowest possible linux priority.
  18
  19 2. It will use the memory you want it have.
  20
  21     Although we have made the most to make its memory footprint the smallest possible,
  22     you can further control the memory it will use, by sizing its round robin memory database.
  23
  24 3. It does not use disk I/O.
  25
  26     All its round robin database is in memory.
  27     It is only saved on disk and loaded back when netdata restarts.
  28     You can also disable the access log of its embedded web server, so that netdata will not use any I/O at all while running.
  29
  30
  31 You can use it to monitor all your applications, servers, linux PCs or linux embedded devices.
  32
  33 Out of the box, it comes with plugins for data collection about system information and popular applications.
  34
  35
  36 # Features
  37
  38 - **highly optimized C code**
  39
  40   It only needs a few milliseconds per second to collect all the data.
  41   It will nicelly run even on a raspberry pi with just one cpu core, or any other embedded system.
  42
  43 - **extremely lightweight**
  44
  45   It only needs a few megabytes of memory to store its round robin database.
  46
  47   Although `netdata` does all its calculation using `long double` (128 bit) arithmetics, it stores all values using a **custom-made 32-bit number**. This custom-made number can store in 29 bits values from -167772150000000.0 to  167772150000000.0 with a precision of 0.00001 (yes, it is a floating point number, meaning that higher integer values have less decimal precision) and 3 bits for flags. This provides an extremely optimized memory footprint with just 0.0001% max accuracy loss (run: `./netdata --unittest` to see it in action).
  48
  49   If your linux box has KSM enabled, netdata will give it all its round robbin database, to lower its memory requirements even further.
  50
  51 - **per second data collection**
  52
  53   Every chart, every value, is updated every second. Of course, you can control collection period per plugin.
  54
  55   **netdata** can perform several calculations on each value (dimension) collected:
  56
  57   - **absolute**, stores the collected value, as collected (this is used, for example for the number of processes running, the number of connections open, the amount of RAM used, etc)
  58
  59   - **incremental**, stores the difference of the collected value to the last collected value (this is used, for example, for the bandwidth of interfaces, disk I/O, i.e. for counters that always get incremented) - **netdata** automatically interpolates these values to second boundary, using nanosecond calculations so that small delays at the data collection layer will not affect the quality of the result - also, **netdata** detects arithmetic overflows and presents them properly at the charts.
  60
  61   - **percentage of absolute row**, stores the percentage of the collected value, over the sum of all dimensions of the chart.
  62
  63   - **percentage of incremental row**, stores the percentage of this collected value, over the sum of the the **incremental** differences of all dimensions of the chart (this is used, for example, for system CPU utilization).
  64
  65 - **visualizes QoS classes automatically**
  66
  67   If you also use FireQOS for QoS, it collects class names automatically.
  68
  69 - **appealing web site**
  70
  71   The web site uses bootstrap and the excellent [dygraphs](http://dygraphs.com), for a very appealing and responsive result.
  72   It works even on mobile devices and adapts to screen size changes and rotation (responsive design).
  73
  74 - **web charts do respect your browser resources**
  75
  76   The charts adapt to show only as many points are required to have a clear view.
  77   Also, the javascript code respects your browser resources (stops refreshing when the window looses focus, when something is selected, when charts are not in the visible viewport, etc).
  78
  79 - **highly configurable**
  80
  81   All charts and all features can be enabled or disabled.
  82   The program generates its configuration file based on the resources available on the system it runs, for you to edit.
  83
  84 - It reads and renders charts for all these:
  85  - `/proc/net/dev` (all netwrok interfaces for all their values)
  86  - `/proc/diskstats` (all disks for all their values)
  87  - `/proc/net/snmp` (total IPv4, TCP and UDP usage)
  88  - `/proc/net/netstat` (more IPv4 usage)
  89  - `/proc/net/stat/nf_conntrack` (connection tracking performance)
  90  - `/proc/net/ip_vs/stats` (IPVS connection statistics)
  91  - `/proc/stat` (CPU utilization)
  92  - `/proc/meminfo` (memory information)
  93  - `/proc/vmstat` (system performance)
  94  - `/proc/net/rpc/nfsd` (NFS server statistics for both v3 and v4 NFS)
  95  - `/proc/interrupts` (total and per core hardware interrupts)
  96  - `/proc/softirqs` (total and per core software interrupts)
  97  - `tc` classes (QoS classes - [with FireQOS class names](http://firehol.org/tutorial/fireqos-new-user/))
  98
  99 - It supports **plugins** for collecting information from other sources!
 100
 101   Plugins can be written in any computer language (pipe / stdout communication for data collection).
 102
 103   It ships with 2 plugins: `apps.plugin` and `charts.d.plugin`:
 104
 105  - `apps.plugin` is a plugin that attempts to collect statistics per process. It groups the entire process tree based on your settings (for example, mplayer, kodi, vlc are all considered `media`) and for each group it attempts to find CPU usage, memory usages, physical and logical disk read and writes, number of processes, number of threads, number of open files, number of open sockets, number of open pipes, minor and major page faults (major = swapping), etc. 15 stackable (per group) charts in total.
 106
 107  - `charts.d.plugin` provides a simple way to script data collection in BASH. It includes example plugins that collect values from:
 108
 109     - `nut` (UPS load, frequency, voltage, etc, for multiple UPSes)
 110     - `sensors` (temperature, voltage, current, power, humidity, fans rotation sensors)
 111     - `cpufreq` (current CPU clock frequency, for all CPUs)
 112     - `postfix` (e-mail queue size)
 113     - `squid` (web proxy statistics)
 114     - `mysql` (mysql global statistics)
 115     - `opensips` (opensips statistics)
 116
 117     Of course, you can write your own using BASH scripting.
 118
 119 - netdata is a web server, supporting gzip compression
 120
 121   It serves its own static files and dynamic files for rendering the site.
 122   It does not support authentication or SSL - limit its access using your firewall, or put it behind an authentication proxy.
 123   It does not allow ` .. ` in the files requested (so it can only serve files stored in the web directory `/usr/share/netdata/web`).
 124
 125
 126 # How it works
 127
 128 1. You run a daemon on your linux: netdata.
 129  This deamon is written in C and is extremely lightweight.
 130
 131  netdata:
 132
 133   - Spawns threads to collect all the data for all sources
 134   - Keeps track of the collected values in memory (no disk I/O at all)
 135   - Generates JSON and JSONP HTTP responses containing all the data needed for the web graphs
 136   - Is a standalone web server.
 137
 138  For example, you can access JSON data by using:
 139
 140  ```
 141
 142  http://netdata.firehol.org/api/v1/data?chart=net.eth0&after=-300&before=0&points=120&group=average&format=json
 143
 144  ```
 145
 146  The above will give you the last 300 seconds of traffic for eth0, aggregated in 120 points, grouped as averages, in json format.
 147
 148 2. If you need to embed a **netdata** chart on your web page, you can add a few javascript lines and a `div` for every graph you need. Check [this example](http://netdata.firehol.org/dashboard.html) (open it in a new tab and view its source to get the idea).
 149
 150 3. No internet access is required. Netdata is standalone.
 151
 152
 153 # Installation
 154
 155 ## Automatic installation
 156
 157 Before you start, make sure you have `zlib` development files installed.
 158
 159 You also need to have a basic build environment in place. You will need packages like
 160 `gcc`, `autoconf`, `autogen`, `automake`, `pgk-config`, etc.
 161
 162 To install them in debian/ubuntu, you need to run:
 163
 164 ```sh
 165 apt-get install zlib1g-dev gcc autoconf autogen automake pkg-config
 166 ```
 167
 168 Then do this to install and run netdata:
 169
 170 ```sh
 171
 172 # download it
 173 git clone https://github.com/firehol/netdata.git netdata.git
 174 cd netdata.git
 175
 176 # build it
 177 ./netdata-installer.sh
 178
 179 ```
 180
 181 The script `netdata-installer.sh` will build netdata and install it to your system.
 182
 183 Once the installer completes, the file `/etc/netdata/netdata.conf` will be created.
 184 You can edit this file to set options. To apply the changes you made, you have to restart netdata.
 185
 186 - You can start netdata by executing it with `/usr/sbin/netdata` (the installer will also start it).
 187
 188 - You can stop netdata by killing it with `killall netdata`.
 189     You can stop and start netdata at any point. Netdata saves on exit its round robbin
 190     database to `/var/cache/netdata` so that it will continue from where it stopped the last time.
 191
 192 To access the web site for all graphs, go to:
 193
 194  ```
 195  http://127.0.0.1:19999/
 196  ```
 197
 198 You can get the running config file at any time, by accessing `http://127.0.0.1:19999/netdata.conf`.
 199
 200 To start it at boot, just run `/usr/sbin/netdata` from your `/etc/rc.local` or equivalent.
 201