Skip to content

Commit

Permalink
[monit_parser] add documentation (Closes: #548)
Browse files Browse the repository at this point in the history
  • Loading branch information
sumpfralle committed Oct 23, 2016
1 parent dcd9434 commit 8d78e45
Showing 1 changed file with 38 additions and 5 deletions.
43 changes: 38 additions & 5 deletions plugins/monit/monit_parser
Original file line number Diff line number Diff line change
@@ -1,12 +1,45 @@
#!/usr/bin/python
# Monit status parser plugin for munin

# This is very raw, but it should work for you out of the box. You of course
# need to have monit configured such that the 'monit status' command works.
"""
=head1 NAME
# Todd Troxell <ttroxell@debian.org>
monit_parser - Monit status parser plugin for munin.
STATUS_CMD = "monit status"
=head1 APPLICABLE SYSTEMS
Any system running monit.
Monit needs to be configured with the httpd port enabled, e.g.:
set httpd port 2812
The configured port is not important, since this plugin uses "monit status"
for retrieving data. Thus the monit configuration is parsed implicitly.
=head1 CONFIGURATION
This plugin requires read access for the monit configuration.
Thus it needs to run as root:
[monit_parser]
user root
=head1 AUTHOR
Todd Troxell <ttroxell@debian.org>
Lars Kruse <devel@sumpfralle.de>
=head1 MAGIC MARKERS
family=auto
capabilities=autoconf
=cut
"""

import os
import re
Expand Down

0 comments on commit 8d78e45

Please sign in to comment.