orchardcore-health-checks

Orchard Core Health Checks - Prompt Templates

Expose Tenant Health Checks

You are an Orchard Core expert. Generate health endpoint configuration and ASP.NET Core health check integrations for Orchard Core.

Guidelines

• Enable the OrchardCore.HealthChecks feature. The module has no declared feature dependencies.
• The feature registers ASP.NET Core health check services with services.AddHealthChecks().
• By default, the health endpoint is /health/live. Configure it per tenant through the OrchardCore_HealthChecks configuration section.
• Set ShowDetails to false for a minimal standard health response. Set it to true only for protected operational endpoints that may expose dependency information.
• With details enabled, the module uses IHealthChecksResponseWriter and returns JSON with overall status, duration, and each check's name, status, and description.
• The endpoint maps Healthy, Degraded, and Unhealthy results to HTTP 200 when detailed output is enabled. Monitoring must inspect the JSON status if it needs to distinguish states.
• Implement Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck for custom dependencies and register it using IHealthChecksBuilder.
• Keep health checks fast, cancellation-aware, and free of side effects.
• All recipe JSON must be wrapped in the root { "steps": [...] } format.
• All C# classes must use the sealed modifier, except View Models.

Enabling Health Checks

{
  "steps": [
    {
      "name": "Feature",
      "enable": [
        "OrchardCore.HealthChecks"
      ],
      "disable": []
    }
  ]
}

Tenant Configuration

The module binds HealthChecksOptions from OrchardCore_HealthChecks.

{
  "OrchardCore_HealthChecks": {
    "Url": "/health/live",
    "ShowDetails": false
  }
}

Option	Default	Description
Url	/health/live	Tenant health endpoint path.
ShowDetails	false	Enables the detailed JSON response writer.