1Munin::Node::Configure:U:sPelrugCionn(t3r)ibuted Perl DoMcuunmienn:t:aNtoidoen::Configure::Plugin(3)
2
3
4

NAME

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

SYNOPSIS

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

METHODS

13       new(%args)
14           Constructor.
15
16           Required arguments are 'name' and 'path', which should be the
17           basename and full path of the plugin, respectively.
18
19       is_wildcard()
20           Returns true if the plugin is a wildcard.  In the case of SNMP
21           plugins, only double-wild plugins will return true (ie.
22           'snmp__memory' would return false, but 'snmp__if_' would return
23           true).
24
25       is_snmp()
26           Returns true if the plugin is an SNMP plugin.
27
28       in_family(@families)
29           Returns true if plugin's family is in @families, false otherwise.
30
31       is_installed()
32           Returns 'yes' if one or more links to this plugin exist in the
33           service directory, 'no' otherwise.
34
35       suggestion_string()
36           Returns a string detailing whether or not autoconf considers that
37           the plugin should be installed.  The string may also report the
38           reason why the plugin declined to be installed, or the list of
39           suggestions it provided, if this information is available.
40
41       installed_services_string()
42           Returns a string detailing which wildcards are installed for this
43           plugin.
44
45       services_to_add()
46       services_to_remove()
47           Return a list of service names that should be added or removed for
48           this plugin.
49
50       add_instance($name)
51           Associates a link from the service directory with this plugin.
52
53       add_suggestions(@suggestions)
54           Adds @suggestions to the list of suggested wildcards for this
55           plugin.  They are not validated.
56
57       read_magic_markers()
58           Sets the family and capabilities from the magic markers embedded in
59           the plugin's executable, as specified by
60           <http://munin-monitoring.org/wiki/ConcisePlugins#Magicmarkers>
61
62       parse_autoconf_response(@response)
63           Parses and validates the autoconf response from the plugin, in the
64           format specified by
65           <http://munin-monitoring.org/wiki/ConcisePlugins#autoconf>
66
67           Invalid input will cause an error to be logged against the plugin.
68
69       parse_suggest_response(@response)
70           Validates the suggestions from the plugin.
71
72           Invalid suggestions will cause an error to be logged against the
73           plugin.
74
75       parse_snmpconf_response(@response)
76           Parses and validates the snmpconf response from the plugin, in the
77           format specified by
78           <http://munin-monitoring.org/wiki/ConcisePlugins#suggest>
79
80           Invalid or inconsistent input will cause an error to be logged
81           against the plugin.
82
83       log_error($message)
84           Logs an error for later retrieval.  The error will also be
85           displayed if debugging output is enabled.
86
87
88
89perl v5.32.1                      2021-02-05 Munin::Node::Configure::Plugin(3)
Impressum