1 # Copyright (C) 2004 Stanislav Sinyagin
3 # This program is free software; you can redistribute it and/or modify
4 # it under the terms of the GNU General Public License as published by
5 # the Free Software Foundation; either version 2 of the License, or
6 # (at your option) any later version.
8 # This program is distributed in the hope that it will be useful,
9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 # GNU General Public License for more details.
13 # You should have received a copy of the GNU General Public License
14 # along with this program; if not, write to the Free Software
15 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
17 # $Id: torrus_collector.pod.in,v 1.1 2010-12-27 00:04:38 ivan Exp $
18 # Stanislav Sinyagin <ssinyagin@yahoo.com>
24 collector - Torrus data Collector.
28 B<torrus collector> --tree=I<TREENAME> [I<options...>]
32 This command starts the Collector process for the tree I<TREENAME>. By
33 default it forks into a daemon, sets the log output file to
34 F<@logdir@/collector.TREENAME.log>, performs one
35 Collector cycle, and sleeps until the next cycle is scheduled. In
36 daemon mode the log file can be reopened by sending it a SIGHUP
39 Collector cycle scheduling is controlled by two parameters defined
40 for each individual configuration leaf: C<collector-period> and
41 C<collector-timeoffset>. See the B<Torrus Configuration Guide> for more
44 The number of OID (Object IDentifier) variable bindings sent by
45 Collector is controlled by the datasource parameter C<snmp-oids-per-pdu>.
46 It is set to a default value of 40 in F<snmp-defs.xml>, and may be
47 overwritten at the host level.
53 =item B<--instance>=I<N>
55 Defines the collector instance. A single tree can allow more than one
56 collector instance. The number of instances is defined in C<run> hash
57 in the F<torrus-siteconfig.pl>'s C<%Torrus::Global::treeConfig>.
58 If the number of instances is more than one, this option is mandatory.
59 The collecting job is split between the instances, and normally all
60 instances should be started by the startup scripts. The tree should
61 be re-compiled after the number of instances is changed in the siteconfig.
62 In the example below the tree I<tree_A> will be served by three
65 %Torrus::Global::treeConfig = (
67 'description' => 'The First Tree',
68 'xmlfiles' => [qw(a1.xml a2.xml a3.xml)],
69 'run' => { 'collector' => 3, 'monitor' => 1 } },
74 Prevents the process from becoming a daemon and sets the log to STDERR.
78 Instructs the collector to run once and exit. Implies B<--nodaemon>.
82 Instructs the collector process to continue running even if no collector
83 datasources are defined in the tree. In this case, the process will check
84 once per hour if the configuration has changed.
88 Sets the log level to debug.
92 Sets the debug level to info.
96 Displays a help message.
104 =item F<@siteconfdir@/torrus-siteconfig.pl>
106 Torrus site configuration script.
108 =item F<@logdir@/collector.TREENAME.log>
110 Collector's log for the tree I<TREENAME>.
112 =item F<@distxmldir@/snmp-defs.xml>
114 Basic variable definitions for the SNMP collector.
120 L<torrus(@mansec_usercmd@)>
124 See more documentation at Torrus home page: http://torrus.org
129 Stanislav Sinyagin E<lt>ssinyagin@yahoo.comE<gt>