logging

README

mindbenders

Logger

type ILogWriter interface {
	Log(context.Context, Fields, Level, string)
	Info(context.Context, Fields, string)
	Error(context.Context, Fields, string)
	Warn(context.Context, Fields, string)
	Debug(context.Context, Fields, string)
}

//ILogger ...
type IDotpeLogger interface {
    ILogWriter
    GinLogger() gin.HandlerFunc
}

In order to initialize one has to have pass the 2 things for sure.

1. logger.WithAppInfo(os.Getenv("APP")), definition is as follows

   func WithAppInfo(app string) Option {
       return func(dlogger *dlogger) {
           dlogger.app = app
       }
   }
   

logger initializations Usage [link]

package utils

import (
    "os"

    mbinterfaces "gitlab.com/dotpe/mindbenders/interfaces"
    logger "gitlab.com/dotpe/mindbenders/logging"
)

var DLogger mbinterfaces.IDotpeLogger

//write your logic to initialize or fetch hookContainer objectct

// InitLogger ..
DLogger, err := logger.Init(
    logger.WithAppInfo(os.Getenv("APP")),
    logger.WithAccessLogOptions(
        logger.AccessLogOptionRequestBody,
        aopt1, // check definition of aopt1, similary you can pass more functions as you need
    ),
    logger.WithLogOptions(opt1),// check definition of opt1, similary you can pass more functions as you need
)

func aopt1(c *gin.Context, fields *Fields) {
    c.Set("ip", c.ClientIP())
}

func opt1(ctx context.Context, fields *Fields) {
    (*fields)["clientIP"] = ctx.Value("ip")
}

attaching GinLogger to add accessLog apiGroup.Use(utils.DLogger.GinLogger())

Recovery Middleware

The call ginmiddleware.Recovery(utils.DLogger) is for making the gin-engine failure safe.

Note: you can't control crashes in orphened go-routines

Documentation

Index

• func AccessLogOptionRequestBody(c *gin.Context, fields Fields)
• func WithZap(dlogger *dlogger)
• func WithZero(dlogger *dlogger)
• type Fields
• type IDotpeLogger
  • func MustGet(opts ...Option) IDotpeLogger
• type ILogWriter
  • func DefaultLogWriter() ILogWriter
  • func LogWriter() ILogWriter
• type Level
  • func (l Level) String() string
• type Option
  • func WithAccessLogOptions(opts ...accessLogOption) Option
  • func WithAppInfo(app string) Option
  • func WithLogOptions(opts ...logOption) Option
  • func WithMetric(level Level) Option

Functions

func AccessLogOptionRequestBody

func AccessLogOptionRequestBody(c *gin.Context, fields Fields)

func WithZap

func WithZap(dlogger *dlogger)

func WithZero

func WithZero(dlogger *dlogger)

Types

type Fields

type Fields map[string]interface{}

type IDotpeLogger

type IDotpeLogger interface {
	ILogWriter
	Gin() gin.HandlerFunc
}

ILogger ...

func MustGet

func MustGet(opts ...Option) IDotpeLogger

type ILogWriter

type ILogWriter interface {
	// Deprecated: Use [Log] instead.
	WriteLogs(context.Context, Fields, Level, string)

	Log(context.Context, Fields, Level, string)
	Info(context.Context, Fields, string)
	Warn(context.Context, Fields, string)
	Error(context.Context, Fields, string)
	Debug(context.Context, Fields, string)
	Panic(context.Context, Fields, string)
	Fatal(context.Context, Fields, string)
}

func DefaultLogWriter

func DefaultLogWriter() ILogWriter

func LogWriter

func LogWriter() ILogWriter

type Level

type Level int8

const (
	PanicLevel Level = iota
	FatalLevel
	ErrorLevel
	WarnLevel
	InfoLevel
	DebugLevel
	TraceLevel
)

func (Level) String

func (l Level) String() string

type Option

type Option func(dlogger *dlogger)

func WithAccessLogOptions

func WithAccessLogOptions(opts ...accessLogOption) Option

func WithAppInfo

func WithAppInfo(app string) Option

func WithLogOptions

func WithLogOptions(opts ...logOption) Option

func WithMetric

func WithMetric(level Level) Option