paycloudgohelper

Go Helper

Introduction

This repo for Golang Helper services.

⚙️ Installation

via go modules

go get bitbucket.org/paycloudid/paycloudgohelper

🎯 Features

• Logger logger
• Data data
• Middleware middleware
• Response V1 snake_case
• Response V2 CamelCase

⚡️ Usage

📖 Logger Wrapper

rs/zerolog is a logger package for Go which follows uber/zap's JSON output format with calls chained for ease of logging.

This package is just a wrapper on initialization of zerolog logger instance which stores and propagates through context.Context.

Usage

Example-1: Initialization and propagation of logger through context variable

package main

import (
	"context"
	"os"

	zlog "bitbucket.org/paycloudid/paycloudgohelper"
)

func main() {
	ctx, logger := zlog.NewLogger(context.Background(), os.Stdout, zlog.LevelDebug)

	logger.Info().Msg("Message from main")

	greet(ctx)
}

func greet(ctx context.Context) {
	logger := zlog.FromContext(ctx)

	logger.Info().Msg("Message from greet")
}

This outputs logs as follows:

{"log-level":"info","timestamp":"2023-03-10T15:32:07+05:30","caller":"main.go:13","log-message":"Message from main"}
{"log-level":"info","timestamp":"2023-03-10T15:32:07+05:30","caller":"main.go:21","log-message":"Message from greet"}

Example-2: Using zerolog's With() to create child logger with added extra fields.

In following example, With adds {"flow": "example-manager"} to child logger which is then stored in Manager instance.

package main

import (
	"context"
	"os"

	zlog "bitbucket.org/paycloudid/paycloudgohelper"
)

func main() {
	ctx, logger := zlog.NewLogger(context.Background(), os.Stdout, zlog.LevelDebug)

	logger.Info().Msg("Message from main")

	manager := NewManager(ctx)
	manager.Greet()
}

func (m Manager) Greet() {
	m.logger.Info().Msg("Message from Greet")
}

type Manager struct {
	logger zlog.Logger
}

func NewManager(ctx context.Context) *Manager {
	logger := zlog.FromContext(ctx).With().
		Str("flow", "example-manager").Logger()

	return &Manager{
		logger: zlog.FromRawLogger(logger),
	}
}

This outputs logs as follows:

{"log-level":"info","timestamp":"2023-03-10T15:41:33+05:30","caller":"main.go:13","log-message":"Message from main"}
{"log-level":"info","flow":"example-manager","timestamp":"2023-03-10T15:41:33+05:30","caller":"main.go:20","log-message":"Message from greet"}

Note: The zlog.FromRawLogger creates zlog.Logger from zerolog.Logger avoiding the need for direct import of zerolog.

📖 Logger Sentry

import (
     ...
     bitbucket.org/paycloudid/paycloudgohelper
     ...
)

func main(){
     ...
      paycloudgohelper.InitSentry("this is url sentry", "environment (develop, staging , production)", "tags release (1.0.0 , 1.0.12)", debug (true,false))
     ...

     ...
     // Send Error
     if err != nil {
		paycloudgohelper.SendSentryError(err, "saas-be-research-manager", "User", "divide")
          // 1. Error
          // 2. Service
          // 3. Module
          // 4. Function
	}
     ...

     // Send Message
     ...
     paycloudgohelper.SendSentryMessage("this is sample message", "saas-be-research-manager", "User", "divide")
          // 1. Message
          // 2. Service
          // 3. Module
          // 4. Function
     ...

     // Send Event
     ...
     paycloudgohelper.SendSentryEvent(*sentry.Event)
          // 1. Sentry Event
          // 2. Service
          // 3. Module
          // 4. Function
     ...
}

• Result

- logger error
+ logger warning
! logger success
# logger info

📖 Data