HCA - Threshold Configurations

Health Check Thresholds

Description

The ensure optimal performance of both the application and the underlying platform, a number of thersholds can be set to compare against.

These can be changed should a customer or system deem the threshold to be incorrect for a particular system. Consult with the AP ENPS support team before changing these defaults.

The sections below are:
Search Engine in Use: If older versions of ENPS are using Windows Search Service, the setting should be changed to $false. This is to used to determine the status of the NOM.
Custom Thresholds: These are preconfigured/determined thresholds that the Health Check uses to compare against those obtained from the system the Health Check is running on. These can be changed as mentioned but the majority have been determined after years of experience.
Internet Information Services Thresholds and Configurations: As ENPS is heavily reliant on IIS, there are a number of configuration checks completed so as to determine and maintain optimal performance.

Configurations

There is a thresholds set within \configurables\hc-custom_config.ps1.
NOTE: If you have any questions, please contact AP ENPS Support before making changes to the HealthCheck configurations.

Search Engine In Use

If Solr is not the primary search engine, then this should be set to $false. This will apply to both STARTUP and HEALTHCHECK NOM status detection methods.

Variable	Default Value	Description
$global:HC_NOM_Search_Engine_Solr	$true	If Solr used, set to $true, if WSS then set to $false (healthcheck.ps1 & startup)

Custom Thresholds

Below are a number of threshold set for the HealthCheck to compare against operating values.

Variable	Default Value	Description
[int]$global:HC_DiskSpace_Critical	5	Percent of disk space remaining before critical sent (hc_platform_details_hdd)
[int]$global:HC_DiskSpace_Warning	20	Percent of disk space remaining before warning sent (hc_platform_details_hdd)
[int]$global:HC_DiskSpace_Increments	5	Threshold increments in percent (hc_platform_details_hdd)
[int]$global:HC_RAM_Critical	90	Percent of memory consumed before critical sent (hc_platform_details_ram)
[int]$global:HC_RAM_Warning	85	Percent of memory consumed before warning sent (hc_platform_details_ram)
[int]$global:HC_Theshold_SSL_Days_To_Expiry	31	Number of days before SSL expires (hc_platform_details_ssl)
[string]$global:HC_Day_To_Send_SSL_Exiry_Msg	"Monday"	Day of week to send SSL notifications (hc_platform_details_ssl)
[int]$global:HC_Threshold_Buddy_Queue_Critical	5000	Set the threshold to check the buddy queue (hc_suite_status_enps_queues)
[int]$global:HC_Threshold_Buddy_Queue_Monitor	2000	Set the threshold to check the buddy queue (hc_suite_status_enps_queues)
[int]$global:HC_Threhold_Mos_Queue_Critical	4000	Set the threshold to check the mos queue (hc_suite_status_enps_queues)
[int]$global:HC_Threhold_Mos_Queue_Monitor	2000	Set the threshold to check the mos queue (hc_suite_status_enps_queues)
$global:HC_Threhold_ARCHIVEQ_Queue_Critical	8	Set the threshold to check the ARCHIVEQ queue (hc_suite_status_enps_queues)
$global:HC_Buddy_queue_backup_if_breached	$false	Backup buddy queue if below critical threshold is breached (hc_suite_status_enps_queues)
[int]$global:HC_ExtFile_Threshold	25	Total Size of Acceptable External Files (GB) (hc_suite_status_enps_extfiles)
[int]$global:HC_MSMQ_Threshold	1000	Threshold for MSMQ (hc_platform_details_msmq)
[string]$global:HC_Preset_Public_Ping_Server	"8.8.8.8"	Public TCP/IP to use for checking internet connectivity (hc_platform_details_ping)
[int]$global:HC_Threshold_MOS_Objects_Count	100000	Number of MOS objects in each MOS folder (hc_suite_status_mos_object_status)
[int]$global:HC_Threshold_MOS_Objects_Age	365	Number of days to check the oldest MOS objects against in each MOS folder (hc_suite_status_mos_object_status)
[int]$global:HC_NOM_License_Expiry_Threshold_In_Days	21	Number of days before NOM Key expires (hc_suite_details_config)
[int]$global:HC_Minutes_For_Blocked_NOM_Check	30	Number of minutes to check for a blocked NOM (hc_suite_status_nom_status-no-solr)
[array]$global:HC_ENPS_Core_Services	"SOLRJavaServer", "W3SVC", "IISADMIN", "MSMQ"	Check ENPS Core Services are running (hc_platform_details_services)
[array]$global:HC_Threshold_Event_Viewer_List	"Application", "Security", "System", "ENPSHealthCheck"	List of platform Event Logs to report size and rollover policy (hc_platform_details_ev)
[int]$global:HC_Threshold_Notice_Time_For_SystemMaint	480	Minutes that System Maintenance is running before message is sent (hc_suite_status_uptime)
[int]$global:HC_Threshold_Solr_Total_Difference_Critical	20000	Critical warning if difference between primary and buddy Solr object counts (hc_suite_status_solr)
[int]$global:HC_Threshold_Solr_Total_Difference_Warning	10000	Critical warning if difference between primary and buddy Solr object counts (hc_suite_status_solr)
[int]$global:HC_Threshold_Solr_Topic_Difference_Critical	100	Critical warning if TOPIC difference between primary and buddy Solr object counts (hc_suite_status_solr)
[int]$global:HC_Threshold_Solr_Assignment_Difference_Critical	100	Critical warning if ASSIGNMENT difference between primary and buddy Solr object counts (hc_suite_status_solr)
[int]$global:HC_Threshold_Windows_Rearm_Warning	10	Number of days before Windows needs re-arming (hc_platform_details)
[array]$global:HC_Preset_Ports_Used_By_ENPS	80, 8080, 8084, 10505, 10506, 10510	Firewall ports to check for ENPS instance (hc_platform_details_fw)
[array]$global:HC_ENPS_WATCH_PROCESSES	"WATCH" , "NOM" , "NWP" , "Maint" , "Buddy" , "WalkCS" , "Extract"	List of ENPS Processes that WATCH can check on (hc_suite_status_enps_processes)
[string]$global:HC_Solr_Details	Not entered for security.	Password for Solr website
[int]$global:HC_MOS_Response_Rate_Records_Monitor_Windows	3	Number increases above average before warning sent (hc_suite_status_mos_response_rate)
[int]$global:HC_MOS_Response_Rate_Records_to_Compare	50	Number of records to check for checking MOS device response times (hc_suite_status_mos_response_rate)
[int]$global:HC_MOS_Response_Rate_Records_Percentage_Allowance	10	Percentage allowance for average response times (hc_suite_status_mos_response_rate)
[int]$global:HC_MOS_Response_Rate_Records_ms_Warning	750	Allowance for average response times if over threshold (hc_suite_status_mos_response_rate)
[int]$global:HC_MOS_Response_Rate_Records_ms_Critical	1000	Allowance for average response times if over threshold (hc_suite_status_mos_response_rate)

