7.5.11.4 Health Monitor System Variables

Table 7.15 Health Monitor System Variable Summary

Variable Name	Variable Type	Variable Scope
health_monitor.disk_fallback_enable	Boolean	Global
health_monitor.disk_fallback_force	Boolean	Global
health_monitor.disk_forecast_report_interval	Integer	Global
health_monitor.disk_forecast_run_mode	String	Global
health_monitor.disk_forecast_running	Boolean	Global
health_monitor.disk_forecast_sample_interval	Integer	Global
health_monitor.disk_forecast_test_filename	File name	Global
health_monitor.disk_low_space_critical_level	Integer	Global
health_monitor.disk_low_space_duration	Integer	Global
health_monitor.disk_low_space_level	Integer	Global
health_monitor.disk_low_space_percent	Integer	Global
health_monitor.disk_monitored	Directory name	Global
health_monitor.disk_recovery_enable	Boolean	Global
health_monitor.disk_recovery_increment	Integer	Global
health_monitor.disk_recovery_level	Integer	Global
health_monitor.disk_recovery_max_cycles	Integer	Global
health_monitor.disk_recovery_time_1	Integer	Global
health_monitor.disk_recovery_time_2	Integer	Global
health_monitor.disk_recovery_window	Integer	Global
health_monitor.disk_retention	Integer	Global
health_monitor.disk_running	Boolean	Global
health_monitor.disk_sample_rate	Integer	Global
health_monitor.disk_usage_warning_level_1	Integer	Global
health_monitor.disk_usage_warning_level_2	Integer	Global
health_monitor.disk_usage_warning_level_3	Integer	Global
health_monitor.memory_report_definition	String	Global
health_monitor.memory_reporting	Boolean	Global
health_monitor.memory_retention	Integer	Global
health_monitor.memory_running	Boolean	Global
health_monitor.memory_sample_rate	Integer	Global
health_monitor.memory_usage_warning_level_1	Integer	Global
health_monitor.memory_usage_warning_level_2	Integer	Global
health_monitor.memory_usage_warning_level_3	Integer	Global
health_monitor.periodic_report_definition	String	Global
health_monitor.periodic_reporting	Boolean	Global
health_monitor.status_interval	Integer	Global
health_monitor.system_cpu_stats_history	Boolean	Global
health_monitor.system_disk_stats_history	Boolean	Global
health_monitor.system_memory_stats_history	Boolean	Global
health_monitor.system_process_stats_history	Boolean	Global
health_monitor.system_retention	Integer	Global
health_monitor.system_running	Boolean	Global
health_monitor.system_sample_rate	Integer	Global

General

• health_monitor.status_interval

  Command-Line Format	--health-monitor.status-interval=#
  System Variable	health_monitor.status_interval
  Scope	Global
  Dynamic	Yes
  SET_VAR Hint Applies	No
  Type	Integer
  Default Value	10
  Minimum Value	0
  Maximum Value	1000

  The frequency, in multiples of the collector's sample rate, at which status messages are sent to the error log table. For example, if status_interval=10 and health_monitor.disk_sample_rate=60, the Health Monitor sends a status message to the error_log table every 600 seconds.

Disk Collector

• health_monitor.disk_running

  Command-Line Format	--health-monitor.disk-running[={OFF|ON}]
  System Variable	health_monitor.disk_running
  Scope	Global
  Dynamic	Yes
  SET_VAR Hint Applies	No
  Type	Boolean
  Default Value	ON

  Whether to enable the Health Monitor's disk monitor.

• health_monitor.disk_sample_rate

  Command-Line Format	--health-monitor.disk-sample-rate=#
  System Variable	health_monitor.disk_sample_rate
  Scope	Global
  Dynamic	Yes
  SET_VAR Hint Applies	No
  Type	Integer
  Default Value	60
  Minimum Value	1
  Maximum Value	864000
  Unit	seconds

  The frequency of disk data collection, in seconds. By default, data is collected every 60 seconds. The minimum sample rate is 1 (every second), and the maximum is 86400 seconds (once a day).

• health_monitor.disk_retention

  Command-Line Format	--health-monitor.disk-retention=#
  System Variable	health_monitor.disk_retention
  Scope	Global
  Dynamic	Yes
  SET_VAR Hint Applies	No
  Type	Integer
  Default Value	86400
  Minimum Value	1
  Maximum Value	864000
  Unit	seconds

  Disk sample retention in seconds. If health_monitor.disk_sample_rate=60 and health_monitor.disk_retention=86400, 1440 samples are retained, with the oldest sample deleted every 60 seconds.

