munin-run(1p) [debian man page]

MUNIN-RUN(1p)						User Contributed Perl Documentation					     MUNIN-RUN(1p)

NAME

       munin-run - A program to run Munin plugins from the command line

SYNOPSIS

       munin-run [options] <plugin> [ config | autoconf | snmpconf | suggest ]

DESCRIPTION

       munin-run is a script to run Munin plugins from the command-line.  It's useful when debugging plugins, as they are run in the same
       conditions as they are under munin-node.

OPTIONS

       --config <configfile>
	    Use <file> as configuration file. [/etc/munin/munin-node.conf]

       --servicedir <dir>
	    Use <dir> as plugin dir. [/etc/munin/plugins/]

       --sconfdir <dir>
	    Use <dir> as plugin configuration dir. [/etc/munin/plugin-conf.d/]

       --sconffile <file>
	    Use <file> as plugin configuration. Overrides sconfdir.  [undefined]

       --paranoia
	    Only run plugins owned by root and check permissions.  [disabled]

       --help
	    View this help message.

       --debug
	    Print debug messages.  Debug messages are sent to STDOUT and are prefixed with "#" (this makes it easier for other parts of munin to
	    use munin-run and still have --debug on).  Only errors go to STDERR.

       --pidebug
	    Plugin debug.  Sets the environment variable MUNIN_DEBUG to 1 so that plugins may enable debugging.  [disabled]

       --version
	    Show version information.

FILES

	   /etc/munin/munin-node.conf
	   /etc/munin/plugins/*
	   /etc/munin/plugin-conf.d/*
	   /var/run/munin/munin-node.pid
	   /var/log/munin/munin-node.log

VERSION

       This is munin-run (munin-node) v2.0.6-4+deb7u2

       $Id$

AUTHORS

       Audun Ytterdal, Jimmy Olsen, Tore Anderson, Nicolai Langfeldt.

BUGS

       Please see http://munin-monitoring.org/report/1 <http://munin-monitoring.org/report/1>.

COPYRIGHT

       Copyright (C) 2002-2009 Audun Ytterdal, Jimmy Olsen, Tore Anderson, Nicolai Langfeldt / Linpro AS.

       This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A
       PARTICULAR PURPOSE.

       This program is released under the GNU General Public License

perl v5.14.2							    2013-11-12							     MUNIN-RUN(1p)

Munin::Node::Configure::Plugin(3pm)			User Contributed Perl Documentation		       Munin::Node::Configure::Plugin(3pm)

NAME

       Munin::Node::Configure::Plugin - Class representing a plugin, along with its installed and suggested services.

SYNOPSIS

	 my $plugin = Munin::Node::Configure::Plugin->new();

METHODS

       new(%args)
	   Constructor.

	   Required arguments are 'name' and 'path', which should be the basename and full path of the plugin, respectively.

       is_wildcard()
	   Returns true if the plugin is a wildcard.  In the case of SNMP plugins, only double-wild plugins will return true (ie. 'snmp__memory'
	   would return false, but 'snmp__if_' would return true).

       is_snmp()
	   Returns true if the plugin is an SNMP plugin.

       in_family(@families)
	   Returns true if plugin's family is in @families, false otherwise.

       is_installed()
	   Returns 'yes' if one or more links to this plugin exist in the service directory, 'no' otherwise.

       suggestion_string()
	   Returns a string detailing whether or not autoconf considers that the plugin should be installed.  The string may also report the
	   reason why the plugin declined to be installed, or the list of suggestions it provided, if this information is available.

       installed_services_string()
	   Returns a string detailing which wildcards are installed for this plugin.

       services_to_add()
       services_to_remove()
	   Return a list of service names that should be added or removed for this plugin.

       add_instance($name)
	   Associates a link from the service directory with this plugin.

       add_suggestions(@suggestions)
	   Adds @suggestions to the list of suggested wildcards for this plugin.  They are not validated.

       read_magic_markers()
	   Sets the family and capabilities from the magic markers embedded in the plugin's executable, as specified by
	   http://munin-monitoring.org/wiki/ConcisePlugins#Magicmarkers <http://munin-monitoring.org/wiki/ConcisePlugins#Magicmarkers>

       parse_autoconf_response(@response)
	   Parses and validates the autoconf response from the plugin, in the format specified by
	   http://munin-monitoring.org/wiki/ConcisePlugins#autoconf <http://munin-monitoring.org/wiki/ConcisePlugins#autoconf>

	   Invalid input will cause an error to be logged against the plugin.

       parse_suggest_response(@response)
	   Validates the suggestions from the plugin.

	   Invalid suggestions will cause an error to be logged against the plugin.

       parse_snmpconf_response(@response)
	   Parses and validates the snmpconf response from the plugin, in the format specified by
	   http://munin-monitoring.org/wiki/ConcisePlugins#suggest <http://munin-monitoring.org/wiki/ConcisePlugins#suggest>

	   Invalid or inconsistent input will cause an error to be logged against the plugin.

       log_error($message)
	   Logs an error for later retrieval.  The error will also be displayed if debugging output is enabled.

perl v5.14.2							    2013-11-12				       Munin::Node::Configure::Plugin(3pm)