Skip to content

Health checks

Overview

The Health service allows you to:

  • Define web services that XPKit should check on a regular basis for uptime
  • Define applications that should phone home (make a request to XPKit) within defined time periods

Web services

Health check service configurations are for web apps that have a publicly accessible endpoint that XPKit can call. They can be created to monitor the service for uptime and status. All the core services provided by XPKit are monitored by default.

When a service enters an error state (it does not return the expected status code specified in the configuration) an alert will be sent to the chosen distribution list.

Applications

Check in application configurations can be created that define how often an application is expected to check in (phone home) to XPKit. Once configured your app should make either a GET or POST request to the check in endpoint at regular intervals.

When an application enters an error state (it does not check in within the defined time period specified in the configuration) an alert will be sent to the chosen distribution list.

Health checks and alerts

By default XPKit provides two alert distribution lists that you can use for both of the use cases above. You will find them in XPKit Portal, called App check in and App health. They contain sample HTML templates you can use if you wish to send email alerts.