Skip to content

System Health

Purpose

System Health shows whether the parts of Clarity Transform that it depends on are working: its database, disk space, runbooks folder, licence, background jobs and data backups. Clarity runs a set of health checks and shows the result of each one as Healthy, Degraded or Unhealthy, with an overall status for the system. It also keeps a history of earlier results.

Where to find it

Select the health icon in the header. System Health is not in the sidebar.

What you see

The page header shows "Last updated: " followed by the time the checks were last loaded. Next to it are a Refresh button and an auto-refresh switch.

Tiles

Four tiles sum up the latest results:

  • the overall status: Healthy, Degraded or Unhealthy.
  • the number of checks passing, shown as "N / total". A check passes when it is Healthy.
  • the number of alerts: the checks that are Degraded or Unhealthy.
  • the total response time of the checks, in ms.

If the results can't be loaded, the overall status reads Error and the Health Checks tab shows "Failed to load health status."

Tabs

  • Health Checks: one row per check.
  • Detailed Metrics: one card per check, with the figures behind its result.
  • History: earlier check results.

Health checks

Clarity runs these checks:

Check What it reports on
Database Connectivity Whether Clarity can reach its database. The card shows the Response Time in ms.
Database Space The space used in each database file. The card shows, for each file, the used and total size in MB and the percentage used.
Disk Space Free space on a drive. The card shows the Drive and how much is Free, in GB and as a percentage.
Runbooks Folder The runbooks folder. The card shows the Path and the number of Scripts Found.
License Status The Clarity licence. The card shows the licence Status and the date it was Issued, and, where they apply, Trial Days Left and Grace Days Left.
Background Jobs The scheduled jobs on Background Jobs. The card shows Total Jobs and the number Running, and lists any jobs that are Stuck:, Failed (24h): or Overdue:.
Data Backups Clarity's data backups.

Each check also has a short description, which Clarity supplies with the result.

On the Health Checks tab, each row shows the check's status, the check, its description, how long it took in ms, the time it was last checked and any tags. Checks that are Unhealthy are listed first, then Degraded, then Healthy. If a check failed with an error, the error is shown in a red row under it.

On the Detailed Metrics tab, each card shows the check's status, its description, how long it took and the figures in the table above. The usage bars change colour as space runs low:

  • Database Space: amber from 85% used, red from 95% used.
  • Disk Space: amber from 90% used, red from 95% used.

If a check failed with an error, the card shows the error in red.

History

The History tab lists earlier health check results in a grid, newest first. The grid loads the first time you open the tab.

How to

Check the system's health now

  1. Select the health icon in the header. System Health opens and runs the checks.
  2. Read the overall status tile. If it is Degraded or Unhealthy, the alerts tile gives the number of checks that need attention.
  3. On the Health Checks tab, read the rows at the top: the checks that are Unhealthy or Degraded are listed first, with any error underneath.
  4. Select Detailed Metrics to see the figures for each check.

Refresh the results

  • Select Refresh to run the checks again straight away.
  • Turn on the auto-refresh switch to run the checks again on a timer. By default the timer is 60 seconds. Turn the switch off to stop.

Look at earlier results

  1. Open System Health.
  2. Select the History tab. The newest results are at the top.

Follow up a background jobs alert

  1. On the Detailed Metrics tab, read the Background Jobs card for the jobs listed as Stuck:, Failed (24h): or Overdue:.
  2. Go to Settings → System → Background Jobs and find the job by its name.
  3. Read its Last Run and Last Result. See Check whether a job ran successfully.