1
0
Fork 0
mirror of https://github.com/munin-monitoring/contrib.git synced 2025-07-21 18:41: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

@ -1,43 +1,70 @@
#!/usr/bin/python
"""
Munin plugin to monitor various items of data from an Apple Airport
Express/Extreme or a Time Capsule.
v1.0 by Chris Jones <cmsj@tenshu.net>
Copyright (C) 2011 Chris Jones
This script is released under the GNU GPL v2 license.
=head1 NAME
Munin plugin to monitor various items of data from an Apple Airport Express/Extreme or a Time Capsule.
=head1 INSTALLATION
To use this plugin, use specially named symlinks:
cd /etc/munin/plugins
ln -s /path/to/snmp__airport snmp_myairport_airport_clients
ln -s /path/to/snmp__airport snmp_myairport_airport_dhcpclients
ln -s /path/to/snmp__airport snmp_myairport_airport_rate
ln -s /path/to/snmp__airport snmp_myairport_airport_signal
ln -s /path/to/snmp__airport snmp_myairport_airport_noise
cd /etc/munin/plugins
ln -s /path/to/snmp__airport snmp_myairport_airport_clients
ln -s /path/to/snmp__airport snmp_myairport_airport_dhcpclients
ln -s /path/to/snmp__airport snmp_myairport_airport_rate
ln -s /path/to/snmp__airport snmp_myairport_airport_signal
ln -s /path/to/snmp__airport snmp_myairport_airport_noise
NOTE: the name 'myairport' should be a valid hostname or IP address for your
Airport. It can be any value, but it must not include the character '_'.
Now add a virtual host entry to your munin server's munin.conf:
[myairport]
address 123.123.123.123
user_node_name no
[myairport]
address 123.123.123.123
user_node_name no
(with the correct IP address, obviously)
this will create a virtual host in munin for the airport named 'myairport' and
produce graphs for:
* number of connected wireless clients
* number of active DHCP leases
* rate at which clients are connected (in Mb/s)
* signal quality of connected clients (in dB)
* noise level of connected clients (in dB)
# Magic markers
#%# capabilities=
#%# family=contrib manual
=over 4
=item number of connected wireless clients
=item number of active DHCP leases
=item rate at which clients are connected (in Mb/s)
=item signal quality of connected clients (in dB)
=item noise level of connected clients (in dB)
=back
=head1 AUTHORS
Copyright (C) 2011 Chris Jones <cmsj@tenshu.net>
=head1 LICENSE
This script is released under the GNU GPL v2 license.
SPDX-License-Identifier: GPL-2.0-only
=head1 MAGIC MARKERS
#%# capabilities=
#%# family=contrib manual
=cut
"""
import sys
import os