XYMOND_CLIENT(8)

💖 XYMOND_CLIENT(8) 💖

okay bestie, so this is a page from the System Manager's Manual — section 8, the big-kid system admin section — and it's all about a lil worker module called xymond_client. grab a boba, we're doing this 💅

✨ NAME ✨

xymond_client — the xymond worker module that handles client data 🧚

🌸 SYNOPSIS 🌸

xymond_channel --channel=client xymond_client [options]

🦋 DESCRIPTION 🦋

so xymond_client is a worker module for xymond, and like, that means it's normally run through the xymond_channel(8) program, not on its own. it's giving "I don't work alone, I'm part of a team" energy fr fr.

what it does: it receives xymond client messages sent from systems that have the Xymon client installed 👑 and then it takes that client data and generates the Xymon status messages for the cpu-, disk-, memory- and procs- columns. iconic. it also feeds Xymon data messages with the netstat- and vmstat- data that the client collected.

and when it's generating all those status messages from the client data? xymond_client uses the configuration rules defined in the analysis.cfg(5) file to figure out the color of each status message. that file is the main character of the color decisions, no cap 🌈

💅 OPTIONS 💅

• --clear-color=COLOR — sets the color used when it sends "msgs", "files" or "ports" reports and there are literally no rules to check for those statuses. default is showing a "clear" status, but some people prefer it "green". and if you'd rather not see those status columns at all? then use the "--no-clear-msgs", "--no-clear-files" and "--no-clear-ports" options instead 🫶
• --no-clear-msgs — if there are no logfile checks, the "msgs" column shows a "clear" status. if you'd rather not have a "msgs" column at all, this option makes xymond_client not send in a clear "msgs" status ✨
• --no-clear-files — if there are no file checks, the "files" column shows a "clear" status. if you'd rather not have a "files" column, this option makes xymond_client not send in a clear "files" status 🎀
• --no-clear-ports — if there are no port checks, the "ports" column shows a "clear" status. if you'd rather not have a "ports" column, this option makes xymond_client not send in a clear "ports" status 🌸
• --no-ps-listing — normally the "procs" status message includes the full process-listing it got from the client. if you'd rather just see the monitored processes, this option turns off the full ps-listing 😌
• --no-port-listing — normally the "ports" status message includes the full netstat-listing it got from the client. if you'd rather just see the monitored ports, this option turns off the full netstat-listing 🌊
• --no-cpu-listing — normally the "cpu" status message includes the full cpu-listing it got from the client. if you'd rather just see the monitored cpu load, this option turns off the full cpu-listing 🔥
• --uptime-status — generates a separate "uptime" status column. the uptime is normally just reported inside the "cpu" status column, but if you want a whole separate status column for it, this is your option. super useful if you wanna generate an alert for a reboot without mixing that alert in with the cpu load alerts ⭐
• --config=FILENAME — sets the filename for the analysis.cfg file. the default value is "etc/analysis.cfg" below the Xymon server directory 🗂️
• --unknownclientosok — expect and attempt to parse clients with unknown CLIENTOS types. handy if you're submitting custom host responses with file or msgs data that you'd like parsed 👀
• --dump-config — dumps the configuration after parsing it. may be useful for tracking down problems with configuration file errors 🔍
• --test — starts an interactive session where you can test the analysis.cfg configuration. playtime, but make it productive 💖
• --collectors=COLLECTOR1[,COLLECTOR2,...] — limits the set of collector modules that xymond_client will handle. this is not normally used, except for running experimental versions of the program. lowkey a "devs only" button 🧪
• --debug — enables debugging output 🐛

🍓 FILES 🍓

• ~xymon/server/etc/analysis.cfg

💀 BUGS 💀

the "disk" status cannot handle filesystems that contain whitespace in the filesystem (device) name. so like, don't do that. periodt 😭

🌈 SEE ALSO 🌈

analysis.cfg(5), xymond(8), xymond_channel(8), xymon(7)

and that's the whole page bestie 🫶 this one came from Xymon, Version 4.3.30, dated 4 Sep 2019 — shoutout to whoever wrote it, they ate 💅✨ mwah, go read your analysis.cfg 💜