# ServicePulse


ServicePulse is a web application designed to provide both administrators and developers with powerful tools for monitoring and managing systems. It offers a clear, near real-time, high-level overview of system functionality, along with common failure recovery operations such as retrying failed messages. Additionally, it provides a rich, graphical view of [detailed performance metrics](/monitoring/metrics/in-servicepulse.md), including insights into logical endpoints, physical instances, and individual message types.

For administrators, ServicePulse simplifies system oversight and is essential for generating [usage reports](/servicepulse/usage.md) to determine licensing requirements. For developers, it offers advanced debugging capabilities; including visualizations of message flows, saga state changes, and other system behaviors. Tools like message [flow diagrams](/servicepulse/flow-diagram.md) and [sequence diagrams](/servicepulse/sequence-diagram.md) make it easy to detect anomalies and incorrect behavior. Developers can also access detailed information, such as message headers and metadata, when viewing individual messages.


#### Pre-requisites

ServicePulse uses information provided by ServiceControl. To use ServicePulse, first set up [ServiceControl](/servicecontrol/index.md).
  - For failed message viewing and retries, only the base [error instance](/servicecontrol/servicecontrol-instances/index.md) is required.
  - For message flow visualisation and viewing successful messages, one or more [audit instances](/servicecontrol/audit-instances/index.md) are required.
  - For monitoring throughput and other metrics, a [monitoring instance](/servicecontrol/monitoring-instances/index.md) is required.

[ServiceControl version 6.13 and above include integrated ServicePulse](/servicecontrol/servicecontrol-instances/integrated-servicepulse.md).

#### Relationship between ServicePulse, ServiceControl, Monitoring, and Endpoints

```mermaid
graph RL
EP[Endpoint]-- Errors -->EQ
EP-- Audits -->AQ
EP-- Metrics -->MQ
EQ(Error Queue)-- Ingests -->SC
MQ(Metrics Queue)-- Ingests -->SCM
AQ(Audit Queue)-- Ingests -->SC
SC[ServiceControl]-- HTTP API ---SP
SCM[Monitoring]-- HTTP API ---SP[ServicePulse]
```

## ServicePulse views

ServicePulse provides a variety of views to help monitor and manage the health of an NServiceBus system. These views offer insights into system status, endpoint health, real-time metrics, and message processing. Each view is designed to give users actionable information to ensure smooth operation and quick resolution of issues. The following views are available in ServicePulse,

![ServicePulse](images/servicepulse-overview.png 'width=500')

See the video below to get an overview of the views available in ServicePulse.

<div style="display:block;width:100%;margin:20px auto;position:relative;height:0;padding-bottom:56.25%;border:solid 1px #ccc;"><iframe src="https://www.youtube.com/embed/OVUqOoPZEW4" allow="accelerometer; encrypted-media; gyroscope; picture-in-picture" allowfullscreen frameborder="0" style="position:absolute;top:0;left:0;width:100%;height:100%;"></iframe></div>

### Dashboard

The dashboard provides a visual overview of the current state of the monitored NServiceBus system. This includes unhealthy endpoints, failed messages and failing custom checks. It also provides information about the latest events in the system, such as detecting a new endpoint or a message processing failure.



**Learn more:**

 * [ServicePulse events](/servicepulse/event-types.md).

### Heartbeats

ServicePulse automatically detects existing endpoints' health in the system by analyzing metadata from [audited messages](/nservicebus/operations/auditing.md). By default, all detected endpoints will be listed but will not be automatically monitored.

In order to monitor an endpoint's health and activity, it is necessary to [configure it for monitoring](/servicepulse/how-to-configure-endpoints-for-monitoring.md).

**Learn more:**

 * [Managing endpoint heartbeats in ServicePulse](/monitoring/heartbeats/in-servicepulse.md).

### Monitoring

The "Monitoring" view provides a real-time overview of all logical endpoints in the system, along with various metrics. To see more details, click on an endpoint name. This opens a view showing the same metrics, broken down by message type or endpoint instance.

<div style="display:block;width:100%;margin:20px auto;position:relative;height:0;padding-bottom:56.25%;border:solid 1px #ccc;"><iframe src="https://www.youtube.com/embed/is9kF7eWkrQ" allow="accelerometer; encrypted-media; gyroscope; picture-in-picture" allowfullscreen frameborder="0" style="position:absolute;top:0;left:0;width:100%;height:100%;"></iframe></div>

**Learn more:**

 * [Explanation of metrics](/monitoring/metrics/index.md)
 * [Setup Monitoring tutorial](/tutorials/monitoring-setup/index.md)

### All messages

The "All Messages" view displays messages processed by the system within a specified timeframe. If [audit instances](/servicecontrol/audit-instances/index.md)  are not deployed, only failed messages will be shown, and the individual message view will lack detailed flow, sequence, and saga information.

**Learn more:**

 * [ Audited/Failed Message Display and Discovery](/servicepulse/all-messages.md).

### Failed messages

Failed messages are highlighted in the ServicePulse dashboard with a red icon displaying the number of failures.

The Failed Messages tab allows inspection of failed messages in more detail and to react to failures (by manually retrying or deleting messages). The messages are grouped by:

* The exception type
* The exception message
* The endpoint name
* The endpoint instance ID
* The queue address

**Learn more:**

 * [Failed Message Monitoring in ServicePulse](/servicepulse/intro-failed-messages.md)
 * [Deleted Message Management in ServicePulse](/servicepulse/intro-archived-messages.md)

### Custom checks

Endpoint health monitoring verifies that an endpoint is operational—able to receive, process, and send messages. However, in some cases, overall system functionality may depend on external factors, such as third-party web services.

ServicePulse supports the development of custom health checks using custom .NET code. Custom checks allow an endpoint to notify ServicePulse if a business-related condition is not met. If a condition is not met, ServicePulse will raise an alert.

**Learn more:**

 * [Managing custom checks in ServicePulse](/monitoring/custom-checks/in-servicepulse.md).

### Events

This dedicated events page shows all events captured within ServiceControl.

**Learn more:**

 * [ServicePulse events](/servicepulse/event-types.md).