Monitoring the health of web roles
|
Applies to |
Content Delivery, Content Management, EXM Dispatch, xDB Processing, Marketing Automation Operations service, Marketing Automation Reporting service, Reference Data service, Sitecore Cortex Processing service, Sitecore Cortex Reporting service, xConnect Collection service, and xConnect Collection Search service. |
|---|
You can monitor the availability of Sitecore roles using endpoints. This is called a health check, and the endpoints use HTTP status codes and text messages to reveal whether the roles are healthy or if they are having problems. Read more about the Microsoft.Extensions.Diagnostics.HealthChecks namespace.
For security reasons, we recommend that you do not make health check end points publicly available.
Liveness health check
A liveness health check shows whether a role is online and can be reached. You or your management software 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 you whether the role is online and has access to all critical dependencies. You or your management software 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 |