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:
parent
384d482fe2
commit
09b88141b3
92 changed files with 556 additions and 388 deletions
|
@ -1,19 +1,31 @@
|
|||
#!/usr/bin/env python
|
||||
|
||||
"""
|
||||
=head1 NAME
|
||||
|
||||
linux_if - munin plugin monitoring Linux network interfaces
|
||||
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
This is not a wildcard plugin. Monitored interfaces are controlled
|
||||
by 'include', 'exclude' in config. By default, only statically
|
||||
configured interfaces (and their sub-interfaces) are monitored.
|
||||
|
||||
Features:
|
||||
* bonding - group bonding slave interfaces with master
|
||||
* vlans - group vlan sub-interfaces with main (dot1q trunk) interface
|
||||
|
||||
plugin configuration:
|
||||
=over
|
||||
|
||||
[linux_if]
|
||||
=item bonding - group bonding slave interfaces with master
|
||||
|
||||
=item vlans - group vlan sub-interfaces with main (dot1q trunk) interface
|
||||
|
||||
=back
|
||||
|
||||
|
||||
=head1 CONFIGURATION
|
||||
|
||||
[linux_if]
|
||||
# run plugin as root (required if you have VLAN sub-interfaces)
|
||||
user = root
|
||||
|
||||
|
@ -31,22 +43,44 @@ plugin configuration:
|
|||
# default: true
|
||||
env.include_configured_if = true
|
||||
|
||||
Include/exclude logic in detail. Interface name is matched..
|
||||
1) if matched by any exclude pattern, then exclude. Otherwise next step.
|
||||
2) if matched by any include pattern, then include, Otherwise next step.
|
||||
3) if 'include_configured_if' is true and 'ifcfg-*' file exists then include
|
||||
4) default is not to include interface in monitoring
|
||||
5) automatically include sub-interface, if the parent interface is monitored
|
||||
Include/exclude logic in detail. Interface name is matched according to the following rules:
|
||||
|
||||
=over 4
|
||||
|
||||
=item 1. if matched by any exclude pattern, then exclude. Otherwise next step.
|
||||
|
||||
=item 2. if matched by any include pattern, then include, Otherwise next step.
|
||||
|
||||
=item 3. if 'include_configured_if' is true and 'ifcfg-*' file exists then include
|
||||
|
||||
=item 4. default is not to include interface in monitoring
|
||||
|
||||
=item 5. automatically include sub-interface, if the parent interface is monitored
|
||||
|
||||
=back
|
||||
|
||||
Tested on: RHEL 6.x and clones (with Python 2.6)
|
||||
|
||||
TODO:
|
||||
* implement 'data loaning' between graphs, removes duplicit measures
|
||||
* add support for bridging
|
||||
* configurable graph max based on interface speed
|
||||
|
||||
MUNIN MAGIC MARKER
|
||||
#%# family=manual
|
||||
=head1 TODO
|
||||
|
||||
=over 4
|
||||
|
||||
=item implement 'data loaning' between graphs, removes duplicit measures
|
||||
|
||||
=item add support for bridging
|
||||
|
||||
=item configurable graph max based on interface speed
|
||||
|
||||
=back
|
||||
|
||||
|
||||
=head1 MAGIC MARKERS
|
||||
|
||||
#%# family=manual
|
||||
|
||||
|
||||
=cut
|
||||
"""
|
||||
|
||||
__author__ = 'Brano Zarnovican'
|
||||
|
|
|
@ -23,34 +23,39 @@ You can install bing by using (Ubuntu/Debian): apt-get install bing
|
|||
The following example configuration shows all settings. Only "hosts" is required for
|
||||
minimal configuration.
|
||||
|
||||
[multibandwidth]
|
||||
user root
|
||||
env.hosts example.org example2.org example3.org
|
||||
env.samples 15
|
||||
env.small_packet_size 44
|
||||
env.big_packet_size 108
|
||||
env.max_valid_bps 15728640
|
||||
[multibandwidth]
|
||||
user root
|
||||
env.hosts example.org example2.org example3.org
|
||||
env.samples 15
|
||||
env.small_packet_size 44
|
||||
env.big_packet_size 108
|
||||
env.max_valid_bps 15728640
|
||||
|
||||
- env.hosts: space separated list of hostnames or IPs of the hosts to calculate the bandwidth.
|
||||
=over 4
|
||||
|
||||
=item env.hosts: space separated list of hostnames or IPs of the hosts to calculate the bandwidth.
|
||||
This setting is required.
|
||||
|
||||
- env.samples: Reset stats after sending this number of ECHO_REQUEST packets.
|
||||
=item env.samples: Reset stats after sending this number of ECHO_REQUEST packets.
|
||||
Defaults to 15 samples.
|
||||
|
||||
- env.small_packet_size: Specifies the number of data bytes to be sent in the small
|
||||
=item env.small_packet_size: Specifies the number of data bytes to be sent in the small
|
||||
packets. The default and minimum value is 44.
|
||||
|
||||
- env.big_packet_size: Specifies the number of data bytes to be sent in the big
|
||||
=item env.big_packet_size: Specifies the number of data bytes to be sent in the big
|
||||
packets. The default is 108. The size should be chosen so that big packet roundtrip times
|
||||
are long enough to be accurately measured.
|
||||
|
||||
- env.max_valid_bps: bing have some random spikes. This variable is used to indicate
|
||||
=item env.max_valid_bps: bing have some random spikes. This variable is used to indicate
|
||||
the maximum value of mbps that can be recorded (in bps).
|
||||
Defaults to the empty string (no validity check).
|
||||
|
||||
=back
|
||||
|
||||
|
||||
=head1 MAGIC MARKERS
|
||||
|
||||
#%# capabilities=autoconf
|
||||
#%# capabilities=autoconf
|
||||
|
||||
=head1 VERSION
|
||||
|
||||
|
@ -59,6 +64,7 @@ env.max_valid_bps 15728640
|
|||
=head1 AUTHOR
|
||||
|
||||
Jose Manuel Febrer Cortés <https://www.linkedin.com/in/jfebrer/>
|
||||
|
||||
Marco Bertola’s help <https://www.linkedin.com/in/bertolamarco/>
|
||||
|
||||
=head1 LICENSE
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue