XYMONCLIENT.CFG

Section: File Formats (5)
Updated: Version 5.0.3-5.el10.tera.terabithia: 4 Sep 2019
Index Return to Main Contents

NAME

xymonclient.cfg - Xymon client environment variables

DESCRIPTION

Xymon programs use multiple environment variables beside the normal set of variables. For the Xymon client, the environment definitions are stored in the ~xymon/client/etc/xymonclient.cfg file. Each line in this file is of the form NAME=VALUE and defines one environment variable NAME with the value VALUE.

SETTINGS

XYMSRV: The IP-address used to contact the Xymon server. Default: Chosen when the Xymon client was compiled.
XYMSERVERS: List of IP-addresses of Xymon servers. Data will be sent to all of the servers listed here. This setting is only used if XYMSRV=0.0.0.0.
XYMONDPORT: The port number for used to contact the Xymon server. Default: 1984.
XYMONHOME: The Xymon client top-level directory. Default: The $XYMONCLIENTHOME setting inherited from the "runclient.sh" script which starts the Xymon client.
XYMONCLIENTLOGS: The directory for the Xymon clients' own log files. Default: $XYMONHOME/logs
XYMONTMP: Directory used for temporary files. Default: $XYMONHOME/tmp/
XYMONCLIENT_FS_INCLUDE_TYPES: Whitespace-separated Linux filesystem types to include in the client's disk and inode reports even when they are normally excluded as pseudo (nodev) filesystems. Types are matched as exact df type tokens. Defaults to zfs virtiofs tmpfs --- real local filesystems that merely happen to be flagged nodev. Set to "" to restore the historical behaviour of dropping every nodev type. Including remote filesystems also requires XYMONCLIENT_FS_DF_LOCAL_ONLY=no.
XYMONCLIENT_FS_EXCLUDE_TYPES: Whitespace-separated Linux filesystem types to exclude in addition to the default pseudo-filesystem exclusions. Matching is on the exact df type token, and nodev types (overlay, fuse, ...) are already excluded by default, so an effective entry names a type that is not a nodev default --- a device-backed type, or a specific FUSE subtype such as fuse.sshfs that the bare nodev fuse default cannot match. If a type appears in both include and exclude settings, exclusion takes precedence. Defaults to iso9660 squashfs fuse.snapfuse --- read-only images reported 100% full by design (snaps mount as squashfs, or as fuse.snapfuse where snapd falls back to FUSE); none is a nodev type, so they must be named here. Set to "" to monitor these too. The full default exclusion list is the nodev entries in /proc/filesystems (rootfs is always kept, and the XYMONCLIENT_FS_INCLUDE_TYPES above are kept back), together with the explicit XYMONCLIENT_FS_EXCLUDE_TYPES above. When /proc/filesystems is not readable the dynamic nodev exclusions are disabled; the explicit XYMONCLIENT_FS_EXCLUDE_TYPES and the local-only df -l behaviour remain active. The script does not fall back to deriving exclusions from mount(8), so it is not a drop-in replacement for distro patches (such as Debian's) that do.
XYMONCLIENT_FS_DF_LOCAL_ONLY: Set to yes (the default) to pass -l to df and report local filesystems only. Set to no to report remote filesystems as well. Invalid values produce a warning and use the safe default. With no, a stale or hard-blocked remote mount can wedge df indefinitely (an uninterruptible D-state wait): the client run never finishes, so the whole host goes purple --- no data for all metrics, not just disk --- until the mount recovers or the host reboots.
: A df that exits non-zero with no output (a real error, not a hang) is marked failed (yellow) rather than left empty, so a failed filesystem probe is not silently reported green. This does not cover the hang above: a wedged df never exits.
XYMON: Full path to the xymon(1) client program. Default: $XYMONHOME/bin/xymon.
Commands: Many extension scripts expect a series of environment variables to point at various system utilities. These are included in the file when the client is built.

INHERITED SETTINGS

Some environment variables are inherited from the "runclient.sh" script which launches the Xymon client:

MACHINEDOTS: The hostname of the local system. Default: Taken from "uname -n".
MACHINE: The hostname of the local system, with dots replaced by commas. For compatibility with Big Brother extension scripts.
SERVEROSTYPE: The operating system of the local system, in lowercase. Default: taken from "uname -s".
XYMONCLIENTHOME: The top-level directory for the Xymon client. Default: The location of the "runclient.sh" script.