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
|
#!/usr/bin/perl
# Copyright (C) 2008-2011 Florian Forster
# Copyright (C) 2011 noris network AG
#
# 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; only version 2 of the License is applicable.
#
# 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.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#
# Authors:
# Florian "octo" Forster <octo at collectd.org>
use strict;
use warnings;
use utf8;
use vars (qw($BASE_DIR));
BEGIN
{
if (defined $ENV{'SCRIPT_FILENAME'})
{
if ($ENV{'SCRIPT_FILENAME'} =~ m{^(/.+)/bin/[^/]+$})
{
$::BASE_DIR = $1;
unshift (@::INC, "$::BASE_DIR/lib");
}
}
}
use Carp (qw(cluck confess));
use CGI (':cgi');
use CGI::Carp ('fatalsToBrowser');
use HTML::Entities ('encode_entities');
use Data::Dumper;
use Collectd::Graph::Config (qw(gc_read_config gc_get_scalar));
use Collectd::Graph::TypeLoader (qw(tl_load_type));
use Collectd::Graph::Common (qw(get_files_from_directory get_all_hosts
get_timespan_selection get_selected_files get_host_selection
get_plugin_selection flush_files));
use Collectd::Graph::Type ();
our $TimeSpans =
{
Hour => 3600,
Day => 86400,
Week => 7 * 86400,
Month => 31 * 86400,
Year => 366 * 86400
};
my %Actions =
(
list_hosts => \&action_list_hosts,
show_selection => \&action_show_selection
);
sub base_dir
{
if (defined $::BASE_DIR)
{
return ($::BASE_DIR);
}
if (!defined ($ENV{'SCRIPT_FILENAME'}))
{
return;
}
if ($ENV{'SCRIPT_FILENAME'} =~ m{^(/.+)/bin/[^/]+$})
{
$::BASE_DIR = $1;
return ($::BASE_DIR);
}
return;
}
sub lib_dir
{
my $base = base_dir ();
if ($base)
{
return "$base/lib";
}
else
{
return "../lib";
}
}
sub sysconf_dir
{
my $base = base_dir ();
if ($base)
{
return "$base/etc";
}
else
{
return "../etc";
}
}
sub init
{
my $lib_dir = lib_dir ();
my $sysconf_dir = sysconf_dir ();
if (!grep { $lib_dir eq $_ } (@::INC))
{
unshift (@::INC, $lib_dir);
}
gc_read_config ("$sysconf_dir/collection.conf");
}
sub main
{
my $Debug = param ('debug') ? 1 : 0;
my $action = param ('action') || 'list_hosts';
if (!exists ($Actions{$action}))
{
print STDERR "No such action: $action\n";
return (1);
}
init ();
$Actions{$action}->();
return (1);
} # sub main
sub can_handle_xhtml
{
my %types = ();
if (!defined $ENV{'HTTP_ACCEPT'})
{
return;
}
for (split (',', $ENV{'HTTP_ACCEPT'}))
{
my $type = lc ($_);
my $q = 1.0;
if ($type =~ m#^([^;]+);q=([0-9\.]+)$#)
{
$type = $1;
$q = 0.0 + $2;
}
$types{$type} = $q;
}
if (!defined ($types{'application/xhtml+xml'}))
{
return;
}
elsif (!defined ($types{'text/html'}))
{
return (1);
}
elsif ($types{'application/xhtml+xml'} < $types{'text/html'})
{
return;
}
else
{
return (1);
}
} # can_handle_xhtml
my $html_started;
sub start_html
{
return if ($html_started);
my $end;
my $begin;
my $timespan;
$end = time ();
$timespan = get_timespan_selection ();
$begin = $end - $timespan;
if (can_handle_xhtml ())
{
print header (-Content_Type => 'application/xhtml+xml; charset=UTF-8');
print <<HTML;
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd"
xml:lang="en">
HTML
}
else
{
print header (-Content_Type => 'text/html; charset=UTF-8');
print <<HTML;
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
<html>
HTML
}
print <<HTML;
<head>
<title>collection.cgi, Version 3</title>
<link rel="icon" href="../share/shortcut-icon.png" type="image/png" />
<link rel="stylesheet" href="../share/style.css" type="text/css" />
<script type="text/javascript" src="../share/navigate.js"></script>
</head>
<body onload="nav_init ($begin, $end);">
HTML
$html_started = 1;
}
sub end_html
{
print <<HTML;
</body>
</html>
HTML
$html_started = 0;
}
sub contains_invalid_chars
{
my $str = shift;
for (split (m//, $str))
{
my $n = ord ($_);
# Whitespace is allowed.
if (($n >= 9) && ($n <= 13))
{
next;
}
elsif ($n < 32)
{
return (1);
}
}
return;
}
sub show_selector
{
my $timespan_selection = get_timespan_selection ();
my $host_selection = get_host_selection ();
my $plugin_selection = get_plugin_selection ();
print <<HTML;
<form action="${\script_name ()}" method="get">
<fieldset>
<legend>Data selection</legend>
<select name="hostname" multiple="multiple" size="15">
HTML
for (sort (keys %$host_selection))
{
next if contains_invalid_chars ($_);
my $host = encode_entities ($_);
my $selected = $host_selection->{$_}
? ' selected="selected"'
: '';
print qq# <option value="$host"$selected>$host</option>\n#;
}
print <<HTML;
</select>
<select name="plugin" multiple="multiple" size="15">
HTML
for (sort (keys %$plugin_selection))
{
next if contains_invalid_chars ($_);
my $plugin = encode_entities ($_);
my $selected = $plugin_selection->{$_}
? ' selected="selected"'
: '';
print qq# <option value="$plugin"$selected>$plugin</option>\n#;
}
print <<HTML;
</select>
<select name="timespan">
HTML
for (sort { $TimeSpans->{$a} <=> $TimeSpans->{$b} } (keys (%$TimeSpans)))
{
next if contains_invalid_chars ($_);
my $name = encode_entities ($_);
my $value = $TimeSpans->{$_};
my $selected = ($value == $timespan_selection)
? ' selected="selected"'
: '';
print qq# <option value="$value"$selected>$name</option>\n#;
}
print <<HTML;
</select>
<input type="hidden" name="action" value="show_selection" />
<input type="submit" name="ok_button" value="OK" />
</fieldset>
</form>
HTML
} # show_selector
sub action_list_hosts
{
start_html ();
show_selector ();
my @hosts = get_all_hosts ();
print " <ul>\n";
for (sort @hosts)
{
my $url = encode_entities (script_name () . "?action=show_selection;hostname=$_");
next if contains_invalid_chars ($_);
my $name = encode_entities ($_);
print qq# <li><a href="$url">$name</a></li>\n#;
}
print " </ul>\n";
end_html ();
} # action_list_hosts
=head1 MODULE LOADING
This script makes use of the various B<Collectd::Graph::Type::*> modules. If a
file like C<foo.rrd> is encountered it tries to load the
B<Collectd::Graph::Type::Foo> module and, if that fails, falls back to the
B<Collectd::Graph::Type> base class.
If you want to create a specialized graph for a certain type, you have to
create a new module which inherits from the B<Collectd::Graph::Type> base
class. A description of provided (and used) methods can be found in the inline
documentation of the B<Collectd::Graph::Type> module.
There are other, more specialized, "abstract" classes that possibly better fit
your need. Unfortunately they are not yet documented.
=over 4
=item B<Collectd::Graph::Type::GenericStacked>
Specialized class that groups files by their plugin instance and stacks them on
top of each other. Example types that inherit from this class are
B<Collectd::Graph::Type::Cpu> and B<Collectd::Graph::Type::Memory>.
=item B<Collectd::Graph::Type::GenericIO>
Specialized class for input/output graphs. This class can only handle files
with exactly two data sources, input and output. Example types that inherit
from this class are B<Collectd::Graph::Type::DiskOctets> and
B<Collectd::Graph::Type::IfOctets>.
=back
=cut
sub action_show_selection
{
start_html ();
show_selector ();
my $all_files;
my $timespan;
my $types = {};
my $id_counter = 0;
$all_files = get_selected_files ();
$timespan = get_timespan_selection ();
if (param ('debug'))
{
print "<pre>", Data::Dumper->Dump ([$all_files], ['all_files']), "</pre>\n";
}
# Send FLUSH command to the daemon if necessary and possible.
flush_files ($all_files,
begin => time () - $timespan,
end => time (),
addr => gc_get_scalar ('UnixSockAddr', undef),
interval => gc_get_scalar ('Interval', 10));
for (@$all_files)
{
my $file = $_;
my $type = ucfirst (lc ($file->{'type'}));
$type =~ s/[^A-Za-z0-9_]//g;
$type =~ s/_([A-Za-z0-9])/\U$1\E/g;
if (!defined ($types->{$type}))
{
$types->{$type} = tl_load_type ($file->{'type'});
if (!$types->{$type})
{
warn ("tl_load_type (" . $file->{'type'} . ") failed");
next;
}
}
$types->{$type}->addFiles ($file);
}
#print STDOUT Data::Dumper->Dump ([$types], ['types']);
print qq# <table>\n#;
for (sort (keys %$types))
{
my $type = $_;
if (!defined ($types->{$type}))
{
next;
}
my $graphs_num = $types->{$type}->getGraphsNum ();
for (my $i = 0; $i < $graphs_num; $i++)
{
my $args = $types->{$type}->getGraphArgs ($i);
my $url = encode_entities ("graph.cgi?$args;begin=-$timespan");
my $id = sprintf ("graph%04i", $id_counter++);
print " <tr>\n";
print " <td rowspan=\"$graphs_num\">$type</td>\n" if ($i == 0);
print <<EOF;
<td>
<div class="graph_canvas">
<div class="graph_float">
<img id="${id}" class="graph_image"
alt="A graph"
src="$url" />
<div class="controls zoom">
<div title="Earlier"
onclick="nav_move_earlier ('${id}');">←</div>
<div title="Zoom out"
onclick="nav_zoom_out ('${id}');">-</div>
<div title="Zoom in"
onclick="nav_zoom_in ('${id}');">+</div>
<div title="Later"
onclick="nav_move_later ('${id}');">→</div>
</div>
<div class="controls preset">
<div title="Show current hour"
onclick="nav_time_reset ('${id}', 3600);">H</div>
<div title="Show current day"
onclick="nav_time_reset ('${id}', 86400);">D</div>
<div title="Show current week"
onclick="nav_time_reset ('${id}', 7 * 86400);">W</div>
<div title="Show current month"
onclick="nav_time_reset ('${id}', 31 * 86400);">M</div>
<div title="Show current year"
onclick="nav_time_reset ('${id}', 366 * 86400);">Y</div>
<div title="Set all images to this timespan"
onclick="nav_set_reference ('${id}');">!</div>
</div>
</div>
</div>
</td>
EOF
# print qq# <td><img src="$url" /></td>\n#;
print " </tr>\n";
}
}
print " </table>\n";
end_html ();
}
main ();
=head1 SEE ALSO
L<Collectd::Graph::Type>
=head1 AUTHOR AND LICENSE
Copyright (c) 2008 by Florian Forster
E<lt>octoE<nbsp>atE<nbsp>verplant.orgE<gt>. Licensed under the terms of the GNU
General Public License, VersionE<nbsp>2 (GPLv2).
=cut
# vim: set shiftwidth=2 softtabstop=2 tabstop=8 :
|
