XYMONSERVER.CFG(5)

📦
version 4.3.30 · 2 versions
, in debian bookworm, ubuntu jammy, ubuntu noble

💖 xymonserver.cfg — the Xymon env var bible (part 1) 💖

okay bestie, welcome to XYMONSERVER.CFG(5) from the File Formats Manual 🎀 this is the page that tells you where Xymon keeps literally every knob it cares about, so grab a snack and let's go ✨

🌸 NAME 🌸

xymonserver.cfg — Xymon environment variables. that's it, that's the vibe 🫶

✨ DESCRIPTION ✨

so here's the tea: Xymon programs don't just use the normal set of environment variables, they use a whole extra pile of them 💅 and all those environment definitions live in the file ~Xymon/server/etc/xymonserver.cfg.

Every single line in that file is shaped like this:

NAME=VALUE

which defines one environment variable NAME with the value VALUE. simple, clean, iconic.

You can also append data to a variable you already made, using this syntax:

NAME+=VALUE

In that case VALUE gets appended to whatever NAME already had. And if NAME wasn't defined yet? no stress — it just acts exactly like a normal definition. slay 🌈

🦋 ENVIRONMENT AREAS 🦋

ngl sometimes you want the same variable to have different values depending on where it's being used. Xymon said "say less" — you do this by defining variables with an associated "area", and those definitions look like:

AREA/NAME=VALUE

like, say you wanted a special setup of the XYMSERVERS variable just for when it's used by an application in the "management" area. you'd do this:

XYMSERVERS="127.0.0.1"            # Default definition
management/XYMSERVERS="10.1.0.5"  # Definition in the "management" area

see how cute that is 🥺

Areas get invoked by using the --area option for all tools, or via the ENVAREA setting in the tasks.cfg(5) file. iykyk.

👑 GENERAL SETTINGS 👑

💜 XYMONSERVERHOSTNAME

The fully-qualified hostname of the server that is running Xymon.

💜 XYMONSERVERWWWNAME

The hostname used to access this servers' web-pages, used to construct URL's in the Xymon webpages. Default is the XYMONSERVERHOSTNAME.

💜 XYMONSERVERIP

The public IP-address of the server that is running Xymon.

💜 XYMONSERVEROS

A name identifying the operating system of the Xymon server. The known names are currently "linux", "freebsd", "solaris", "hpux", "aix" and "osf".

💜 FQDN

If set to TRUE, Xymon will use fully-qualified hostnames throughout. If set to FALSE, hostnames are stripped of their domain-part before being processed. It is highly recommended that you keep this set to TRUE. Default: TRUE.

💜 XYMONLOGSTATUS

Controls how the HTML page for a status log is generated. If set to DYNAMIC, the HTML logs are generated on-demand by the svcstatus.cgi(1) script. If set to STATIC, you must activate the xymond_filestore(8) module (through an entry in the tasks.cfg(5) file) to create and store the HTML logs whenever a status update is received. Setting "XYMONLOGSTATUS=STATIC" is discouraged since the I/O load on the Xymon server will increase significantly. 😭

💜 PINGCOLUMN

Defines the name of the column for "ping" test status. The data from the "ping" test is used internally by Xymon, so it must be defined here so all of the Xymon tools know which column to watch for this data. The default setting is PINGCOLUMN=conn.

💜 INFOCOLUMN

Defines the name of the column for the "info" pages.

💜 TRENDSCOLUMN

Defines the name of the column for the RRD graph pages.

💜 RRDHEIGHT

The default height (in pixels) of the RRD graph images. Default: 120 pixels.

💜 RRDWIDTH

The default width (in pixels) of the RRD graph images. Default: 576 pixels.

💜 RRDGRAPHOPTS

Extra options for the RRD graph command. These are passed directly to the "rrdgraph" command used to generate graphs, see the rrdgraph(1) man-page for details of the options.

💜 TRENDSECONDS

The graphs on the "trends" page show data for the past TRENDSECONDS seconds. Default: 172800 seconds, i.e. 48 hours.

💜 HTMLCONTENTTYPE

