Update readme and rabbitmq

minhduc140583 · minhduc140583 · commit 9b41918e8fe5 · 2024-07-27T19:56:54.000+07:00
diff --git a/README.md b/README.md
@@ -55,10 +55,10 @@ A health check in microservices is a mechanism that ensures each service is func
 ## Implementation of [core-go/health](https://github.com/core-go/health)
 #### Core Library
 - <b>Purpose</b>: Provides basic health check functionalities
-- <b>Features:
+- <b>Features</b>:
   - Define standard health check interfaces.
     - Model [Health](https://github.com/core-go/health/blob/main/health.go)
-      ```json
+      ```go
       package health
 
       type Health struct {
@@ -67,8 +67,9 @@ A health check in microservices is a mechanism that ensures each service is func
         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):
-    ```json
+    ```go
     package health
 
     import "context"
@@ -79,8 +80,9 @@ A health check in microservices is a mechanism that ensures each service is func
       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)) 
+    - 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)
@@ -101,44 +103,38 @@ A health check in microservices is a mechanism that ensures each service is func
 - <b>Features</b>:
   - Check connectivity to cache servers (Redis, Memcached).
     - Redis: support [go-redis/redis](https://github.com/core-go/health/blob/main/redis/v9/health_checker.go) and [garyburd/redigo](https://github.com/core-go/health/blob/main/redigo/health_checker.go). The sample is at [go-admin](https://github.com/project-samples/go-admin).
-      - nodejs library for Redis is at [redis-plus](https://www.npmjs.com/package/redis-plus) 
   - Validate cache hit/miss ratio and performance metrics.
 
-#### Database Health Check Library
+#### Database Health Check Libraries
 - <b>Purpose</b>: Monitors the health of database connections
 - <b>Features</b>:
   - 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).
-      - nodejs library for My SQL is at [mysql2-core](https://www.npmjs.com/package/mysql2-core). The sample is at [sql-modular-sample](https://github.com/source-code-template/sql-modular-sample).
-      - nodejs library for Oracle is at [oracle-core](https://www.npmjs.com/package/oracle-core).
-      - nodejs library for Postgres is at [pg-extension](https://www.npmjs.com/package/pg-extension).
-      - nodejs library for MS SQL is at [mssql-core](https://www.npmjs.com/package/mssql-core).
     - [mongo](https://github.com/core-go/health/blob/main/mongo/health_checker.go). The sample is at [go-mongo-sample](https://github.com/go-tutorials/go-mongo-sample).
-      - nodejs library for mongo is at [mongodb-extension](https://www.npmjs.com/package/mongodb-extension). The sample is at [mongo-modular-sample](https://github.com/source-code-template/mongo-modular-sample). 
     - [dynamodb](https://github.com/core-go/health/blob/main/dynamodb/health_checker.go). 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). 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). 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). 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). 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 Library
+#### Message Queue Health Check Libraries
 - <b>Purpose</b>: Ensures message queues are operational.
 - <b>Features</b>:
   - Check connectivity and queue depth for different message brokers.
     - [Amazon SQS](https://github.com/core-go/health/blob/main/sqs/health_checker.go). 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). The sample is at [go-pubsub-sample](https://github.com/project-samples/go-pubsub-sample).
-      - health check for nodejs is at [google-pubsub](https://www.npmjs.com/package/google-pubsub). The sample is at [pubsub-sample](https://github.com/typescript-tutorial/pubsub-sample). 
+      - health check for nodejs is at [google-pubsub](https://www.npmjs.com/package/google-pubsub). The sample is at [pubsub-sample](https://github.com/typescript-tutorial/pubsub-sample).
     - [Kafka](https://github.com/core-go/health/blob/main/kafka/health_checker.go). The sample is at [go-kafka-sample](https://github.com/project-samples/go-kafka-sample).
-      - health check for nodejs is at [kafka-plus](https://www.npmjs.com/package/kafka-plus). The sample is at [kafka-sample](https://github.com/typescript-tutorial/kafka-sample). 
+      - health check for nodejs is at [kafka-plus](https://www.npmjs.com/package/kafka-plus). The sample is at [kafka-sample](https://github.com/typescript-tutorial/kafka-sample).
     - [NATS](https://github.com/core-go/health/blob/main/nats/health_checker.go). The sample is at [go-nats-sample](https://github.com/project-samples/go-nats-sample).
-      - health check for nodejs is at [NATS](https://www.npmjs.com/package/nats-plus). The sample is at [nats-sample](https://github.com/typescript-tutorial/nats-sample) 
+      - health check for nodejs is at [NATS](https://www.npmjs.com/package/nats-plus). The sample is at [nats-sample](https://github.com/typescript-tutorial/nats-sample)
     - [Active MQ](https://github.com/core-go/health/blob/main/activemq/health_checker.go). The sample is at [go-active-mq-sample](https://github.com/project-samples/go-active-mq-sample).
-      - health check for nodejs is at [activemq](https://www.npmjs.com/package/activemq). The sample is at [activemq-sample](https://github.com/typescript-tutorial/activemq-sample) 
+      - health check for nodejs is at [activemq](https://www.npmjs.com/package/activemq). The sample is at [activemq-sample](https://github.com/typescript-tutorial/activemq-sample)
     - [RabbitMQ](https://github.com/core-go/health/blob/main/rabbitmq/health_checker.go). The sample is at [go-rabbit-mq-sample](https://github.com/project-samples/go-rabbit-mq-sample).
       - health check for nodejs is at [rabbitmq-ext](https://www.npmjs.com/package/rabbitmq-ext). The sample is at [rabbitmq-sample](https://github.com/typescript-tutorial/rabbitmq-sample)
     - [IBM MQ](https://github.com/core-go/health/blob/main/ibmmq/health_checker.go). The sample is at [go-ibm-mq-sample](https://github.com/project-samples/go-ibm-mq-sample).
-      - health check for nodejs is at [ibmmq-plus](https://www.npmjs.com/package/ibmmq-plus). The sample is at [ibmmq-sample](https://github.com/typescript-tutorial/ibmmq-sample). 
+      - health check for nodejs is at [ibmmq-plus](https://www.npmjs.com/package/ibmmq-plus). The sample is at [ibmmq-sample](https://github.com/typescript-tutorial/ibmmq-sample).
   - Monitor message lag and processing time (Not yet implemented)
 
 ### Future Libraries to develop
@@ -163,7 +159,39 @@ A health check in microservices is a mechanism that ensures each service is func
   - [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  is at [go-sql-gin-sample](https://github.com/go-tutorials/go-sql-gin-sample).
-    - 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).  
+
+### 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 wrap and simplify [redis](https://www.npmjs.com/package/redis).
+- Mongo: [mongodb-extension](https://www.npmjs.com/package/mongodb-extension), to wrap and simplify [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 wrap and simplify [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 wrap and simplify [oracledb](https://www.npmjs.com/package/oracledb).
+- Postgres: [pg-extension](https://www.npmjs.com/package/pg-extension), to wrap and simplify [pg](https://www.npmjs.com/package/pg).
+- MS SQL: [mssql-core](https://www.npmjs.com/package/mssql-core), to wrap and simplify [mssql](https://www.npmjs.com/package/mssql).
+- SQLite: [sqlite3-core](https://www.npmjs.com/package/sqlite3-core) to wrap and simplify [sqlite3](https://www.npmjs.com/package/sqlite3).
+
+#### Message Queue Health Check Libraries
+- Kafka: [kafka-plus](https://www.npmjs.com/package/kafka-plus), to wrap and simplify [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 wrap and simplify [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 wrap and simplify [@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 wrap and simplify [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 wrap and simplify [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 wrap and simplify [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:
diff --git a/http/health_checker.go b/http/health_checker.go
@@ -4,7 +4,6 @@ import (
 	"context"
 	"fmt"
 	"io"
-	"io/ioutil"
 	"net"
 	"net/http"
 	"time"
@@ -43,7 +42,7 @@ func (s *HealthChecker) Check(ctx context.Context) (map[string]interface{}, erro
 	} else if err != nil {
 		return res, err
 	}
-	_, _ = io.Copy(ioutil.Discard, resp.Body)
+	_, _ = io.Copy(io.Discard, resp.Body)
 	_ = resp.Body.Close()
 	if resp.StatusCode >= 500 {
 		return res, fmt.Errorf("status code is: %d", resp.StatusCode)
@@ -56,7 +55,7 @@ func (s *HealthChecker) Build(ctx context.Context, data map[string]interface{},
 		return data
 	}
 	if data == nil {
-		data = make(map[string]interface{}, 0)
+		data = make(map[string]interface{})
 	}
 	data["error"] = err.Error()
 	return data
diff --git a/rabbitmq/channel.go b/rabbitmq/channel.go
@@ -1,8 +1,9 @@
 package rabbitmq
 
 import (
-	"github.com/streadway/amqp"
 	"time"
+
+	amqp "github.com/rabbitmq/amqp091-go"
 )
 
 func NewChannel(url string) (*amqp.Channel, error) {
@@ -24,4 +25,3 @@ func NewChannelWithTimeOut(url string, timeout time.Duration) (*amqp.Channel, er
 	}
 	return conn.Channel()
 }
-

Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,9 @@`
`1`	`1`	`package rabbitmq`
`2`	`2`
`3`	`3`	`import (`
`4`		`- "github.com/streadway/amqp"`
`5`	`4`	`"time"`
	`5`	`+`
	`6`	`+ amqp "github.com/rabbitmq/amqp091-go"`
`6`	`7`	`)`
`7`	`8`
`8`	`9`	`func NewChannel(url string) (*amqp.Channel, error) {`
`@@ -24,4 +25,3 @@ func NewChannelWithTimeOut(url string, timeout time.Duration) (*amqp.Channel, er`
`24`	`25`	`}`
`25`	`26`	`return conn.Channel()`
`26`	`27`	`}`
`27`		`-`