REPORTLOG.CGI(1)

πŸ’– REPORTLOG.CGI β€” the reportlog.cgi manual, bestie edition πŸ’–

okay so real talk, this is the reportlog.cgi page from the General Commands Manual section, and it's about a CGI program that reports on your service availability log. she's niche, she's useful, she's lowkey carrying your SLA reporting. let's get into it 🫢


✨ NAME ✨

reportlog.cgi β€” a CGI program that reports the service availability log. that's it, that's the girl πŸ’…


🌸 SYNOPSIS 🌸

reportlog.cgi

no args, no flags at the command line, she just is. the real tea is all in the environment, iykyk ✨


πŸ¦‹ DESCRIPTION πŸ¦‹

so reportlog.cgi gets invoked as a CGI script through the reportlog.sh CGI wrapper. not you calling her directly, bestie β€” she comes through the wrapper, main character entrance and all. πŸ’…

based on the parameters she receives, she generates an availability report for one specific host-service combo, for whatever time period you asked for. and this report is not playing around, it includes:

  • a calculation of the availability percentage, split out into percent green time, yellow time, and red time 🚦
  • an eventlog for the period, listing all the status changes that happened β€” so you can drill down into the actual test reports that show where a problem was πŸ‘€

and if you want to get at the individual historical status logs themselves, you go through the svcstatus.cgi(1) CGI script. different girl, different job, she's linked below πŸŽ€

reportlog.cgi gets handed a QUERY_STRING environment variable, and inside it are these parameters:

  • HOSTSVC β€” the host and service to report on
  • STYLE β€” the report style, and it can be "crit", "non-crit", or "all"
  • ST β€” the starttime, in seconds since 1-1-1970 00:00 UTC
  • END β€” the endtime, in seconds since 1-1-1970 00:00 UTC

and then there's a whole other lil squad of non-standard parameters that the Xymon version of history.cgi handles. yes, history.cgi, not reportlog.cgi β€” that's what the page says, don't come for me πŸ™ˆ:

  • IP β€” the IP address of the host, and this one is for display purposes only (she's decorative, not functional, respect her craft πŸ’…)
  • REPORTTIME β€” the REPORTTIME: setting for this host
  • WARNPCT β€” the WARNPCT: setting for this host

so the REPORTTIME and WARNPCT options get pulled from the hosts.cfg(5) definition for the host β€” or, if there's nothing there, the defaults get used instead. no drama either way. ✨

and why do these two matter so much? because they modify the availability calculation so it can report against agreed Service Level Agreements β€” specifically re. the time of day when the service must be available, and the agreed availability level. so basically she's doing SLA math for you and you don't even have to cry about it πŸ˜­πŸ‘‘


πŸŽ€ OPTIONS πŸŽ€

  • --env=FILENAME β€” loads the environment from FILENAME before executing the CGI. cute lil pre-game ritual, she needs her environment set before she goes on stage 🫢

🌈 SEE ALSO 🌈

the whole friend group, honestly. go read them, they're all giving ⭐


and that's the page bestie!! πŸ’– this one's from Xymon, version 4.3.30, dated 4 Sep 2019 β€” so yeah she's a lil vintage but she still ate, no cap. go forth and report your availability, periodt πŸ¦‹βœ¨

πŸ“¦ where this page comes from