Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

torrus_configsnapshot(8) [debian man page]

TORRUS_CONFIGSNAPSHOT(8)					      torrus						  TORRUS_CONFIGSNAPSHOT(8)

NAME

       configsnapshot - Generates a configuration snapshot for a Torrus tree.

SYNOPSIS

       torrus configsnapshot --tree=TREENAME [options...]

DESCRIPTION

       This command generates a configuration snapshot from current datasources for tree TREENAME. The output is an XML file, ready for
       compilation, representing all datasources, monitors and tokensets of a given tree. The snapshot does not include view definitions.
       Templates and file patterns are expanded inside the file. It does not require any other XML configuration files, except for defaults.xml
       and your custom view definitions.

       Warning: "configsnapshot" from RRFW release 0.1.5 will not work correctly with databases from previous releases. Use RRFW release
       "0.1.4bf2" instead.  "configsnapshot" utility from RRFW release 0.1.4bf2 does not preserve aliases.

       This utility is useful in Torrus upgrade process. In case when RRD files structure is changing in Torrus default templates, and user(s)
       demand to preserve the historical data, the following steps could be done:

       o   Stop the collector and monitor processes.

       o   Install newest Torrus software and do not run "compilexml" immediately.

       o   Create snapshots of the trees that you want to preserve for historical reasons:

	     torrus configsnapshot --tree=myrouters 
	       --out=/etc/torrus/xmlconfig/myrouters-snapshot.xml

       o   If needed, move the existing RRD files into different directory. Then change the "data-dir" parameters in the snapshot XML accordingly.

       o   Create a new tree with only the snapshot file in it. Compile the tree.

       o   At this stage, it is up to the user to decide wether to continue running the collector and monitor daemons for this new tree. The old
	   data may be preserved for historical reference, and collector may be run with the newest tree structure and definitions.

OPTIONS

       --tree=TREE
	   Mandatory parameter specifying the tree name.

       --out=FILE
	   Sets the output file to FILE. Default is snapshot.xml.

       --param=PARAM  --value=VALUE
	   Sets the filter on datasource leaves that have to be included in the snapshot.  PARAM specifies the name of the datasource parameter,
	   and VALUE sets the matching value. By default the numeric comparison is performed.

       --op=OPERATOR
	   Sets the fiter comparison operator. Accepted values: = (numeric), eq (text string comparison), and re (regular expression match).
	   Default is numeric comparison.

       --verbose
	   Displays some extra information.

       --help
	   Displays a help message.

FILES

       /usr/share/torrus/xmlconfig/defaults.xml
	   XML configuration file with default settings for the datasources and tokensets, as well as default view definitions.

       snapshot.xml
	   Default configsnapshot output file.

SEE ALSO

       torrus(8), torrus_compilexml(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_CONFIGSNAPSHOT(8)

Check Out this Related Man Page

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)
Man Page