1
0
Fork 0
mirror of https://github.com/munin-monitoring/contrib.git synced 2025-07-25 10:28:36 +00:00

Improve documentation formatting of some plugins

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

View file

@ -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