ViewVC Help
View File | Revision Log | Show Annotations | Revision Graph | Root Listing
root/i-scream/projects/cms/source/reports/rrdgraphing/watch.pl
Revision: 1.4
Committed: Tue May 21 16:47:16 2002 UTC (22 years, 6 months ago) by tdb
Content type: text/plain
Branch: MAIN
Changes since 1.3: +3 -2 lines
Log Message:
Added URL to GPL headers.

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 tdb 1.4 # http://www.i-scream.org.uk
6 tdb 1.2 # 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 tdb 1.1 # -----------------------------------------------------------
24     # i-scream graph generation scripts
25     # http://www.i-scream.org.uk
26     #
27     # Generates rrd databases for i-scream data by connecting to
28     # the i-scream server and collecting data.
29     #
30     # $Author: tdb $
31 tdb 1.4 # $Id: watch.pl,v 1.3 2002/05/21 15:01:43 tdb Exp $
32 tdb 1.1 #------------------------------------------------------------
33    
34 tdb 1.4 my($version) = '$Id: watch.pl,v 1.3 2002/05/21 15:01:43 tdb Exp $';
35 tdb 1.1
36     $| = 1;
37    
38     use strict;
39 tdb 1.3 use Getopt::Std;
40     use IO::Socket;
41 tdb 1.1 use iscream::XMLParser;
42     use RRDs;
43    
44 tdb 1.3 # define variables that will be read from the config
45     # nb. keep this insync with the config file!
46     use vars qw{
47     $imgdir $rrddir
48     $maxrrdage $maximgage $deleterrds $deleteimgs
49     $hex_slash $hex_underscore
50     $rrdstep $retry_wait
51     $verbose $quiet
52     };
53    
54     # default locate of the config file
55     my($configfile) = "rrdgraphing.conf";
56    
57     # check for command line arguments
58     my(%opts);
59     my($ret) = getopts('hvqVc:', \%opts);
60    
61     # if invalid argument given, $ret will not be 1
62     &usage() if $ret != 1;
63    
64     # first process the arguments which might mean we exit now
65    
66     # -h is usage
67     if($opts{h}) {
68     &usage();
69     }
70     # -V is version
71     if($opts{V}) {
72     print "watch.pl version: $version\n";
73     exit(1);
74     }
75 tdb 1.1
76 tdb 1.3 # Then try getting the config
77 tdb 1.1
78 tdb 1.3 # -c specifies the config file location
79     if($opts{c}) {
80     $configfile = $opts{c};
81     }
82     # suck in the config
83     &log("reading config from $configfile\n");
84     do $configfile;
85    
86     # Then any options we might want to override the config with
87    
88     # -v is verbose
89     if($opts{v}) {
90     $verbose = $opts{v};
91     }
92     # -q is verbose
93     if($opts{q}) {
94     $quiet = $opts{q};
95     # if we're meant to be quiet, we can hardly be verbose!
96     # $verbose = 0;
97     }
98 tdb 1.1
99 tdb 1.3 # Finally check for required arguments
100    
101     # check we still have two arguments left
102 tdb 1.1 if (@ARGV != 2) {
103 tdb 1.3 &usage();
104 tdb 1.1 }
105    
106     # user supplied client interface server and port
107     my($addr) = $ARGV[0];
108     my($cport) = $ARGV[1];
109    
110 tdb 1.3
111     # Main program loop
112 tdb 1.1 while(1) {
113    
114 tdb 1.3 &log("Connecting control channel to port $cport on $addr...\n");
115 tdb 1.1
116     # attempt to connect the control channel
117     my($csock) = new IO::Socket::INET(
118     PeerAddr => $addr,
119     PeerPort => $cport,
120     Proto => 'tcp'
121     );
122    
123     # if socket isn't defined connection failed
124     if (!defined $csock) {
125 tdb 1.3 &error("ERROR: Could not connect control channel to $addr:$cport.\n");
126     &error("Please check that there is an i-scream server at this address.\n");
127 tdb 1.1 &wait_then_retry();
128     next;
129     }
130    
131     my($response);
132    
133     # client interface should send it's protocol ID
134     # we know about "PROTOCOL 1.1", and will only accept the same
135     $response = <$csock>;
136 tdb 1.3 &log("CLI sent: $response");
137 tdb 1.1 if ($response && $response ne "PROTOCOL 1.1\n") {
138 tdb 1.3 &error("The i-scream server sent an unexpected protocol ID: $response\n");
139 tdb 1.1 close($csock);
140     &wait_then_retry();
141     next;
142     }
143    
144     # send our identifier to the client interface
145     print $csock "rrdgraphing\n";
146 tdb 1.3 &log("we sent: rrdgraphing\n");
147 tdb 1.1 $response = <$csock>;
148 tdb 1.3 &log("CLI sent: $response");
149 tdb 1.1 if ($response && $response ne "OK\n") {
150 tdb 1.3 &error("Received unexpected response: $response\n");
151 tdb 1.1 close($csock);
152     &wait_then_retry();
153     next;
154     }
155    
156     # tell the client interface we'd like to start the data channel
157     print $csock "STARTDATA\n";
158 tdb 1.3 &log("we sent: STARTDATA\n");
159    
160 tdb 1.1 # the response should be the socket to connect the data channel to
161     $response = <$csock>;
162 tdb 1.3 &log("CLI sent: $response");
163 tdb 1.1 chomp $response;
164    
165     my($dport) = $response;
166 tdb 1.3 &log("Connecting data channel to port $dport on $addr...\n");
167 tdb 1.1
168     # attempt to connect the data channel
169     my($dsock) = new IO::Socket::INET(
170     PeerAddr => $addr,
171     PeerPort => $dport,
172     Proto => 'tcp'
173     ) or die "arse?";
174    
175     # if socket isn't defined connection failed
176     if (!defined $dsock) {
177 tdb 1.3 &error("ERROR: Could not connect data channel to $addr:$dport.\n");
178     &error("Failure in communications.\n");
179 tdb 1.1 close($csock);
180     &wait_then_retry();
181     next;
182     }
183    
184     # the data channel should now be sending us data!
185    
186     # call sub to process data being received over the data channel
187     &processdata($dsock);
188    
189     # data processing has stopped, close sockets
190     close($csock);
191     close($dsock);
192    
193     # wait before retrying
194     &wait_then_retry();
195     }
196    
197     # we'll never reach here... unless 1 becomes false for some reason ;)
198     exit 0;
199    
200    
201     #
202     # wait for a while before retrying
203     #
204     sub wait_then_retry() {
205 tdb 1.3 &error("Will retry connection to i-scream server in $retry_wait seconds.\n\n");
206 tdb 1.1 sleep $retry_wait;
207     }
208    
209     #
210     # Given the socket of the data channel will process all
211     # the incoming XML data, creating and updating the appropriate
212     # database files.
213     #
214     # $dsock = socket connected to the data channel
215     #
216     sub processdata() {
217     # the socket connected to the data channel
218     my($dsock) = @_;
219     # save us recreating this variable each time we loop
220     my($xml);
221    
222     while(1) {
223     # read data
224     $xml = <$dsock>;
225    
226     # something odd has happened
227     last if not defined $xml;
228    
229     # attempt to parse the data
230     my($err, %xmlhash) = &iscream::XMLParser::parse($xml);
231     if($err) {
232 tdb 1.3 &error("Skipped, XML did not parse: $xml");
233 tdb 1.1 next;
234     }
235    
236     # standard data packet
237     if($xmlhash{"packet.attributes.type"} eq "data") {
238     my($machine) = $xmlhash{"packet.attributes.machine_name"};
239     my($date) = $xmlhash{"packet.attributes.date"};
240    
241     # make directory for machine
242     if(! -d "$rrddir/$machine") {
243     # not sure on this umask, but it seems to work?
244     mkdir "$rrddir/$machine", 0777;
245 tdb 1.3 &log("created directory $rrddir/$machine\n");
246 tdb 1.1 }
247    
248     my(@data);
249    
250     # cpu
251     @data = ( "packet.cpu.idle:idle:GAUGE",
252     "packet.cpu.user:user:GAUGE",
253     "packet.cpu.kernel:kernel:GAUGE",
254     "packet.cpu.swap:swap:GAUGE",
255     "packet.cpu.iowait:iowait:GAUGE",
256     );
257     &updaterrd($machine, "cpu", $date, $rrdstep, \%xmlhash, @data);
258    
259     # mem
260     @data = ( "packet.memory.free:free:GAUGE",
261     "packet.memory.total:total:GAUGE",
262     );
263     &updaterrd($machine, "mem", $date, $rrdstep, \%xmlhash, @data);
264    
265     # load
266     @data = ( "packet.load.load1:load1:GAUGE",
267     "packet.load.load5:load5:GAUGE",
268     "packet.load.load15:load15:GAUGE",
269     );
270     &updaterrd($machine, "load", $date, $rrdstep, \%xmlhash, @data);
271    
272     # processes
273     @data = ( "packet.processes.cpu:cpu:GAUGE",
274     "packet.processes.sleeping:sleeping:GAUGE",
275     "packet.processes.stopped:stopped:GAUGE",
276     "packet.processes.total:total:GAUGE",
277     "packet.processes.zombie:zombie:GAUGE",
278     );
279     &updaterrd($machine, "proc", $date, $rrdstep, \%xmlhash, @data);
280    
281     # swap
282     @data = ( "packet.swap.free:free:GAUGE",
283     "packet.swap.total:total:GAUGE",
284     );
285     &updaterrd($machine, "swap", $date, $rrdstep, \%xmlhash, @data);
286    
287     # users
288     @data = ( "packet.users.count:count:GAUGE",
289     );
290     &updaterrd($machine, "users", $date, $rrdstep, \%xmlhash, @data);
291    
292     # disk
293     my($i) = 0;
294     while(defined $xmlhash{"packet.disk.p$i.attributes.mount"}) {
295     my($mount) = $xmlhash{"packet.disk.p$i.attributes.mount"};
296     $mount =~ s/_/$hex_underscore/g;
297     $mount =~ s/\//$hex_slash/g;
298     @data = ( "packet.disk.p$i.attributes.kbytes:kbytes:GAUGE",
299     "packet.disk.p$i.attributes.used:used:GAUGE",
300     );
301     &updaterrd($machine, "disk-$mount", $date, $rrdstep, \%xmlhash, @data);
302     ++$i;
303     }
304     }
305    
306     # queue statistics packet
307     elsif($xmlhash{"packet.attributes.type"} eq "queueStat") {
308     # psuedo machine for internal server stuff
309     my($machine) = "i-scream-server";
310     # make directory
311     if(! -d "$rrddir/$machine") {
312     # not sure on this umask, but it seems to work?
313     mkdir "$rrddir/$machine", 0777;
314 tdb 1.3 &log("created directory $rrddir/$machine\n");
315 tdb 1.1 }
316     my($hash) = $xmlhash{"packet.attributes.hashCode"};
317     my($date) = $xmlhash{"packet.attributes.date"};
318     my($name) = $xmlhash{"packet.attributes.name"};
319     # take a look to see if we have a shutdown packet...
320     if($xmlhash{"packet.attributes.shutdown"} && $xmlhash{"packet.attributes.shutdown"} eq "true") {
321     unlink <$rrddir/$machine/$hash\_*.rrd>, "$rrddir/$machine/$hash.def", <$imgdir/$machine/$hash*.png>;
322 tdb 1.3 &log("deleted $rrddir/$machine/$hash\_*.rrd $rrddir/$machine/$hash.def $imgdir/$machine/$hash*.png\n");
323 tdb 1.1 next;
324     }
325     # look through to see how many internal queues we have
326     my($i) = 0;
327     while(defined $xmlhash{"packet.queue.attributes.queue$i"}) {
328     # see if the queue has been removed
329     if($xmlhash{"packet.queue.attributes.queue$i"} eq "[deleted]") {
330     # delete the queues rrd
331     unlink "$rrddir/$machine/$hash\_$i.rrd";
332 tdb 1.3 &log("deleted $rrddir/$machine/$hash\_$i.rrd\n");
333 tdb 1.1 # are there any other rrd's left on this queue? if not, cleanup.
334     # get a list of any that may be still there..
335     opendir(DIR, "$rrddir/$machine");
336     my(@rrdcountfiles) = grep { -f "$rrddir/$machine/$_" && /^$hash\_\d+.rrd$/ } readdir(DIR);
337     closedir DIR;
338     # count them (+1 because an empty array is size -1)
339     my($rrdcount) = $#rrdcountfiles + 1;
340     if($rrdcount == 0) {
341     # clean up the def file and any images
342     unlink "$rrddir/$machine/$hash.def", <$imgdir/$machine/$hash*.png>;
343 tdb 1.3 &log("deleted $rrddir/$machine/$hash.def $imgdir/$machine/$hash*.png\n");
344 tdb 1.1 }
345     ++$i;
346     next;
347     }
348     # the &updaterrd will also do this check, but we want
349     # to write our def file out first
350     if( ! -f "$rrddir/$machine/$hash\_$i.rrd" ) {
351     open(DEF, ">$rrddir/$machine/$hash.def");
352     print DEF $name;
353     close DEF;
354 tdb 1.3 &log("created $rrddir/$machine/$hash.def\n");
355 tdb 1.1 }
356     my(@data) = ( "packet.queue.attributes.queue$i:size:GAUGE",
357     "packet.queue.attributes.total:total:COUNTER",
358     );
359     &updaterrd($machine, "$hash\_$i", $date, $rrdstep, \%xmlhash, @data);
360     ++$i;
361     }
362     }
363     else {
364 tdb 1.3 #&error("SKIPPED: valid xml, but not a data or statistics packet\n");
365 tdb 1.1 }
366     }
367    
368     # we'll now return from this sub and reconnect
369 tdb 1.3 &error("Data channel socket gave no data, bailing out...\n");
370 tdb 1.1 }
371    
372     #
373     # sub to update an rrd file
374     #
375     # $machine = name of the machine
376     # (eg. kernow.ukc.ac.uk)
377     # $type = the type of graph for the machine
378     # (eg. cpu)
379     # $date = the date of the item we want to add
380     # (in seconds since the epoch)
381     # $step = the interval at which the database steps
382     # used when we create a new rrd
383     # $xmlref = reference to the xml data packet
384     # @data = array containing data items to add
385     # (eg. "packet.cpu.user:user:GAUGE")
386     #
387     sub updaterrd() {
388     my($machine, $type, $date, $step, $xmlref, @data) = @_;
389     # get hold of the xmlhash we have a reference to
390     my(%xmlhash) = %$xmlref;
391     # check if we need to create a new rrd
392     if( ! -f "$rrddir/$machine/$type.rrd") {
393     my(@createdata);
394     # pull the details out of the data we've been given
395     foreach my $dataitem (@data) {
396     if($dataitem =~ /^\S+:(\S+):(\S+)$/) {
397     push @createdata, "$1:$2";
398     }
399     }
400     # call the &makerrd to actually create the rrd
401 tdb 1.3 &log("making new rrd for $rrddir/$machine/$type.rrd\n");
402 tdb 1.1 &makerrd($machine, $type, $date, $step, @createdata);
403     }
404     # get the details out of the data we've been given
405     my($updateparams) = "$date";
406     foreach my $dataitem (@data) {
407     if($dataitem =~ /^(\S+):\S+:\S+$/) {
408     # pull the values straight out of the xmlhash
409     my($value) = $xmlhash{$1};
410     # if it's undefined we'll set it to 0
411     # this probably shouldn't happen, but it'd be best to handle it "nicely" :)
412     $value = "0" if not defined $value;
413     $updateparams .= ":$value";
414     }
415     }
416     # perform the update
417     RRDs::update ("$rrddir/$machine/$type.rrd", $updateparams);
418 tdb 1.3 &log("updating $rrddir/$machine/$type.rrd\n");
419 tdb 1.1 my($err) = RRDs::error;
420 tdb 1.3 &error("Error updating $rrddir/$machine/$type.rrd: $err\n") if $err;
421 tdb 1.1 }
422    
423     #
424     # sub to create a new rrd file
425     #
426     # $machine = name of the machine
427     # (eg. kernow.ukc.ac.uk)
428     # $type = the type of graph for the machine
429     # (eg. cpu)
430     # $start = the date of the first item we want to add
431     # (in seconds since the epoch)
432     # $step = the interval at which the database steps
433     # @data = the data items we want to put in the rrd
434     # in the form: $dsname:dstype
435     # (eg. "size:GAUGE")
436     #
437     sub makerrd() {
438     my($machine, $type, $start, $step, @data) = @_;
439     # check if directory exists for rrd
440     if(! -d "$rrddir/$machine") {
441     # not sure on this umask, but it seems to work?
442     mkdir "$rrddir/$machine", 0777;
443 tdb 1.3 &log("created directory $rrddir/$machine\n");
444 tdb 1.1 }
445     my(@rrdcmd);
446     # we'll want to add our first data item at $start,
447     # so we start our rrd $step before that.
448     $start -= $step;
449     push @rrdcmd, "$rrddir/$machine/$type.rrd";
450     push @rrdcmd, "--start=$start";
451     push @rrdcmd, "--step=$step";
452     foreach my $dataitem (@data) {
453     # dataitem should be: "dsname:dstype"
454     if($dataitem =~ /^(\S+):(\S+)$/) {
455     push @rrdcmd, "DS:$1:$2:600:U:U";
456     }
457     }
458     push @rrdcmd, (
459     # 3h in 15s samples
460     "RRA:AVERAGE:0.5:1:720",
461     "RRA:MAX:0.5:1:720",
462     # 1d in 2m samples
463     "RRA:AVERAGE:0.5:8:720",
464     "RRA:MAX:0.5:8:720",
465     # 1w in 15m samples
466     "RRA:AVERAGE:0.5:60:672",
467     "RRA:MAX:0.5:60:672",
468     # 1m in 1hr samples
469     "RRA:AVERAGE:0.5:240:744",
470     "RRA:MAX:0.5:240:744",
471     # 1y in 12hr samples
472     "RRA:AVERAGE:0.5:2880:730",
473     "RRA:MAX:0.5:2880:730",
474     );
475     RRDs::create (@rrdcmd);
476     my($err) = RRDs::error;
477 tdb 1.3 &error("Error creating rrd for $rrddir/$machine/$type: $err\n") if $err;
478     }
479    
480     # prints out usage information then exits
481     sub usage() {
482     print "Usage: watch.pl [options] i-scream_client_interface port\n";
483     print "Options\n";
484     print " -c config Specifies the configuration file\n";
485     print " default: rrdgraphing.conf\n";
486     print " -v Be verbose about what's happening\n";
487     print " -q Be quiet, even supress errors\n";
488     print " -V Print version number\n";
489     print " -h Prints this help page\n";
490     exit(1);
491     }
492    
493     # prints a log message if verbose is turned on
494     sub log() {
495     my($msg) = @_;
496     print $msg if $verbose;
497     }
498    
499     # prints an error message unless quiet is turned on
500     sub error() {
501     my($msg) = @_;
502     print STDERR $msg unless $quiet;
503 tdb 1.1 }