Monitoring the health of non-web roles

Abstract

Overview of the health check endpoints of Sitecore non-web roles.

Applies to

Marketing Automation Engine, Sitecore Cortex Processing Engine, and xConnect Search Indexer.

Non-web roles exposes HTTP health check endpoints that you can configure for a variety of real-time monitoring scenarios. Sitecore uses the endpoints for having the container orchestrator check application status during deployment and for runtime liveness and readiness monitoring. Read more about the Microsoft.Extensions.Diagnostics.HealthChecks namespace.

The end points are enabled for container deployments only (Docker Compose and Kubernetes) and can only be reached from within the containers internal network. They are disabled for SIF installations and PaaS deployments, and for security reasons we recommend that you do not make them publicly available.

Liveness health check

A liveness health check shows whether a role is online and can be reached. Your container orchestrator can monitor the role's liveness at https://<role instance name>/healthz/live, which returns the following codes and messages:

Code

Message

200

Healthy

503

Unhealthy

Readiness health check

A readiness health check shows whether the role is online and has access to all critical dependencies. Your container orchestrator can monitor the role's readiness at https://<role instance name>/healthz/ready, which returns the following codes and messages:

Code

Message

200

Healthy

503

Unhealthy