1
0
Fork 0
mirror of https://github.com/munin-monitoring/contrib.git synced 2025-07-22 02:51:03 +00:00

Improve documantion of many plugins

Specifically the configuration examples are now indented properly.
This commit is contained in:
Lars Kruse 2020-10-24 17:28:11 +02:00
parent 384d482fe2
commit 09b88141b3
92 changed files with 556 additions and 388 deletions

View file

@ -3,8 +3,7 @@
"""=cut
=head1 NAME
git_commit_behind - Munin plugin to monitor local git repositories and report
how many commits behind their remote they are
git_commit_behind - Munin plugin to monitor local git repositories and report how many commits behind their remote they are
=head1 NOTES
@ -19,13 +18,20 @@ separate cron job.
=head1 REQUIREMENTS
- Python3
- Git
=over 4
=item Python3
=item Git
=back
=head1 INSTALLATION
Link this plugin, as usual.
For example :
ln -s /path/to/git_commit_behind /etc/munin/plugins/git_commit_behind
If you wish to update the repositories via cron and not during the plugin
@ -33,16 +39,17 @@ execution (cf CONFIGURATION section), you need a dedicated cron job.
For example, you can use the following cron :
# If the git_commit_behind plugin is enabled, fetch git repositories randomly
# according to the plugin configuration.
# By default : once an hour (12 invocations an hour, 1 in 12 chance that the
# update will happen), but ensure that there will never be more than two hours
# (7200 seconds) interval between updates.
*/5 * * * * root if [ -x /etc/munin/plugins/git_commit_behind ]; then /usr/sbin/munin-run git_commit_behind update >/dev/null; fi
# If the git_commit_behind plugin is enabled, fetch git repositories randomly
# according to the plugin configuration.
# By default : once an hour (12 invocations an hour, 1 in 12 chance that the
# update will happen), but ensure that there will never be more than two hours
# (7200 seconds) interval between updates.
*/5 * * * * root if [ -x /etc/munin/plugins/git_commit_behind ]; then /usr/sbin/munin-run git_commit_behind update >/dev/null; fi
=head1 CONFIGURATION
Use your "/etc/munin/plugin-conf.d/munin-node" to configure this plugin.
[git_commit_behind]
user [user]
env.git_path /path/to/git
@ -63,7 +70,8 @@ env.update.maxinterval : optional (default : 7200),
Then, for each repository you want to check, you need the following
configuration block under the git_commit_behind section
configuration block under the git_commit_behind section:
env.repo.[repoCode].path /path/to/local/repo
env.repo.[repoCode].name Repo Name
env.repo.[repoCode].user user