Health Checks

Note

For Azure Terraform deployments, health checks are automatically configured and enabled.

Overview

Health checks are diagnostic tools that monitor the readiness of your XMPro services. They evaluate various aspects of system health including:

• XMPro service availability
• Database connectivity
• Redis Cache status (when configured)

Health checks are always enabled in all XMPro products.

Health Endpoints

Each XMPro application exposes health check endpoints:

Application	Endpoint	Description
Application Designer (AD)	/health	JSON health status
Application Designer (AD)	/health/ping	Liveness probe (returns pong)
Data Stream Designer (DS)	/health	JSON health status
Data Stream Designer (DS)	/health/ping	Liveness probe (returns pong)
Subscription Manager (SM)	/health	JSON health status
Subscription Manager (SM)	/health/ping	Liveness probe (returns pong)
XMPro AI	/health	JSON health status
XMPro AI	/health/ping	Liveness probe (returns pong)

The /health endpoint returns JSON with detailed status information:

{
  "status": "Healthy",
  "totalDuration": "00:00:00.0123456",
  "entries": {
    "database": {
      "data": {},
      "description": null,
      "duration": "00:00:00.0050000",
      "status": "Healthy",
      "tags": ["database"]
    }
  }
}

The /health/ping endpoint returns the plain text string pong and is suitable for use as a liveness probe (e.g. Azure App Service health check).

Tip

Because health endpoints are polled frequently, /health and /health/ping are excluded from OpenTelemetry trace spans by default, along with /version. Requests to them still appear in request metrics. See Excluding Paths From Traces.

---

Last modified: September 28, 2026