Coder Social home page Coder Social logo

apihealthcheck's Introduction

API health check

CI CD Docker Image Version (latest by date)

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

apihealthcheck's People

Contributors

arnab-developer avatar arnabcog avatar

Stargazers

 avatar

Watchers

 avatar  avatar

apihealthcheck's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.