Configuring health checks for managed systems

Health checks are used to monitor the availability, connectivity, and overall operational status of managed systems, helping to ensure that integrations function reliably and that issues are detected early. By properly configuring health checks and receiving notifications when a managed system is up or down, administrators can proactively identify problems, reduce downtime, and maintain stable communication between OpenIAM and connected systems.

To enable connector health checks, log in to webconsole and navigate to Administration > System configuration > System tab. Scroll down to the Connector status notification group.

Select the required group (the group System Notifications is used in the example below) and click Save.

With this configuration, when any managed system goes up or down, all users in the selected group will receive an email notification based on the corresponding email template.

You can select the email template to be used in webconsole > Administration > Mail template editor, choosing MNG_SYS_CONNECTION_ERROR or MNG_SYS_CONNECTION_SUCCESS as appropriate. The template content is provided below.

MNG_SYS_CONNECTION_ERROR

<h3 style='color: green;'>Healthcheck</h3> 
An uptime check on ${req?.getNotificationParam(‘MANAGED_SYSTEM’)?.valueObj?.name}
(Uptime Check URL labels: ${req?.getNotificationParam(‘HOST_URL’)?.valueObj}) is failing.

Summary
Target system URL: ${req?.getNotificationParam(‘MANAGED_SYSTEM’)?.valueObj?.hostUrl}
Port: ${req?.getNotificationParam(‘MANAGED_SYSTEM’)?.valueObj?.port}

Start time
${req?.getNotificationParam(‘DATE’)?.valueObj}

Condition
Healthcheck

Observed
${req?.getNotificationParam(‘MANAGED_SYSTEM_ERROR’)?.valueObj}

MNG_SYS_CONNECTION_SUCCESS

An uptime check on ${req?.getNotificationParam(‘MANAGED_SYSTEM’)?.valueObj?.name}
(Uptime Check URL labels: ${req?.getNotificationParam(‘HOST_URL’)?.valueObj}) has returned to a normal state.

Summary
Target system URL: ${req?.getNotificationParam(‘MANAGED_SYSTEM’)?.valueObj?.hostUrl}
Port: ${req?.getNotificationParam(‘MANAGED_SYSTEM’)?.valueObj?.port}

Start time
${req?.getNotificationParam(‘DATE’)?.valueObj}

Condition
Healthcheck