Mirrors/Munin-Contrib
1
0
Fork 0
mirror of https://github.com/munin-monitoring/contrib.git synced 2025-07-22 02:51:03 +00:00
Code Issues Releases Wiki Activity

Improve documentation formatting of some plugins

Browse source
This commit is contained in:
Lars Kruse 2020-10-06 00:05:51 +02:00
parent f9d8ce70ed
commit 743395a605
3 changed files with 29 additions and 46 deletions
Download patch file Download diff file Expand all files Collapse all files

8
plugins/icinga/icinga_checks
View file

@ -9,13 +9,15 @@ icinga_checks - Plugin to monitor results of icinga monitoring
No configuration No configuration
=head1 AUTHOR =head1 AUTHORS
mafri with help by sumpfralle and ndo84bw Copyright (C) 2019 mafri (with help from sumpfralle and ndo84bw)
=head1 LICENSE =head1 LICENSE
GPLv3 GNU General Public License v3.0 only
SPDX-License-Identifier: GPL-3.0-only
=head1 MAGIC MARKERS =head1 MAGIC MARKERS

34
plugins/user/cronjobs
View file

@ -3,44 +3,34 @@
""" """
=head1 NAME =head1 NAME
Plugin to monitor the number of cronjobs running per user, gathering data from cronjobs - Plugin to monitor the number of cronjobs running per user, gathering data from syslog.
syslog.
=head1 INSTALLATION =head1 INSTALLATION
Usage: Place in /etc/munin/plugins/ (or link it there using ln -s) Place in /etc/munin/plugins/ (or link it there using ln -s)
=head1 CONFIGURATION =head1 CONFIGURATION
Add this to your /etc/munin/plugin-conf.d/munin-node: Add this to your /etc/munin/plugin-conf.d/munin-node:
=over 2
[cronjobs] [cronjobs]
user root user root
env.syslog_path /var/log/syslog # default value env.syslog_path /var/log/syslog # default value
env.cron_ident_regex crond? # for finding cron entries in the syslog, env.cron_ident_regex crond? # for finding cron entries in the syslog, case-insensitive (default value)
case-insensitive (default value)
=back
The plugin needs to run as root in order to read from syslog. The plugin needs to run as root in order to read from syslog.
=head1 HISTORY =head1 AUTHORS
2019-09-09: v 1.0 pcy <pcy.ulyssis.org>: created Copyright (C) 2019 pcy <pcy.ulyssis.org>
=head1 USAGE
Parameters understood:
config (required)
autoconf (optional - used by munin-config)
=head1 MAGIC MARKERS =head1 MAGIC MARKERS
#%# family=auto #%# family=auto
#%# capabilities=autoconf #%# capabilities=autoconf
=cut
""" """

33
plugins/user/procbyuser
View file

@ -3,42 +3,33 @@
: << =cut : << =cut
=head1 INTRODUCTION =head1 NAME
Plugin to monitor the amount of processes owned by a user procbyuser - Plugin to monitor the amount of processes owned by a user
=head1 INSTALLATION =head1 INSTALLATION
Usage: Place in /etc/munin/plugins/ (or link it there using ln -s) Place in /etc/munin/plugins/ (or link it there using ln -s)
=head1 CONFIGURATION =head1 CONFIGURATION
Add this to your /etc/munin/plugin-conf.d/munin-node: Add this to your /etc/munin/plugin-conf.d/munin-node:
=over 2 [procbyuser]
user root # required if /proc can't be read from by any user!
env.USERS root yann # defaults to ALL, i.e. display all users. 'root' is counted as one of the 'others'
env.OTHER_FIELD others # enable 'others'-list, set the label/field name
[procbyuser] =head1 AUTHORS
user root # required if /proc can't be read from by any user!
env.USERS root yann # defaults to ALL, i.e. display all users. 'root' is counted as one of the 'others'
env.OTHER_FIELD others # enable 'others'-list, set the label/field name
=back Copyright (C) 2019 pcy <pcy@ulyssis.org>
=head1 HISTORY Based on the plugin "cpubyuser".
2019-09-06 v 1.0 pcy <pcy@ulyssis.org>: created (based on cpubyuser)
=head1 USAGE
Parameters understood:
config (required)
autoconf (optional - used by munin-config)
=head1 MAGIC MARKERS =head1 MAGIC MARKERS
#%# family=auto #%# family=auto
#%# capabilities=autoconf #%# capabilities=autoconf
=cut =cut