Improve documentation formatting of some plugins
This commit is contained in:
parent
f9d8ce70ed
commit
743395a605
|
@ -9,13 +9,15 @@ icinga_checks - Plugin to monitor results of icinga monitoring
|
|||
|
||||
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
|
||||
|
||||
GPLv3
|
||||
GNU General Public License v3.0 only
|
||||
|
||||
SPDX-License-Identifier: GPL-3.0-only
|
||||
|
||||
=head1 MAGIC MARKERS
|
||||
|
||||
|
|
|
@ -3,44 +3,34 @@
|
|||
"""
|
||||
=head1 NAME
|
||||
|
||||
Plugin to monitor the number of cronjobs running per user, gathering data from
|
||||
syslog.
|
||||
cronjobs - Plugin to monitor the number of cronjobs running per user, gathering data from syslog.
|
||||
|
||||
=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
|
||||
|
||||
Add this to your /etc/munin/plugin-conf.d/munin-node:
|
||||
|
||||
=over 2
|
||||
|
||||
[cronjobs]
|
||||
user root
|
||||
env.syslog_path /var/log/syslog # default value
|
||||
env.cron_ident_regex crond? # for finding cron entries in the syslog,
|
||||
case-insensitive (default value)
|
||||
|
||||
=back
|
||||
[cronjobs]
|
||||
user root
|
||||
env.syslog_path /var/log/syslog # default value
|
||||
env.cron_ident_regex crond? # for finding cron entries in the syslog, case-insensitive (default value)
|
||||
|
||||
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
|
||||
|
||||
=head1 USAGE
|
||||
|
||||
Parameters understood:
|
||||
|
||||
config (required)
|
||||
autoconf (optional - used by munin-config)
|
||||
Copyright (C) 2019 pcy <pcy.ulyssis.org>
|
||||
|
||||
=head1 MAGIC MARKERS
|
||||
|
||||
#%# family=auto
|
||||
#%# capabilities=autoconf
|
||||
#%# family=auto
|
||||
#%# capabilities=autoconf
|
||||
|
||||
=cut
|
||||
"""
|
||||
|
||||
|
||||
|
|
|
@ -3,42 +3,33 @@
|
|||
|
||||
: << =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
|
||||
|
||||
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
|
||||
|
||||
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]
|
||||
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
|
||||
=head1 AUTHORS
|
||||
|
||||
=back
|
||||
Copyright (C) 2019 pcy <pcy@ulyssis.org>
|
||||
|
||||
=head1 HISTORY
|
||||
|
||||
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)
|
||||
Based on the plugin "cpubyuser".
|
||||
|
||||
=head1 MAGIC MARKERS
|
||||
|
||||
#%# family=auto
|
||||
#%# capabilities=autoconf
|
||||
#%# family=auto
|
||||
#%# capabilities=autoconf
|
||||
|
||||
=cut
|
||||
|
||||
|
|
Loading…
Reference in New Issue