Merge pull request #353 from gofr-dev/development

Release v1.0.2

Author: aryanmehrotra

.github/workflows/go.yml

@@ -16,19 +16,22 @@ on:
 
 jobs:
   MIGRATION-Unit-Testing:
-    name: Migration Unit Testing🛠
+    name: Migration Unit Testing (v${{ matrix.go-version }})🛠
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        go-version: ['1.21', '1.20']
 
     steps:
       - name: Checkout code into go module directory
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
-      - name: Set up  Go 1.21
+      - name: Set up Go ${{ matrix.go-version }}
         uses: actions/setup-go@v4
         with:
-          go-version: 1.21
+          go-version: ${{ matrix.go-version }}
         id: Go
 
       - name: Get dependencies
@@ -43,14 +46,19 @@ jobs:
           go tool cover -func profile.cov
 
       - name: Upload Test Coverage
+        if: ${{ matrix.go-version == '1.21'}}
         uses: actions/upload-artifact@v3
         with:
           name: MIGRATION-Coverage-Report
           path: profile.cov
 
   Example-Unit-Testing:
-    name: Example Unit Testing🛠
+    name: Example Unit Testing (v${{ matrix.go-version }})🛠
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        go-version: ['1.21', '1.20']
+
     services:
       zookeeper:
         image: wurstmeister/zookeeper
@@ -90,10 +98,10 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: Set up  Go 1.21
+      - name: Set up Go ${{ matrix.go-version }}
         uses: actions/setup-go@v4
         with:
-          go-version: 1.21
+          go-version: ${{ matrix.go-version }}
         id: Go
 
       - name: Get dependencies
@@ -116,25 +124,29 @@ jobs:
           go tool cover -func profile.cov
 
       - name: Upload Test Coverage
+        if: ${{ matrix.go-version == '1.21'}}
         uses: actions/upload-artifact@v3
         with:
           name: Example-Test-Report
           path: profile.cov
 
   PKG-Unit-Testing:
-    name: PKG Unit Testing🛠
+    name: PKG Unit Testing (v${{ matrix.go-version }})🛠
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        go-version: ['1.21', '1.20']
 
     steps:
       - name: Checkout code into go module directory
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
-      - name: Set up  Go 1.21
+      - name: Set up Go ${{ matrix.go-version }}
         uses: actions/setup-go@v4
         with:
-          go-version: 1.21
+          go-version: ${{ matrix.go-version }}
         id: Go
 
       - name: Get dependencies
@@ -149,6 +161,7 @@ jobs:
           go tool cover -func profile.cov
 
       - name: Upload Test Coverage
+        if: ${{ matrix.go-version == '1.21'}}
         uses: actions/upload-artifact@v3
         with:
           name: PKG-Coverage-Report
@@ -157,7 +170,7 @@ jobs:
   parse_coverage:
     name: Code Coverage
     runs-on: ubuntu-latest
-    needs: [Example-Unit-Testing,PKG-Unit-Testing,MIGRATION-Unit-Testing]
+    needs: [ Example-Unit-Testing,PKG-Unit-Testing,MIGRATION-Unit-Testing ]
     steps:
       - name: Check out code into the Go module directory
         uses: actions/checkout@v4
@@ -167,6 +180,7 @@ jobs:
         with:
           path: artifacts
 
+
       - name: Merge Coverage Files
         working-directory: artifacts
         run: |
@@ -191,7 +205,7 @@ jobs:
     name: Upload Coverage📊
     runs-on: ubuntu-latest
     needs: [Example-Unit-Testing,PKG-Unit-Testing,MIGRATION-Unit-Testing]
-    if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/development' }}
+    if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/development'}}
     steps:
       - name: Check out code into the Go module directory
         uses: actions/checkout@v4

docs/quick-start/introduction/page.md

@@ -1,6 +1,6 @@
 # Prerequisite
 
