https://github.com/core-go/health

health health-check health-monitor health-monitoring
Last synced: 2 months ago
JSON representation
Host: GitHub
URL: https://github.com/core-go/health
Owner: core-go
Created: 2020-04-03T02:11:34.000Z (about 5 years ago)
Default Branch: main
Last Pushed: 2024-09-14T09:55:23.000Z (10 months ago)
Last Synced: 2025-04-05T12:33:08.606Z (3 months ago)
Topics: health, health-check, health-monitor, health-monitoring
Language: Go
Homepage:
Size: 68.4 KB
Stars: 3
Watchers: 0
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
Awesome Lists containing this project

README

        # Health Check in Microservices

### Health Check Definition

A health check in microservices is a mechanism that ensures each service is functioning correctly and is available. It typically involves periodically checking the status of various components of a service and reporting their health.

- You can refer to [Microservice Health Check](https://www.linkedin.com/pulse/microservice-health-check-go-nodejs-duc-nguyen-qunvc) at my [Linked In](https://vn.linkedin.com/in/duc-nguyen-437240239?trk=article-ssr-frontend-pulse_publisher-author-card) for more details.

![health](https://cdn-images-1.medium.com/max/800/1*NreJfea6tHobxMpiq96PPQ.png)

### Use Cases of Health Check

#### Service Availability Monitoring:

- Scenario: Ensuring that each microservice is up and running.

- Benefit: Helps in quickly identifying and addressing service outages.

#### Dependency Checking

- Scenario: Verifying that all dependencies of a service are available and functioning.

- Benefit: Ensures the entire application stack is healthy and operational.

#### Deployment Validation

- Scenario: Checking the health of services post-deployment to ensure they are functioning as expected.

- Benefit: Detects deployment issues early, preventing faulty services from affecting the system.

#### Load Balancing

- Scenario: Directing traffic only to healthy instances of a service.

- Benefit: Ensures reliable service delivery by avoiding unhealthy instances.

#### Auto-scaling

- Scenario: Scaling up or down based on the health and load of the services.

- Benefit: Optimizes resource usage and cost efficiency.

### Implementation

#### Tools

- Spring Boot Actuator, AWS Elastic Load Balancer, Kubernetes liveness and readiness probes

#### Endpoints:

- Health check endpoints (e.g., /health, /status) that return the health status of the service.

#### API Design:

- Request: GET /health

- Response:

  ```json

  {

    "status": "DOWN",

    "details": {

      "sql": {

        "status": "DOWN",

        "data": {

          "error": "pq: database 'demo' does not exist"

        }

      },

      "firestore": {

        "status": "UP"

      },

      "kafka": {

        "status": "UP"

      }

    }

  }

  ```

#### Health Status

- UP: Indicates that the application is functioning normally and all health checks have passed.

- DOWN: Indicates that the application is experiencing issues, and one or more health checks have failed.

## Implementation of [core-go/health](https://github.com/core-go/health)

#### Core Library

- Purpose: Provides basic health check functionalities

- Features:

  - Define standard health check interfaces.

    - Model [Health](https://github.com/core-go/health/blob/main/health.go)

      ```go

      package health

      type Health struct {

        Status  string                 `json:"status,omitempty"`

        Data    map[string]interface{} `json:"data,omitempty"`

        Details map[string]Health      `json:"details,omitempty"`

      }

      ```

  - Allow custom health checks with this standard interface [Checker](https://github.com/core-go/health/blob/main/checker.go):

```go

package health

import "context"

type Checker interface {

  Name() string

  Check(ctx context.Context) (map[string]interface{}, error)

  Build(ctx context.Context, data map[string]interface{}, err error) map[string]interface{}

}

```

  - Build the response JSON from many custom health checks by this GO function [Check](https://github.com/core-go/health/blob/main/check.go)

    - This function can be called by http handler ([gin](https://github.com/gin-gonic/gin), [echo](https://github.com/labstack/echo), [mux](https://github.com/gorilla/mux), [go-chi](https://github.com/go-chi/chi))

  - Implement basic checks

    - CPU, memory, disk space: not yet implemented.

    - Cache (Redis, Memcached)

    - Databases: [sql](https://github.com/core-go/health/blob/main/sql/health_checker.go), [mongo](https://github.com/core-go/health/blob/main/mongo/health_checker.go), [dynamodb](https://github.com/core-go/health/blob/main/dynamodb/health_checker.go), [firestore](https://github.com/core-go/health/blob/main/firestore/health_checker.go), [elasticsearch](https://github.com/core-go/health/blob/main/elasticsearch/v8/health_checker.go), [cassandra](https://github.com/core-go/health/blob/main/cassandra/health_checker.go), [hive](https://github.com/core-go/health/blob/main/hive/health_checker.go)

    - Message Queue

    - External Service Health

  - Integration with Existing Systems, by supporting these Go libraries: [gin](https://github.com/gin-gonic/gin), [echo](https://github.com/labstack/echo), [mux](https://github.com/gorilla/mux), [go-chi](https://github.com/go-chi/chi)

#### External Service Health Check Library

- Purpose: Monitors the availability of external services.

- Features:

  - Check HTTP/HTTPS endpoints for expected responses.

    - [http client](https://github.com/core-go/health/blob/main/http/health_checker.go). The sample is at [go-sql-hexagonal-architecture-sample](https://github.com/go-tutorials/go-sql-hexagonal-architecture-sample).

  - Measure response time and reliability.

#### Cache Health Check Library

- Purpose: Verifies the status of cache services.

- Features:

  - Check connectivity to cache servers (Redis, Memcached).

    - Redis:

      - [go-redis/redis](https://github.com/core-go/health/blob/main/redis/v9/health_checker.go) to support [redis/go-redis](https://github.com/redis/go-redis). The sample is at [go-admin](https://github.com/project-samples/go-admin).

      - [garyburd/redigo](https://github.com/core-go/health/blob/main/redigo/health_checker.go) to support [gomodule/redigo](https://github.com/gomodule/redigo).

  - Validate cache hit/miss ratio and performance metrics.

#### Database Health Check Libraries

- Purpose: Monitors the health of database connections

- Features:

  - Check connectivity and response time for various databases (SQL, NoSQL).

    - [sql](https://github.com/core-go/health/blob/main/sql/health_checker.go). The sample is at [go-sql-sample](https://github.com/go-tutorials/go-sql-sample).

    - [mongo](https://github.com/core-go/health/blob/main/mongo/health_checker.go) to support [mongo-driver/mongo](https://pkg.go.dev/go.mongodb.org/mongo-driver/mongo). The sample is at [go-mongo-sample](https://github.com/go-tutorials/go-mongo-sample).

    - [dynamodb](https://github.com/core-go/health/blob/main/dynamodb/health_checker.go) to support [aws/aws-sdk-go/service/dynamodb](https://github.com/aws/aws-sdk-go/tree/main/service/dynamodb). The sample is at [go-dynamodb-tutorial](https://github.com/go-tutorials/go-dynamodb-tutorial).

    - [firestore](https://github.com/core-go/health/blob/main/firestore/health_checker.go) to support [go/firestore](https://pkg.go.dev/cloud.google.com/go/firestore). The sample is at [go-firestore-sample](https://github.com/go-tutorials/go-firestore-sample).

    - [elasticsearch](https://github.com/core-go/health/blob/main/elasticsearch/v8/health_checker.go) to support [elastic/go-elasticsearch](https://github.com/elastic/go-elasticsearch). The sample is at [go-elasticsearch-sample](https://github.com/go-tutorials/go-elasticsearch-sample).

    - [cassandra](https://github.com/core-go/health/blob/main/cassandra/health_checker.go) to support [apache/cassandra-gocql-driver](https://github.com/apache/cassandra-gocql-driver). The sample is at [go-cassandra-sample](https://github.com/go-tutorials/go-cassandra-sample).

    - [hive](https://github.com/core-go/health/blob/main/hive/health_checker.go) to support [beltran/gohive](https://github.com/beltran/gohive). The sample is at [go-hive-sample](https://github.com/go-tutorials/go-hive-sample).

  - Provide detailed status messages and error handling.

#### Message Queue Health Check Libraries

- Purpose: Ensures message queues are operational.

- Features:

  - Check connectivity and queue depth for different message brokers.

    - [Amazon SQS](https://github.com/core-go/health/blob/main/sqs/health_checker.go): support [aws-sdk-go/service/sqs](https://github.com/aws/aws-sdk-go/tree/main/service/sqs). The sample is at [go-amazon-sqs-sample](https://github.com/project-samples/go-amazon-sqs-sample).

    - [Google Pub/Sub](https://github.com/core-go/health/blob/main/pubsub/health_checker.go): support [go/pubsub](https://pkg.go.dev/cloud.google.com/go/pubsub). The sample is at [go-pubsub-sample](https://github.com/project-samples/go-pubsub-sample).

    - [Kafka](https://github.com/core-go/health/blob/main/kafka/health_checker.go): support 3 GO libraries: [segmentio/kafka-go](https://github.com/segmentio/kafka-go), [IBM/sarama](https://github.com/IBM/sarama) and [confluent](https://github.com/confluentinc/confluent-kafka-go). The sample is at [go-kafka-sample](https://github.com/project-samples/go-kafka-sample).

    - [NATS](https://github.com/core-go/health/blob/main/nats/health_checker.go): support [nats.go](https://github.com/nats-io/nats.go). The sample is at [go-nats-sample](https://github.com/project-samples/go-nats-sample).

    - [Active MQ](https://github.com/core-go/health/blob/main/activemq/health_checker.go): support [go-stomp](https://github.com/go-stomp/stomp). The sample is at [go-active-mq-sample](https://github.com/project-samples/go-active-mq-sample).

    - [RabbitMQ](https://github.com/core-go/health/blob/main/rabbitmq/health_checker.go): support [rabbitmq/amqp091-go](https://github.com/rabbitmq/amqp091-go). The sample is at [go-rabbit-mq-sample](https://github.com/project-samples/go-rabbit-mq-sample).

    - [IBM MQ](https://github.com/core-go/health/blob/main/ibmmq/health_checker.go): support [ibmmq](https://github.com/ibm-messaging/mq-golang). The sample is at [go-ibm-mq-sample](https://github.com/project-samples/go-ibm-mq-sample).

  - Monitor message lag and processing time (Not yet implemented)

### Future Libraries to develop

#### Cluster Health Check Library

- Purpose: Ensures the health of the microservices cluster.

- Features:

  - Check node status, CPU, and memory usage across the cluster.

  - Integrate with orchestration platforms like Kubernetes for liveness and readiness probes.

#### Metrics and Monitoring Integration Library

- Purpose: Integrates health checks with monitoring tools.

- Features:

  - Export health check results to monitoring systems (Prometheus, Grafana, ELK stack).

  - Provide detailed dashboards and alerting mechanisms.

#### Notification and Alerting Library

- Purpose: Sends alerts based on health check results.

- Features:

  - Integrate with notification systems (Slack, PagerDuty, email).

  - Provide configurable thresholds and alerting rules.

### Integration with Existing Systems

- Designed to integrate seamlessly with existing Go libraries: [Gorilla mux](https://github.com/gorilla/mux), [Go-chi](https://github.com/go-chi/chi), [Echo](https://github.com/labstack/echo) and [Gin](https://github.com/gin-gonic/gin).

  - [handler](https://github.com/core-go/health/blob/main/handler.go), to support [Gorilla mux](https://github.com/gorilla/mux) and [Go-chi](https://github.com/go-chi/chi). The sample is at [go-sql-sample](https://github.com/go-tutorials/go-sql-sample).

  - [echo handler](https://github.com/core-go/health/blob/main/echo/handler.go) to support [Echo](https://github.com/labstack/echo). The sample is at [go-sql-echo-sample](https://github.com/go-tutorials/go-sql-echo-sample).

  - [gin handler](https://github.com/core-go/health/blob/main/gin/handler.go) to support [Gin](https://github.com/gin-gonic/gin). The sample is at [go-sql-gin-sample](https://github.com/go-tutorials/go-sql-gin-sample).

### Benefits and Challenges:

#### Benefits:

- Improved Reliability: Continuous monitoring of services ensures quick detection and resolution of issues.

- Scalability: Supports growth by maintaining health across distributed systems.

- Better Resource Management: Helps optimize resource usage and prevent failures.

#### Challenges:

- Overhead: Adding health checks can introduce some performance overhead.

- Complexity: Requires careful planning and integration to avoid false positives and negatives.

- Maintenance: Health check implementations need regular updates to stay relevant and effective.

## Appendix

### Health Check for nodejs

#### Database Health Check Libraries

- Redis: [redis-plus](https://www.npmjs.com/package/redis-plus), to support [redis](https://www.npmjs.com/package/redis).

- Mongo: [mongodb-extension](https://www.npmjs.com/package/mongodb-extension), to support [mongodb](https://www.npmjs.com/package/mongodb). The sample is at [mongo-modular-sample](https://github.com/source-code-template/mongo-modular-sample).

- My SQL: [mysql2-core](https://www.npmjs.com/package/mysql2-core), to support [mysql2](https://www.npmjs.com/package/mysql2). The sample is at [sql-modular-sample](https://github.com/source-code-template/sql-modular-sample).

- Oracle: [oracle-core](https://www.npmjs.com/package/oracle-core), to support [oracledb](https://www.npmjs.com/package/oracledb).

- Postgres: [pg-extension](https://www.npmjs.com/package/pg-extension), to support [pg](https://www.npmjs.com/package/pg).

- MS SQL: [mssql-core](https://www.npmjs.com/package/mssql-core), to support [mssql](https://www.npmjs.com/package/mssql).

- SQLite: [sqlite3-core](https://www.npmjs.com/package/sqlite3-core) to support [sqlite3](https://www.npmjs.com/package/sqlite3).

#### Message Queue Health Check Libraries

- Kafka: [kafka-plus](https://www.npmjs.com/package/kafka-plus), to support [kafkajs](https://www.npmjs.com/package/kafkajs). The sample is at [kafka-sample](https://github.com/typescript-tutorial/kafka-sample).

- RabbitMQ: [rabbitmq-ext](https://www.npmjs.com/package/rabbitmq-ext), to support [amqplib](https://www.npmjs.com/package/amqplib). The sample is at [rabbitmq-sample](https://github.com/typescript-tutorial/rabbitmq-sample).

- Google Pub/Sub: [google-pubsub](https://www.npmjs.com/package/google-pubsub), to support [@google-cloud/pubsub](https://www.npmjs.com/package/@google-cloud/pubsub). The sample is at [pubsub-sample](https://github.com/typescript-tutorial/pubsub-sample)

- IBM MQ: [ibmmq-plus](https://www.npmjs.com/package/ibmmq-plus), to support [ibmmq](https://www.npmjs.com/package/ibmmq). The sample is at [ibmmq-sample](https://github.com/typescript-tutorial/ibmmq-sample).

- Active MQ: [activemq](https://www.npmjs.com/package/activemq), to support [amqplib](https://www.npmjs.com/package/amqplib). The sample is at [activemq-sample](https://github.com/typescript-tutorial/activemq-sample).

- NATS: [nats-plus](https://www.npmjs.com/package/nats-plus), to support [nats](https://www.npmjs.com/package/nats). The sample is at [nats-sample](https://github.com/typescript-tutorial/nats-sample).

#### Integration with Existing Systems

- for nodejs, we have [express-ext](https://www.npmjs.com/package/express-ext) to integrate with [express](https://www.npmjs.com/package/express). The sample is at  is at [mongo-modular-sample](https://github.com/source-code-template/mongo-modular-sample).

## Installation

Please make sure to initialize a Go module before installing core-go/health:

```shell

go get -u github.com/core-go/health

```

Import:

```go

import "github.com/core-go/health"

```
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/core-go/health

Awesome Lists containing this project

README
