| 1 |
OVERVIEW |
|---|
| 2 |
-------- |
|---|
| 3 |
This directory contains shell and cgi scripts which maintain a |
|---|
| 4 |
database of sensor data and generate web pages containing |
|---|
| 5 |
graphs of sensor data. |
|---|
| 6 |
|
|---|
| 7 |
The RRD (Round Robin Database) package is REQUIRED. |
|---|
| 8 |
Get this package from |
|---|
| 9 |
http://oss.oetiker.ch/rrdtool |
|---|
| 10 |
|
|---|
| 11 |
A web server with CGI support is required. |
|---|
| 12 |
|
|---|
| 13 |
We have provided these scripts because the RRD package, |
|---|
| 14 |
while simple to build and install, is rather difficult |
|---|
| 15 |
to configure to store and display data. |
|---|
| 16 |
|
|---|
| 17 |
RRD, together with lm_sensors and these scripts, provide the |
|---|
| 18 |
following advantages: |
|---|
| 19 |
- True round-robin (constant-size) database |
|---|
| 20 |
- On-the-fly graph generation with CGI scripts |
|---|
| 21 |
- Multiple data views using single database |
|---|
| 22 |
- Automatic time stamping, interpolation of missing data, |
|---|
| 23 |
large data dropouts (during machine downtime) correctly |
|---|
| 24 |
shown on graphs |
|---|
| 25 |
|
|---|
| 26 |
If you are looking for something a little simpler, |
|---|
| 27 |
that does not require RRD, try ../tellerstats. |
|---|
| 28 |
|
|---|
| 29 |
The RRD scripts read /proc or /sys entries and do not use libsensors. |
|---|
| 30 |
Therefore the scale factors in /etc/sensors.conf are not used, |
|---|
| 31 |
and you may have to change the scale factors in the cgi scripts. |
|---|
| 32 |
|
|---|
| 33 |
|
|---|
| 34 |
WARNING! |
|---|
| 35 |
-------- |
|---|
| 36 |
The 'make install' script tries to make it easy for you but |
|---|
| 37 |
makes a lot of assumptions about your cron and web setup. |
|---|
| 38 |
If you have any concerns, do NOT run make install, and |
|---|
| 39 |
install the items by hand instead. |
|---|
| 40 |
|
|---|
| 41 |
|
|---|
| 42 |
INSTALLATION INSTRUCTIONS |
|---|
| 43 |
------------------------- |
|---|
| 44 |
|
|---|
| 45 |
- Make and install lm_sensors. Get it working (run 'sensors') |
|---|
| 46 |
before you try this! |
|---|
| 47 |
- Get RRD, make and install it |
|---|
| 48 |
- Edit the top of the Makefile. Do NOT skip this step. |
|---|
| 49 |
The defaults will probably not work for you. |
|---|
| 50 |
Here are the defaults: |
|---|
| 51 |
Cron user |
|---|
| 52 |
USER=httpd |
|---|
| 53 |
Path to rrdtool and rrdcgi |
|---|
| 54 |
RRDPATH=/usr/local/rrdtool/bin |
|---|
| 55 |
Place to install sens_update_rrd script |
|---|
| 56 |
BINPATH=/usr/local/bin |
|---|
| 57 |
Place to store the database |
|---|
| 58 |
RRDDIR=/var/lib/sensors-rrd |
|---|
| 59 |
Place to put the cgi script and the graphs |
|---|
| 60 |
APACHE=/usr/local/apache/htdocs |
|---|
| 61 |
APACHDIR=$(APACHE)/senspix |
|---|
| 62 |
The sensor device in your system |
|---|
| 63 |
(isa recommended over i2c if both are available) |
|---|
| 64 |
2.4 kernel - look in /proc/sys/dev/sensors: |
|---|
| 65 |
SENSDEV=w83781d-isa-0290 |
|---|
| 66 |
2.6 kernel up to 2.6.13 - look in /sys/i2c/bus/devices: |
|---|
| 67 |
SENSDEV=0-0290 |
|---|
| 68 |
2.6.14+ kernel - look in /sys/class/hwmon: |
|---|
| 69 |
SENSDEV=hwmon0 |
|---|
| 70 |
- make |
|---|
| 71 |
- (as root) make install, which does the following. |
|---|
| 72 |
If you don't want it to do this, install by hand!!! |
|---|
| 73 |
Creates a database |
|---|
| 74 |
Installs the data gathering script |
|---|
| 75 |
Installs the CGI script in your web server |
|---|
| 76 |
- Manually add the following line to the crontab for |
|---|
| 77 |
the user specified above, which will call the data gathering |
|---|
| 78 |
script every 5 minutes (adjust paths as necessary) |
|---|
| 79 |
*/5 * * * * /usr/local/bin/sens_update_rrd /var/lib/sensors-rrd/sensors.rrd w83781d-isa-0290 |
|---|
| 80 |
- Load http://localhost/senspix/sens_day.cgi in your web browser |
|---|
| 81 |
to test |
|---|
| 82 |
|
|---|
| 83 |
|
|---|
| 84 |
TROUBLESHOOTING |
|---|
| 85 |
--------------- |
|---|
| 86 |
RRD problems: See the RRD documentation |
|---|
| 87 |
|
|---|
| 88 |
Cron problems: check the cron logs, maybe your cron format |
|---|
| 89 |
is different or you need to signal the cron daemon? |
|---|
| 90 |
|
|---|
| 91 |
Unused sensors: remove appropriate sections from sens_*.cgi.in |
|---|
| 92 |
and remake and install. |
|---|
| 93 |
|
|---|
| 94 |
Sensor scaling factors incorrect (in3-in6): Edit lines in |
|---|
| 95 |
sens_*.cgi.in that start |
|---|
| 96 |
'CDEF:' to change the scale factor. |
|---|
| 97 |
|
|---|
| 98 |
CGI problems: Check the apache logs. If CGI is not enabled for |
|---|
| 99 |
the directory add a .htaccess file to the directory |
|---|
| 100 |
including the line |
|---|
| 101 |
Options ExecCGI |
|---|
| 102 |
|
|---|
| 103 |
Removing the "RRDTOOL / TOBI OETIKER" tag in RRD graphs: |
|---|
| 104 |
Comment out the line |
|---|
| 105 |
gator(gif, (int) im->xgif-5, 5); |
|---|
| 106 |
in src/rrd_graph.c in the RRD package. |
|---|
