XYMONLAUNCH(8)

💖 XYMONLAUNCH 💖

okay bestie, gather round, because this is the manual page for xymonlaunch — that's section 8 of the System Manager's Manual, so you already know it's giving system administrator energy. ✨

🌸 NAME 🌸

xymonlaunch — the master program that launches all the other Xymon programs. like, the mom friend of the Xymon ecosystem, fr fr. 👑

🎀 SYNOPSIS 🎀

xymonlaunch [options]

that's it. that's the whole vibe. one command, a pile of options, and a whole system to run. 💅

🦋 DESCRIPTION 🦋

so xymonlaunch(8) is the main program that controls the execution and the scheduling of literally every component in the Xymon system. not me being the backbone of the whole operation. 😭

here's the slay part: xymonlaunch lets the administrator add, remove, or change the set of Xymon applications and extensions without restarting Xymon. she will automatically notice any changes in the set of tasks and adjust the scheduling of activities accordingly. no restart, no drama, no downtime. iconic behaviour only. ✨

and it also lets the administrator set up specific logfiles for each component of the Xymon system, instead of getting output from all components dumped into one single file. separate logs for separate girls. we love boundaries. 🫶

✨ OPTIONS ✨

• --env=FILENAME — loads the environment from FILENAME before starting other tools. heads up tho: the environment defined by FILENAME is the default, and it can be overridden by the ENVFILE option in tasks.cfg(5). so like, defaults first, queen second. 💖
• --config=FILENAME — this one defines the file that xymonlaunch scans for the tasks it has to launch. the full description of that file lives in tasks.cfg(5). and if you don't specify anything? she goes looking in these places: /etc/tasks.cfg, /etc/xymon/tasks.cfg, and /etc/xymon-client/clientlaunch.cfg, plus ~/server/etc/tasks.cfg. she's thorough, okay?? 🔍
• --log=FILENAME — defines the logfile where xymonlaunch logs info about failures to launch tasks, plus other data about the operation of xymonlaunch. the logs from the individual tasks themselves are defined over in the tasks.cfg file. by default, this is logged to stdout. 💅
• --pidfile=FILENAME — the filename where xymonlaunch saves its own process-ID. commonly used by automated start/stop scripts. it's giving "here's my number, call me". 📞
• --verbose — logs the launch of all tasks to the logfile. but bestie, listen: the logfile may become quite large if you enable this. you've been warned. 😭
• --dump — just dumps the contents of the tasks.cfg file after parsing it. used for debugging. a little peek behind the curtain. 🙈
• --debug — enables debugging output while running. for when you need to see everything. 🔥
• --no-daemon — normally xymonlaunch detaches from the controlling tty and runs as a background task. this option keeps it running in the foreground. for the girlies who like to keep an eye on things. 👀

🌈 STARTING TASKS 🌈

xymonlaunch will read the configuration file and start all of the tasks listed there. every single one. no skips.

now for the messy part. if a task completes abnormally — and yes, that means terminated by a signal or with a non-zero exit status — then xymonlaunch will attempt to restart it 5 times. and if it still will not run? the task is disabled for 10 minutes. this whole saga gets logged to the xymonlaunch logfile. she tried her best, okay. 😭

and here's the part that's genuinely so satisfying: if the configuration file changes, xymonlaunch will re-read it and notice any changes. 💖

• if a running task was removed from the configuration, then the task is stopped. bye bestie. 👋
• if a new task was added, it will be started. hi bestie! 🎀
• if the command used for a task changed, or it was given a new environment definition file, or the logfile was changed — then the task is stopped and restarted with the new definition. glow-up protocol, activated. ✨

⭐ SEE ALSO ⭐

tasks.cfg(5), xymon(7)

go read those too, iykyk. 📚

and that's the whole page, bestie. no cap, every flag accounted for. 💅

sign-off szn 🌸 this was Xymon, Version 4.3.30, dated 4 Sep 2019, and it lives in section XYMONLAUNCH(8). periodt. 💖✨🦋