Skip to main content

Health check

Bravura Security Fabric servers can only be reliable if the environment they operate in is reliable. The Health check monitor reports on issues that may hinder performance.

Health check monitor is installed and enabled when Bravura Security Fabric is installed and will periodically report the status of the following components:

  • Admin events

    The Functional.hid_healthcheck_admin_events component scans the Windows event logs for critical failures related to replication queue or the loaddb stored procedure.

  • Application crashes

    The Functional.hid_healthcheck_app_crashes component scans the Windows event logs for application crashes that have occurred within a specified amount of days.

  • Disk space - Drive C

    The Functional.hid_healthcheck_disk_space component provides an alert when the configured disk drive free space drops under the configured thresholds. Bravura Security Fabric administrators can customize this component, including adding additional drives to monitor, and the alert thresholds.

  • Health Check password conflict count

    The Functional.hid_healthcheck_pwd_conflict_count should be enabled for Bravura Privilege and runs pwdconflicts to identify existing password conflicts.

  • Long processes

    The Functional.hid_healthcheck_long_processes component checks for, and flags processes running under the Bravura Security Fabric instance directory on the server that run for longer than the configured threshold. This can be used, for example, to check for "stuck" listing agents configured with "infinite timeout" which would prevent auto discovery from proceeding and alert an administrator.

  • Services

    The Functional.hid_healthcheck_long_processes component checks for, and flags processes running under the Bravura Security Fabric instance directory on the server that run for longer than the configured threshold. This can be used, for example, to check for "stuck" listing agents configured with "infinite timeout" which would prevent Autodiscovery from proceeding and alert an administrator.

  • URL

    The Functional.hid_healthcheck_url component attempts to connect to the configured URL to check if the WebUI or some other monitored application endpoint is available.

  • User class cache validity

    The Functional.hid_healthcheck_uc_cache_validity component checks what percentage of user class caches or user class point caches have expired. Click Recalculate user class caches to recalculate all or only expired caches.

By default, Health check monitor provides generic functionality. To obtain the most from this feature, it is recommended that the various components be configured to suit your particular environment. At a minimum the following updates are recommended:

  • Add email addresses to receive email notifications

  • Add additional drives to be monitored and set the alert thresholds to suit your environment.

  • Add URLS to be monitored

See the Health check monitor configuration example for a walkthrough of the common customizations recommended.

If none of the healthcheck tasks are needed, the product administrator can disable the Windows Scheduler > Library > HID Healthcheck task and either disable the healthcheck components or uninstall them. See Components for more information on how to do this.

Dashboard

The status of the health check components are displayed on a dashboard in the Front-end module. You can view the details by expanding each individual component.

healthcheck128.png

The Health check monitor is driven through Windows Task Scheduler. The task is set to run every five minutes by default. Use the Windows Task Scheduler to modify the interval to suit your needs.

Each test is denoted by one of two statuses:

  • OK - the component is working normally.

  • Critical - an outstanding issue requires immediate attention.

Health check monitor configuration example

This example demonstrates how to edit the hid_healthcheck_configuration table to make the following changes:

  • Add product administrator email addresses

  • Add additional drives and configure threshold values to be monitored

  • Add a second url to monitor

  • Edit the processes monitored

  1. From the main menu, click Manage external data store.

  2. Click hid_healthcheck_configuration.

  3. Search for Namespace='HEALTHCHECK_DISK_SPACE'.

  4. Edit the row for the EMAILS setting and add the email address of the product administrator.

  5. Add the following new set of entries in order to have health check monitor other disk partitions. Ensure the Key value is different from the existing entries.

    Namespace

    Setting

    Key

    Value

    Description

    HEALTHCHECK_DISK_SPACE

    DESCRIPTION

    2

    Disk space - Drive D

    The description

    HEALTHCHECK_DISK_SPACE

    EMAILS

    2

    alerts@example.com

    Comma separated list of emails

    HEALTHCHECK_DISK_SPACE

    EMAIL_THRESHOLD

    2

    info

    Threshold to send emails

    HEALTHCHECK_DISK_SPACE

    EMAIL_SEND_DELAY

    2

    60

    Delay between emails in minutes

    HEALTHCHECK_DISK_SPACE

    DEVICE_ID

    2

    D:

    Device ID for drive

    HEALTHCHECK_DISK_SPACE

    MIN_SIZE

    2

    30

    Critical threshold for disk size in GB

    HEALTHCHECK_DISK_SPACE

    MIN_FREE

    2

    5

    Critical threshold for free disk space in GB

    HEALTHCHECK_DISK_SPACE

    MIN_PERCENT_FREE

    2

    10

    Critical threshold for percent free disk space

    The DEVICE_ID value on the existing entry can be edited from C: to another drive if you do not want to monitor C:.

    Best practice

    Ensure the MIN_SIZE, MIN_FREE and MIN_PERCENT_FREE values are slightly smaller than the values from the service\iddb.cfg configuration file, so that the warning email about running out of space goes out before the Database Service actually runs out of space.

  6. Search for Namespace='HEALTHCHECK_APP_CRASHES'.

  7. Edit the row for the EMAILS setting and add the email address of the product administrator.

  8. Search for Namespace='HEALTHCHECK_ADMIN_EVENTS'.

  9. Edit the row for the EMAILS setting and add the email address of the product administrator.

  10. Search for Namespace='HEALTHCHECK_URL'.

  11. Edit the row for the EMAILS setting and add the email address of the product administrator.

  12. Edit the URL setting and add all comma-delimited URLs to be monitored.

  13. Search for Namespace='HEALTHCHECK_SERVICES'.

  14. Edit the row for the EMAILS setting and add the email address of the product administrator.

  15. Search for Namespace='HEALTHCHECK_LONG_PROCESSES'.

  16. Edit the row for the EMAILS setting and add the email address of the product administrator.

  17. Edit the PROCESS_WHITELIST row to allow processes to be long-running and exclude them from monitoring

  18. Edit the PROCESS_TIMESPAN row to a value acceptable for your organization.

  19. Search for Namespace='HEALTHCHECK_PASSWORD_CONFLICT_COUNT'.

  20. Edit the row for the EMAILS setting and add the email address of the product administrator.

See also:

Components for more detailed information about components.

In this section: