File: collector

package info (click to toggle)
cricket 1.0.5-9
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 1,480 kB
  • ctags: 390
  • sloc: perl: 8,287; sh: 920; ansic: 318; makefile: 62; sql: 16
file content (640 lines) | stat: -rwxr-xr-x 19,451 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
#!/usr/local/bin/perl -w
# -*- perl -*-

# Cricket: a configuration, polling and data display wrapper for RRD files
#
#    Copyright (C) 1998 Jeff R. Allen and WebTV Networks, Inc.
#
#    This program is free software; you can redistribute it and/or modify
#    it under the terms of the GNU General Public License as published by
#    the Free Software Foundation; either version 2 of the License, or
#    (at your option) any later version.
#
#    This program is distributed in the hope that it will be useful,
#    but WITHOUT ANY WARRANTY; without even the implied warranty of
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#    GNU General Public License for more details.
#
#    You should have received a copy of the GNU General Public License
#    along with this program; if not, write to the Free Software
#    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

BEGIN {
    my $programdir = (($0 =~ m:^(.*/):)[0] || "./") . ".";
    eval "require '$programdir/cricket-conf.pl'";
    eval "require '/usr/local/etc/cricket-conf.pl'"
        unless $Common::global::gInstallRoot;
    $Common::global::gInstallRoot ||= $programdir;
}

use lib "$Common::global::gInstallRoot/lib";

use RRDs 1.000101;

use Common::Version;
use Common::global;
use Common::Log;
use Common::Options;
use Common::Util;
use Common::Map;
use Common::HandleTarget;
use ConfigTree::Cache;
use Monitor;

# here's where the individual datasource routines live
use snmp;
use exec;
use file;
use field;
eval "use sql";

if (Common::Util::isWin32()) {
    eval "use wbem";
    eval "use perfmon";
}

my $starttime = time();

# See the documentation on ds-source FUNC for why this defaults
# to commented out.
# use func;

Common::Options::commonOptions(
                 "skipMonitor" => \$Common::global::gSkipMonitor);

Info("Starting collector: $Common::global::gVersion");
$gTargetCt = 0;

$Common::global::isCollector = 1;

$Common::global::gCT ||= new ConfigTree::Cache;
$gCT = $Common::global::gCT;
$gCT->Base($Common::global::gConfigRoot);
$gCT->Warn(\&Warn);

if (! $gCT->init()) {
    Die("Failed to open compiled config tree from " .
        "$Common::global::gConfigRoot/config.db: $!");
}

my($recomp, $why) = $gCT->needsRecompile();
if ($recomp) {
    Warn("Config tree needs to be recompiled: $why");

    system( (Common::Util::isWin32() ? 'perl ' : '') .
            "$Common::global::gInstallRoot/compile " .
            "-base $Common::global::gConfigRoot");

    $gCT = new ConfigTree::Cache;
    $gCT->Base($Common::global::gConfigRoot);

    if (! $gCT->init()) {
        Die("Failed to open compiled config tree from " .
            "$Common::global::gConfigRoot/config.db: $!");
    }
}

&snmpUtils::init();

# if they gave us no subtrees to focus on, use the root of the config tree
if ($#ARGV+1 == 0) {
    push @ARGV, '/';
}

# foreach subtree to do
#     find the base node of that subtree
#    foreach leaf node of this subtree
#        process it

my($subtree);
foreach $subtree (@ARGV) {
    if ($gCT->nodeExists($subtree)) {
        $gCT->visitLeafs($subtree, \&handleTarget,
                         \&handleTargetInstance, \&localHandleTargetInstance);
    } else {
        Warn("Unknown subtree $subtree.");
    }
}

if (!$Common::global::gSkipMonitor) {
    foreach $subtree (@ARGV) {
        if ($gCT->nodeExists($subtree)) {
            $gCT->visitLeafs($subtree, \&handleTarget, \&checkTargetInstance);
        } else {
            Warn("Unknown subtree $subtree.");
        }
    }
}

