SVCSTATUS.CGI(1)

💖 NAME 💖

okay bestie so like. this page is all about svcstatus.cgi — a CGI program to view Xymon status logs. that's the whole vibe. iconic. moving on ✨

🎀 SYNOPSIS 🎀

svcstatus.cgi [--historical] [--history={top|bottom}]

🦋 DESCRIPTION 🦋

so svcstatus.cgi is a CGI program that serves up a Xymon status log in HTML form — like, as an actual web page, bestie. she's versatile, fr fr: she works for the logs showing your current status AND for the historical logs living over in the "histlogs" directory. normally she gets invoked as a CGI program, which means most of her input parameters come sliding in through the CGI QUERY_STRING environment variable. that's just how she rolls. 💅

unless the --historical option is present, the current status log is what you get. and this assumes a QUERY_STRING environment variable shaped like this:

HOSTSVC=hostname.servicename

where "hostname" is the name of the host with commas instead of dots, and "servicename" is the name of the service — that's the column name in Xymon, iykyk. links like this get auto-generated by the xymongen(1) tool when the environment contains XYMONLOGSTATUS=dynamic. she's self-sufficient like that 🫶

with the --historical option present, a historical logfile gets used instead. this one assumes a QUERY_STRING environment variable shaped like:

HOST=hostname&SERVICE=servicename&TIMEBUF=timestamp

where "hostname" is the name of the host with commas instead of dots, "servicename" is the name of the service, and "timestamp" is the time of the log. this one's automatically generated by the history.cgi(1) tool. teamwork makes the dream work 💜

✨ OPTIONS ✨

• --historical — use a historical logfile instead of the current logfile. throwback mode, activated. 📼
• --history={top|bottom|none} — when showing the current logfile, this gives you a "HISTORY" button at the top or the bottom of the webpage, or, like, not at all. the default is to put the HISTORY button at the bottom of the page. classic bottom placement. 🍑
• --env=FILENAME — load the environment from FILENAME before executing the CGI. get her prepped and ready bestie 💅
• --templates=DIRECTORY — where to look for the HTML header- and footer-templates used when generating the webpages. Default: $XYMONHOME/web/
• --no-svcid — do not include the HTML tags that identify the hostname/service on the generated web page. useful if this already happens in the hostsvc_header template file, for instance. don't double up, that's not the vibe 🙈
• --multigraphs=TEST1[,TEST2] — this makes svcstatus.cgi generate links to service graphs that are split up into multiple images, with at most 5 graphs per image. ⚠️ this option only works in Xymon mode. if you don't specify it, only the "disk" status gets split up this way. okay queen, break it up 💅
• --no-disable — by default, the info-column page includes a form letting users disable and re-enable tests. if your setup uses the default separation of administration tools into a separate, password-protected area, then using the disable- and enable-functions requires access to the administration tools. if you'd rather do all that only via the dedicated administration page, this option will remove the disable-function from the info page. no stray buttons, periodt ✋
• --no-jsvalidation — the disable-function on the info-column page by default uses JavaScript to validate the form before submitting the input to the Xymon server. BUT 😭 some browsers cannot handle the JavaScript code correctly, so the form just does not work. this option disables the use of JavaScript for form-validation, letting those browsers actually use the disable-function. accessibility queen 👑
• --nkconfig=FILENAME — use FILENAME as the configuration file for the Critical Systems information. the default is to load this from $XYMONHOME/etc/critical.cfg

🌸 FILES 🌸

• $XYMONHOME/web/hostsvc_header — HTML template header
• $XYMONHOME/web/hostsvc_footer — HTML template footer

🌈 ENVIRONMENT 🌈

• NONHISTS=info,trends,graphs — a comma-separated list of services that does not have meaningful history, e.g. the "info" and "trends" columns. services listed here do not get a "History" button. no history for you, bestie 🚫📜
• TEST2RRD=test,test — a comma-separated list of the tests that have an RRD graph. 📈

👑 SEE ALSO 👑

xymon(7), xymond(1)

okay that's the whole page, you ate that 💖 and just so you know who to thank: this one's from the Xymon girlies, Version 4.3.30: 4 Sep 2019 — yes she's a 2019 baby and she's still slaying, no cap. mwah, go read your logs bestie 🎀✨🦋