Giter VIP home page Giter VIP logo

healthcheck-aggregator-ui's Introduction

Healthcheck Aggregator UI

Two simple microservices and one health check UI service have been developed to explain the approach.

Downstream Microservices

Basket and Product services represent microservices.

A simple health check service has been added to both services for proof of concept. ProcessAllocatedMemoryHealthCheck checks the process memory exceeds the threshold or not using AspNetCore.HealthChecks.System library. In this example, 100 MB has been set as a limit. If this limit is exceeded, the service will respond as unhealthy.

public void ConfigureServices(IServiceCollection services)
{
    services.AddHealthChecks()
            .AddProcessAllocatedMemoryHealthCheck(100, "Memory");
}

Let's configure the /health endpoint to return health check results as JSON.

public void Configure(IApplicationBuilder app)
{
    app.UseEndpoints(endpoints =>
    {
        endpoints.MapHealthChecks("/health", new HealthCheckOptions()
        {
            ResponseWriter = UIResponseWriter.WriteHealthCheckUIResponse
        });
    });
}

Aggregator UI

All possible parameters in the aggregator UI application are placed in the appsettings.json file. Two sections are written for configuration parameters: HealthCheck and Services. In the HealthCheck section, there are parameters for the UI.

"HealthCheck": {
    "HeaderText": "HealthCheck Aggregator UI",
    "PollingInterval": 60,
    "UIPath": "/health-ui",
    "ApiPath": "/health-api"
}
  • Header Text: header in the page
  • PollingInterval: polling interval in seconds
  • UIPath: relative path for UI
  • ApiPath: relative path for JSON response

The second section is Services that contains the information of the services to be aggregated.

"Services": [
  {
    "Name": "Basket Service",
    "Url": "http://basketservice/health"
  },
  {
    "Name": "Product Service",
    "Url": "http://productservice/health"
  }
]

How to run

A docker-compose file can be used to run demo with docker-compose up command.

The health check UI will be accessible at http://localhost:5001/health-ui

healthcheck-aggregator-ui's People

Contributors

emreteoman avatar teomane avatar

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.