The Content-type reported by the CGI scripts that generate web pages. By default, this it "text/html". If you have on-line help texts in character sets other than the ISO-8859-1 (western european) character set, it may be necessary to modify this to include a character set. E.g.

HTMLCONTENTTYPE="text/html; charset=euc-jp"

for a Japanese character sets. Note: Some webservers will automatically add this, if configured to do so.

💜 XYMWEBREFRESH

The default HTTP page reload interval for many xymongen and status pages. Note that while this can be overridden in the header template files for regular pages, dynamically generated status logs displayed with svcstatus.cgi(1) use this value in the HTTP response header and for security reasons the value in hostsvc_header may be ignored on many modern browsers. (default [seconds]: 60)

💜 HOLIDAYS

Defines the default set of holidays used if there is no "holidays" tag for a host in the hosts.cfg file. Holiday sets are defined in the holidays.cfg(5) file. If not defined, only the default holidays (those defined outside a named holiday set) will be considered as holidays.

💜 WEEKSTART

Defines which day is the first day of the week. Set to "0" for Sunday, "1" for Monday. Default: 1 (Monday).

💜 XYMONBODYHEADER

Text that is included in the Xymon web pages at the location specified by ~xymon/server/web/*_header templates. If this is set to a value beginning with "file:", then the contents of the specified file is included. Default: "file:$XYMONHOME/etc/xymonmenu.cfg"

💜 XYMONBODYFOOTER

Text that is included in the Xymon web pages at the location specified by ~xymon/server/web/*_footer templates. If this is set to a value beginning with "file:", then the contents of the specified file is included. Default: Empty.

💜 XYMONBODYMENUCSS

URL for the Xymon menu CSS file. Default: "$XYMONMENUSKIN/xymonmenu.css"

💜 HOSTPOPUP

Determines what is used as the host comment on the webpages. The comment by default appears as a pop-up when the mouse hovers over the hostname, and is also shown on the "info" status page. This setting must be one or more of the letters "C" (COMMENT), "D" (DESCRIPTION) or "I" (IP-address). Including "C" uses the COMMENT setting for the host, including "D" uses the DESCR setting for the host, and "I" uses the IP-address of the host. If more than one of these is set, then COMMENT takes precedence over DESCR which again has precence over IP. Note that DESCR and IP only appear in pop-up windows (if enabled), whereas the COMMENT is always used — if pop-up's have been disabled, then the COMMENT value is displayed next to the hostname on the webpages. Default: CDI

💜 STATUSLIFETIME

The number of minutes that a status is considered valid after an update. After this time elapses, the status will go purple. Default: 30 minutes

🎀 DIRECTORIES 🎀

🍓 XYMONSERVERROOT

The top-level directory for the Xymon installation. The default is the home-directory for the user running Xymon.

🍓 XYMONSERVERLOGS

The directory for the Xymon's own logfiles (NOT the status-logs from the monitored hosts).

🍓 XYMONHOME

The Xymon server directory, where programs and configurations are kept. Default: $XYMONSERVERROOT/server/ .

🍓 XYMONTMP

Directory used for temporary files. Default: $XYMONHOME/tmp/

🍓 XYMONWWWDIR

Directory for Xymon webfiles. The $XYMONWEB URL must map to this directory. Default: $XYMONHOME/www/

🍓 XYMONNOTESDIR

Directory for Xymon notes-files. The $XYMONNOTESSKIN URL must map to this directory. Default: $XYMONHOME/www/notes/

🍓 XYMONREPDIR

Directory for Xymon availability reports. The $XYMONREPURL URL must map to this directory. Note also that your webserver must have write-access to this directory, if you want to use the report.cgi(1) CGI script to generate reports on-demand. Default: $XYMONHOME/www/rep/

🍓 XYMONSNAPDIR

Directory for Xymon snapshots. The $XYMONSNAPURL URL must map to this directory. Note also that your webserver must have write-access to this directory, if you want to use the snapshot.cgi(1) CGI script to generate snapshots on-demand. Default: $XYMONHOME/www/snap/

🍓 XYMONVAR

Directory for all data stored about the monitored items. Default: $XYMONSERVERROOT/data/

🍓 XYMONRAWSTATUSDIR

Directory for storing the raw status-logs. Not used unless "xymond_filestore --status" is running, which is discouraged since it increases the load on the Xymon server significantly. Default: $XYMONVAR/logs/

🍓 XYMONHTMLSTATUSDIR

Directory for storing HTML status-logs. Not used unless "xymond_filestore --status --html" is running, which is discouraged since it increases the load on the Xymon server significantly. Default: $XYMONHOME/www/html/

🍓 XYMONHISTDIR

Directory for storing the history of monitored items. Default: $XYMONVAR/hist/

🍓 XYMONHISTLOGS

Directory for storing the detailed status-log of historical events. Default: $XYMONVAR/histlogs/

🍓 XYMONACKDIR

Directory for storing information about alerts that have been acknowledged. Default: $XYMONVAR/acks/

🍓 XYMONDISABLEDDIR

Directory for storing information about tests that have been disabled. Default: $XYMONVAR/disabled/

🍓 XYMONDATADIR

Directory for storing incoming "data" messages. Default: $XYMONVAR/data/

🍓 XYMONRRDS

Top-level directory for storing RRD files (the databases with trend-information used to generate graphs). Default: $XYMONVAR/rrd/

🍓 CLIENTLOGS

Directory for storing the data sent by a Xymon client around the time a status changes to a warning (yellow) or critical (red) state. Used by the xymond_hostdata(8) module. Default: $XYMONVAR/hostdata/

🍓 XYMONCGILOGDIR

Directory where debug output from CGI applications are stored. If not specified, it defaults to $XYMONSERVERLOGS, but this is often a directory that is not writable by the userid running the CGI applications. It is therefore recommended when using "--debug" on CGI applications that you create a separate directory owned by the user running your webserver, and point XYMONCGILOGDIR to this directory. 🫶

okay bestie that's part 1 done, and there's MORE coming so don't you dare close the tab 👀💅

🗂️ SYSTEM FILES 🗂️

The "where does everything live" corner of the config, bestie. Three whole settings. Iconic.

  • HOSTSCFG — the full path to the Xymon hosts.cfg(5) configuration file. Default: $XYMONHOME/etc/hosts.cfg.
  • XYMON — the full path to the xymon(1) client program. Default: $XYMONHOME/bin/xymon.
  • XYMONGEN — the full path to the xymongen(1) webpage generator program. Default: $XYMONHOME/bin/xymongen.

🔗 URLS 🔗

Okay so this entire section is basically "Xymon, where do your own web things live?" Every single one of these is a URL prefix with no hostname in it, and if your webserver isn't actually mapped to them, nothing renders. It's giving ✨plumbing✨ but make it cute.

  • XYMONSERVERWWWURL — the root URL for the Xymon webpages, without the hostname. This URL must be mapped to the ~/server/www/ directory in your webserver configuration. There's a sample Apache configuration you can peek at in ~/server/etc/xymon-apache.conf.
  • XYMONSERVERCGIURL — the root URL for the Xymon CGI-scripts, again without the hostname. This directory must be mapped to the ~/cgi-bin/ directory in your webserver configuration, and it must be flagged as holding executable scripts. Sample Apache configuration lives in ~/server/etc/xymon-apache.conf.
  • XYMONWEBHOST — the initial part of the Xymon URL, including just the protocol and the hostname, e.g. "http://www.foo.com".
  • XYMONWEBHOSTURL — the prefix for all of the static Xymon webpages, e.g. "http://www.foo.com/xymon".
  • XYMONWEBHTMLLOGS — the URL prefix for the static HTML status-logs generated when XYMONLOGSTATUS=STATIC.
🚩 Note that this setting is discouraged, so this setting should not be used. Like, at all. Periodt.
  • XYMONWEB — the URL prefix (without hostname) of the Xymon webpages. E.g. "/xymon".
  • XYMONSKIN — the URL prefix (without hostname) of the Xymon graphics. E.g. "/xymon/gifs".
  • XYMONHELPSKIN — the URL prefix (without hostname) of the Xymon on-line help files. E.g. "/xymon/help".
  • XYMONMENUSKIN — the URL prefix (without hostname) of the Xymon menu files. E.g. "/xymon/menu".
  • XYMONNOTESSKIN — the URL prefix (without hostname) of the Xymon on-line notes files. E.g. "/xymon/notes".
  • XYMONREPURL — the URL prefix (without hostname) of the Xymon availability reports. E.g. "/xymon/rep".
  • XYMONSNAPURL — the URL prefix (without hostname) of the Xymon snapshots. E.g. "/xymon/snap".
  • XYMONWAP — the URL prefix (without hostname) of the Xymon WAP/WML files. E.g. "/xymon/wml".
  • CGIBINURL — the URL prefix (without hostname) of the Xymon CGI-scripts. Default: $XYMONSERVERCGIURL.
  • COLUMNDOCURL — a format string used to build a link to the documentation for a column heading. Default: "$CGIBINURL/columndoc.sh?%s", which causes links to use the columndoc.sh(1) script to document a column.
  • HOSTDOCURL — a format string used to build a link to the documentation for a host. If it's not set, then Xymon falls back to scanning the XYMONNOTES directory for files matching the hostname, or the hostname together with a common filename extension (.php, .html, .doc and so on). If it is set, this string becomes a formatting string for the documentation URL. E.g. for the host "myhost", a setting of HOSTDOCURL="/docs/%s.php" will generate a link to "/docs/myhost.php". Default: not set, so host documentation gets retrieved from the XYMONNOTES directory.

📨 SETTINGS FOR SENDING MESSAGES TO XYMON 📨

This is the "how do I slide into the server's DMs" block. 💌

  • XYMSRV — the IP-address used to contact the xymond(8) service. Used by clients and the tools that perform network tests. Default: $XYMONSERVERIP.
  • XYMSERVERS — a list of IP-addresses. Clients and network test tools will try to send status reports to a Xymon server running on each of these addresses. This setting is only used if XYMSRV=0.0.0.0.
  • XYMONDPORT — the portnumber used to contact the xymond(8) service. Used by clients and the tools that perform network tests. Default: 1984.
  • MAXMSGSPERCOMBO — the maximum number of status messages to combine into one combo message. Default: 100.
  • SLEEPBETWEENMSGS — the length of a pause introduced between each successive transmission of a combo-message by xymonnet, in microseconds. Default: 0 (send messages as quickly as possible).

🧠 XYMOND SETTINGS 🧠

Big brain server daemon behaviour. Main character energy only.

  • ALERTCOLORS — a comma-separated list of the colors that may trigger an alert-message. The default is "red,yellow,purple". Note that alerts may further be generated or suppressed based on the configuration in the alerts.cfg(5) file.
  • OKCOLORS — a comma-separated list of the colors that may trigger a recovery-message. The default is "green,clear,blue".
  • ALERTREPEAT — how often alerts get repeated while a status is in an alert state. This is the default setting, which may be changed in the alerts.cfg(5) file.
  • MAXMSG_STATUS — the maximum size of a "status" message in kB, default: 256. Status messages are the ones that end up as columns on the web display. The default size should be adequate in most cases, but some extension scripts can generate very large status messages — close to 1024 kB. You should only change this if you see messages in the xymond log file about status messages being truncated.
  • MAXMSG_CLIENT — the maximum size of a "client" message in kB, default: 512. "client" messages are generated by the Xymon client, and often include large process-listings. You should only change this if you see messages in the xymond log file about client messages being truncated.
  • MAXMSG_DATA — the maximum size of a "data" message in kB, default: 256. "data" messages are typically used for client reports of e.g. netstat or vmstat data. You should only change this setting if you see messages in the xymond log file about data messages being truncated.
  • MAXMSG_NOTES — the maximum size of a "notes" message in kB, default: 256. "notes" messages provide a way for uploading documentation about a host to Xymon; it is not enabled by default. If you want to upload large documents, you may need to change this setting.
  • MAXMSG_STACHG — the maximum size of a "status change" message in kB, default: current value of the MAXMSG_STATUS setting. Status-change messages occur when a status changes color. There is no reason to change this setting.
  • MAXMSG_PAGE — the maximum size of a "page" message in kB, default: current value of the MAXMSG_STATUS setting. "page" messages are alerts, and include the status message that triggers the alert. There is no reason to change this setting.
  • MAXMSG_ENADIS — the maximum size of an "enadis" message in kB, default: 32. "enadis" are small messages used when enabling or disabling hosts and tests, so the default size should be adequate.
  • MAXMSG_CLICHG — the maximum size of a "client change" message in kB, default: current value of the MAXMSG_CLIENT setting. Client-change messages occur when a status changes color to one of the alert-colors, usually red, yellow and purple. There is no reason to change this setting.
  • MAXMSG_USER — the maximum size of a "user" message in kB, default: 128. "user" messages are for communication between custom Xymon modules you have installed, it is not used directly by Xymon.

📜 XYMOND_HISTORY SETTINGS 📜

The memory-keeping, scrapbook-keeping corner of Xymon. She remembers everything, fr. 🎀

  • XYMONALLHISTLOG — if set to TRUE, xymond_history(8) will update the $XYMONHISTDIR/allevents file logging all changes to a status. The allevents file is used by the eventlog.cgi(1) tool to show the list of recent events on the "All non-green" webpage.
  • XYMONHOSTHISTLOG — if set to TRUE, xymond_history(8) will update the host-specific eventlog that keeps record of all status changes for a host. This logfile is not used by any Xymon tool.
  • SAVESTATUSLOG — if set to TRUE, xymond_history(8) will save historical detailed status-logs to the $XYMONHISTLOGS directory.

🚨 XYMOND_ALERT SETTINGS 🚨

How Xymon yells at you when something goes sideways. 💅

  • MAIL — the command used to send alerts via e-mail, including a "Subject:" header in the mail. Default: "mail -s".
  • MAILC — the command used to send alerts via e-mail in a form that does not have a "Subject" in the mail. Default: "mail".
  • SVCCODES — maps status-columns to numeric service-codes. The numeric codes are used when sending an alert using a script, where the numeric code of the service is provided in the BBSVCNUM variable.

📈 XYMOND_RRD SETTINGS 📈

Graphs. Charts. Data that goes up and to the right (or, y'know, dramatically down). Obsessed. 🔥

  • TEST2RRD — a list of "COLUMNNAME[=RRDSERVICE]" settings, that define which status- and data-messages have a corresponding RRD graph. You will normally not need to modify this, unless you have added a custom TCP-based test to the protocols.cfg file, and want to collect data about the response-time, OR if you are using the xymond_rrd(8) external script mechanism to collect data from custom tests. Note: All TCP tests are automatically added.
  • GRAPHS_<COLUMNAME> — a list of GRAPHs that should be displayed on the corresponding column page. Note this will override the default, so to add multiple graphs you should include the original one (e.g. GRAPHS_cpu="la,vmstat1").

These are used together by the svcstatus.cgi(1) script to determine if the detailed status view of a test should include a graph.

  • GRAPHS — a list of the RRD databases, that should be shown as a graph on the "trends" column.
  • NORRDDISKS — this is used to disable the tracking of certain filesystems. By default all filesystems reported by a client are tracked. In some cases you may want to disable this for certain filesystems, e.g. database filesystems since they are always completely full. This setting is a regular expression that is matched against the filesystem name (the Unix mount-point, or the Windows disk-letter) — if the filesystem name matches this expression, then it will not be tracked by Xymon.
⚠️ Note: Setting this does not affect filesystems that are already being tracked by Xymon — to remove them, you must remove the RRD files for the unwanted filesystems from the ~xymon/data/rrd/HOSTNAME/ directory.
  • RRDDISKS — this is used to enable tracking of only selected filesystems (see the NORRDDISKS setting above). By default all filesystems are being tracked, setting this changes that default so that only those filesystems that match this pattern will be tracked.

✨ XYMONNET NETWORK TEST SETTINGS ✨

  • XYMONNETWORK — define this and only the hosts tagged with "NET:$XYMONNETWORK" get tested by the xymonnet tool. Everyone else? Not invited to this party 💅
  • CONNTEST — set it to TRUE and the connectivity (ping) test actually happens. 🏓
  • IPTEST_2_CLEAR_ON_FAILED_CONN — if this is TRUE, then network tests that fail go CLEAR whenever the conn-test fails. Basically: if we can't even ping it, we're not gonna drag every service for it. 🫶
  • NONETPAGE — a list of network services (separated by a <space>) that should go yellow when they fail instead of red. Softer landing, bestie.
  • XYMONROUTERTEXT — okay so when you use the "router" or "depends" tags for a host, a failure status will include text saying an "Intermediate router is down". But like… it's 2024-coded network topologies out here, and that "router" could be a switch or some other network device. If you define this environment variable, the word "router" gets swapped for whatever you put in it. So to tell your users it's an intermediate switch or router that's down, you'd do:
XYMONROUTERTEXT="switch or router"

This can also be set on a per-host basis using the "DESCR:hosttype:description" tag in the hosts.cfg(5) file. 🎀

  • NETFAILTEXT — when a network test fails, the status message says "SERVICENAME not OK". This variable lets you change that "not OK" bit — e.g. flip it to "FAILED" or customize it however you want. Your words, your rules. ✨
  • FPING — the command used to run the xymonping(1) tool for the connectivity test. (The name FPING is a little throwback moment: the "fping" utility was used until Xymon version 4.2, iykyk 🕰️). This can include suid-root wrappers and xymonping options. Default: "xymonping"
  • FPINGOPTS — options used for the fping(1) or xymonping(1) tool for the connectivity test. Heads up though: xymonnet will still expect the output to match the default format, no cap. Default: "-Ae"
  • TRACEROUTE — it's just listed here, that's the whole entry, no description, we move 🚶♀️. The actual deets live in TRACEROUTEOPTS right below.
  • TRACEROUTEOPTS — defines the location of the "traceroute" tool and any options needed to run it. traceroute gets used by the connectivity test when the ping test fails; if it's requested via the "trace" tag, the TRACEROUTE command is executed to try to point at the exact spot in the network causing the problem. 🔍

For backwards compatibility with prior versions: if TRACEROUTEOPTS is unset, TRACEROUTE is assumed to have whatever options you want and no addl options are used. The recommended defaults are:

"-n -q 2 -w 2 -m 15"

which is: no DNS lookup, max. 2 probes, wait 2 seconds per hop, max 15 hops.

If you have the mtr(8) tool installed — it's available from http://www.bitwizard.nl/mtr/ — I strongly recommend using that instead. The recommended TRACEROUTEOPTS for mtr are:

"-c 2 -n --report"
Note that mtr needs to be installed suid-root on most systems. ⚠️
  • NTPDATE — defines the ntpdate(1) program used for the "ntp" test. Default: "ntpdate" ⏰
  • NTPDATEOPTS — options used for the ntpdate(1) program. Default: "-u -q -p 1"
  • RPCINFO — defines the rpcinfo(8) program used for "rpc" tests. Default: "rpcinfo"

🎀 XYMONGEN WEBPAGE GENERATOR SETTINGS 🎀

  • XYMONLOGO — HTML code that gets inserted on all standard headers. The default adds the text "Xymon" in the upper-left corner of the page, but you can absolutely swap that out for, like, a company logo, slay. If you do, the suggestion is to keep it around 30-35 pixels high and 100-150 pixels wide so it doesn't eat the whole header. 🖼️
  • XYMONPAGELOCAL — the string "Pages hosted locally" that shows up above all the pages linked from the main Xymon webpage.
  • XYMONPAGESUBLOCAL — the string "Subpages hosted locally" that shows up above all the sub-pages linked from pages below the main Xymon webpage.
  • XYMONPAGEREMOTE — the string "Remote status display" that shows up above the summary statuses displayed on the min Xymon webpage.
  • XYMONPAGETITLE — HTML tags designed to go inside a <FONT> tag, to choose the font for the titles of the webpages. 💖
  • XYMONPAGEROWFONT — HTML tags designed to go inside a <FONT> tag, to choose the font for row headings (that's your hostnames) on the webpages.
  • XYMONPAGECOLFONT — HTML tags designed to go inside a <FONT> tag, to choose the font for column headings (that's your test names) on the webpages.
  • XYMONPAGEACKFONT — HTML tags designed to go inside a <FONT> tag, to choose the font for the acknowledgement text displayed on the status-log HTML page for an acknowledged status. ✅
  • ACKUNTILMSG — when displaying the detailed status of an acknowledged test, Xymon includes the time the acknowledgement expires, using the print-format defined in this setting. You define the timeformat with the controls in your system's strftime(3) routine, and you can add whatever text suits your setup.
  • ACK_COOKIE_EXPIRATION — the valid length of an acknowledgement cookie. You want this big enough that a late-answered acknowledgement for an alert still gets processed properly. Default value: 86400 🍪
  • XYMONDATEFORMAT — on webpages generated by xymongen, the default header includes the current date and time. Normally it looks like "Tue Aug 24 21:59:47 2004". This variable controls the format of that timestamp — define it with the controls in the strftime(3) routine. E.g. to have it show up as "2004-08-24 21:59:47 +0200" you'd set:
XYMONDATEFORMAT="%Y-%m-%d %H:%M:%S %z"
  • HOLIDAYFORMAT — how holiday dates are displayed. The default is "%d/%m", which shows the day and month. American users may want to change this to "%m/%d" to suit their preferred date-display style. This is a formatting string for the system strftime(3) routine, so any controls available for that routine may be used. 📅
  • XYMONPAGECOLREPEAT — inspired by Jeff Stoner's col_repeat_patch.tgz patch, this defines the maximum number of rows before repeating the column headings on a webpage. It sets the default value for the xymongen(1) "--maxrows" option; if the command-line option is also specified, then it overrides this environment variable. And note: unlike Jeff's patch, xymongen implements this for both the "All non-green" page and all other pages (xymon.html, subpages, critical.html). 👑
  • SUMMARY_SET_BKG — if set to TRUE, then summaries will affect the color of the main Xymon webpage. Default: FALSE.
  • DOTHEIGHT — the height (in pixels) of the icons showing the color of a status. Default: 16, which matches the default icons.
  • DOTWIDTH — the width (in pixels) of the icons showing the color of a status. Default: 16, which matches the default icons.
  • CLIENTSVCS — list of the status logs fed by data from the Xymon client. These status logs will — if there are Xymon client data available for the host — include a link to the raw data sent by the client. Default: cpu,disk,memory,procs,svcs. 🖥️
  • XYMONRSSTITLE — if defined, this is the title of the RSS/RDF documents generated when xymongen(1) is invoked with the "--rss" option. The default value is "Xymon Alerts".
  • WMLMAXCHARS — maximum size of a WAP/WML output "card" when generating these. Default: 1500.
  • XYMONNONGREENEXT — list of scripts to run as extensions to the "All non-green" page. Note that two scripts, "eventlog.sh" and "acklog.sh", are handled specially: they're handled internally by xymongen, but the script names must be listed in this variable for that function to be enabled. 🔥
  • XYMONHISTEXT — list of scripts to run as extensions to a history page.
  • XYMONREPWARN — default threshold for listing the availability as "critical" (red) when generating the availability report. This can be set on a per-host basis with the WARNPCT setting in hosts.cfg(5). Default: 97 (percent) 🚨
  • XYMONGENREPOPTS — default xymongen options used for reports. This will typically include options like "--subpagecolumns", and also "--ignorecolumns" if you want to exclude certain tests from reports by default.
  • XYMONGENSNAPOPTS — default xymongen options used by snapshots. This should be identical to the options you normally use when building Xymon webpages. 📸

📁 FILES 📁

~xymon/server/etc/xymonserver.cfg

🌈 SEE ALSO 🌈

xymon(7)

and that's a wrap on XYMONSERVER.CFG(5), bestie 💖 this whole thing was Xymon Version 4.3.30 from 4 Sep 2019, and honestly? iconic of it. go forth and configure responsibly 🫶✨🎀

📦 where this page comes from