ViewVC Help
View File | Revision Log | Show Annotations | Revision Graph | Root Listing
root/i-scream/projects/cms/source/reports/rrdgraphing/graph.pl
Revision: 1.7
Committed: Thu Jun 20 13:46:54 2002 UTC (22 years, 3 months ago) by tdb
Content type: text/plain
Branch: MAIN
Changes since 1.6: +48 -30 lines
Log Message:
Added values to the legend for "latest, average, min, and max". It's a bit
hard to make it look neat, rrd's features are limited. Also need to suss
out rounding etc.

File Contents

# User Rev Content
1 tdb 1.1 #!/usr/bin/perl -w
2    
3 tdb 1.2 #
4     # i-scream central monitoring system
5     # Copyright (C) 2000-2002 i-scream
6     #
7     # This program is free software; you can redistribute it and/or
8     # modify it under the terms of the GNU General Public License
9     # as published by the Free Software Foundation; either version 2
10     # of the License, or (at your option) any later version.
11     #
12     # This program is distributed in the hope that it will be useful,
13     # but WITHOUT ANY WARRANTY; without even the implied warranty of
14     # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15     # GNU General Public License for more details.
16     #
17     # You should have received a copy of the GNU General Public License
18     # along with this program; if not, write to the Free Software
19     # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20     #
21    
22 tdb 1.1 # -----------------------------------------------------------
23     # i-scream graph generation script
24     # http://www.i-scream.org.uk
25     #
26     # Generates graphs from rrd databases for i-scream data.
27     #
28     # $Author: tdb $
29 tdb 1.6 # $Id: graph.pl,v 1.5 2002/05/21 15:01:43 tdb Exp $
30 tdb 1.1 #------------------------------------------------------------
31    
32     ## TODO
33     # possibly make more configurable?
34     # -- allow configurable periods of graphs
35     # -- comments, types, etc
36 tdb 1.5
37 tdb 1.6 my($version) = '$Id: graph.pl,v 1.5 2002/05/21 15:01:43 tdb Exp $';
38 tdb 1.1
39     $| = 1;
40 tdb 1.5
41 tdb 1.1 use strict;
42 tdb 1.5 use Getopt::Std;
43 tdb 1.1 use RRDs;
44    
45 tdb 1.5 # define variables that will be read from the config
46     # nb. keep this insync with the config file!
47     use vars qw{
48     $imgdir $rrddir
49     $maxrrdage $maximgage $deleterrds $deleteimgs
50     $hex_slash $hex_underscore
51     $rrdstep $retry_wait
52     $verbose $quiet
53     };
54    
55     # default locate of the config file
56     my($configfile) = "rrdgraphing.conf";
57    
58     # check for command line arguments
59     my(%opts);
60     my($ret) = getopts('hvqVc:', \%opts);
61    
62     # if invalid argument given, $ret will not be 1
63     &usage() if $ret != 1;
64    
65     # first process the arguments which might mean we exit now
66    
67     # -h is usage
68     if($opts{h}) {
69     &usage();
70     }
71     # -V is version
72     if($opts{V}) {
73     print "graph.pl version: $version\n";
74     exit(1);
75     }
76    
77     # Then try getting the config
78    
79     # -c specifies the config file location
80     if($opts{c}) {
81     $configfile = $opts{c};
82     }
83     # suck in the config
84     &log("reading config from $configfile\n");
85     do $configfile;
86    
87     # Then any options we might want to override the config with
88    
89     # -v is verbose
90     if($opts{v}) {
91     $verbose = $opts{v};
92     }
93     # -q is verbose
94     if($opts{q}) {
95     $quiet = $opts{q};
96     # if we're meant to be quiet, we can hardly be verbose!
97     $verbose = 0;
98     }
99    
100    
101 tdb 1.1 # Read the contents of the base directory
102     # and pull out the list of subdirectories (except . and .. :)
103     opendir(DIR, $rrddir);
104     my(@rrddirlist) = grep { -d "$rrddir/$_" && !/^\.$/ && !/^\.\.$/ } readdir(DIR);
105     closedir DIR;
106    
107     # look through each directoty, as they might
108     # contain rrds for a particular machine
109     foreach my $machine (@rrddirlist) {
110     # Read the contents of the directory
111     opendir(DIR, "$rrddir/$machine");
112     my(@rrdlist) = grep { /\.rrd$/ && -f "$rrddir/$machine/$_" } readdir(DIR);
113     closedir DIR;
114    
115     # See what rrd we have, and generate the graphs accordingly
116     foreach my $rrd (@rrdlist) {
117     chomp $rrd;
118 tdb 1.3 # stat the file
119     my($dev,$ino,$mode,$nlink,$uid,$gid,$rdev,$size,$atime,$mtime,
120     $ctime,$blksize,$blocks) = stat("$rrddir/$machine/$rrd");
121     # check if it's old enough to be deleted
122     if((time - $mtime) > $maxrrdage) {
123 tdb 1.4 # do we delete the rrd, or just ignore it?
124     if($deleterrds) {
125     # if so, delete it
126     unlink("$rrddir/$machine/$rrd");
127 tdb 1.5 &log("deleted old rrd $rrddir/$machine/$rrd\n");
128     }
129     else {
130     &log("ignored old rrd $rrddir/$machine/$rrd\n");
131 tdb 1.4 }
132 tdb 1.3 # no more processing required for this rrd
133     next;
134     }
135 tdb 1.1 if($rrd =~ /^(cpu)\.rrd$/) {
136     my(@data);
137     my(@rawdata);
138 tdb 1.7 push @data, "LINE2:$1:idle:idle#00FF00:OK:idle cpu";
139     push @data, "LINE2:$1:user:user#0000FF:OK:user cpu";
140     push @data, "LINE2:$1:kernel:kernel#00FFFF:OK:kernel cpu";
141     push @data, "LINE2:$1:swap:swap#FF00FF:OK:swap cpu";
142     push @data, "LINE2:$1:iowait:iowait#FF0000:OK:iowait cpu";
143 tdb 1.1 push @rawdata, "--upper-limit=100";
144     &makegraph($machine, $1, "CPU Usage for $machine", \@data, \@rawdata);
145     }
146     if($rrd =~ /^(mem)\.rrd$/) {
147     my(@data);
148     my(@rawdata);
149     # we don't actually want to display free memory,
150     # although we need it to do inuse...
151 tdb 1.7 push @data, "NONE:$1:free:free#CCCCFF:NONE:free memory";
152     push @data, "LINE2:$1:total:total#0000FF:NONE:total memory";
153 tdb 1.1 # calculate inuse
154     push @rawdata, "CDEF:inuse=total,free,-";
155     # and add it to the graph
156 tdb 1.7 push @rawdata, "AREA:inuse#CCCCFF:memory in use\\l";
157 tdb 1.1 push @rawdata, "--base=1024";
158 tdb 1.7 # add some nice values to the legend
159     &addlegend(\@rawdata, "inuse");
160 tdb 1.1 &makegraph($machine, $1, "Memory Usage for $machine", \@data, \@rawdata);
161     }
162     if($rrd =~ /^(load)\.rrd$/) {
163     my(@data);
164 tdb 1.7 push @data, "LINE2:$1:load1:load1#CCCCFF:OK:1 minute load average";
165     push @data, "LINE2:$1:load5:load5#7777FF:OK:5 minute load average";
166     push @data, "LINE2:$1:load15:load15#0000FF:OK:15 minute load average";
167 tdb 1.1 &makegraph($machine, $1, "Loads for $machine", \@data);
168     }
169     if($rrd =~ /^(proc)\.rrd$/) {
170     my(@data);
171 tdb 1.7 push @data, "LINE2:$1:cpu:cpu#00FF00:OK:cpu processes";
172     push @data, "LINE2:$1:sleeping:sleeping#0000FF:OK:sleeping processes";
173     push @data, "LINE2:$1:stopped:stopped#00FFFF:OK:stopped processes";
174     push @data, "LINE2:$1:total:total#FF00FF:OK:total processes";
175     push @data, "LINE2:$1:zombie:zombie#FF0000:OK:zombie processes";
176 tdb 1.1 &makegraph($machine, $1, "Processes on $machine", \@data);
177     }
178     if($rrd =~ /^(swap)\.rrd$/) {
179     my(@data);
180     my(@rawdata);
181     # we don't actually want to display free swap,
182     # although we need it to do inuse...
183 tdb 1.7 push @data, "NONE:$1:free:free#CCCCFF:NONE:free swap";
184     push @data, "LINE2:$1:total:total#0000FF:NONE:total swap";
185 tdb 1.1 # calculate inuse
186     push @rawdata, "CDEF:inuse=total,free,-";
187     # and add it to the graph
188 tdb 1.7 push @rawdata, "AREA:inuse#CCCCFF:swap in use\\l";
189 tdb 1.1 push @rawdata, "--base=1024";
190 tdb 1.7 # add some nice values to the legend
191     &addlegend(\@rawdata, "inuse");
192 tdb 1.1 &makegraph($machine, $1, "Swap Usage for $machine", \@data, \@rawdata);
193     }
194     if($rrd =~ /^(users)\.rrd$/) {
195     my(@data);
196 tdb 1.7 push @data, "AREA:$1:count:count#CCCCFF:OK:user count";
197 tdb 1.1 &makegraph($machine, $1, "User Count for $machine", \@data);
198     }
199     if($rrd =~ /^(disk)-(\S+).rrd$/) {
200     my(@data);
201     my(@rawdata);
202 tdb 1.7 push @data, "LINE2:$1-$2:kbytes:kbytes#0000FF:NONE:total size";
203     push @data, "AREA:$1-$2:used:used#CCCCFF:OK:used";
204 tdb 1.1 push @rawdata, "--base=1024";
205     my($type) = $1;
206     my($name) = $2;
207     my($nicename) = $2;
208     $nicename =~ s/$hex_slash/\//g;
209     $nicename =~ s/$hex_underscore/_/g;
210     &makegraph($machine, "$type-$name", "Disk Usage for $machine on $nicename", \@data, \@rawdata);
211     }
212     # probably a queue with a name like this :)
213     if($rrd =~ /^(\d+)_0\.rrd$/) {
214     my(@data);
215     my(@rawdata);
216     my($baserrd) = $1;
217     my($i) = 0;
218     while( -f "$rrddir/$machine/$baserrd\_$i.rrd" ) {
219 tdb 1.7 push @data, "LINE2:$baserrd\_$i:size:size$i" . &get_colour($i) . ":OK:queue$i size ";
220 tdb 1.1 ++$i;
221     }
222 tdb 1.7 push @data, "LINE2:$baserrd\_0:total:total#FF0000:OK:packets/sec";
223 tdb 1.1 my($comment);
224     if(-f "$rrddir/$machine/$baserrd.def") {
225     open(DEF, "$rrddir/$machine/$baserrd.def");
226     $comment = <DEF>;
227     chomp $comment if defined $comment;
228     }
229     $comment = "unknown queue" if not defined $comment;
230     &makegraph($machine, $baserrd, $comment, \@data, \@rawdata);
231     }
232 tdb 1.3 }
233     # have a last check, maybe we can remove the directory now?
234 tdb 1.4 # (only if we're deleting stuff)
235     if($deleterrds) {
236     # Read the contents of the directory
237     opendir(DIR, "$rrddir/$machine");
238     my(@dirlist) = grep { !/^\.$/ && !/^\.\.$/ } readdir(DIR);
239     closedir DIR;
240     if($#dirlist == -1) {
241     rmdir "$rrddir/$machine";
242 tdb 1.5 &log("deleting empty rrd directory $rrddir/$machine\n");
243 tdb 1.4 }
244 tdb 1.3 }
245     }
246    
247 tdb 1.4 if($deleteimgs) {
248     # Read the contents of the graphs directory
249     # and pull out the list of subdirectories (except . and .. :)
250     opendir(DIR, $imgdir);
251     my(@imgdirlist) = grep { -d "$imgdir/$_" && !/^\.$/ && !/^\.\.$/ } readdir(DIR);
252 tdb 1.3 closedir DIR;
253    
254 tdb 1.4 # look through each directoty, as they might
255     # contain images for a particular machine
256     foreach my $machine (@imgdirlist) {
257     # Read the contents of the directory
258     opendir(DIR, "$imgdir/$machine");
259     my(@imglist) = grep { /\.png$/ && -f "$imgdir/$machine/$_" } readdir(DIR);
260     closedir DIR;
261    
262     # See what rrd we have, and generate the graphs accordingly
263     foreach my $img (@imglist) {
264     chomp $img;
265     # stat the img
266     my($dev,$ino,$mode,$nlink,$uid,$gid,$rdev,$size,$atime,$mtime,
267     $ctime,$blksize,$blocks) = stat("$imgdir/$machine/$img");
268     # check if it's old enough to be deleted
269     if((time - $mtime) > $maximgage) {
270     # if so, delete it
271     unlink("$imgdir/$machine/$img");
272 tdb 1.5 &log("deleted old image $imgdir/$machine/$img\n");
273 tdb 1.4 }
274     }
275     # have a last check, maybe we can remove the directory now?
276     # Read the contents of the directory
277     opendir(DIR, "$imgdir/$machine");
278     my(@dirlist) = grep { !/^\.$/ && !/^\.\.$/ } readdir(DIR);
279     closedir DIR;
280     if($#dirlist == -1) {
281     rmdir "$imgdir/$machine";
282 tdb 1.5 &log("deleted empty image directory $imgdir/$machine\n");
283 tdb 1.3 }
284     }
285 tdb 1.1 }
286 tdb 1.4
287     exit(0);
288    
289 tdb 1.1
290     #
291     # subroutine to make some graphs
292     #
293     # $machine = name of the machine
294     # (eg. kernow.ukc.ac.uk)
295     # $type = the type of graph for the machine
296     # (eg. cpu)
297     # $title = the title for the graph
298     # (eg. kernow CPU usage)
299     # $dataref = a reference to an array containing information for the graph
300 tdb 1.7 # elements of format: "gtype:rrdname:dsname:name#colour:legend:comment with spaces"
301 tdb 1.1 # (if gtype is "NONE" only a DEF of 'name' will be defined, no line will be plotted)
302 tdb 1.7 # (if legend is "NONE" the latest/average/max/min legend won't be printed)
303 tdb 1.1 # $rawcmdref = a reference to an array containing raw rrd commands
304     # elements a single command each, no spaces
305     #
306    
307     sub makegraph() {
308     my($machine, $type, $title, $dataref, $rawcmdref) = @_;
309     # pass in these arrays by reference
310     my(@data) = @$dataref if defined $dataref;
311     my(@rawcmd) = @$rawcmdref if defined $rawcmdref;
312     # check if directory exists for images
313     if(! -d "$imgdir/$machine") {
314     # not sure on this umask, but it seems to work?
315     mkdir "$imgdir/$machine", 0777;
316 tdb 1.5 &log("created directory $imgdir/$machine\n");
317 tdb 1.1 }
318     my(@rrdcmd);
319     foreach my $dataitem (@data) {
320 tdb 1.7 # dataitem should be: "gtype:rrdname:dsname:name#colour:legend:comment with spaces"
321 tdb 1.1 # (if gtype is "NONE" only a DEF of 'name' will be defined, no line will be plotted)
322 tdb 1.7 # (if legend is "NONE" the latest/average/max/min legend won't be printed)
323     if($dataitem =~ /^(\S+):(\S+):(\S+):(\S+)#(.{6}):(\S+):(.*)$/) {
324 tdb 1.1 push @rrdcmd, "DEF:$4=$rrddir/$machine/$2.rrd:$3:AVERAGE";
325     if($1 ne "NONE") {
326 tdb 1.7 push @rrdcmd, "$1:$4#$5:$7\\s";
327     if($6 ne "NONE") {
328     # add some nice values to the legend
329     &addlegend(\@rrdcmd, $4);
330     }
331 tdb 1.1 }
332     }
333     }
334     push @rrdcmd, "--title=$title";
335     push @rrdcmd, "--imgformat=PNG";
336     push @rrdcmd, "--lower-limit=0";
337     # not entirely convinced this is good...
338     push @rrdcmd, "--alt-autoscale-max";
339     # add any further raw commands
340     push @rrdcmd, @rawcmd;
341     RRDs::graph ("$imgdir/$machine/$type-3h.png", "--start=-10800", @rrdcmd);
342     my($err_3h) = RRDs::error;
343 tdb 1.5 &log("created $imgdir/$machine/$type-3h.png\n") unless $err_3h;
344     &error("Error generating 3h graph for $machine/$type: $err_3h\n") if $err_3h;
345 tdb 1.1 RRDs::graph ("$imgdir/$machine/$type-1d.png", "--start=-86400", @rrdcmd);
346     my($err_1d) = RRDs::error;
347 tdb 1.5 &log("created $imgdir/$machine/$type-1d.png\n") unless $err_1d;
348     &error("Error generating 1d graph for $machine/$type: $err_1d\n") if $err_1d;
349 tdb 1.1 RRDs::graph ("$imgdir/$machine/$type-1w.png", "--start=-604800", @rrdcmd);
350     my($err_1w) = RRDs::error;
351 tdb 1.5 &log("created $imgdir/$machine/$type-1w.png\n") unless $err_1w;
352     &error("Error generating 1w graph for $machine/$type: $err_1w\n") if $err_1w;
353 tdb 1.1 RRDs::graph ("$imgdir/$machine/$type-1m.png", "--start=-2678400", @rrdcmd);
354     my($err_1m) = RRDs::error;
355 tdb 1.5 &log("created $imgdir/$machine/$type-1m.png\n") unless $err_1m;
356     &error("Error generating 1m graph for $machine/$type: $err_1m\n") if $err_1m;
357 tdb 1.1 RRDs::graph ("$imgdir/$machine/$type-1y.png", "--start=-31536000", @rrdcmd);
358     my($err_1y) = RRDs::error;
359 tdb 1.5 &log("created $imgdir/$machine/$type-1y.png\n") unless $err_1y;
360     &error("Error generating 1y graph for $machine/$type: $err_1y\n") if $err_1y;
361 tdb 1.1 return;
362 tdb 1.7 }
363    
364     # subroutine to add a legend
365     # accepts reference to an array and a name
366     sub addlegend() {
367     my($dataref, $name) = @_;
368     push @$dataref, "GPRINT:$name:LAST:latest=\%lf\\r";
369     push @$dataref, "GPRINT:$name:AVERAGE:average=\%lf";
370     push @$dataref, "GPRINT:$name:MAX:max=\%lf";
371     push @$dataref, "GPRINT:$name:MIN:min=\%lf\\r";
372 tdb 1.1 }
373    
374     # hacky subroutine to return a colour
375     # could be done much better somehow :/
376     sub get_colour {
377     my($col) = @_;
378     if($col == 0) {
379     return "#0000FF";
380     }
381     elsif($col == 1) {
382     return "#00FF00";
383     }
384     elsif($col == 2) {
385     return "#FF00FF";
386     }
387     elsif($col == 3) {
388     return "#FFFF00";
389     }
390     elsif($col == 4) {
391     return "#00FFFF";
392     }
393     else {
394     return "#000066";
395     }
396 tdb 1.5 }
397    
398     # prints out usage information then exits
399     sub usage() {
400     print "Usage: graph.pl [options]\n";
401     print "Options\n";
402     print " -c config Specifies the configuration file\n";
403     print " default: rrdgraphing.conf\n";
404     print " -v Be verbose about what's happening\n";
405     print " -q Be quiet, even supress errors\n";
406     print " -V Print version number\n";
407     print " -h Prints this help page\n";
408     exit(1);
409     }
410    
411     # prints a log message if verbose is turned on
412     sub log() {
413     my($msg) = @_;
414     print $msg if $verbose;
415     }
416    
417     # prints an error message unless quiet is turned on
418     sub error() {
419     my($msg) = @_;
420     print STDERR $msg unless $quiet;
421 tdb 1.1 }