XYMOND_FILESTORE(8)

💖 XYMOND_FILESTORE 💖

okay bestie, welcome to the manual page for xymond_filestore, which lives in section 8 (System Manager's Manual) of the XYMOND_FILESTORE(8) pages. yes this is a system manager's situation, very grown-up, very serious, but we're gonna have fun with it anyway 💅

✨ NAME ✨

xymond_filestore — the xymond worker module that stores Xymon data. that's the whole job. it's giving "I just save things" and honestly? iconic.

🌸 SYNOPSIS 🌸

xymond_channel --channel=status xymond_filestore --status [options]
xymond_channel --channel=data   xymond_filestore --data [options]
xymond_channel --channel=notes  xymond_filestore --notes [options]
xymond_channel --channel=enadis xymond_filestore --enadis [options]

four ways to run her, one for each channel, no cap 🫶

🦋 DESCRIPTION 🦋

so. xymond_filestore is a worker module for xymond, which means she does not run alone — she's normally launched through the xymond_channel(8) program. that's her whole ride-or-die setup.

what she does: she receives xymond messages off a xymond channel via stdin, and then she stores them in the filesystem in a way that's compatible with the Big Brother daemon, bbd. yes, that Big Brother. ancient lore. respect it 💀

and here's the cute part — this program can be started multiple times if you wanna store messages for more than one channel. she's not jealous. run as many as you need, periodt ✨

🎀 OPTIONS 🎀

• --status — incoming messages are "status" messages, and they get stored in the $XYMONRAWSTATUSDIR/ directory. now listen: if you're using xymon(7) all over your Xymon server, you will not need to run this module to save status messages, unless you've got a third-party add-on that reads the status-logs directly. also — very important bestie — this module is NOT needed to get trend graphs. for that you should run the xymond_rrd(8) module instead. do not come for me about graphs, that's not her job 😭
• --data — incoming messages are "data" messages, and they get stored in the $XYMONDATADIR directory. this module is not needed unless you have a third-party module that processes the data-files. and again, loud and clear: this module is NOT needed to get trend graphs, you should run the xymond_rrd(8) module instead 💅
• --notes — incoming messages are "notes" messages, and they get stored in the $XYMONNOTESDIR directory. this module is only needed if you want to let people remotely update the notes-files available on the Xymon webpages. remote note-updating privileges? the way that's a whole trust fall 🫶
• --enadis — incoming messages are enable/disable messages, and they will update files in the $XYMONDISABLEDDIR directory. this is only needed if you have third-party add-ons that use these files. if not? skip her, she's fine.
• --dir=DIRECTORY — overrides the default output directory. simple. she goes where you tell her to go 🦋
• --html — used together with --status. tells xymond_filestore to also save an HTML version of the status-log. should not be used unless you must run with XYMONLOGSTATUS=static. read that twice, bestie, it's a "only if you literally have to" situation 🌸
• --htmldir=DIRECTORY — the directory where HTML-versions of the status logs are stored. default: $XYMONHTMLSTATUSDIR
• --htmlext=.EXT — sets the filename extension for generated HTML files. by default, HTML files are saved with a .html extension.
• --multigraphs=TEST1[,TEST2] — this makes xymond_filestore generate HTML status pages with links to service graphs that are split up into multiple images, with at most 5 graphs per image. if you don't specify it, only the "disk" status is split up this way. 5 per image. not 4, not 6. five. 👑
• --only=test[,test,test] — save status messages only for the listed set of tests. this can be useful if you have an external script that needs to parse some of the status logs, but you do not want to save all status logs. picky eater behavior and honestly? valid 🙈
• --debug — enable debugging output. turn it on when things are weird, turn it off when they're not 💜

🧚 FILES 🧚

this module does not rely on any configuration files. zero config files. she simply does not need them. free spirit energy ✨

🌈 SEE ALSO 🌈

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

go read those too, they're the rest of the friend group 🫶

one little vibe check before you go: if you're here for trend graphs, you're in the wrong place, bestie. xymond_rrd(8) is the one you want. this page said it like three times because it means it 😭

and that's the whole page! this little manual was brought to you by Xymon, Version 4.3.30, dated 4 Sep 2019 — yeah she's been around a minute and she still slays 💖✨🎀