File: graph-writer.pod

package info (click to toggle)
remstats 1.00a4-8woody1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 4,576 kB
  • ctags: 1,020
  • sloc: perl: 11,706; ansic: 2,776; makefile: 944; sh: 869
file content (60 lines) | stat: -rw-r--r-- 2,251 bytes parent folder | download
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
=cut

TITLE=graph-writer
DESCRIPTION=makes web-pages to generate the graphs and web-pages to tie the graphs together.
KEYWORDS=graph-writer
DOCTOP=index
DOCPREV=check-config
DOCNEXT=snmpif-setspeed

=pod

=head1 graph-writer

=head2 Usage:

=exec ../graph-writer -h 2>&1

=head2 Description:

This is the main remstats L<pagemaker|pagemakers>.  It makes the 
web-pages with the graphs and other pages to link them together and 
organize them.  There are three kinds of page that it makes:

=over 4

=item B<Indices> - The main three indices are the B<Overall Index>, the
B<Ping Index> and the B<Quick Index>.  Each of these shows all the hosts
being monitored, grouped by the group you assigned them to.  The 
B<Overall Index> shows a section for each host, with a link to all of the
graphs for that host.  The B<Ping Index> shows a small graph of the last
two hours of ping data for that host, for each host, with the graph background
specially coloured for hosts which aren't reachable.  The B<Quick Index>
shows, for each host: a link, a status indicator and optionally a link to
L<alert.cgi|alert-cgi> for alerts for that host.

There is also the B<Custom Index> to show links to all the 
L<customgraphs|configfile-customgraphs>.

=item B<Host Pages> - For each host, there is a B<Host Page> which shows
some information about the host and all the day graphs for that host.  The 
graphs are all links to ...

=for html <P></P>

=item B<Graph Pages> - Each graph is also available in various timespans, 
depending on the L<times|configfile-times> that you specified in
the L<rrd|configfile-rrds> definition which caused the generation of
that graph.

=back 4

Graph-writer is the replacement for both C<grapher> and C<html-writer>.  
Before version 0.10.0, C<grapher> would make new graphs, as part of the 
update run, and C<html-writer> would re-write the html pages.  Now, 
C<graph-writer> makes a CGI script for each web-page, using C<rrdcgi> as 
its interpreter.  C<Rrdcgi> simply spits out the page as it was written 
with "magic cookies" replaced by <IMG SRC...> tags and makes sure that 
there is a recent version of the graph file.  Much better than generating 
all the graphs every five minutes and have most of them never get looked at.