ServicePulse is a web application aimed mainly at administrators. It gives a clear, near real-time, high-level overview of how a system is functioning.
Notifications will occur when the endpoint is down or when a message fails. Custom checks can be built to get alerts for specific scenarios. The interface supports performing common operations for failure recovery, such as retrying failed messages. In order to display and handle them in a custom way see subscribe to publicly exposed events.
ServicePulse uses information provided by ServiceControl. In order to use ServicePulse, first set up ServiceControl.
The Dashboard provides a visual overview of the current state of the monitored NServiceBus system. It informs about the latest Events in the system, such as detecting a new endpoint or a message processing failure.
ServicePulse automatically detects what endpoints exist in the system by analyzing metadata from audited messages. All detected endpoints will, by default, be listed in the Endpoints tab, but will not be automatically monitored.
In order to monitor endpoints health and activity it is necessary to configure them for monitoring.
ServicePulse informs about the failed messages by showing in the Dashboard event messages and showing a red Failed Messages icon with the number of failing messages.
The Failed Messages tab allows inspection of failed messages in more detail and to react to failures (by manually retrying or archiving messages). The messages are grouped by the exception type and the exception message to simplify group actions.
Endpoints health monitoring ensures that the endpoint is functional, meaning it can receive, process and send messages. However, in some situations the system's operation might depend on other factors, such as a 3rd party webservice.
ServicePulse allows for developing Custom and Period Checks that can verify any required condition using custom .NET code. If the specified condition cannot satisfied, ServicePulse will raise alerts.