• health_monitor.disk_monitored

  Command-Line Format	--health-monitor.disk-monitored=dir_name
  System Variable	health_monitor.disk_monitored
  Scope	Global
  Dynamic	No
  SET_VAR Hint Applies	No
  Type	Directory name
  Default Value	empty

  Path on the filesystem to monitor. Empty or valid absolute path of maximum 511 bytes length. Empty selects the data directory filesystem.

• health_monitor.disk_fallback_enable

  Command-Line Format	--health-monitor.disk-fallback-enable[={OFF|ON}]
  System Variable	health_monitor.disk_fallback_enable
  Scope	Global
  Dynamic	Yes
  SET_VAR Hint Applies	No
  Type	Boolean
  Default Value	OFF

  If there is a significant or sustained shortage of disk space, Health Monitor sets the system variables, SUPER_READ_ONLY=ON and OFFLINE_MODE=ON. This is called disk fencing.

• health_monitor.disk_fallback_force

  Command-Line Format	--health-monitor.disk-fallback-force[={OFF|ON}]
  System Variable	health_monitor.disk_fallback_force
  Scope	Global
  Dynamic	Yes
  SET_VAR Hint Applies	No
  Type	Boolean
  Default Value	ON

  Whether to enable termination of blocking foreground sessions during attempts to enable disk fencing.

• health_monitor.disk_low_space_duration

  Command-Line Format	--health-monitor.disk-low-space-duration=#
  System Variable	health_monitor.disk_low_space_duration
  Scope	Global
  Dynamic	Yes
  SET_VAR Hint Applies	No
  Type	Integer
  Default Value	300
  Minimum Value	1
  Maximum Value	86400
  Unit	seconds

  The duration in seconds for which the available disk space can remain below either health_monitor.disk_low_space_level or health_monitor.disk_low_space_percent, whichever is lower, before Health Monitor sets SUPER_READ_ONLY=ON and OFFLINE_MODE=ON.

• health_monitor.disk_low_space_level

  Command-Line Format	--health-monitor.disk-low-space-level=#
  System Variable	health_monitor.disk_low_space_level
  Scope	Global
  Dynamic	Yes
  SET_VAR Hint Applies	No
  Type	Integer
  Default Value	5000
  Minimum Value	0
  Maximum Value	18446744073709551614
  Unit	MiB

  The low space threshold for the storage reserve, in MiB. If the available disk space drops below this percentage of total available storage for longer than the value of health_monitor.disk_low_space_duration, Health Monitor sets SUPER_READ_ONLY=ON and OFFLINE_MODE=ON.

• health_monitor.disk_low_space_percent

  Command-Line Format	--health-monitor.disk-low-space-percent=#
  System Variable	health_monitor.disk_low_space_percent
  Scope	Global
  Dynamic	Yes
  SET_VAR Hint Applies	No
  Type	Integer
  Default Value	4
  Minimum Value	0
  Maximum Value	100
  Unit	percent

  The low space threshold for the storage reserve, expressed as a percentage. If the available disk space drops below this percentage of total available storage for longer than the value of health_monitor.disk_low_space_duration, Health Monitor sets SUPER_READ_ONLY=ON and OFFLINE_MODE=ON.

• health_monitor.disk_low_space_critical_level

  Command-Line Format	--health-monitor.disk-low-space-critical-level=#
  System Variable	health_monitor.disk_low_space_critical_level
  Scope	Global
  Dynamic	Yes
  SET_VAR Hint Applies	No
  Type	Integer
  Default Value	2000
  Minimum Value	0
  Maximum Value	18446744073709551614
  Unit	MiB

  The critical low disk space threshold in MiB. If the available disk space falls below this value for any duration, and health_monitor.disk_fallback_enable=ON, Health Monitor sets SUPER_READ_ONLY=ON and OFFLINE_MODE=ON.

• health_monitor.disk_usage_warning_level_1

  Command-Line Format	--health-monitor.disk-usage-warning-level-1=#
  System Variable	health_monitor.disk_usage_warning_level_1
  Scope	Global
  Dynamic	Yes
  SET_VAR Hint Applies	No
  Type	Integer
  Default Value	20
  Minimum Value	0
  Maximum Value	100
  Unit	percent

  A percentage of available disk space above the defined health_monitor.disk_low_space_level. If the available disk space falls below this level, the warning WARNING_DISK_USAGE_LEVEL_1 is logged.