--  Go 1.19 or above.
+-  Go 1.20 or above.
    To check the version use the following command `go version`.
 
 -  Prior familiarity with Golang syntax is essential. [Golang Tour](https://tour.golang.org/) is highly recommended as it has an excellent guided tour.

docs/quick-start/observability/page.md

@@ -73,11 +73,27 @@ GoFr by default publishes metrics automatically to port: _2121_ on _/metrics_ en
 ---
 * app_sql_stats
 * histogram
-* Observes the response time for SQL queries
+* Response time of SQL queries in microseconds
 ---
 * app_redis_stats
 * histogram
-* Observes the response time for Redis commands
+* Response time of Redis commands in microseconds
+---
+* app_pubsub_publish_total_count
+* counter
+* Number of total publish operations
+---
+* app_pubsub_publish_success_count
+* counter
+* Number of successful publish operations
+---
+* app_pubsub_subscribe_total_count
+* counter
+* Number of total subscribe operations
+---
+* app_pubsub_subscribe_success_count
+* counter
+* Number of successful subscribe operations
 
 {% /table %}
 

pkg/gofr/container/container.go

@@ -30,7 +30,7 @@ type Container struct {
 
 	Services       map[string]service.HTTP
 	metricsManager metrics.Manager
-	pubsub         pubsub.Client
+	PubSub         pubsub.Client
 
 	Redis *redis.Redis
 	SQL   *sql.DB
@@ -82,18 +82,18 @@ func (c *Container) Create(conf config.Config) {
 			partition, _ := strconv.Atoi(conf.GetOrDefault("PARTITION_SIZE", "0"))
 			offSet, _ := strconv.Atoi(conf.GetOrDefault("PUBSUB_OFFSET", "-1"))
 
-			c.pubsub = kafka.New(kafka.Config{
+			c.PubSub = kafka.New(kafka.Config{
 				Broker:          conf.Get("PUBSUB_BROKER"),
 				Partition:       partition,
 				ConsumerGroupID: conf.Get("CONSUMER_ID"),
 				OffSet:          offSet,
-			}, c.Logger)
+			}, c.Logger, c.metricsManager)
 		}
 	case "GOOGLE":
-		c.pubsub = google.New(google.Config{
+		c.PubSub = google.New(google.Config{
 			ProjectID:        conf.Get("GOOGLE_PROJECT_ID"),
 			SubscriptionName: conf.Get("GOOGLE_SUBSCRIPTION_NAME"),
-		}, c.Logger)
+		}, c.Logger, c.metricsManager)
 	}
 }
 
