Skip to content
2 changes: 2 additions & 0 deletions menu/menu.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1567,6 +1567,8 @@
Title: Endpoint connection settings
- Url: servicepulse/usage
Title: Measuring system usage
- Url: servicepulse/platform-health
Title: Platform Health

- Name: ServiceControl
Topics:
Expand Down
6 changes: 5 additions & 1 deletion monitoring/custom-checks/in-servicepulse.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Managing custom checks in ServicePulse
summary: ServicePulse displays custom check status, helping track endpoint issues and maintain NServiceBus health
reviewed: 2026-07-06
reviewed: 2026-09-03
redirects:
- servicepulse/intro-endpoints-custom-checks
---
Expand All @@ -27,3 +27,7 @@ Sometimes a custom check reports an easy-to-solve error; however, the custom che
Rather than waiting for the failing custom check to run again to update its status, the check can be muted. Muted custom checks have been removed from ServicePulse and will no longer contribute to the main custom checks dashboard badge.

Whenever a muted custom check is executed and reports its status to ServiceControl, it is automatically unmuted.

## System checks

Some custom checks are raised internally by ServiceControl to monitor its own health and functionality. These are referred to as "platform custom checks" and are hidden by default on the custom checks page and will instead appear as an alert in the [platform health](/servicepulse/platform-health.md) dashboard.
Binary file modified servicepulse/images/endpoint-connection-link.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added servicepulse/images/platform-health-dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added servicepulse/images/platform-health-details.png

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's weird kerning in these screenshots because I didn't have zoom at 100%, can just leave them as placeholders until we are happy.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 26 additions & 0 deletions servicepulse/platform-health.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
title: Platform Health
summary: Describes the Platform Health dashboard
component: ServicePulse
related:
- servicepulse/troubleshooting
reviewed: 2026-09-03
---

The Platform Health dashboard provides a central view of the Platform components.

![Platform Health dashboard](images/platform-health-dashboard.png)

The main screen of the Platform Health dashboard displays a list of all the Platform components along with their current versions, upgrade availability, and overall health status. Each of these can be expanded to view any alerts and some basic information about the instance configuration.

![Expanded component view with error](images/platform-health-details.png)

#### Opening a Support Case

The Open Support Case on this page allows you to quickly export a snapshot of the status of your installed Platform components before contacting support.
![Open Support Case dialog](images/platform-health-open-support.png)

Opening a Support Case from the Platform Health dashboard will assist the support team by including an up to date snapshot of the Platform instances and their details.

> [!NOTE]
> While ServicePulse does not include sensitive information such as connection strings in the snapshot, it is still recommended that you review the content for any confidential information before sending it to support.