Update README.md
Costa Tsaousis committed
Apr 17, 2014 at 23:38 UTC
54af621b695b54975b8bb2224289d947c55ab8ac
1 file changed
+24
-20
README.md
+24
-20
@@ -1,9 +1,21 @@
1
netdata
2
=======
3
4
-linux network traffic web monitoring
4
+linux real time system monitoring
5
6
-This little program will allow you to create embedable live monitoring charts on any web page.
6
+This program is a daemon that collects system information from /proc and other sources.
7
+It is heavily optimized and lightweight.
8
+
9
+It updates everything every second!
10
+But tt only needs a few microseconds (just a fraction of a millisecond) of one of your cores and a few megabytes of memory.
11
+
12
+If listens on port 19999 and it will give you a full featured web interface using google charts.
13
+
14
+Check it live at:
15
+
16
+http://www.tsaousis.gr:19999/
17
+
18
+Here is a screenshot:
19
20
21
@@ -14,8 +26,9 @@ This little program will allow you to create embedable live monitoring charts on
26
27
netdata:
28
17
- - reads /proc/net/dev and for every interface present there it keeps in its memory a short history of its received and sent bytes.
18
- - generates JSON HTTP responses containing all the data needed for the web graphs.
29
+ - reads several /proc files
30
+ - keeps track of the values in memroy (a short history)
31
+ - generates JSON and JSONP HTTP responses containing all the data needed for the web graphs
32
- is a web server. You can access JSON data by using:
33
34
```
@@ -47,7 +60,7 @@ This little program will allow you to create embedable live monitoring charts on
60
61
## Automatic installation
62
50
-1. Download everything in a directory inside your web server.
63
+1. Download the git.
64
2. cd to that directory
65
3. run:
66
@@ -55,14 +68,10 @@ This little program will allow you to create embedable live monitoring charts on
68
./netdata.start
69
```
70
58
-For this to work, you need to have persmission to create a directory in /run or /var/run or /tmp.
59
-If you run into problems, try to become root to verify it works. Please, do not run netdata are root permanently.
60
-Since netdata is a web server, the right thing to do, is to have a special user for it.
61
-
71
Once you run it, the file netdata.conf will be created. You can edit this file to set options for each graph.
72
To apply the changes you made, you have to run netdata.start again.
73
65
-To access the panel for all graphs, go to:
74
+To access the web site for all graphs, go to:
75
76
```
77
http://127.0.0.1:19999/
@@ -78,24 +87,20 @@ To access the panel for all graphs, go to:
87
step into the directory you downloaded everything and compile netdata
88
89
```sh
81
-gcc -Wall -O3 -o netdata netdata.c -lpthread
90
+gcc -Wall -O3 -o netdata netdata.c -lpthread -lz
91
```
92
93
### run netdata
94
Run netdata:
95
96
```sh
88
-./netdata -d -l 60 -u 1 -p 19999
97
+./netdata -u nobody -d -l 1200 -u 1 -p 19999
98
```
99
- -d says to go daemon mode
91
- - -l 60 says to keep 60 history entries
92
- - -u 1 says to add a new history entry every second
100
+ - -l 1200 says to keep 1200 history entries (20 minutes)
101
+ - -t 1 says to add a new history entry every second
102
- -p 19999 is the port to listen for web clients
94
-
95
-### edit index.html
96
-Set in index.html the interfaces you would like to monitor on the web page.
97
-
98
-** REMEMBER: there are 2 sections in index.html to edit. A javascript section and an HTML section. **
103
+ - -u nobody to run as nobody
104
105
### open a web browser
106
@@ -103,4 +108,3 @@ Set in index.html the interfaces you would like to monitor on the web page.
108
http://127.0.0.1:19999/
109
```
110
106
-