Configuring monitoring checks

This page describes the options you can set for the monitoring checks that run on your nodes, including the options common to every check and the options specific to individual checks. For an overview of how the platform uses Sensu, see Sensu (monitoring).

The SC//Reliant Platform Manager is used to toggle each service check on and off as well as define the configuration settings for the check. This is done using the Sensu Go Check Configurations hash in the node group the monitoring servers in your management plane use.

This document describes both the common configuration options for the checks we provide as well as the custom configuration options available for some of the checks. For more information about the checks available, see Monitoring check reference.

Common configuration options

The following are the common set of configuration options available, called Schedule and Controls in SC//Reliant Platform Manager, for every service check.

Property	Parameters	Description
Schedule	Interval	This setting triggers a service check at a regular, fixed interval. The default interval can be configured for each service check and is defined in seconds.
Schedule	Cron	This setting triggers a service check at specific times and dates using cron syntax. When enabled, this option overrides any value set for the interval.
Controls	Timeout	The maximum duration, in seconds, a health check is allowed to run before it is stopped. This prevents checks from executing indefinitely.
	Time to Live (TTL)	The duration, in seconds, after which a check result is considered stale. This value must be greater than the check interval to ensure there is enough time for the check to execute and its results to be processed before the last result expires.
	Low Flap Threshold	The percentage of recent state changes below which a check is no longer considered to be flapping. Once a check's state change drops to this value or below, it signals that the rapid, repeated state changes have stopped, and notifications are no longer suppressed.
	High Flap Threshold	The percentage of recent state changes above which a check is considered to be flapping. When a check's state change reaches this value, the system interprets it as a sign of instability and will begin suppressing notifications to prevent an alert storm.

Individual check configuration options

Some of the checks have additional configuration options, called Parameters in SC//Reliant Platform Manager. The following table describes the available custom configuration options for the checks that provide them.

Check Name	Parameters	Description
Free Disk Space	Warning Threshold	The percentage of free disk space remaining on the file system that will trigger a warning alert. The default value is `20%`.
	Critical Threshold	The percentage of free disk space remaining on the file system that will trigger a critical alert. The default value is `10%`.
	Additional Paths	Any specific file paths or mount points you want to monitor on the host, in addition to the default directories.
Puppet Client	Warning Threshold	The number of days after which a warning alert will be triggered if a Puppet client has been disabled with a reason. The default value is `1` day.
Puppet Client	Critical Threshold	The number of days after which a critical alert will be triggered if a Puppet client has been disabled with a reason. The default value is `2` days.
CPU Load Utilization	Warning Threshold	The per-core CPU load average that triggers a warning alert. The default value is `2`, which corresponds to each processor core having, on average, twice as many active processes as it can execute at once. The load average itself is calculated over 1, 5, and 15-minute intervals to provide a comprehensive view of the system's performance trend over time.
CPU Load Utilization	Critical Threshold	The per-core CPU load average that triggers a critical alert. The default value is `3`, which corresponds to each processor core having, on average, three times as many active processes as it can execute at once. The load average itself is calculated over 1, 5, and 15-minute intervals to provide a comprehensive view of the system's performance trend over time.
Memory Utilization	Warning Threshold	The percentage of memory used on the host that triggers a warning alert. The default value is `90%`.
Memory Utilization	Critical Threshold	The percentage of memory used on the host that triggers a critical alert. The default value is `95%`.
Windows Free Disk Space	Warning Threshold	The percentage of disk space used on the Windows file system that will trigger a warning alert. The default value is `90%`.
	Critical Threshold	The percentage of disk space used on the Windows file system that will trigger a critical alert. The default value is `95%`.
	Ignored Disk	Any disk drives, specified by the drive letter, you want the check to ignore. For example, to ignore drives `D:` and `E:`, specify `DE`. The default value is null.
Windows CPU Load Utilization	Warning Threshold	The CPU load threshold that triggers a warning alert. The default value is `90%`.
Windows CPU Load Utilization	Critical Threshold	The CPU load threshold that triggers a critical alert. The default value is `95%`.
Windows Memory Utilization	Warning Threshold	The percentage of memory used on the Windows host that triggers a warning alert. The default value is `90%`.
Windows Memory Utilization	Critical Threshold	The percentage of memory used on the Windows host that triggers a critical alert. The default value is `95%`.
Host Ports	Ports	A list of TCP ports to check on the host. Add a new value for each port.
	Host	The IP address of the host to be checked. For example, `192.168.23.25`.
	Strict	When `Strict` mode is enabled, a critical alert is triggered if even a single port in the list is unresponsive. When disabled, the check will return a warning if any ports are found to be closed, but only a critical alert if all ports are unresponsive.
	Timeout	The maximum duration, in seconds, the check will wait for a response before timing out.
Transaction File Size	Warning Threshold	The offline EFT file size threshold that will trigger a warning alert. You must specify the unit of measure (KB, MB, GB). For example, 300KB. The default value is `300KB`.
Transaction File Size	Critical Threshold	The offline EFT file size threshold that will trigger a critical alert. You must specify the unit of measure (KB, MB, GB). For example, 500KB. The default value is `500KB`.
AJB RTS SAF	Critical Threshold	The maximum age, in seconds, a file can remain unprocessed before a critical alert is triggered.
HTTPS Server	Host	The hostname, or IP address, of the server that is running the HTTPS service.
	Port	The port on which the HTTPS service is running. The default value is `443`.
	Timeout	The maximum duration, in seconds, the check will wait for a response before timing out.
OpenVPN Server	OpenVPN Server Name	The name of the OpenVPN server as defined in its configuration. The default value is `mgmt`.
	Instance Failure Threshold	This setting defines the maximum percentage of failed instances that the healthcheck will tolerate before displaying an additional warning message. The check will show an error if the percentage of unhealthy instances exceeds this value. Even if this threshold is not met, the health check will always report a critical status if even a single OpenVPN instance is completely down. If a value is not specified, this feature is not active.
	Minimum Connected Clients	The minimum number of clients required to be connected to each server instance. If the count drops below this value, the check will return a critical status. The default value is `1`.
	Maximum Connected Clients	The maximum number of clients that should be connected to a single server instance. If the client count for any instance reaches or exceeds this value, the check will return a critical status. The default value is `10`.
	Port	The port on which the OpenVPN server is running. The default value is `1194`.
DNS (bind9)	Target	The Fully Qualified Domain Name (FQDN) or IP address to test for name resolution against the BIND9 service.

Configuring monitoring checks

Configuring monitoring checks

Common configuration options

Individual check configuration options

Related documentation