@@ -115,19 +115,26 @@ func (c *Container) registerFrameworkMetrics() {
 	c.Metrics().NewGauge("app_go_numGC", "Number of completed Garbage Collector cycles.")
 	c.Metrics().NewGauge("app_go_sys", "Number of total bytes of memory.")
 
-	histogramBuckets := []float64{.001, .003, .005, .01, .02, .03, .05, .1, .2, .3, .5, .75, 1, 2, 3, 5, 10, 30}
-
 	// http metrics
-	c.Metrics().NewHistogram("app_http_response", "Response time of http requests in seconds.", histogramBuckets...)
-	c.Metrics().NewHistogram("app_http_service_response", "Response time of http service requests in seconds.", histogramBuckets...)
+	httpBuckets := []float64{.001, .003, .005, .01, .02, .03, .05, .1, .2, .3, .5, .75, 1, 2, 3, 5, 10, 30}
+	c.Metrics().NewHistogram("app_http_response", "Response time of http requests in seconds.", httpBuckets...)
+	c.Metrics().NewHistogram("app_http_service_response", "Response time of http service requests in seconds.", httpBuckets...)
 
 	// redis metrics
-	c.Metrics().NewHistogram("app_redis_stats", "Observes the response time for Redis commands.", histogramBuckets...)
+	redisBuckets := []float64{50, 75, 100, 125, 150, 200, 300, 500, 750, 1000, 1250, 1500, 2000, 2500, 3000}
+	c.Metrics().NewHistogram("app_redis_stats", "Response time of Redis commands in microseconds.", redisBuckets...)
 
 	// sql metrics
-	c.Metrics().NewHistogram("app_sql_stats", "Observes the response time for SQL queries.", histogramBuckets...)
+	sqlBuckets := []float64{50, 75, 100, 125, 150, 200, 300, 500, 750, 1000, 2000, 3000, 4000, 5000, 7500, 10000}
+	c.Metrics().NewHistogram("app_sql_stats", "Response time of SQL queries in microseconds.", sqlBuckets...)
 	c.Metrics().NewGauge("app_sql_open_connections", "Number of open SQL connections.")
 	c.Metrics().NewGauge("app_sql_inUse_connections", "Number of inUse SQL connections.")
+
+	// pubsub metrics
+	c.Metrics().NewCounter("app_pubsub_publish_total_count", "Number of total publish operations.")
+	c.Metrics().NewCounter("app_pubsub_publish_success_count", "Number of successful publish operations.")
+	c.Metrics().NewCounter("app_pubsub_subscribe_total_count", "Number of total subscribe operations.")
+	c.Metrics().NewCounter("app_pubsub_subscribe_success_count", "Number of successful subscribe operations.")
 }
 
 func (c *Container) GetAppName() string {
@@ -139,9 +146,9 @@ func (c *Container) GetAppVersion() string {
 }
 
 func (c *Container) GetPublisher() pubsub.Publisher {
-	return c.pubsub
+	return c.PubSub
 }
 
 func (c *Container) GetSubscriber() pubsub.Subscriber {
-	return c.pubsub
+	return c.PubSub
 }

pkg/gofr/container/container_test.go

@@ -58,7 +58,7 @@ func Test_newContainerPubSubIntializationFail(t *testing.T) {
 	for _, tc := range testCases {
 		c := NewContainer(testutil.NewMockConfig(tc.configs))
 
-		assert.Nil(t, c.pubsub)
+		assert.Nil(t, c.PubSub)
 	}
 }
 
@@ -112,7 +112,7 @@ func TestContainer_GetAppVersion(t *testing.T) {
 func TestContainer_GetPublisher(t *testing.T) {
 	publisher := &mockPubSub{}
 
-	c := &Container{pubsub: publisher}
+	c := &Container{PubSub: publisher}
 
 	out := c.GetPublisher()
 
@@ -122,7 +122,7 @@ func TestContainer_GetPublisher(t *testing.T) {
 func TestContainer_GetSubscriber(t *testing.T) {
 	subscriber := &mockPubSub{}
 
-	c := &Container{pubsub: subscriber}
+	c := &Container{PubSub: subscriber}
 
 	out := c.GetSubscriber()
 

pkg/gofr/datasource/pubsub/google/google.go

@@ -23,12 +23,13 @@ type Config struct {
 type googleClient struct {
 	Config
 
-	client *gcPubSub.Client
-	logger pubsub.Logger
+	client  *gcPubSub.Client
+	logger  pubsub.Logger
+	metrics Metrics
 }
 
 //nolint:revive // We do not want anyone using the client without initialization steps.
-func New(conf Config, logger pubsub.Logger) *googleClient {
+func New(conf Config, logger pubsub.Logger, metrics Metrics) *googleClient {
 	err := validateConfigs(&conf)
 	if err != nil {
 		logger.Errorf("google pubsub could not be configured, err : %v", err)
@@ -44,9 +45,10 @@ func New(conf Config, logger pubsub.Logger) *googleClient {
 	}
 
 	return &googleClient{
-		Config: conf,
-		client: client,
-		logger: logger,
+		Config:  conf,
+		client:  client,
+		logger:  logger,
+		metrics: metrics,
 	}
 }
 
@@ -63,6 +65,8 @@ func validateConfigs(conf *Config) error {
 }
 
 func (g *googleClient) Publish(ctx context.Context, topic string, message []byte) error {
+	g.metrics.IncrementCounter(ctx, "app_pubsub_publish_total_count", "topic", topic)
+
 	t, err := g.getTopic(ctx, topic)
 	if err != nil {
 		return err
@@ -80,10 +84,14 @@ func (g *googleClient) Publish(ctx context.Context, topic string, message []byte
 
 	g.logger.Debugf("published google message %v on topic %v", string(message), topic)
 
+	g.metrics.IncrementCounter(ctx, "app_pubsub_publish_success_count", "topic", topic)
+
 	return nil
 }
 
 func (g *googleClient) Subscribe(ctx context.Context, topic string) (*pubsub.Message, error) {
+	g.metrics.IncrementCounter(ctx, "app_pubsub_subscribe_total_count", "topic", topic)
+
 	var m = pubsub.NewMessage(ctx)
 
 	t, err := g.getTopic(ctx, topic)
@@ -118,6 +126,8 @@ func (g *googleClient) Subscribe(ctx context.Context, topic string) (*pubsub.Mes
 
 	g.logger.Debugf("received google message %v on topic %v", string(m.Value), m.Topic)
 
+	g.metrics.IncrementCounter(ctx, "app_pubsub_subscribe_success_count", "topic", topic)
+
 	return m, nil
 }