Home → Admin Manual → System Administration → Viewing and Tracking System Health

4.1. Viewing and Tracking System Health

Updated: Jul 15 2026, 05:57 PM

The System Health page (Admin > System > System Health) System Health runs a full set of diagnostic checks against your installation and reports an overall status.

It gives administrators a single place to confirm that HelpSpot's core services and dependencies are healthy and functioning correctly, and it proactively alerts administrators when it detects a serious issue, so problems are surfaced automatically rather than requiring someone to watch the page.

Administrators can download a system health report by clicking the Download report for support button at the top of the page, which exports a .txt file that mirrors the page.

Note: System Health was introduced in HelpSpot 5.8.2. It replaces the former standalone System Information page, whose details are now shown at the bottom of this page (see System Information below).

Status Levels

Each check reports one of four statuses:

✓ (OK) – A green checkmark result means the check passed.
⚠ (Warning) – A caution triangle result means something needs attention but is not yet critical.
✗ (Critical) – A red X result means there’s a serious problem that should be addressed immediately.
ℹ (Info) – A grey info box means the result is informational; no action needed.

Check results adapt to how your installation is deployed — self-hosted versus Cloud, Windows versus Linux, and MySQL versus SQL Server — so the exact checks and remediation text you see will depend on your environment. On HelpSpot Cloud, checks managed by a self-hosting infrastructure are hidden from the page.

For Warning and Critical results, the System Health page will display a brief explanation of the issue and where/how to fix it (if applicable).

Checks

Checks are grouped by severity into three tiers.

Tier 1 – Critical Systems

Database Connection – connection status to the database.
Queue Worker – whether the queue worker is processing jobs, if any jobs are waiting, and how many jobs have yet to be processed.
Task Scheduler – whether the scheduler is running, and if not, when it was run last.
License – type and validity of your license and support contract.
Storage Permissions – whether all directories are writable, and if not, which are not writable (the specific paths are listed on the page).

Tier 2 – Mail Health

Mailbox Fetching – whether active mailboxes are polling for new mail, and if not, which are not fetching along with the time of each mailbox's last successful fetch.
Mail Delivery – whether there are failed email jobs in the last 24 hours, and if so, how many.
Rejected Emails – whether there are any rejected inbound emails in the last 24 hours, and if so, how many.

Tier 3 – System Information

This section shows key facts about your installation as informational rows, including HelpSpot version, PHP version, database, active mailbox count, and default email sending method.

As noted above, some of this information (PHP version, PHP extensions, PHP upload limits, Database Version) are specific to self-hosted (on-premise) Help Spot instances.

PHP Version (Self-Hosted) – The version of PHP installed on your server and if that PHP version is supported.
PHP Extensions Self-Hosted) – Whether required and optional extensions are installed, and if not, which are missing.
PHP Upload Limits Self-Hosted) – That post_max_size is at least upload_max_filesize.
Database Version (Self-Hosted) – Shows your database engine version and whether it is supported. On SQL Server, full-text search availability is also evaluated.
Search Index – Whether your HelpSpot mailboxes have been fully indexed for search, shown as a percentage of indexed requests.
Failed Jobs – Whether there are any failed jobs currently in the queue, and if so, how many.
Queue Depth – Whether there are any pending jobs in the queue, and if so, how many.
Error Log – If there have been any errors detected in your Help Spot instance over the last 24 hours and 7 days, and if so, how many.
Disk Space (Self-Hosted) – Available disk space.
Help Spot Version – The version of HelpSpot your cloud instance is on.
Active Mailboxes – The number of mailboxes in use.
Active Staff – The number of team members active in your organization.

Proactive Alerting

System Health displays a banner with a link to the System Health page on every admin page when it detects a critical issue that needs attention. The banner is not dismissible and clears on its own once the issue is resolved.

Additionally, administrators receive an in-app notification linking to the System Health page when critical issues are detected, followed by a resolution notification when the issue clears.

Running System Health from the Command Line

A companion CLI command runs the same set of checks:

php hs health

The command exits with a non-zero status when any check is critical, so it can be wired into your own monitoring or deployment scripts. On Windows, run the command using the PHP that ships with HelpSpot, as described in HelpSpot Command Line Tool.

Knowledge Tags

This page was: Helpful | Not Helpful

HelpSpot Command Line Tool →