MSGCACHE(8)

💖 MSGCACHE 💖 — like, the manual page for msgcache(8), bestie

okay so this is msgcache from section 8 of the System Manager's Manual, and honestly? she's a little queen of caching. let's get into it 🎀

✨ NAME ✨

msgcache — cache client messages for later pickup by xymonfetch 🦋

🌸 SYNOPSIS 🌸

msgcache [options]

💅 DESCRIPTION 💅

okay so msgcache implements a Xymon message cache, and it's literally built for clients that cannot deliver their data to the Xymon server the normal way. like, they just can't, bestie, don't make them 😭

So instead of having the client tools connect to the Xymon server directly, msgcache runs locally, and the client tools deliver their data to the msgcache daemon instead. Then msgcache just sits there holding all that data like a good little backpack 🎒 and gets polled regularly by the xymonfetch(8) utility — which collects the client messages stored by msgcache and forwards them to the Xymon server. slay, teamwork, periodt ✨

NOTE: when you're using msgcache, the XYMSRV setting for the clients should be XYMSRV=127.0.0.1 instead of pointing at the real Xymon server. don't skip this, it's giving important 💀

🚫 RESTRICTIONS 🚫

Clients delivering their data to msgcache instead of the real Xymon server will, in general, not notice this. like, they're living their best life, totally oblivious 🙈

Specifically: the client configuration data provided by the Xymon server when a client delivers its data is forwarded through the xymonfetch / msgcache chain, so the normal centralized client configuration totally works. no cap 👑

BUT — and this is the part where we hold hands 🫶 — other commands which rely on clients communicating directly with the Xymon server will not work. that includes:

• the config command
• the query command

which clients may use to fetch configuration files and query the Xymon server for a current status. nope, not happening, not today 💀

The download command also does not work with msgcache. Which means the automatic client update facility will not work for clients communicating via msgcache. she's not coming to that party, sorry bestie 😭

⭐ OPTIONS ⭐

• --listen=IPADDRESS[:PORT] — Defines the IP-address and portnumber where msgcache listens for incoming connections. By default, msgcache listens for connections on all network interfaces, port 1984. yes queen, all of them 🌈
• --server=IPADDRESS[,IPADDRESS] — Restricts which servers are allowed to pick up the cached messages. By default anyone can contact the msgcache utility and request all of the cached messages (iconic but also kind of chaotic tbh 💀). This option allows only the listed servers to request the cached messages. set your boundaries bestie, it's giving self-care 💅
• --max-age=N — Defines how long cached messages are kept. If the message has not been picked up within N seconds after being delivered to msgcache, it is silently discarded. gone. poof. no note, no text back 🦋 Default: N=600 seconds (10 minutes).
• --daemon — Run as a daemon, i.e. msgcache will detach from the terminal and run as a background task. main character energy, doesn't need the spotlight 🌟
• --no-daemon — Run as a foreground task. This option must be used when msgcache is started by xymonlaunch(8), which is the normal way of running msgcache. fr fr, this is the usual setup 🔥
• --pidfile=FILENAME — Store the process ID of the msgcache task in FILENAME.
• --logfile=FILENAME — Log msgcache output to FILENAME.
• --debug — Enable debugging output. the receipts, the lore, the whole story 👑

👀 SEE ALSO 👀

• xymonfetch(8)
• xymon(7)

and that's the whole vibe check, bestie 💜 this page is from Xymon, Version 4.3.30: 4 Sep 2019 — yes she's been around a minute, and she still ate 💅✨ bye ily 🎀