2
0
mirror of https://github.com/munin-monitoring/contrib.git synced 2018-11-08 00:59:34 +01:00

Add the documentation in to the script. Should have gone with previous commit.

This commit is contained in:
Nye Liu 2016-11-16 18:25:53 -08:00
parent 49b79ca228
commit 21572e11a5

View File

@ -1,17 +1,46 @@
#!/bin/sh
# -*- sh -*-
#
# This plugin is based on the if_ plugin.
#
# Parameters
# None
#
# Magic markers (optional - used by munin-config and some installation
# scripts):
#
: << =cut
=pod
=encoding UTF-8
=head1 NAME
tc_ - Plugin to monitor traffic control queue class bandwidth usage
=head1 CONFIGURATION
None needed.
=head1 INTERPRETATION
Traffic control is the name given to the sets of queuing systems and mechanisms by which packets are received and transmitted on a router. This includes deciding which (and whether) packets to accept at what rate on the input of an interface and determining which packets to transmit in what order at what rate on the output of an interface.
This plugin monitors the bandwidth used by each queue class. The root class will draw as a single line, whereas children will be drawn in a stacked graph. Complex hierarchies which have more than the root and its direct children are not fully supported and may not render correctly.
=head1 SEE ALSO
"man tc" and "tc -s class show dev <interface>" to get more information about tc and to see the format of the statistics being parsed.
=head1 MAGIC MARKERS
#%# family=auto
#%# capabilities=autoconf suggest
=head1 AUTHORS
Steve Schnepp <steve.schnepp@gmail.com>,
Samuel Smith <esaym@cpan.org>,
Nye Liu <nyet@nyet.org>
=head1 LICENSE
GPLv2 or later
=cut
DEVICE=${0##*/tc_}