smokeping_matchers_base(3) [debian man page]

..::lib::Smokeping::matchers::base(3)				     SmokePing				     ..::lib::Smokeping::matchers::base(3)

NAME

       Smokeping::matchers::base - Base Class for implementing SmokePing Matchers

OVERVIEW

       This is the base class for writing SmokePing matchers. Every matcher must inherit from the base class and provide it's own methods for the
       'business' logic.

       Note that the actual matchers must have at least one capital letter in their name, to differentiate them from the base class(es).

DESCRIPTION

       Every matcher must provide the following methods:

   new
       The new method expects hash elements as an argument eg new({x=>'d+',y=>'d+'},x=>1,y=>2). The first part is a syntax rule for the
       arguments it should expect and the second part are the arguments itself. The first part will be supplied by the child class as it calls the
       parent method.

   Length
       The Length method returns the number of values the matcher will expect from SmokePing. This method must be overridden by the children of
       the base class.

   Desc
       Simply return the description of the function. This method must be overwritten by a children of the base class.

   Test
       Run the matcher and return true or false. The Test method is called with a hash containing two arrays giving it access to both rtt and loss
       values.

	 my $data=shift;
	 my @rtt = @{$data->{rtt}};
	 my @loss = @{$data->{loss}};

       The arrays are ordered from old to new.

	 @rdd[old..new]

       There may be more than the expected number of elements in this array. Address them with $x[-1] to $x[-max].

       There's also a key called 'prevmatch' in the hash. It contains the value returned by the previous call of the 'Test' method. This allows
       for somewhat more intelligent alerting due to state awareness.

	 my $prevmatch = $data->{prevmatch};

COPYRIGHT

       Copyright (c) 2004 by OETIKER+PARTNER AG. All rights reserved.

LICENSE

       This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by
       the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

       This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

       You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation,
       Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

AUTHOR

       Tobias Oetiker <tobi@oetiker.ch>

2.6.8								    2012-02-26				     ..::lib::Smokeping::matchers::base(3)

SMOKEPING(1)							     SmokePing							      SMOKEPING(1)

NAME

       smokeping - Commandline tool for SmokePing

SYNOPSIS

       smokeping [ --email | --makepod | --version | --restart ]

	Options:

	--man[=x]    Show the manpage for the program (or for probe x, if specified)

	--help	     Help :-)

	--email      Send SmokePing Agents to all Targets marked DYNAMIC

	--config=x   Use a config file different from the default

	--check      Just check the config file syntax, don't start the daemon

	--makepod[=x] Create POD documentation on Config file (or for probe x, if specified)

	--version    Show SmokePing Version

	--debug      Run Only once and do not Fork

	--debug-daemon Start the daemon with debugging enabled

	--restart    Restart SmokePing

	--reload     Reload configuration in the running process without interrupting
		     any probes

	--nodaemon    Do no daemonize the process (no fork)

	--filter=x   Only measure entries which pass the filter x

	--logfile=x    Append warnings to logfile x.

	--static[=x] Generates a static website in directory x.  If x is left out,
		     pagedir from the config is used.

	--nosleep    For debugging you may want to run SmokePing without sleep interval

	--gen-examples Generate the smokeping_examples document and example config files
		       (to be used while building inside the smokeping distribution)
		       With --check : check the syntax of the generated examples.

	--master-url=s Run smokeping in slave mode. Attach to master for config.

	--slave-name=s By default the slave will use whatever it thinks its name
		       is, when talking to its master. In some cases you may
		       probably want to override this.

	--shared-secret=s File containing the shared secret for talking to the server.

	--cache-dir=s Directory for temporary data storage when running in slave mode.

	--pid-dir=s Directory for the PID file when running in slave mode.
		    (optional, defaults to --cache-dir)

DESCRIPTION

       The smokeping tool is the commandline part of the SmokePing system. Its main function is to run as a daemon and send Pings to all the
       Targets you have specified in the Config file. When you call smokeping without arguments it will start as a daemon and do its work.

       If called with an argument, then further functions can be activated, as seen in the Synopsis above. The --email function is explained in
       the documentation on the config file.

       The --filter option allows you to run the daemon on a big config file, but have the config file filtered and only measure the entries that
       pass the filter. This is useful for remote measurement. Run Smokeping with two exclusive filters in two locations and rsync the rrds back
       to the webserver host where you run the cgi. Filters act on the section names in the config file. Multiple section names are concatenated
       with / like path names:

	*** targets ***
	+ A
	....
	+ B
	...
	++ C

       This gives

	/A

       and

	/B, /B/C

       If I want to monitor /A my filter would look like this:

	--filter=/A

       Filters follow regular expression syntax. The are always anchored at the tip of the string.  by adding a ! to the front of the filter
       string you negate it. Matching entries will be excluded from monitoring.  Multiple --filter arguments can be used to assemble complex
       filters:

	 --filter=/A --filter=/B

       would include all the targets

	 --filter=/A --filter=/B --filter=!/B/C

       would include all but /B/C.

       The --makepod does get used internally to produce the documentation on the SmokePing configuration file.

       Please refer to the installation document for detailed setup instructions.

SETUP

       When installing SmokePing, this file has to be adjusted to fit your local system. Three paths have to be entered.

       One pointing to your rrdtool installation

	use lib qw(/usr/pack/rrdtool-1.0.33-to/lib/perl);

       One pointing to the place where you have installed the SmokePing libraries

	use lib qw(/home/oetiker/public_html/smokeping/lib);

       The third path is the argument to the Smokeping::main command. It points to the SmokePing configuration file.

	use Smokeping;
	Smokeping::main("/home/oetiker/.smokeping/config");

COPYRIGHT

       Copyright (c) 2002 by Tobias Oetiker. All right reserved.

LICENSE

       This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by
       the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

       This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

       You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation,
       Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

AUTHOR

       Tobias Oetiker <tobi@oetiker.ch>

2.6.8								    2012-02-26							      SMOKEPING(1)