• health_monitor.disk_usage_warning_level_2

  Command-Line Format	--health-monitor.disk-usage-warning-level-2=#
  System Variable	health_monitor.disk_usage_warning_level_2
  Scope	Global
  Dynamic	Yes
  SET_VAR Hint Applies	No
  Type	Integer
  Default Value	10
  Minimum Value	0
  Maximum Value	100
  Unit	percent

  A percentage of available disk space above the defined health_monitor.disk_low_space_level. If the available disk space falls below this level, the warning WARNING_DISK_USAGE_LEVEL_2 is logged.

• health_monitor.disk_usage_warning_level_3

  Command-Line Format	--health-monitor.disk-usage-warning-level-3=#
  System Variable	health_monitor.disk_usage_warning_level_3
  Scope	Global
  Dynamic	Yes
  SET_VAR Hint Applies	No
  Type	Integer
  Default Value	4
  Minimum Value	0
  Maximum Value	100
  Unit	percent

  A percentage of available disk space above the defined health_monitor.disk_low_space_level. If the available disk space falls below this level, the warning WARNING_DISK_USAGE_LEVEL_3 is logged.

• health_monitor.disk_recovery_enable

  Command-Line Format	--health-monitor.disk-recovery-enable[={OFF|ON}]
  System Variable	health_monitor.disk_recovery_enable
  Scope	Global
  Dynamic	Yes
  SET_VAR Hint Applies	No
  Type	Boolean
  Default Value	ON

  Whether to enable automatic recovery from Health Monitor fencing.

• health_monitor.disk_recovery_level

  Command-Line Format	--health-monitor.disk-recovery-level=#
  System Variable	health_monitor.disk_recovery_level
  Scope	Global
  Dynamic	Yes
  SET_VAR Hint Applies	No
  Type	Integer
  Default Value	5
  Minimum Value	0
  Maximum Value	100
  Unit	percent

  The percentage of total disk space above the storage reserve.

  • If the available storage remains above the health_monitor.disk_recovery_level level for health_monitor.disk_recovery_time_1 seconds, the Health Monitor sets OFFLINE_MODE=OFF.

  • If storage remains above the health_monitor.disk_recovery_level for an additional health_monitor.disk_recovery_time_2 seconds, the Health Monitor sets SUPER_READ_ONLY=OFF.

• health_monitor.disk_recovery_time_1

  Command-Line Format	--health-monitor.disk-recovery-time-1=#
  System Variable	health_monitor.disk_recovery_time_1
  Scope	Global
  Dynamic	Yes
  SET_VAR Hint Applies	No
  Type	Integer
  Default Value	300
  Minimum Value	1
  Maximum Value	86400
  Unit	seconds

  The amount of time (in seconds) that the available storage must remain above health_monitor.disk_recovery_level before the Health Monitor sets OFFLINE_MODE=OFF.

• health_monitor.disk_recovery_time_2

  Command-Line Format	--health-monitor.disk-recovery-time-2=#
  System Variable	health_monitor.disk_recovery_time_2
  Scope	Global
  Dynamic	Yes
  SET_VAR Hint Applies	No
  Type	Integer
  Default Value	300
  Minimum Value	1
  Maximum Value	86400
  Unit	seconds

  The additional time (in seconds) that the available storage must remain above health_monitor.disk_recovery_level after health_monitor.disk_recovery_time_1 before the Health Monitor sets SUPER_READ_ONLY=OFF.

• health_monitor.disk_recovery_max_cycles

  Command-Line Format	--health-monitor.disk-recovery-max-cycles=#
  System Variable	health_monitor.disk_recovery_max_cycles
  Scope	Global
  Dynamic	Yes
  SET_VAR Hint Applies	No
  Type	Integer
  Default Value	3
  Minimum Value	0
  Maximum Value	2147483647
  Unit	cycles

  The maximum number of times that the server can be placed back into normal operating mode within the duration set by health_monitor.disk_recovery_window.

