File: README.PluginConfiguration

package info (click to toggle)
munin 2.0.63-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 7,008 kB
  • sloc: perl: 11,644; java: 1,924; sh: 1,619; makefile: 636; javascript: 365; python: 267
file content (71 lines) | stat: -rw-r--r-- 2,360 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
Munin plugin configuration
==========================

Munin plugins are configured by editing existing or placing new files in
/etc/munin/plugin-conf.d/.  Since files in this directory may contain passwords
or other sensitive information, the directory is not world readable.

Configuration files are read only once during the startup of "munin-node".
Thus a restart of this service is necessary for changes to take effect.

A plugin configuration file contains one or more sections.  Each section starts
with a label (between '[' and ']'), and contains an optional "user" statement,
an optional "group" statement, and zero or more lines beginning with "env.":

Example:

 [mailthingie]
  user        mail
  group       adm
  env.logfile /var/log/mail.info

[Label]
-------

A label matching the plugin name starts a new configuration block.

For wildcard plugins requiring similar configuration, the label within [] can
end in a wildcard, like "[ip_*]".

User
----

If munin (or munin-run) is run with root privileges, munin will change user for
the matching plugins to the user specified.

Group
-----

If munin (or munin-run) is run with root privileges, munin will run the plugin
with an additional group specified here.

env.variable
------------

A line 

 "env.logfile /var/log/syslog"

...will run the plugin with an extra environment variable "logfile" with the
content "/var/log/syslog".  A plugin is expected to provide sane default values
for such variables, but such defaults may not exist, or be "sane" on other
platforms.

Debugging
---------

To check if plugin configuration is applied, run munin-run with "-d" to enable
debugging, as root, (like "sudo munin-run -d someplugin") and check the output.

If you do not execute "munin-run" as root, you may not be able to read the
plugin configuration files, and debugging your plugins may be harder than
necessary.

Please note that the "munin-node" process may be restricted if it is executed
via systemd.  This may include access to certain directories (e.g. /home or
/tmp) as well as write access to unusual locations.
See /lib/systemd/system/munin-node.service for the packaging defaults of such
restrictions.  Use "systemctl edit munin-node" for overriding specific settings
locally.
The output of "munin-run" may differ from the output of the munin-node service
due to these restrictions.