# print some summary stuff (number of targets, time taken)
# before exiting.

my($time) = runTime($starttime);
Info("Processed $gTargetCt targets in $time.");
exit;

# only use strict for the subroutines
use strict;

sub localHandleTargetInstance {
    my($name, $target) = @_;
    my($tname) = $target->{'auto-target-name'};
    my($tpath) = $target->{'auto-target-path'};

    # first, dump the dict, to help debug things
    if (isDebug()) {
        my($k, $v, $t);
        $t =  "target $tname\n";
        foreach $k (sort (keys(%{$target}))) {
            next if ($k eq "auto-target-name");
    
            $v = $target->{$k};
            $v = "[undef]" if (! defined($v));
    
            $t .= "\t$k = $v\n";
        }
        Debug($t);
    }

    # skip this if it's a meta-target
    if ((defined($target->{'targets'})) || (defined($target->{'mtargets'}))) {
        Debug("Skipping meta target $tname");
        return;
    }

    if (defined($target->{'collect'}) && isFalse($target->{'collect'})) {
        Debug("Skipping target $tname due to collect=false tag.");
        return;
    }

    $main::gTargetCt++;

    my($datafile) = $target->{'rrd-datafile'};

    if (!defined($datafile)) {
        Warn("Could not find a datafile for $tname.");
        return;
    }

    if (! -f $datafile) {
        return unless newRRD($name, $target);
    }

    my $agent_restart = 0;
    my(@data) = retrieveData($name, $target, \$agent_restart);
    if ($#data+1 == 0) {
        Warn("No data retrieved. Skipping RRD update.");
        return;
    }

    # look for date strings, suck em out.
    my($data, $when, @data2);
    foreach $data (@data) {
        if ($data =~ /@(\d+)/) {
            my($when2) = $1;
            if (defined($when) && ($when ne $when2)) {
                Warn("Found inconsistent times in retrieved data. " .
                     "Using first one seen.");
            } else {
                $when = $when2;
            }
            $data =~ s/\@${when2}//;
        }
        push @data2, $data;
    }

    if (! defined($when)) {
        # if they didn't tell us when, use RRD's "now" syntax.
        $when = "N";
    }

    # If an SNMP agent restart occurred, insert a dummy record consisting
    # of all "U" one second before the current sample. This causes RRD
    # to set the previous value of counters to undefined, avoiding weird
    # results when a counter goes negative because of a restart.

    if ($agent_restart && $when eq "N") {
        my @dummyresults = @data2;
        grep { $_ = 'U'} @dummyresults;
        Info("Inserting dummy record because of agent restart");
        my $now = time();
      RRDs::update($datafile, join(":", $now - 1, @dummyresults));
    }

    RRDs::update($datafile, join(":", $when, @data2));
    if (my $error = RRDs::error()) {
        Warn("Cannot update $datafile: $error\n");
    }

    # if we were asked to copy this to someplace, go for it.
    if (defined($target->{'copy-to'})) {
        my($copyto) = $target->{'copy-to'};

        my($to, $args) = split(/:/, $copyto, 2);
        $to = lc($to);

        if ($to eq "trap") {
            # In this case, args is expected to have SNMP info in
            # it. Example:         trap:public@nms-101
            # We just pass it straight thru to snmptrap.

            # This number lets our NMS identify this as a Cricket
            # data trap. The enterprise for the trap
            # is hardcoded in snmpUtils::trap.
            my($specific) = 3;

            snmpUtils::trap($args, $specific, "/$tpath/$tname", @data2);
        } elsif ($to eq "sql") {
            sqlUtils::sendto($args, @data2);
        } else {
            Warn("Unknown copy-to type: $to. Ignoring.");
        }
    }
}

sub handleMultiTarget {
    # the collector completely ignores this -- it's only
    # used by the grapher.
}

