From 21572e11a5d35e6a33e3744bbca91745f76b214e Mon Sep 17 00:00:00 2001 From: Nye Liu Date: Wed, 16 Nov 2016 18:25:53 -0800 Subject: [PATCH] Add the documentation in to the script. Should have gone with previous commit. --- plugins/network/tc_ | 51 +++++++++++++++++++++++++++++++++++---------- 1 file changed, 40 insertions(+), 11 deletions(-) diff --git a/plugins/network/tc_ b/plugins/network/tc_ index 3b373434..9933edd2 100755 --- a/plugins/network/tc_ +++ b/plugins/network/tc_ @@ -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): -# -#%# family=auto -#%# capabilities=autoconf suggest +: << =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 " 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 , +Samuel Smith , +Nye Liu + +=head1 LICENSE + +GPLv2 or later + +=cut DEVICE=${0##*/tc_}