✨ DevOps | Changing HealthCheck path for Web APIs

[jernejk]

Cc: @vladislav-kir @chrisschultzssw @RobJT-wq

Hi @adamcogan,

Pain

Currently, we are getting a lot of errors on Application Insights because it's doing a health check on / instead of /health. Updating the path will improve error reporting.

Suggested Solution

In az-deploy.yml run the script:

az webapp config set \
        --resource-group ${{ steps.bicep.outputs.resourceGroupName }} \
        --name ${{ steps.bicep.outputs.appServiceName }} \
        --health-check-path "/health"

Tasks

• Update the script
• Verify the health check no longer pings /

Acceptance Criteria

• Meets Definition of Done - https://github.com/SSWConsulting/SSW.Rewards.Mobile/blob/main/_docs/Definition-of-Done.md
• We no longer should get / errors from health checks

Screenshots

Figure: We have consistent errors on / endpoint due health check ping from Azure.

Thanks!

[chrisschultzssw]

You should be able to do this within the app service bicep module:
https://github.com/SSWConsulting/SSW.Rewards.Mobile/blob/main/infra/modules/webapp.bicep

e.g.:

resource app 'Microsoft.Web/sites@2022-09-01' = {
  name: appServiceName
  location: location
  tags: tags
  identity: {
  properties: {
    siteConfig: {
      healthCheckPath: '/health'
    }
  }
}

As per: https://medium.com/@mariekie/bicep-enable-azure-health-checks-on-app-services-dbc057abed35