orchardcore-diagnostics

Orchard Core Diagnostics

OrchardCore.Diagnostics wires tenant-aware error handling into the Orchard Core pipeline. Its startup filter uses /Error for unhandled exceptions outside development and re-executes status code responses at /Error/{status}. The module maps the Error/{status?} route to DiagnosticsController.Error.

Guidelines

• Enable the exact OrchardCore.Diagnostics feature before relying on its error route and shapes.
• In non-development environments it calls UseExceptionHandler("/Error").
• It calls UseStatusCodePagesWithReExecute("/Error/{0}") for status responses.
• Do not expose exception details in theme templates or production error pages.
• Static-file paths are excluded from status page rendering when their extension maps to a content type.
• Override error rendering through theme shapes rather than changing the module controller.
• Use IConfigureOptions for your own options registration, not to replace the diagnostic middleware order.
• Error templates must tolerate an absent status code because /Error also handles exceptions.
• All C# classes in examples are sealed except View Models.

Enable Diagnostics

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

Pipeline Behavior

The module registers DiagnosticsStartupFilter as an IStartupFilter. This ensures the error handling runs in the correct tenant pipeline without an application manually adding duplicate middleware.

Situation	Result
Unhandled exception in production	Re-executes /Error.
Response with a 4xx or 5xx status	Re-executes /Error/{status}.
Development environment exception	The exception handler is not registered by this filter.
Missing static asset	Status page rendering is disabled for known file extensions.

Avoid calling UseExceptionHandler or UseStatusCodePagesWithReExecute again for the same tenant unless you deliberately replace this behavior and have verified pipeline order.