LEGACY - Configuring PanelCheck

Version: Identity Panel Windows Service (Panel Service) 3.3.10 and newer

The Panel Check capability of PanelTool.exe is used to monitor the health and operational status of Identity Panel itself. Panel Check has modes for monitoring Both Panel Tools and web server application roles.

Panel Check should be scheduled to run by Task Scheduler every 15 minutes on every server with Identity Panel components installed.

Before configuring PanelCheck:

1. Download and install Panel Tools
2. Run Panel Tools and validate connectivity to web application

The default Panel Tools config.json file contains sample Panel Check configuration sections for the web server role and the Panel Tools role. These are identified by the keys "_comment_Test_WebServer" and "_comment_Test_Client". Settings should only be copied from a config file representing the installed version. Before copying settings, check if there is a config_x.x.x.xxx.json with a version number matching the current version. If so, use the model section from that file.

Setting Up PanelCheck

Use the guide to settings below to setup Panel Check for either the Client role, the Web role, or both. Leave TryResolve false for now.

After setting up the configuration run

PanelTool.exe --panelcheck

If the results look as expected without error messages set TryResolve to true. Save and re-run the command.

Once the settings are validated create an activity in Task Scheduler to run PanelTool with the --panelcheck argument every 15 minutes.

PanelCheck Configuration

All Panel Check settings are in the "PanelCheck" section of config.json.

Panel Check has the following settings:

• TryResolve – Whether Panel check should try to fix issues identified. This should be changed to true after initial interactive validation (see below)
• PingInterval – By default Panel Check will email SoftwareIDM the current installed version once per week. This acts a per-server validation of installation health and version. If you set this value to "" or remove it, version pings will be disabled.
• SendErrorTo – PanelCheck will copy this email address with information about failed panel check tests
• MongoDB and MongoConnectionString – These values give database connectivity information for Identity Panel. The default settings are correct unless you have customized your web environment post installation.
• StepsWait – This indicates the amount of time Identity Panel can go without starting schedule steps before it is considered an error state.
• SMTP – Panel Check must have SMTP settings configured in order to send notifications regarding identified issues. These settings are recorded independently from Identity Panel SMTP settings because Panel Check does not assume that the web application will be accessible.
• Test – This section lists the validations performed by Panel Check (see below) 

Tests

Tests may be enabled or disabled on a per-probe basis by setting the probe name to true or false. Suggested lists are modeled in the config.json file.

• DB – Checks SoftwareIDM Identity Panel Database service is running and attempts to connect. Resolution is to start the service.
• SearchIndex – Checks that SoftwareIDM.Elastic service is running. Resolution is to start the service.
• MaintenanceService – Checks that SoftwareIDM Web Maintenance service is running. Resolution is to start the service
• PanelService – Checks that SoftwareIDM Panel Service is running. Resolution is to start the service.
• PanelHost – Checks that the Identity Panel web application can be accessed at the URL specified in the Application section. There is no resolution associated, only a notification.
• StepsExecuting – Checks that run history records exist with a start time within the range specified by StepsWait. Resolution is to purge schedule execution state. This probe should be left disabled unless schedule stability has been an issue. Instead schedule execution state may be probed by an Identity Panel health check.
• ScheduleService – Checks that schedule sub-service in Panel Service is continuing to poll the web application.