HealthChecks UI Docker Image

HealthChecks UI

Sections

• Custom Branding
• Configure UI Paths
• Storage Providers Configuration
• Azure App Configuration Service
• Environment variables table
• Samples
• Docker Compose Sample

HealthChecks is available as a docker image on DockerHub. This image is a simple ASP.NET Core project with the HealthCheckUI middleware.

docker pull xabarilcoding/healthchecksui
docker run --name ui -p 5000:80 -d xabarilcoding/healthchecksui:latest

You can use environment variables to configure all properties on HealthChecksUI.

docker run --name ui -p 5000:80 -e 'HealthChecksUI:HealthChecks:0:Name=httpBasic' -e 'HealthChecksUI:HealthChecks:0:Uri=http://the-healthchecks-server-path' -d xabarilcoding/healthchecksui:latest

Custom Branding

Since version 3.0.3 you can use an environment variable and a volume to configure your own css stylesheet and display your own branding within the UI:

docker run -v /c/temp/css:/app/css -e ui_stylesheet=/app/css/dotnet.css -p 5000:80 xabarilcoding/healthchecksui:latest

Configure UI paths (UI path, Api path and resources path)

Since version 3.0.3 you can use environment variables to configure the different paths where resources are served.

The environment variables are:

• ui_path to configure the frontend spa segment
• ui_api_path to configure the path where the api middleware will be served
• ui_webhooks_path to configure the path where the webhooks middleware will be served
• ui_resources_path to configure the path where static files will be served
• ui_no_relative_paths to disable relative paths in the ui frontend resources

docker run -e ui_path=/healthchecks-e ui_resources_path=/static -e ui_api_path=/health-api -p 5000:80 xabarilcoding/healthchecksui:latest

Storage Providers Configuration

Since version 3.1.1 we do support different configuration providers. There are two environment variables related with this feature: storage_provider and storage_connection

Azure App Configuration Service

Since version 2.2.32, our docker image supports configuration by using Azure App Configuration service.

Configuring a large amount of healthchecks and webhooks will require to pass a lot of environment variables or mounting a volume so Asp.Net Core configuration providers can find a settings file containing the HealthChecks config section.

By using Azure App Configuration service you can centralize HealthChecks configuration in Azure and bind it directly to the executing container at ease.

You should use environment variables to configure Azure App Configuration Service (AAC from now for brevity) in the UI docker image.

Environment variables table

The existing environment variables are explained below:

Environment Variable	Description	Notes
storage_provider	Configures an storage provider. Available options are SqlServer, Sqlite, PostgreSql, MySql and InMemory	InMemory by default
storage_connection	Configured the connection string for the selected provider	Not set by default
ui_path	Configures the frontend spa segment	/healthchecks-ui
ui_api_path	Configures the path where api middleware will be served	/healthchecks-api
ui_webhooks_path	Configures the path where webhooksm middleware will be served	/healthchecks-webhooks
ui_resources_path	Configures the path where static files will be served	/ui/resources
ui_no_relative_paths	Disables relative paths for UI frontend resources	false
AAC_Enabled	Enables AAC config provider	Not set by default
AAC_ConnectionString	Connection string to configuration service	If set, Managed Service Identity won't be used
AAC_ManagedIdentityEndpoint	Your AAC endpoint to connect using Managed Identity	Sample: https://your-endpoint.azconfig.io
AAC_Label	Filter configuration keys containing this label	Sample: HealthChecksConfig
AAC_CacheExpiration	Cache expiration time before a refresh operation is triggered	Sample: 60, default: 30

As table explains, if AAC_ConnectionString is set, the image will connect to AAC using that connection string. If you want to connect using managed identity service only specify AAC_ManagedIdentityEndpoint environment variable.

Samples

• Creating an Azure Container instance using a connection string:

az container create --resource-group group-name --name container-name -e 'AAC_Enabled=true' 'AAC_Label=HealthChecksConfig' 'AAC_ConnectionString=Endpoint={your_connectionstring}' --image xabarilcoding/healthchecksui:latest --dns-name-label dns-checks --ports 80

• Creating an Azure Container instance using managed service identity:

az container create --resource-group group-name  --name container-name -e 'AAC_Enabled=true' 'AAC_Label=HealthChecksConfig' 'AAC_ManagedIdentityEndpoint=https://your-endpoint.azconfig.io' --image xabarilcoding/healthchecksui:latest  --dns-name-label dns-checks-msi --ports 80 --assign-identity

Read the DockerHub full description to get more information about HealthChecksUI docker configuration.

Sample Docker Compose

version: "3.7"
services:
  healthchecks:
    image: xabarilcoding/healthchecksui
    depends_on:
      sqlserver:
        condition: service_healthy
    environment:
      - storage_provider=SqlServer
      - storage_connection=Server=sqlserver,1433;User Id=sa;Password=Password12!;Initial Catalog=DockerUI
      - Logging:LogLevel:Default=Debug
      - Logging:Loglevel:Microsoft=Warning
      - Logging:LogLevel:HealthChecks=Debug
    ports:
      - 5000:80
    volumes:
      - config:/config
  sqlserver:
    image: mcr.microsoft.com/mssql/server
    environment:
      - ACCEPT_EULA=Y
      - SA_PASSWORD=Password12!
    ports:
      - 1433:1433
    healthcheck:
      test: /opt/mssql-tools/bin/sqlcmd -S localhost -U sa -P "$$SA_PASSWORD" -Q "SELECT 1" || exit 1
      interval: 10s
      timeout: 3s
      retries: 10
      start_period: 10s
volumes:
  config: