Health.md

Health Page

The health page shows information about the current machine running the service, including CPU and memory usage of the application. It also lists out all the loaded assemblies and their version. To access the page, navigate to hostname/health (note there is no version).

The health page can be used to quickly diagnose if the service is running and also to help identify problems where routes aren't being picked up, as it shows the loaded assemblies.

Note By default the health page is only provided in Development environments.

Enabling The Health Page

By default, the health page is enabled for Development environments only, as it contains information about the machine running the service. If you want to change this behaviour then you can set this option in the appsettings.json (or the appsettings.Environment.json file to enable it for specific environments only):

{
  "hostingOptions": {
    "DisplayHealth": true
  }
}