Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Munin::...:Plugin(3)   User Contributed Perl Documentation  Munin::...:Plugin(3)

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 re-
	 turn 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 pro-
	 vided, if this information is available.

     installed_services_string()
	 Returns a string detailing which wildcards are installed for this plu-
	 gin.

     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-monitor-
	 ing.org/wiki/ConcisePlugins#Magicmarkers>

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

	 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 plu-
	 gin.

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

	 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.42.3			   2026-08-04		    Munin::...:Plugin(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=Munin::Node::Configure::Plugin&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help