XYMOND_HISTORY(8)

💖 XYMOND_HISTORY 💖

ok so this is xymond_history, part of the System Manager's Manual crew (section 8, daemons and sysadmin stuff, iykyk). buckle up bestie, we're logging status changes 💅

✨ NAME ✨

xymond_history — a xymond worker module whose whole job is logging status changes 🌸

✨ SYNOPSIS ✨

xymond_channel --channel=stachg xymond_history [options]

✨ DESCRIPTION ✨

okay so real talk: xymond_history is a worker module for xymond, which means it does not run on its own like a main character — it normally gets run through the xymond_channel(8) program. think of xymond_channel as the group chat and xymond_history as the bestie who actually reads every message 📲

it receives xymond status-change messages from the "stachg" channel via stdin, and then uses those messages to update the history logfiles. and the way it updates them? fully compatible with the standard Big Brother daemon, bbd. no cap. 🤝

✨ OPTIONS ✨

• --histdir=DIRECTORY — where the history files live 📁. if you don't say anything, it uses whatever directory the XYMONHISTDIR environment gives it.
• --histlogdir=DIRECTORY — where the historical status-logs go 🗂️. if you don't specify, it takes the directory from the XYMONHISTLOGS environment instead.
• --minimum-free=N — sets the minimum percentage of free filesystem space on the $XYMONHISTLOGS directory. if there's less than N% free space, xymond_history will not save the detailed status-logs 😭. default: 5
• --pidfile=FILENAME — xymond_history writes the process-ID it's running with into this file, which is for automated startup scripts (the robots need to know 🫶). the default file is $XYMONSERVERLOGS/xymond_history.pid.
• --debug — turns on debugging output. it's giving verbose, and honestly? valid 🐛

✨ ENVIRONMENT ✨

• XYMONALLHISTLOG — this environment variable controls whether the $XYMONHISTDIR/allevents logfile gets updated. that file is used by the event-log display on the nongreen html page, the eventlog-webpage, and other stuff too. you can disable it by setting XYMONALLHISTLOGS=FALSE, but bestie… that is not recommended. 🙈
• XYMONHOSTHISTLOG — this one controls whether the $XYMONHISTDIR/HOSTNAME logfile gets updated. this file holds a list of every status change seen for a single host, but heads up: it's not used by any of the standard Xymon tools. if you don't want to save it, set XYMONHOSTHISTLOG=FALSE and it's gone 💨
• SAVESTATUSLOG — controls whether the historical status-logs get saved every time a status change happens. these logfiles live in the $XYMONHISTLOGS directory, and they're what powers the detailed log-display of a status from the Xymon "History" page 👑. if you don't want them saved, set SAVESTATUSLOG=FALSE. want to save everything except a few specific ones? use SAVESTATUSLOG=TRUE,!TEST1[,!TEST2...]. want to save nothing except a few specific ones? use SAVESTATUSLOG=FALSE,TEST1[,TEST2...].

NOTE: status logs will not be saved if there's less than 5% free space on the filesystem hosting the $XYMONHISTLOGS directory 😬 the threshold can be tuned via the --minimum-free option.

✨ FILES ✨

this module does not rely on any configuration files. zero config, zero drama, just vibes ✨🧚

✨ SEE ALSO ✨

xymond_channel(8), xymond(8), xymon(7)

and that's the whole page, bestie 🎀 this was Xymon, Version 4.3.30, dated 4 Sep 2019 — go forth and log those status changes, you've got this 💜🦋⭐