ViewVC Help
View File | Revision Log | Show Annotations | Revision Graph | Root Listing
root/i-scream/projects/cms/source/reports/rrdgraphing/graph.pl
Revision: 1.20
Committed: Thu Nov 23 16:37:44 2006 UTC (18 years, 1 month ago) by tdb
Content type: text/plain
Branch: MAIN
CVS Tags: HEAD
Changes since 1.19: +5 -3 lines
Error occurred while calculating annotation data.
Log Message:
Make graph sizes configurable. Needed for rrdtool 1.2.x when text is
anti-aliased and no longer fits.

File Contents

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