• health_monitor.disk_recovery_increment

  Command-Line Format	--health-monitor.disk-recovery-increment=#
  System Variable	health_monitor.disk_recovery_increment
  Scope	Global
  Dynamic	Yes
  SET_VAR Hint Applies	No
  Type	Integer
  Default Value	300
  Minimum Value	1
  Maximum Value	86400
  Unit	seconds

  Delay in seconds added to health_monitor.disk_recovery_time_1 and health_monitor.disk_recovery_time_2 after each recovery cycle.

• health_monitor.disk_recovery_window

  Command-Line Format	--health-monitor.disk-recovery-window=#
  System Variable	health_monitor.disk_recovery_window
  Scope	Global
  Dynamic	Yes
  SET_VAR Hint Applies	No
  Type	Integer
  Default Value	18446744073709551614
  Minimum Value	0
  Maximum Value	86400
  Unit	seconds

  The amount of time, in seconds, following the last successful recovery cycle after which the recovery count is reset. 0 means the recovery count is never reset.

Disk Forecaster

• health_monitor.disk_forecast_running

  Command-Line Format	--health-monitor.disk-forecast-running[={OFF|ON}]
  System Variable	health_monitor.disk_forecast_running
  Scope	Global
  Dynamic	Yes
  SET_VAR Hint Applies	No
  Type	Boolean
  Default Value	ON

  Whether to enable disk metric collection and forecasting.

• health_monitor.disk_forecast_sample_interval

  Command-Line Format	--health-monitor.disk-forecast-sample-interval=#
  System Variable	health_monitor.disk_forecast_sample_interval
  Scope	Global
  Dynamic	Yes
  SET_VAR Hint Applies	No
  Type	Integer
  Default Value	60
  Minimum Value	10
  Maximum Value	86400
  Unit	seconds

  The frequency, in seconds, at which disk metrics are recorded to the disk_metric table.

• health_monitor.disk_forecast_report_interval

  Reserved for future development.

• health_monitor.disk_forecast_run_mode

  Command-Line Format	--health-monitor.disk-forecast-run-mode=value
  System Variable	health_monitor.disk_forecast_run_mode
  Scope	Global
  Dynamic	Yes
  SET_VAR Hint Applies	No
  Type	String
  Default Value	NORMAL
  Valid Values	NORMAL NONE TEST STANDBY

  The run mode of the disk usage forecaster, which can be one of the following:

  • NONE: Do not collect disk metrics or generate forecasts.

  • NORMAL: Collect disk metrics, generate forecasts.

  • TEST:

  • STANDBY: Pause disk metric collection and forecasting.

• health_monitor.disk_forecast_test_filename

  Command-Line Format	--health-monitor.disk-forecast-test-filename=file_name
  System Variable	health_monitor.disk_forecast_test_filename
  Scope	Global
  Dynamic	Yes
  SET_VAR Hint Applies	No
  Type	File name
  Default Value	empty string

  Input file selected for TEST mode.

Memory Collector and Reporter

• health_monitor.memory_running

  Command-Line Format	--health-monitor.memory-running[={OFF|ON}]
  System Variable	health_monitor.memory_running
  Scope	Global
  Dynamic	Yes
  SET_VAR Hint Applies	No
  Type	Boolean
  Default Value	ON

  Whether to enable host and MySQL process memory collection.

• health_monitor.memory_sample_rate

  Command-Line Format	--health-monitor.memory-sample-rate=#
  System Variable	health_monitor.memory_sample_rate
  Scope	Global
  Dynamic	Yes
  SET_VAR Hint Applies	No
  Type	Integer
  Default Value	60
  Minimum Value	1
  Maximum Value	86400
  Unit	seconds

  Memory sample interval in seconds.

• health_monitor.memory_retention

  Command-Line Format	--health-monitor.memory-retention=#
  System Variable	health_monitor.memory_retention
  Scope	Global
  Dynamic	Yes
  SET_VAR Hint Applies	No
  Type	Integer
  Default Value	86400
  Minimum Value	1
  Maximum Value	864000
  Unit	seconds

  Memory sample retention in seconds. If health_monitor.memory_sample_rate=60 and health_monitor.memory_retention=86400, 1440 samples are retained, with the oldest sample deleted every 60 seconds.

