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
|
=cut
TITLE=Tools
DESCRIPTION=remstats programs which don't fit into any of the other categories
KEYWORDS=tools
DOCTOP=index
DOCPREV=cgis
DOCNEXT=do-traceroute
=pod
=head1 Tools
=head2 Configuration Tools
These tools are intended to help you build the hosts part of your
configuration file. They take a file (or files) of hostnames and
emit (or update) L<host config-files|configfile-hosts> for them.
There are currently no config generators
for the log-collector, the remoteping-collector.
=over 4
=item L<make-ping-hosts>
Supply it with a file (or files) named for the group you want to put the
hosts in and it will generate minimal host config-files for each of the hosts.
If the file has a '_' in the name, the group name used will have spaces
substituted for the '_'s.
=item L<make-port-hosts>
Supply it with a file of hostnames and it will do a very limited port-scan
to find which services seem to be running on those hosts and generate the
appropriate rrd lines invoking the port-collector.
=item L<make-snmp-hosts>
Supply it with a file of hostnames and it will spit out host config-files and
rrd lines invoking the snmp-collector.
=item L<check-config>
As you might suspect, it does a basic check on the config file. It also does
two other things: first, it creates any missing directories, so the other
scripts won't complain, and second, it pulls out some config information
so that the shell-scripts don't have to parse the config file. The
L<run-remstats> script runs it first, to make sure
the config file is ok, but it's also a good idea to run it yourself
when you change the config file, just to make sure it's still valid.
=item L<snmp-showif>
Shows some basic SNMP interface information, so you can decide which interfaces
to monitor.
=back 4
=for html <HR>
=for text
-------------------------------------------------------------------
=head2 CGI scripts
These are intended to be invoked via the html-writer created toolbars, to
do the supplied functions to the host in question.
=over 4
=item L<alert.cgi|alert-cgi>
Shows the current alert status of selected rrd variables.
=item L<dataimage.cgi|dataimage-cgi>
Generates images based on live data.
=item L<datapage.cgi|datapage-cgi>
Generates web-pages containing dynamic data.
=item L<ping.cgi|ping-cgi>
Ping the host.
=item L<showlog.cgi|showlog-cgi>
display selected portions of the remstats log files.
=item L<traceroute.cgi|traceroute-cgi>
Invoke traceroute and find out how your packets are getting to the host.
The traceroute output is slightly massaged to provide links to look up
various things.
=item L<whois.cgi|whois-cgi>
The traceroute.cgi script makes links to this to look up ASNs and IP numbers.
=back 4
=for html <HR>
=for text
-------------------------------------------------------------------
=head2 Main Process Scripts
To check that the configuration file is syntactically valid, and to create
any missing directories, you can run L<check-config>.
remstats also supplies a collection of shell-scripts to invoke a specific
sequence of programs. Many of them simply invoke a collector, run
its output through L<updater> Those are: C<do-log>, C<do-ping>,
C<do-port>, C<do-remoteping>, C<do-snmp> and C<do-unix-status>.
L<alert-email> is triggered by the L<alert-monitor> to send email
when a problem is detected. You can have your own alert mechanism if
you want; look at the L<alert-monitor> docs.
The final script is L<do-remstats>, which is what you usually run out of
crontab to do "everything". It also runs L<graph-writer> and the rest
of the L<pagemakers>.
=for html <HR>
=for text
-------------------------------------------------------------------
=head2 Miscellaneous Scripts
=over 4
=item L<rrd-report>
This makes simple reports on data in an RRD. It's not tied into remstats
in any way and should run fine on its own.
=back 4
|
