Mirrors/Munin-Contrib
1
0
Fork 0
mirror of https://github.com/munin-monitoring/contrib.git synced 2025-07-22 02:51:03 +00:00
Code Issues Releases Wiki Activity

Improve documantion of many plugins

Browse source 
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
Download patch file Download diff file Expand all files Collapse all files

32
plugins/network/multibandwidth
View file

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