• health_monitor.memory_usage_warning_level_1

  Command-Line Format	--health-monitor.memory-usage-warning-level-1=#
  System Variable	health_monitor.memory_usage_warning_level_1
  Scope	Global
  Dynamic	Yes
  SET_VAR Hint Applies	No
  Type	Integer
  Default Value	1024
  Minimum Value	0
  Maximum Value	18446744073709551614
  Unit	MiB

  An amount of available memory. If the available memory falls below this level, the warning WARNING_MEMORY_USAGE_LEVEL_1 is raised.

• health_monitor.memory_usage_warning_level_2

  Command-Line Format	--health-monitor.memory-usage-warning-level-2=#
  System Variable	health_monitor.memory_usage_warning_level_2
  Scope	Global
  Dynamic	Yes
  SET_VAR Hint Applies	No
  Type	Integer
  Default Value	500
  Minimum Value	0
  Maximum Value	18446744073709551614
  Unit	MiB

  An amount of available memory. If the available memory falls below this level, the warning WARNING_MEMORY_USAGE_LEVEL_2 is raised.

• health_monitor.memory_usage_warning_level_3

  Command-Line Format	--health-monitor.disk-usage-warning-level-3=#
  System Variable	health_monitor.memory_usage_warning_level_3
  Scope	Global
  Dynamic	Yes
  SET_VAR Hint Applies	No
  Type	Integer
  Default Value	100
  Minimum Value	0
  Maximum Value	18446744073709551614
  Unit	MiB

  An amount of available memory. If the available memory falls below this level, the warning WARNING_MEMORY_USAGE_LEVEL_3 is raised.

• health_monitor.memory_reporting

  Reserved for future development.

• health_monitor.memory_report_definition

  Reserved for future development.

Periodic Reporter

• health_monitor.periodic_reporting

  Reserved for future development.

• health_monitor.periodic_report_definition

  Reserved for future development.

System Collector

• health_monitor.system_running

  Command-Line Format	--health-monitor.system-running[={OFF|ON}]
  System Variable	health_monitor.system_running
  Scope	Global
  Dynamic	Yes
  SET_VAR Hint Applies	No
  Type	Boolean
  Default Value	ON

  Enable CPU, disk, memory and MySQL process statistics collection.

• health_monitor.system_sample_rate

  Command-Line Format	--health-monitor.system-sample-rate=#
  System Variable	health_monitor.system_sample_rate
  Scope	Global
  Dynamic	Yes
  SET_VAR Hint Applies	No
  Type	Integer
  Default Value	60
  Minimum Value	1
  Maximum Value	864000
  Unit	seconds

  System statistics sample interval in seconds.

• health_monitor.system_retention

  Command-Line Format	--health-monitor.system-retention=#
  System Variable	health_monitor.system_retention
  Scope	Global
  Dynamic	Yes
  SET_VAR Hint Applies	No
  Type	Integer
  Default Value	86400
  Minimum Value	1
  Maximum Value	864000
  Unit	seconds

  System statistics retention in seconds.

• health_monitor.system_cpu_stats_history

  Command-Line Format	--health-monitor.system-cpu-stats-history-running[={OFF|ON}]
  System Variable	health_monitor.system_cpu_stats_history
  Scope	Global
  Dynamic	Yes
  SET_VAR Hint Applies	No
  Type	Boolean
  Default Value	ON

  Whether system CPU usage statistics are collected and stored in the system_cpu_stats_history table. If these statistics are not stored, you can still access a snapshot on demand by querying the system_cpu_stats table.

• health_monitor.system_disk_stats_history

  Command-Line Format	--health-monitor.system-disk-stats-history-running[={OFF|ON}]
  System Variable	health_monitor.system_disk_stats_history
  Scope	Global
  Dynamic	Yes
  SET_VAR Hint Applies	No
  Type	Boolean
  Default Value	ON

  Enable disk history rows when disk statistics are available.

• health_monitor.system_memory_stats_history

  Command-Line Format	--health-monitor.system-memory-stats-history-running[={OFF|ON}]
  System Variable	health_monitor.system_memory_stats_history
  Scope	Global
  Dynamic	Yes
  SET_VAR Hint Applies	No
  Type	Boolean
  Default Value	ON

  Enable system memory history rows.

• health_monitor.system_process_stats_history

  Command-Line Format	--health-monitor.system-process-stats-history-running[={OFF|ON}]
  System Variable	health_monitor.system_process_stats_history
  Scope	Global
  Dynamic	Yes
  SET_VAR Hint Applies	No
  Type	Boolean
  Default Value	ON

  Enable MySQL process history rows.