README.md

API health check

This is a background task application with .NET (with DI, logging, configuration) to check API health. A small utility app to check API health in a perticular time interval. Add the details of the APIs in configuration (like appsettings) to check their health status. It uses an Azure Application Insights to log API health status.

You need Visual Studio 2022 and ASP.NET 6 to work on this project locally.

Run the app as is

This app uses some example APIs for health check. If you want to run the app as is then follow the below steps.

• Create an Azure Application Insights resource.
• Update the appsettings.json with the reference of the Application Insights.

"ApplicationInsights": {
  "Key": "",
  "LogLevel": {
    "Default": "Information",
    "Microsoft": "Error"
  }

• Build the app and create docker image.
• Store the docker image in any container registry.
• Create a Azure Container Instence with the docker image from that container registry.

You can find the health check logs in Application Insights.

Test your own APIs

If you want to test different APIs then follow the below steps.

• Update the appsettings.json with API details to check their health.

"ApiDetails": [
  {
    "Name": "Microsoft",
    "Url": "https://microsoft.com",
    "Credential": {
    "UserName": "",
    "Password": ""
    },
    "IsEnable": true
  }
]

• Create an Azure Application Insights resource.
• Update the appsettings.json with the reference of the Application Insights.

"ApplicationInsights": {
  "Key": "",
  "LogLevel": {
    "Default": "Information",
    "Microsoft": "Error"
  }

• Build the app and create docker image.
• Store the docker image in any container registry.
• Create a Azure Container Instence with the docker image from that container registry.

You can find the health check logs in Application Insights.

Docker image

This app is in a docker image and stored in dockerhub.

https://hub.docker.com/r/45862391/apihealthcheck