sub retrieveData {
    my($name, $target, $restart_ref) = @_;

    my($tname) = $target->{'auto-target-name'};
    my($inst) = $target->{'inst'};
    if (defined($inst)) {
        $tname .= " ($inst)";
    }

    my($ttype) = lc($target->{'target-type'});
    my($ttRef) = $main::gCT->configHash($name, 'targettype', $ttype, $target);
    if (! $ttRef) {
        Warn("Unknown target type: $ttype.");
        return;
    }

    Debug("Retrieving data for target $tname ($ttype)");

    # Determine the list of data sources for this target.
    my(@targetDSs) = split(/\s*,\s*/, $ttRef->{'ds'});
    if (!@targetDSs) {
        Warn("Could not find any datasources for target type $ttype.");
        return ();
    }

    # take the count before we start dicking with it
    # below...
    my($dsCount) = $#targetDSs + 1;

    # if we need to fetch a key to verify a cached instance,
    # we append it to targetDSs here.

    my($mapkey, $mapRef, $match, $snmp, $baseOID, $oid);
    if ($target->{'--verify-mapkey--'}) {
        $mapkey = $target->{'--verify-mapkey--'};
        $mapRef = $main::gCT->configHash($name, 'map', $mapkey, $target);

        if (defined($mapRef)) {
            $match = $mapRef->{'match'};
            if (defined($match)) {
                $match = ConfigTree::Cache::expandString($match,
                                                         $target, \&Warn);
            }
            $baseOID = $mapRef->{'base-oid'};

            my($oidMap) = $main::gCT->configHash($name, 'oid', undef, $target);
            $oid = mapOid($oidMap, $baseOID);
        } else {
            Warn("Unknown mapkey. This should not happen.");
        }

        $snmp = $target->{'snmp'};

        if (!defined($match) || !defined($snmp) || !defined($oid)) {
            Warn("Data needed to verify $mapkey is missing. " .
                 "Skipping verification.");
            delete($target->{'--verify-mapkey--'});
        } else {
            my($inst) = $target->{'inst'};
            my($newds) = "--snmp://${snmp}/${oid}.${inst}";
            push @targetDSs, $newds;
        }
    }
    if (defined($target->{'snmp-uptime'})) {
        my $ds = "--snmp://$target->{'snmp'}/$target->{'snmp-uptime'}";
        push @targetDSs, $ds;
    }

    # this will hold a hash of ds-method names. the values will
    # be a ref to a list of the sources that get passed to
    # the ds-method later.
    my(%targetDataSources) = ();

    my($dsIndex) = 0;

    my($ds);
    foreach $ds ( @targetDSs ) {
        my($dataSource);
        if ($ds =~ /^--/) {
            # this is a hacked one, from the verify code, above.
            $dataSource = $ds;
            $dataSource =~ s/^--//;
        } else {
            # this is a normal ds, so go look it up.
            my($dsRef) = $main::gCT->configHash($name, 'datasource',
                                                lc($ds), $target);
            if ($dsRef) {
                # computed data sources need to be excluded fetch
                if ($dsRef->{'rrd-ds-type'} eq 'COMPUTE') {
                   $dsCount--; # don't penalize for missing these DS
                   next;
                }
                $dataSource = $dsRef->{'ds-source'};
                $dataSource = ConfigTree::Cache::expandString($dataSource,
                                                              $target, \&Warn);
            } else {
                Warn("Datasource named $ds not found.");
                next;
            }
        }

        my($dsMethod,$dsLine) = split(':', $dataSource, 2);

        # create a hash entry which is an array of datasources
        # of the same TYPE (i.e. snmp, shell, etc).
        # NOTE: The datasource type is REPLACED by the datasource
        # index.  This is so that we can be sure to reassemble the
        # data source return value array in the right order.

        push(@{ $targetDataSources{lc($dsMethod)} }, "$dsIndex:$dsLine");
        Debug("ds$dsIndex is: $dsLine");
        $dsIndex++;
    }

    # For each different data source type (snmp, exec, etc.)
    # call the fetcher to retrieve the data.

    my($dsList, $type, @mixedResults);
    while (($type, $dsList) = each %targetDataSources) {
        if (defined ($main::gDSFetch{$type})) {
            push(@mixedResults,
                 map { $_ = $type . ":" . $_ }
                     &{$main::gDSFetch{$type}}($dsList, $name, $target));
        } else {
            Warn("Could not find a fetcher with type $type to " .
                 "fetch data for $tname.");
        }
    }

    # Reassemble the data in the right order.

    my($line, @results);
    foreach $line (@mixedResults) {
        my($type, $index, $value) = split(/:/, $line, 3);

        # only take the first token from the line... that
        # way, they can put in-line comments in the returned data.
        # do this only for 'exec' and 'file' data sources
        if (lc($type) ne 'snmp') {
            $value =~ s/^\s*//;
            ($value) = split(/\s+/, $value, 2);
        }

        $results[$index] = $value;
    }

    # Make sure there are no gaps in the return data!
    # If any data is missing, make it undefined ("U")

    my($ctr, $missingData) = (0, 0);
    for $ctr (0 .. $#results) {
        if (! defined $results[$ctr]) {
            $results[$ctr] = "U";
            $missingData = 1;
        } else {
            if ($results[$ctr] eq 'U') {
                $missingData = 1;
            }
        }
    }

    # Check the agent uptime with the poll interval. If the uptime is
    # less then one poll interval, notify our caller of the restart.

    if (defined($target->{'snmp-uptime'})) {
        my($agent_uptime) = pop @results;
        my($poll) = $target->{'rrd-poll-interval'};
        $poll = 300 unless (defined($poll));
        if ($agent_uptime ne "U" && $agent_uptime < $poll * 100) {
            Info("Agent uptime is less than poll interval");
            $$restart_ref = 1 if (defined($restart_ref));
        }
    }

    # if we are verifying, check the
    # fetched mapping key to make certain it's right

    if (defined($target->{'--verify-mapkey--'})) {
        my($fetchedKey) = pop @results;
        my($wrongInst);

        if ($match =~ /^\s*\/(.*)\/\s*$/) {
            $match = $1;
            $wrongInst = ($fetchedKey !~ /$match/i);
        } else {
            $wrongInst = ($fetchedKey ne $match);
        }

        if ($wrongInst) {
            # damn, they didn't match. this means we need to
            # fix the instance number using mapInstance, and
            # retry.

            Common::Map::mapInstance($name, $target);

            if (defined($target->{'inst'})) {
                # now that we have the correct inst, fetch again
                # (this time there is no need to verify)
                delete($target->{'--verify-mapkey--'});
                @results = retrieveData($name, $target, undef);
            } else {
                # fill in all unknown, since the mapping key seems
                # to no longer exist
                @results = ();
                for ($ctr = 0; $ctr < $dsCount; $ctr++) {
                    push @results, "U";
                }
            }

        }
    }

    # Make sure that we have the same number of return values
    # as datasources.
    my($numRes) = $#results+1;
    if ( $numRes != $dsCount ) {
        Warn("$dsCount datasources required, $numRes results returned!");
        @results = ();
    }

    if ($Common::global::gLogFullPath) {
        my $tpath = $target->{'auto-target-path'};
        Info("Retrieved data for $tpath/$tname: ", join(",", @results));
        Info("Some data is missing for $tpath/$tname.") if ($missingData);
    } else {
        Info("Retrieved data for $tname: ", join(",", @results));
        Info("Some data is missing for $tname.") if ($missingData);
    }

    return @results;
}

