README.md

   1 netdata
   2 =======
   3
   4 linux real time system monitoring
   5
   6 This program is a daemon that collects system information from a linux system and presents a web site to view the data.
   7 This presentation is full of charts that precisely render all system values, in realtime, for a short time (1 hour by default).
   8
   9 # Features
  10
  11 - **highly optimized C code**
  12
  13   it only needs a few milliseconds per second to collect all the data.
  14
  15 - **extremely lightweight**
  16
  17   it only needs a few megabytes of memory to store all its round robin database.
  18
  19 - **per second data collection**
  20
  21   every chart, every value, is updated every second.
  22
  23 - **visualizes QoS classes automatically**
  24
  25   if you also use fireqos for QoS, it even collects class names automatically.
  26
  27 - **appealing web site**
  28
  29   the generated web site uses bootstrap and google charts for a very appealing result.
  30   it works even on mobile devices, adapts to screen size changes and rotation.
  31
  32 - **web charts do respect your browser resources**
  33
  34   the charts adapt to show only as many points are required to have a clear view.
  35
  36 - **highly configurable**
  37
  38   all charts and all features can be enabled or disabled.
  39
  40 - it reads and renders charts for all these:
  41  - `/proc/net/dev` (all netwrok interfaces for all their values)
  42  - `/proc/diskstats` (all disks for all their values)
  43  - `/proc/net/snmp` (total IPv4, TCP and UDP usage)
  44  - `/proc/net/netstat` (more IPv4 usage)
  45  - `/proc/net/stat/nf_conntrack` (connection tracking performance)
  46  - `/proc/net/ip_vs/stats` (IPVS connection statistics)
  47  - `/proc/stat` (CPU utilization)
  48  - `/proc/meminfo` (memory information)
  49  - `/proc/vmstat` (system performance)
  50  - `tc` classes (QoS classes)
  51
  52
  53 Check it live at:
  54
  55 http://www.tsaousis.gr:19999/
  56
  57 Here is a screenshot:
  58
  59 ![image](https://cloud.githubusercontent.com/assets/2662304/2593406/3c797e88-ba80-11e3-8ec7-c10174d59ad6.png)
  60
  61
  62 # How it works
  63
  64 1. You run a daemon on your linux: netdata.
  65  This deamon is written in C and is extremely lightweight.
  66
  67  netdata:
  68
  69   - reads several /proc files
  70   - keeps track of the values in memroy (a short history)
  71   - generates JSON and JSONP HTTP responses containing all the data needed for the web graphs
  72   - is a web server. You can access JSON data by using:
  73
  74  ```
  75  http://127.0.0.1:19999/data/net.eth0
  76  ```
  77
  78  This will give you the JSON file for traffic on eth0.
  79  The above is equivalent to:
  80
  81  ```
  82  http://127.0.0.1:19999/data/net.eth0/3600/1/average/0/0
  83  ```
  84
  85  where:
  86
  87   - 3600 is the number of entries to generate (3600 is a default which can be overwritten by -l).
  88   - 1 is grouping count, 1 = every single entry, 2 = half the entries, 3 = one every 3 entries, etc
  89   - `average` is the grouping method. It can also be `max`.
  90   - 0/0 they are `before` and `after` timestamps, allowing panning on the data
  91
  92
  93 2. On your web page, you add a few javascript lines and a DIV for every graph you need.
  94  Your browser will hit the web server to fetch the JSON data and refresh the graphs.
  95
  96 3. Graphs are generated using Google Charts API.
  97
  98
  99
 100 # Installation
 101
 102 ## Automatic installation
 103
 104 Before you start, make sure you have `zlib` development files installed.
 105 To install it in Ubuntu, you need to run:
 106
 107 ```sh
 108 apt-get install zlib1g-dev
 109 ```
 110
 111 Then do this to install and run netdata:
 112
 113 ```sh
 114 git clone https://github.com/ktsaou/netdata.git netdata
 115 cd netdata
 116 ./netdata.start
 117 ```
 118
 119 Once you run it, the file netdata.conf will be created. You can edit this file to set options for each graph.
 120 To apply the changes you made, you have to run netdata.start again.
 121
 122 To access the web site for all graphs, go to:
 123
 124  ```
 125  http://127.0.0.1:19999/
 126  ```
 127