.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "TORRUS_COLLECTOR 8" .TH TORRUS_COLLECTOR 8 "2016-11-17" "torrus 2.09" "torrus" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" collector \- Torrus data Collector. .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBtorrus collector\fR \-\-tree=\fI\s-1TREENAME\s0\fR [\fIoptions...\fR] .SH "DESCRIPTION" .IX Header "DESCRIPTION" This command starts the Collector process for the tree \fI\s-1TREENAME\s0\fR. By default it forks into a daemon, sets the log output file to \&\fI/var/log/torrus/collector.TREENAME.log\fR, performs one Collector cycle, and sleeps until the next cycle is scheduled. In daemon mode the log file can be reopened by sending it a \s-1SIGHUP\s0 signal. .PP Collector cycle scheduling is controlled by two parameters defined for each individual configuration leaf: \f(CW\*(C`collector\-period\*(C'\fR and \&\f(CW\*(C`collector\-timeoffset\*(C'\fR. See the \fBTorrus Configuration Guide\fR for more details. .PP The number of \s-1OID \s0(Object IDentifier) variable bindings sent by Collector is controlled by the datasource parameter \f(CW\*(C`snmp\-oids\-per\-pdu\*(C'\fR. It is set to a default value of 40 in \fIsnmp\-defs.xml\fR, and may be overwritten at the host level. .SH "OPTIONS" .IX Header "OPTIONS" .IP "\fB\-\-instance\fR=\fIN\fR" 4 .IX Item "--instance=N" Defines the collector instance. A single tree can allow more than one collector instance. The number of instances is defined in \f(CW\*(C`run\*(C'\fR hash in the \fItorrus\-siteconfig.pl\fR's \f(CW%Torrus::Global::treeConfig\fR. If the number of instances is more than one, this option is mandatory. The collecting job is split between the instances, and normally all instances should be started by the startup scripts. The tree should be re-compiled after the number of instances is changed in the siteconfig. In the example below the tree \fItree_A\fR will be served by three collector instances: .Sp .Vb 6 \& %Torrus::Global::treeConfig = ( \& \*(Aqtree_A\*(Aq => { \& \*(Aqdescription\*(Aq => \*(AqThe First Tree\*(Aq, \& \*(Aqxmlfiles\*(Aq => [qw(a1.xml a2.xml a3.xml)], \& \*(Aqrun\*(Aq => { \*(Aqcollector\*(Aq => 3, \*(Aqmonitor\*(Aq => 1 } }, \& ); .Ve .IP "\fB\-\-nodaemon\fR" 4 .IX Item "--nodaemon" Prevents the process from becoming a daemon and sets the log to \s-1STDERR.\s0 .IP "\fB\-\-runonce\fR" 4 .IX Item "--runonce" Instructs the collector to run once and exit. Implies \fB\-\-nodaemon\fR. .IP "\fB\-\-runalways\fR" 4 .IX Item "--runalways" Instructs the collector process to continue running even if no collector datasources are defined in the tree. In this case, the process will check once per hour if the configuration has changed. .IP "\fB\-\-debug\fR" 4 .IX Item "--debug" Sets the log level to debug. .IP "\fB\-\-verbose\fR" 4 .IX Item "--verbose" Sets the debug level to info. .IP "\fB\-\-help\fR" 4 .IX Item "--help" Displays a help message. .SH "FILES" .IX Header "FILES" .IP "\fI/etc/torrus/conf/torrus\-siteconfig.pl\fR" 4 .IX Item "/etc/torrus/conf/torrus-siteconfig.pl" Torrus site configuration script. .IP "\fI/var/log/torrus/collector.TREENAME.log\fR" 4 .IX Item "/var/log/torrus/collector.TREENAME.log" Collector's log for the tree \fI\s-1TREENAME\s0\fR. .IP "\fI/usr/share/torrus/xmlconfig/snmp\-defs.xml\fR" 4 .IX Item "/usr/share/torrus/xmlconfig/snmp-defs.xml" Basic variable definitions for the \s-1SNMP\s0 collector. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fItorrus\fR\|(8) .SH "NOTES" .IX Header "NOTES" See more documentation at Torrus home page: http://torrus.org .SH "AUTHOR" .IX Header "AUTHOR" Stanislav Sinyagin