torrus/doc/manpages/torrus_collector.pod.in

   1 #  Copyright (C) 2004  Stanislav Sinyagin
   2 #
   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.
   7 #
   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.
  12 #
  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.
  16
  17 # $Id: torrus_collector.pod.in,v 1.1 2010-12-27 00:04:38 ivan Exp $
  18 # Stanislav Sinyagin <ssinyagin@yahoo.com>
  19 #
  20 #
  21
  22 =head1 NAME
  23
  24 collector - Torrus data Collector.
  25
  26 =head1 SYNOPSIS
  27
  28 B<torrus collector> --tree=I<TREENAME> [I<options...>]
  29
  30 =head1 DESCRIPTION
  31
  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
  37 signal.
  38
  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
  42 details.
  43
  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.
  48
  49 =head1 OPTIONS
  50
  51 =over 4
  52
  53 =item B<--instance>=I<N>
  54
  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
  63 collector instances:
  64
  65   %Torrus::Global::treeConfig = (
  66     'tree_A' => {
  67       'description' => 'The First Tree',
  68       'xmlfiles' => [qw(a1.xml a2.xml a3.xml)],
  69       'run' => { 'collector' => 3, 'monitor' => 1 } },
  70    );
  71
  72 =item B<--nodaemon>
  73
  74 Prevents the process from becoming a daemon and sets the log to STDERR.
  75
  76 =item B<--runonce>
  77
  78 Instructs the collector to run once and exit. Implies B<--nodaemon>.
  79
  80 =item B<--runalways>
  81
  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.
  85
  86 =item B<--debug>
  87
  88 Sets the log level to debug.
  89
  90 =item B<--verbose>
  91
  92 Sets the debug level to info.
  93
  94 =item B<--help>
  95
  96 Displays a help message.
  97
  98 =back
  99
 100 =head1 FILES
 101
 102 =over 4
 103
 104 =item F<@siteconfdir@/torrus-siteconfig.pl>
 105
 106 Torrus site configuration script.
 107
 108 =item F<@logdir@/collector.TREENAME.log>
 109
 110 Collector's log for the tree I<TREENAME>.
 111
 112 =item F<@distxmldir@/snmp-defs.xml>
 113
 114 Basic variable definitions for the SNMP collector.
 115
 116 =back
 117
 118 =head1 SEE ALSO
 119
 120 L<torrus(@mansec_usercmd@)>
 121
 122 =head1 NOTES
 123
 124 See more documentation at Torrus home page: http://torrus.org
 125
 126
 127 =head1 AUTHOR
 128
 129 Stanislav Sinyagin E<lt>ssinyagin@yahoo.comE<gt>