sub newRRD {
    # Create a new RRD file base on the contents of the
    # referenced dictionary.
    my($name, $target) = @_;

    my($datafile) = $target->{'rrd-datafile'};
    my($tname) = $target->{'auto-target-name'};
    my($ttype) = lc($target->{'target-type'});

    # Create the data directory if it does not exist:
    $datafile =~ /(.*)\/.*$/;
    my($dataDir) = $1;
    if (! -d $dataDir) {
        Common::Util::MkDir($dataDir);
    }

    # Start rrd one week ago.
    my($week) = (60 * 60 * 24 * 7);
    my($start) = time - $week - 1;

    my($poll) = $target->{'rrd-poll-interval'};
    $poll = 300 unless (defined($poll));

    my(@arg) = ($datafile,
                "--start",         $start,
                "--step",          $poll);

    my($type, $val);
    my($valid) = 0;
    my(@dsDesc) = ();
    my(@rraDesc) = ();
    my($dsCnt) = 0;

    my($ttRef) = $main::gCT->configHash($name, 'targettype', $ttype, $target);
    if (! $ttRef) {
        Warn("Unknown target type: $ttype.");
        return;
    }

    # first, process the ds tag

    my($dses) = $ttRef->{'ds'};
    if (! $dses) {
        Warn("No ds tag found for target type $ttype.");
        return;
    }

    my($ds);
    foreach $ds (split(/\s*,\s*/, $dses)) {
        my($dsname) = lc($ds);
        my($d) = $main::gCT->configHash($name, 'datasource', $dsname, $target);

        if (defined($d)) {

            my($dst) = $d->{'rrd-ds-type'};
            $dst = "GAUGE" unless (defined($dst));
            $dst = uc($dst);

            my($hb) = $d->{'rrd-heartbeat'};
            $hb = $target->{'rrd-heartbeat'}
            if (defined($target->{'rrd-heartbeat'}));
            $hb = 1800 unless (defined($hb));

            my($min) = $d->{'rrd-min'};
            $min = $target->{'rrd-min'}
            if (defined($target->{'rrd-min'}));
            $min = 'U' unless (defined($min));

            my($max) = $d->{'rrd-max'};
            $max = $target->{'rrd-max'}
            if (defined($target->{'rrd-max'}));
            $max = 'U' unless (defined($max));

            my($cdef) = $d -> {'rrd-cdef'};
            if ($dst eq 'COMPUTE' && !defined($cdef)) {
                Warn("Datasource $ds is of type $dst but tag " .
                     "rrd-cdef is missing.");
                return;
            }

            my $rrd_dsname;
            if ($Common::global::gLongDSName) {
                $rrd_dsname = Common::Util::mungeDsName($dsname);
            } else {
                $rrd_dsname = "ds$dsCnt";
            }

            if ($dst ne 'COMPUTE') {
                push @dsDesc, join(":", 'DS', $rrd_dsname,
                                   $dst, $hb, $min, $max);
            } else {
                push @dsDesc, join(":", 'DS', $rrd_dsname,
                                   $dst, $cdef);
            }
            $dsCnt++;

        } else {
            Warn("Datasource $ds referenced by target " .
                 "type $ttype does not exist.");
            return;
        }
    }

    # now do RRA's

    my($rras) = $ttRef->{'rra'};
    if (! $rras) {
        Warn("No rra tag found for target type $ttype.");
        return;
    }

    my($rra);
    foreach $rra (split(/\s*,\s*/, $rras)) {
        my($rraname) = lc($rra);
        my($r) = $main::gCT->configHash($name, 'rra', undef, $target);

        if (defined($r)) {
            if (defined $r->{$rraname}) {
                push(@rraDesc, "RRA:$r->{$rraname}");
            } else {
                Warn("RRA $rra referenced by target " .
                     "type $ttype does not exist.");
                return;
            }
        } else {
            # this shouldn't happen... right?
            Warn("Could not find RRA dictionary.");
            return;
        }
    }

    push(@arg, @dsDesc, @rraDesc);

    Info("Creating datafile $datafile for target name $tname.");
    Debug(join(' ', 'RRDs::create', @arg));
    RRDs::create(@arg);
    if (my $error = RRDs::error()) {
        Warn("Cannot create $datafile: $error\n");
    }

    return 1;
}

# Local Variables:
# mode: perl
# indent-tabs-mode: nil
# tab-width: 4
# perl-indent-level: 4
# End: