HealthCheck Assistance
There are a number of configurations that enable the Health Check to function. These configurations enable a granular approach to monitoring, as modules and comunications can be enabled or disabled for a customer. As the Health Check is installed on each system within an enterprise, the systems may even have differen configurations.
Below are the configurations that pertain to customer communications. These are:
Customer Monitoring Communications Configurations: To send the mails, a customer needs to add the SMTP relay details.
Customer Monitoring Communications Channels: To enabled the various messages and channels that a customer will receive are enabled in this section.
Customer Critical Notification Options: If an option is enabled, the customer will be notifed via the configured channel for the specific module.
There are settings set within \configurables\customer_communication_channels.config
The customer communications are configured by running the Customer_Comms_Configurator.ps1 utiltiy.
NOTE: If you have any questions, please contact AP ENPS Support before making changes to the HealthCheck configurations.
There are thresholds set within \configurables\hc-custom_config.ps1.
Enable Customer Monitoring Communications Channels
Below are a number of options where a customers notifications can be customized. When a channel is set to $true, and there is a channel configured, then the customer will receive notifications on that channel.
The section below allows the customer setting for the startup messages, and whether or not to receive the Heartbeat Summary mail.
| Variable | Default Value | Description |
|---|---|---|
| $global:HC_Customer_SMTP_Configuration |
$true | Set to $true to for ALL customer deployments |
| $global:HC_Customer_Slack_Configuration | $false | Set to $true to allow customers to receive Slack notifications if configured |
| $global:HC_Customer_MSTeams_Configuration | $false | Set to $true to allow customers to receive MS-Teams notificatiosn if configured |
| $global:HC_Customer_ENPS_API_Configuration | $false | Set to $true to allow customers to receive ENPS Top Line notifications if configured |
| $global:HC_Mail_Heartbeat_Visualisation_JPG | $false | Use stand alone JPG for visualisation. Select if no internet access |
| $global:HC_Mail_Heartbeat_Visualisation_JavaScript | $true | Use Javascript for visualisation. |
| $global:HC_Enable_Onscreen_Notifications | $true | This enables the HC place on screen notifications where configured to notify the user of an issue |
| Variable | Default Value | Description |
|---|---|---|
| $global:HC_Customer_Slack_Startup_Messages |
$false | Enable startup Slack messages to customer (startup) |
| $global:HC_Customer_Mail_Startup_Messages | $true | Enable startup Mail messages to customer (startup) |
| $global:HC_Customer_MSTeams_Startup_Messages | $false | Enable startup MS Teams messages to customer (startup) |
Heartbeat Summary Sections
A number of additional sections can be added to the Heartbeat Summary mail. These include graphing a number of systems resources, the thresholds set for the Health Check, the Windows Roles and Features installed and a zipped copy of the G_ tables.
| Variable | Default Value | Description |
|---|---|---|
| $global:HC_Customer_Mail_Heartbeat_Message | $true | Enable heartbeat Mail mail to customer (hc_SendTo_Mail_Heartbeat) |
| $global:HC_Customer_Slack_Heartbeat_Message | $false | Enable heartbeat Slack messages to AP Support (healthcheck) The above, $global:HC_Customer_Mail_Heartbeat_Message is required to be enabled to produce the required downstream information. |
| $global:HC_Customer_MSTeams_Heartbeat_Message | $false | Enable heartbeat Slack messages to AP Support (healthcheck) The above, $global:HC_Customer_Mail_Heartbeat_Message is required to be enabled to produce the required downstream information. |
| $global:HC_Mail_Heartbeat_Visualisation |
$true | Enable Visualisations to be added to HeartBeat Mail messages (hc_platform_details_ram & hc_SendTo_Mail_Heartbeat) |
| $global:HC_Mail_Heartbeat_Thresholds | $false | Enable Threshold values to be added to HeartBeat Mail messages (hc_SendTo_Mail_Heartbeat) |
| $global:HC_Mail_Heartbeat_RnF | $false | Enable Roles and Features to be attached to HeartBeat Mail message (hc_SendTo_Mail_Heartbeat) |
| $global:HC_Mail_Heartbeat_PB_G_TABLES | $false | Enable G_ tables to be attached, currently only the G_CONFIG |
ENPS Messages
If an ENPS API service is installed, a number of messages can be sent to all system supervisors in ENPS when an event occurs. These are: if a system restarts, a NOM is blocked, there is an issue with disk storage space and MOS queues.
| Variable | Default Value | Description |
|---|---|---|
| $global:HC_Customer_STARTUP_State |
$false | Enable ENPS API Client messages to Supervisors when a server is started |
| $global:HC_Customer_ENPS_NOM_State | $false | Enable ENPS API Client messages to Supervisors if NOM blocked |
| $global:HC_Customer_ENPS_HDD_State | $false | Enable ENPS API Client messages to Supervisors for HDD state |
| $global:HC_Customer_ENPS_Queue_State | $false | Enable ENPS API Client messages to Supervisors for Buddy_Queue |
| $global:HC_Customer_ENPS_MOS_Response_Time_State | $false | Enable ENPS API Client messages to Supervisors for MOS Response Times |
| $global:HC_Customer_ENPS_QueueAge_State | $false | Enable ENPS API Client messages to Supervisors for Buddy_Queue |
| $global:HC_Customer_ENPS_License_State | $false | Enable ENPS API Client messages to Supervisors if license is nearing expiry |
Notification Frequency
When a critical event occurs, notifications can be sent once per day or every time the Health Check is executed.
| Variable | Default Value | Description |
|---|---|---|
| $global:HC_Critical_Message_Frequency_HDD | multiple | Frequency of critical messages for storage/disk space issues |
| $global:HC_Critical_Message_Frequency_RAM | multiple | Frequency of critical messages when system RAM is being monitored |
| $global:HC_Critical_Message_Frequency_RDP_SESSION | once | Frequency of critical messages if multiple sessions are found |
| $global:HC_Critical_Message_Frequency_ENPS_CORE_SERVICES | multiple | Frequency of critical messages for the core ENPS server components |
| $global:HC_Critical_Message_Frequency_WINDOWS_LICENSE | once | Frequency of critical messages for Windows license status |
| $global:HC_Critical_Message_Frequency_SOLR_FOLDERS | once | Frequency of critical messages for monitoring Solr folders |
| $global:HC_Critical_Message_Frequency_IIS | multiple | Frequency of critical messages for IIS configurations |
| $global:HC_Critical_Message_Frequency_PING | multiple | Frequency of critical messages for ping status |
| $global:HC_Critical_Message_Frequency_ENPS_LICENSE | once | Frequency of critical messages for ENPS license state |
| $global:HC_Critical_Message_Frequency_XMLStorage | mutliple | Frequency of critical messages for XML configuration status |
| $global:HC_Critical_Message_Frequency_External_Files | once | Frequency of critical messages for the size of external files |
| $global:HC_Critical_Message_Frequency_MOS_Object_Count | once | Frequency of critical messages for MOS object counts |
| $global:HC_Critical_Message_Frequency_QUEUECOUNT | multiple | Frequency of critical messages for buddy and MOS queues |
| $global:HC_Critical_Message_Frequency_QUEUEAGE | multiple | Frequency of critical message for when the archive queue is stuck. |
| $global:HC_Critical_Message_Frequency_WebService | multiple | Frequency of critical messages for webservice configurations and resolution |
| $global:HC_Critical_Message_Frequency_SOLR | multiple | Frequency of critical messages for Solr state |
| $global:HC_Critical_Message_Frequency_PB_Firewall | multiple | Frequency of critical messages for firewall states |
| $global:HC_Critical_Message_Frequency_Java_Log4J_Check | once | Frequency of critical messages for the Log4J security check |
| $global:HC_Critical_Message_Frequency_PB_Config_Check | once | Frequency of critical messages for a number of Playbook configuration checks |
| $global:HC_Critical_Message_Frequency_IIS_AppPool | multiple | Frequency of critical messages for the IIS AppPool configurations |
| $global:HC_Critical_Message_Frequency_AVATAR | multiple | Frequency of critical messages for the PB avatar state |
| $global:HC_Critical_Message_Frequency_SSO | multiple | Frequency of critical messages for the state of SSO configurations |
| $global:HC_Critical_Message_Frequency_MOS_Response_Times | multiple | Frequency of critical messages for MOS Response Times |
Customer Critical Notification Options
If any of the below are set to $true, then when an event occurs, a critical notification will be sent to the enabled customer's communication channels for their support staff. For example, if the NOM was found to be in blocked mode, a critical notification in the configured channels would be sent. This works in relation to the above
enabled modules.
Critical messages look like.
| Variable | Default Value | Description |
|---|---|---|
| $global:HC_Customer_Slack_NOM_INI_Processes |
$false | Enable Slack messages to customer when processes enabled in NOM.INI aren't running (suite_status_enps_processes) |
| $global:HC_Customer_Mail_NOM_INI_Processes | $true | Enable Mail messages to customer when processes enabled in NOM.INI aren't running (suite_status_enps_processes) |
| $global:HC_Customer_MSTeams_NOM_INI_Processes | $false | Enable MS Teams messages to customer when processes enabled in NOM.INI aren't running (suite_status_enps_processes) |
| $global:HC_Customer_Slack_NOM_State | $false | Enable Slack messages to customer if NOM blocked (hc_suite_status_nom_status-no-solr.ps1 and hc_suite_status_nom_status-solr.ps1) |
| $global:HC_Customer_Mail_NOM_State | $true | Enable Mail messages to customer if NOM blocked (hc_suite_status_nom_status-no-solr.ps1 and hc_suite_status_nom_status-solr.ps1) |
| $global:HC_Customer_MSTeams_NOM_State | $false | Enable MS Teams messages to customer if NOM blocked (hc_suite_status_nom_status-no-solr.ps1 and hc_suite_status_nom_status-solr.ps1) |
| $global:HC_Customer_Slack_HDD_State | $false | Enable Slack messages to customer for HDD state (platform_details_hdd) |
| $global:HC_Customer_Mail_HDD_State | $true | Enable Mail messages to customer for HDD state (platform_details_hdd) |
| $global:HC_Customer_MSTeams_HDD_State | $false | Enable MS Teams messages to customer for HDD state (platform_details_hdd) |
| $global:HC_Customer_Slack_RAM_State | $false | Enable Slack messages to customer for RAM (platform_details_ram) |
| $global:HC_Customer_Mail_RAM_State | $true | Enable Mail messages to customer for RAM (platform_details_ram) |
| $global:HC_Customer_MSTeams_RAM_State | $false | Enable MS Teams messages to customer for RAM (platform_details_ram) |
| $global:HC_Customer_Slack_SSL_State | $false | Enable Slack messages to customer for SSL (platform_details_ssl) |
| $global:HC_Customer_Mail_SSL_State | $true | Enable Mail messages to customer for SSL (platform_details_ssl) |
| $global:HC_Customer_MSTeams_SSL_State | $false | Enable MS Teams messages to customer for SSL (platform_details_ssl) |
| $global:HC_Customer_Slack_RDP_SESSION_State | $false | Enable Slack messages to customer for RDP_SESSION (platform_details_sessions) |
| $global:HC_Customer_Mail_RDP_SESSION_State | $true | Enable Mail messages to customer for RDP_SESSION (platform_details_sessions) |
| $global:HC_Customer_MSTeams_RDP_SESSION_State | $false | Enable MS Teams messages to customer for RDP_SESSION (platform_details_sessions) |
| $global:HC_Customer_Slack_ENPS_CORE_SERVICES_State | $false | Enable Slack messages to customer for ENPS_CORE_SERVICES (platform_details_services) |
| $global:HC_Customer_Mail_ENPS_CORE_SERVICES_State | $true | Enable Mail messages to customer for ENPS_CORE_SERVICES (platform_details_services) |
| $global:HC_Customer_MSTeams_ENPS_CORE_SERVICES_State | $false | Enable MS Teams messages to customer for ENPS_CORE_SERVICES (platform_details_services) |
| $global:HC_Customer_Slack_WINDOWS_LICENSE_State | $false | Enable Slack messages to customer for WINDOWS_LICENSE (platform_details) |
| $global:HC_Customer_Mail_WINDOWS_LICENSE_State | $true | Enable Mail messages to customer for WINDOWS_LICENSE (platform_details) |
| $global:HC_Customer_MSTeams_WINDOWS_LICENSE_State | $false | Enable MS Teams messages to customer for WINDOWS_LICENSE (platform_details) |
| $global:HC_Customer_Slack_SOLR_FOLDERS_State | $false | Enable Slack messages to customer for SOLR_FOLDERS (platform_details_solr_folders) |
| $global:HC_Customer_Mail_SOLR_FOLDERS_State | $true | Enable Mail messages to customer for SOLR_FOLDERS (platform_details_solr_folders) |
| $global:HC_Customer_MSTeams_SOLR_FOLDERS_State | $false | Enable MS Teams messages to customer for SOLR_FOLDERS (platform_details_solr_folders) |
| $global:HC_Customer_Slack_IIS_State | $false | Enable Slack messages to customer for IIS (platform_details_iis) |
| $global:HC_Customer_Mail_IIS_State | $true | Enable Mail messages to customer for IIS (platform_details_iis) |
| $global:HC_Customer_MSTeams_IIS_State | $false | Enable MS Teams messages to customer for IIS (platform_details_iis) |
| $global:HC_Customer_Slack_IIS_Policy_State | $false | Enable Slack messages to customer for IIS Response Header (platform_details_iispolicies) |
| $global:HC_Customer_Mail_IIS_Policy_State | $true | Enable Mail messages to customer for IIS Response Header (platform_details_iispolicies) |
| $global:HC_Customer_MSTeams_IIS_Policy_State | $false | Enable MS Teams messages to customer for IIS Response Header (platform_details_iispolicies) |
| $global:HC_Customer_Slack_PING_State | $false | Enable Slack messages to customer for PING (platform_details_ping) |
| $global:HC_Customer_Mail_PING_State | $true | Enable Mail messages to customer for PING (platform_details_ping) |
| $global:HC_Customer_MSTeams_PING_State | $false | Enable MS Teams messages to customer for PING (platform_details_ping) |
| $global:HC_Customer_Slack_ENPS_LICENSE_State | $false | Enable Slack messages to customer for ENPS_LICENSE (suite_details_config) |
| $global:HC_Customer_Mail_ENPS_LICENSE_State | $true | Enable Mail messages to customer for ENPS_LICENSE (suite_details_config) |
| $global:HC_Customer_MSTeams_ENPS_LICENSE_State | $false | Enable MS Teams messages to customer for ENPS_LICENSE (suite_details_config) |
| $global:HC_Customer_Slack_XMLStorage_State | $false | Enable Slack messages to customer for XMLStorage (suite_details_config) |
| $global:HC_Customer_Mail_XMLStorage_State | $true | Enable Mail messages to customer for XMLStorage (suite_details_config) |
| $global:HC_Customer_MSTeams_XMLStorage_State | $false | Enable MS Teams messages to customer for XMLStorage (suite_details_config) |
| $global:HC_Customer_Slack_External_Files_State | $false | Enable Slack messages to customer for External_Files (platform_details_extfiles) |
| $global:HC_Customer_Mail_External_Files_State | $true | Enable Mail messages to customer for External_Files (platform_details_extfiles) |
| $global:HC_Customer_MSTeams_External_Files_State | $false | Enable MS Teams messages to customer for External_Files (platform_details_extfiles) |
| $global:HC_Customer_Slack_MOS_Object_Count_State | $false | Enable Slack messages to customer for MOS_Object_Count (suite_status_mos_object_status) |
| $global:HC_Customer_Mail_MOS_Object_Count_State | $true | Enable Mail messages to customer for MOS_Object_Count (suite_status_mos_object_status) |
| $global:HC_Customer_MSTeams_MOS_Object_Count_State | $false | Enable MS Teams messages to customer for MOS_Object_Count (suite_status_mos_object_status) |
| $global:HC_Customer_Slack_MSMQ_Object_Count_State | $false | Enable Slack messages to customer for MSMQ_Object_Count (platform_details_msmq) |
| $global:HC_Customer_Mail_MSMQ_Object_Count_State | $true | Enable Mail messages to customer for MSMQ_Object_Count (platform_details_msmq) |
| $global:HC_Customer_MSTeams_MSMQ_Object_Count_State | $false | Enable MS Teams messages to customer for MSMQ_Object_Count (platform_details_msmq) |
| $global:HC_Customer_Slack_QueueCount_State | $false | Enable Slack messages to customer for Buddy & MOS Queue (suite_status_enps_queues) |
| $global:HC_Customer_Mail_QueueCount_State | $true | Enable Mail messages to customer for Buddy & MOS Queue (suite_status_enps_queues) |
| $global:HC_Customer_MSTeams_QueueCount_State | $false | Enable MS Teams messages to customer for Buddy & MOS Queue (suite_status_enps_queues) |
| $global:HC_Customer_Slack_QueueAge_State | $false | Enable Slack messages to customer for ARCHIVEQ Queue (suite_status_enps_queues) |
| $global:HC_Customer_Mail_QueueAge_State | $true | Enable Slack messages to customer for ARCHIVEQ Queue (suite_status_enps_queues) |
| $global:HC_Customer_MSTeams_QueueAge_State | $false | Enable MS Teams messages to customer for ARCHIVEQ Queue (suite_status_enps_queues) |
| $global:HC_Customer_Slack_WebService_State | $false | Enable Slack messages to customer for WebService (suite_status_json) |
| $global:HC_Customer_Mail_WebService_State | $true | Enable Mail messages to customer for WebService (suite_status_json) |
| $global:HC_Customer_MSTeams_WebService_State | $false | Enable MS Teams messages to customer for WebService (suite_status_json) |
| $global:HC_Customer_Slack_SOLR_State | $false | Enable Slack messages to customer for SOLR (suite_status_solr) |
| $global:HC_Customer_Mail_SOLR_State | $true | Enable Mail messages to customer for SOLR (suite_status_solr) |
| $global:HC_Customer_MSTeams_SOLR_State | $false | Enable MS Teams messages to customer for SOLR (suite_status_solr) |
| $global:HC_Customer_Slack_Firewall_State | $false | Enable Slack messages to customer for Firewall (platform_details_fw) |
| $global:HC_Customer_Mail_Firewall_State | $true | Enable Mail messages to customer for Firewall (platform_details_fw) |
| $global:HC_Customer_MSTeams_Firewall_State | $false | Enable MS Teams messages to customer for Firewall (platform_details_fw) |
| $global:HC_Customer_Slack_Java_Log4J_Check_State | $false | Enable Slack messages to customer for Java_Log4J_Check (hc_platform_details_java_log_version) |
| $global:HC_Customer_Mail_Java_Log4J_Check_State | $true | Enable Mail messages to customer for Java_Log4J_Check (hc_platform_details_java_log_version) |
| $global:HC_Customer_MSTeams_Java_Log4J_Check_State | $false | Enable MS Teams messages to customer for Java_Log4J_Check (hc_platform_details_java_log_version) |
| $global:HC_Customer_Slack_PB_Config_Check_State | $false | Enable Slack messages to customer for Playbook config check (hc_suite_status_pb_config_check) |
| $global:HC_Customer_Mail_PB_Config_Check_State | $true | Enable Mail messages to customer for Playbook config check (hc_suite_status_pb_config_check) |
| $global:HC_Customer_MSTeams_PB_Config_Check_State | $false | Enable MS Teams messages to customer for Playbook config check (hc_suite_status_pb_config_check) |
| $global:HC_Customer_Slack_IIS_VD_State | $false | Enable Slack messages to customer for IIS_VD (platform_details_IIS_VD) |
| $global:HC_Customer_Mail_IIS_VD_State | $true | Enable Mail messages to customer for IIS_VD (platform_details_IIS_VD) |
| $global:HC_Customer_MSTeams_IIS_VD_State | $false | Enable MS Teams messages to Customer for IIS_VD (platform_details_IIS_VD) |
| $global:HC_Customer_Slack_SSO_State | $false | Enable Slack messages to Customer Support for SSO (hc_suite_details_config) |
| $global:HC_Customer_Mail_SSO_State | $true | Enable Mail messages to Customer Support for SSO (hc_suite_details_config) |
| $global:HC_Customer_MSTeams_SSO_State | $false | Enable MS Teams messages to Customer Support for SSO (hc_suite_details_config) |
| $global:HC_Customer_Slack_MOS_Response_Time_State | $false | Enable Slack messages to customer for MOS_Response_Time (hc_suite_status_mos_response_rate) |
| $global:HC_Customer_Mail_MOS_Response_Time_State | $true | Enable Mail messages to customer for MOS_Response_Time (hc_suite_status_mos_response_rate) |
| $global:HC_Customer_MSTeams_MOS_Response_Time_State | $false | Enable MS Teams messages to customer for MOS_Response_Time (hc_suite_status_mos_response_rate) |