/
Pulse Health Check

Pulse Health Check

Pulse Health Check

The Pulse Health Check provides a quick way to verify that all Pulse components and dependencies are operating correctly. Use it as part of regular maintenance or when troubleshooting unexpected behaviour.

Accessing the Health Check

The Pulse status and health information is available on the About page in the Pulse web client:

  1. Log in to Pulse.

  2. Click About in the left navigation menu.

  3. Click the Status tab.

What the Status Page Shows

Component

What to Check

Component

What to Check

Pulse Application Server

Version number, uptime, and JVM memory usage

Pulse Monitor

Version and connection status for each connected monitor

Pulse Opensearch

Cluster health (Green / Yellow / Red) and index count

Pulse Database

Database type (H2 / SQL Server / Postgres), size, and connection status

TM1 Instances

Active/inactive status and last successful documentation run

Opensearch Cluster Health

The Opensearch cluster health indicator uses a traffic-light system:

Status

Meaning

Status

Meaning

🟒 Green

All shards are assigned and operational

🟑 Yellow

Some replica shards are unassigned β€” data is safe but redundancy is reduced

πŸ”΄ Red

One or more primary shards are missing β€” data loss may have occurred

A Yellow status on a single-node Opensearch installation is normal and expected, since there are no nodes available to host replica shards.

Manual Health Check Steps

Run through the following checks periodically:

  1. Pulse services running β€” Open Windows Services and verify all four Pulse services are in the Running state.

  2. Web client accessible β€” Navigate to http://<PulseServer>:8099 and confirm the login page loads.

  3. TM1 instances connected β€” Go to Administration β†’ Servers and confirm all expected instances show as online.

  4. Documentation up to date β€” Check the last documentation run timestamp via Model Spotlight for each instance.

  5. Disk space β€” Verify sufficient free disk space on the Pulse installation drive and the Opensearch data drive.

  6. Log errors β€” Review pulse.log for any ERROR or WARN level entries since the last check.

  7. Alerts firing β€” Check the Pulse Alerts section for any active or recently triggered alerts.

Automated Health Alerts

Pulse can send automated alerts when system health thresholds are breached. Configure system-level alerts under Administration β†’ Alerts to notify the team when:

  • Disk space on the Pulse server falls below a threshold.

  • A TM1 instance goes offline.

  • CPU or memory on a monitored server exceeds a defined limit.

  • The Pulse database reaches a configured maximum size (controlled by MaximumPulseDiskSpaceGB in Pulse.cfg).