TORRUS_COLLECTOR(8) torrus TORRUS_COLLECTOR(8)NAME
collector - Torrus data Collector.
SYNOPSIS
torrus collector --tree=TREENAME [options...]
DESCRIPTION
This command starts the Collector process for the tree TREENAME. By default it forks into a daemon, sets the log output file to
/var/log/torrus/collector.TREENAME.log, 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 SIGHUP signal.
Collector cycle scheduling is controlled by two parameters defined for each individual configuration leaf: "collector-period" and
"collector-timeoffset". See the Torrus Configuration Guide for more details.
The number of OID (Object IDentifier) variable bindings sent by Collector is controlled by the datasource parameter "snmp-oids-per-pdu".
It is set to a default value of 40 in snmp-defs.xml, and may be overwritten at the host level.
OPTIONS --instance=N
Defines the collector instance. A single tree can allow more than one collector instance. The number of instances is defined in "run"
hash in the torrus-siteconfig.pl's %Torrus::Global::treeConfig. 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 tree_A will be served by
three collector instances:
%Torrus::Global::treeConfig = (
'tree_A' => {
'description' => 'The First Tree',
'xmlfiles' => [qw(a1.xml a2.xml a3.xml)],
'run' => { 'collector' => 3, 'monitor' => 1 } },
);
--nodaemon
Prevents the process from becoming a daemon and sets the log to STDERR.
--runonce
Instructs the collector to run once and exit. Implies --nodaemon.
--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.
--debug
Sets the log level to debug.
--verbose
Sets the debug level to info.
--help
Displays a help message.
FILES
/etc/torrus/conf/torrus-siteconfig.pl
Torrus site configuration script.
/var/log/torrus/collector.TREENAME.log
Collector's log for the tree TREENAME.
/usr/share/torrus/xmlconfig/snmp-defs.xml
Basic variable definitions for the SNMP collector.
SEE ALSO torrus(8)NOTES
See more documentation at Torrus home page: http://torrus.org
AUTHOR
Stanislav Sinyagin <ssinyagin@yahoo.com>
torrus 2.03 2013-07-26 TORRUS_COLLECTOR(8)
Check Out this Related Man Page
TORRUS_SNMPFAILURES(8) torrus TORRUS_SNMPFAILURES(8)NAME
snmpfailures - Displays SNMP collector failures.
SYNOPSIS
torrus snmpfailures --tree=TREENAME [options...]
OPTIONS --details
In addition to failure counters, list the failed SNMP hosts and the time stamps of failure events.
--help
Displays a help message.
DESCRIPTION
This utility prints the SNMP collector failure information in JSON format. Without --details option, it prints only the failure counters.
Upon collector startup or after the tree re-compilation, the failure counters are reset to zero.
The output is very convenient for further automatic processing in any scripting language.
The top level of the output is a JSON object with the following name/value pairs:
total_unreachable: NUMBER
Displays the number SNMP hosts that are currently unreachable. The number adds up across multiple collector instances for a given
tree. If a host becomes reachable again, the number is decreased.
total_deleted: NUMBER
Displays the number SNMP hosts that are completely removed from SNMP collection for the life cycle of the collector process. This
happens when a host is unreachable for too long time and the collector gives up to reach it again. The number adds up across multiple
collector instances for a given tree.
total_mib_errors: NUMBER
Displays the number of MIB errors (noSuchObject, noSuchInstance, and endOfMibView) during the collector life cycle. The number adds up
across multiple collector instances for a given tree.
detail_unreachable: OBJECT, detail_deleted: OBJECT
If the option --details is specified, these objects contain the host names and timestamps of the failures. The keys are
contactenations of SNMP host, UDP port, and SNMP community separated by "|". The values are objects representing the UNIX timestamp
and a human-readable time string.
detail_mib_errors: OBJECT
If the option --details is specified, this object displays the MIB error details: for each SNMP host, it lists the datasource leaves
which had these errors and the event timestamps.
EXAMPLES
The following example illustrates an SNMP host unreachable:
torrus failures --tree=main --details
{
"detail_deleted" : {},
"detail_mib_errors" : {},
"detail_unreachable" : {
"217.101.101.101|161|public" : {
"time" : "Fri Jul 23 14:15:10 2010",
"timestamp" : 1279887310
}
},
"total_deleted" : 0,
"total_mib_errors" : 0,
"total_unreachable" : 1
}
The following example illustrates a MIB error:
torrus failures --tree=main --details
{
"detail_deleted" : {},
"detail_mib_errors" : {
"217.101.102.102|161|public" : {
"count" : 1,
"nodes" : {
"/Routers/CMTS3/Temperature_Sensors/sensor_01" : {
"time" : "Fri Jul 23 15:26:14 2010",
"timestamp" : 1279891574
}
}
}
},
"detail_unreachable" : {},
"total_deleted" : 0,
"total_mib_errors" : 1,
"total_unreachable" : 0
}
SEE ALSO torrus(8),
NOTES
See more documentation at Torrus home page: http://torrus.org
AUTHOR
Stanislav Sinyagin <ssinyagin@yahoo.com>
torrus 2.03 2013-07-26 TORRUS_SNMPFAILURES(8)