MRTG-SQUID(1)

🌸 MRTG-SQUID(1) 🌸

okay bestie, welcome to mrtg-squid — it's the mrtg manual page that teaches you how to monitor Squid and honestly? it's giving niche-but-iconic. 💅

---

✨ NAME ✨

mrtg-squid — using mrtg to monitor Squid 🦑

---

💖 DESCRIPTION 💖

so here's the tea: Squid 2.3 knows SNMP, which means you can point mrtg at it and monitor it super easily. no cap. 🎀

the author made some modifications to mrtg to make this even simpler. their work is based on earlier modifications made by: matija.grabnar@arnes.si and kostas@nlanr.net. shoutout to the OGs 🫶

---

🦋 MODIFICATIONS 🦋

they added new code for displaying correct units to the previous patches perminute and perhour (those are "option" tokens, bestie), which lets you measure stuff in units other than just "persecond". periodt. ✨

then they created a new option token dorelpercent which lets you calculate the percentage of IN-stream / OUT-stream on the fly, and then displays it on a fixed scale from 0% to 100%. for their requirements this does good work. maybe someone wants a floating scale — it should not be a problem to implement it too (but give them an option to keep their fixed scale, okay? 🙏). 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 (and for router monitoring: rel. droprates) easily now. 🔥

⚠️ okay important: if you use this option, please consider that you need a 5th colourname/value pair in your Colours statements! don't forget it bestie 😭

due to some discussion on this list, they implemented two tokens too:

"kilo" and "kMG" 💫

• "kilo" should contain the value of k (1000 or 1024), where 1000 is the default.
• "kMG" is a comma separated list of multiplier prefixes, used instead of "", "k", "M", "G", "T" on the MRTG display. leave the place free if you want no prefix.

also an incomplete list of OIDs for the new SQUID release is added. 📋

you may need to turn on snmp_port in squid.conf as it is disabled by default. 🙈

they hope you enjoy it. 💜

---

🌈 CONFIG EXAMPLE 🌈

first, load the squid mib:

LoadMIBs: /usr/share/squid/mib.txt

you can measure responsetimes in ms and display it with MRTG correctly with:

kMG[measure-ms]: m,,k,M,G,T
short[measure-ms]: s

you can display now MB/s as 1024*1024 B/s with:

kilo[volume]: 1024

assuming you're not running squid's SNMP on the default snmp port, you need to include a port number in your target line:

Target[proxy-hit]: cacheHttpHits&cacheProtoClientHttpRequests:public@localhost:3401

a sample config for squid:

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

---

👑 AUTHOR 👑

Andreas Papst <andreas.papst@univie.ac.at> Dirk-LXder Kreie <deelkar@gmx.de> Chris Chiappa <chris+debian@chiappa.net>

---

and that's the whole page bestie, we ate and left no crumbs 🍓✨ this was mrtg version 2.17.10, dated 2022-01-19 — mwah, tysm for reading, iykyk 💖🎀💅