.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "MRTG-SQUID 1"
.TH MRTG-SQUID 1 "2022-01-19" "2.17.10" "mrtg"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
mrtg\-squid \- using mrtg to monitor Squid
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Squid 2.3 knows \s-1SNMP\s0 and you can therefore use mrtg to
monitor it quite easily.
.PP
I have made some modifications to mrtg which simplify this.
My work is based on earlier modification made by:
matija.grabnar@arnes.si and kostas@nlanr.net.
.SH "MODIFICATIONS"
.IX Header "MODIFICATIONS"
I added new code for displaying correct units to the
previous patches \*(L"perminute\*(R" and \*(L"perhour\*(R" (\*(L"option\*(R" tokens),
which allows other measurement in addition to \*(L"persecond\*(R".
.PP
Then I created a new option token \*(L"dorelpercent\*(R" which
allows the calculation of the percentage of IN-stream / OUT-stream on
the fly and then displays it on a fixed scale from 0% to 100%. For my
requirements, this does good work. Maybe someone wants a floating
scale. It should not be a problem to implement it, too (but 
give me an option to keep my fixed scale). If IN-stream is always
less than OUT-stream both lines (OUT-stream and relative percent)
are always displayed on top of IN-stream bulk. Otherwise this
option makes no sense. With this option you can display hitrates,
errorrates (for router monitoring: rel. droprates) easily now.
.PP
If you use this options please consider that you need a 5th
colourname/value pair in your Colours statements!
.PP
Due to some discussion on this list, I have implemented two
tokens too:
.PP
\&\*(L"kilo\*(R" and \*(L"kMG\*(R"
.PP
\&\*(L"kilo\*(R" should contain the value of k (1000 or 1024), where 1000 is the
default.
.PP
\&\*(L"kMG\*(R" is a comma separated list of multiplier prefixes, used
instead of "\*(L", \*(R"k\*(L", \*(R"M\*(L", \*(R"G\*(L", \*(R"T" on the \s-1MRTG\s0 display. Leave the
place free, if you want no prefix.
.PP
Also an incomplete list of OIDs for the new \s-1SQUID\s0 release is
added.
.PP
You may need to turn on snmp_port in squid.conf to as it is disabled by default.
.PP
I hope you enjoy it.
.SH "CONFIG EXAMPLE"
.IX Header "CONFIG EXAMPLE"
First load the squid mib
.PP
.Vb 1
\& LoadMIBs: /usr/share/squid/mib.txt
.Ve
.PP
You can measure responsetimes in ms and display it with \s-1MRTG\s0
correctly with:
.PP
.Vb 2
\& kMG[measure\-ms]: m,,k,M,G,T
\& short[measure\-ms]: s
.Ve
.PP
You can display now MB/s as 1024*1024 B/s with:
.PP
.Vb 1
\& kilo[volume]: 1024
.Ve
.PP
Assuming you're not running squid's \s-1SNMP\s0 on the default snmp port, you need
to include a port number in your target line:
.PP
.Vb 1
\& Target[proxy\-hit]: cacheHttpHits&cacheProtoClientHttpRequests:public@localhost:3401
.Ve
.PP
A sample config for squid:
.PP
.Vb 11
\& Target[proxy\-hit]: cacheHttpHits&cacheProtoClientHttpRequests:public@proxy
\& Title[proxy\-hit]: HTTP Hits
\& PageTop[proxy\-hit]: <H2>proxy Cache Statistics: HTTP Hits / Requests</H2>
\& Suppress[proxy\-hit]: y
\& LegendI[proxy\-hit]:  HTTP hits
\& LegendO[proxy\-hit]:  HTTP requests
\& Legend1[proxy\-hit]:  HTTP hits
\& Legend2[proxy\-hit]:  HTTP requests
\& YLegend[proxy\-hit]: perminute
\& ShortLegend[proxy\-hit]: req/min
\& Options[proxy\-hit]: nopercent, perminute, dorelpercent
\&
\& Target[proxy\-srvkbinout]: cacheServerInKb&cacheServerOutKb:public@proxy
\& Title[proxy\-srvkbinout]: Cache Server Traffic In / Out
\& PageTop[proxy\-srvkbinout]: <H2>Cache Statistics: Server traffic volume (In/Out) </H2>
\& Suppress[proxy\-srvkbinout]: y
\& LegendI[proxy\-srvkbinout]:  Traffic In
\& LegendO[proxy\-srvkbinout]:  Traffic Out
\& Legend1[proxy\-srvkbinout]:  Traffic In
\& Legend2[proxy\-srvkbinout]:  Traffic Out
\& YLegend[proxy\-srvkbinout]: per minute
\& ShortLegend[proxy\-srvkbinout]: b/min
\& kMG[proxy\-srvkbinout]: k,M,G,T
\& kilo[proxy\-srvkbinout]: 1024
\& Options[proxy\-srvkbinout]: nopercent, perminute
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Andreas Papst <andreas.papst@univie.ac.at>
Dirk-LXder Kreie <deelkar@gmx.de>
Chris Chiappa <chris+debian@chiappa.net>