Internet Information Services Thresholds and Configurations

ENABLE IIS properties to be set if found outside the threshold (hc_platform_details_iis.ps1). They are:
IIS Logging Rollover
IIS Maximum size of log file
IIS Log Fields set as per the configuration file etry
AppPool per application

Variable	Default Value	Description
[string]$global:HC_Preset_AppPool_For_NOMWebService	"NOMWebServiceAppPool"	Name of AppPool assigned to NOM WebServices (hc_platform_details_iis)
[string]$global:HC_Preset_AppPool_For_Playbook	"APPlaybookAppPool"	Name of AppPool assigned to AP Playbook (hc_platform_details_iis)
[string]$global:HC_Preset_AppPool_For_Storytelling	"APStorytellingAppPool"	Name of AppPool assigned to AP Storytelling (hc_platform_details_iis)
[string]$global:HC_Preset_AppPool_For_ENPSAPI	"ENPSAPIAppPool"	Name of AppPool assigned to AP ENPS API (hc_platform_details_iis)
[string]$global:HC_Preset_AppPool_For_NOMWebService_JSON	"NOMWebServices3JSON"	Name of AppPool assigned to NOM WebServices JSON (hc_platform_details_iis)
[string]$global:HC_Preset_AppPool_For_Mobile	"ENPSWebAccessAppPool"	Name of AppPool assigned to ENPS Mobile(hc_platform_details_iis)
[string]$global:HC_Preset_AppPool_For_PlatformAuth	"AuthAppPool"	Name of AppPool assigned to SSO Platform Auth (hc_platform_details_iis)
[string]$global:HC_Preset_AppPool_For_ServerAppPool	"ServerAppPool"	Name of AppPool assigned to ENPS ServerApps (hc_platform_details_iis)

Solr SSL Name

When Solr is configured to use secure protocols, HTTPS, a certificate is required. To enable the HealthCheck to report on the certificates status, the certificate "Friendly Name" is required so that the details can be retrieved from the server's certificate store.

Using the procedure from AP, the default "friendly name" is "solr-ssl". If this is changed during the certificate creation process, the varible will need to be updated.

Variable	Default Value	Description
[string]$global:HC_SOLR_SSL_FriendlyName	"solr-ssl"	Name of SOLR SSL (hc_suite_details_config)