zapx

README

zapx.go

Context

package main

import (
	"context"

	"github.com/hhk7734/zapx.go"
	"go.uber.org/zap"
)

func main() {
	ctx := context.Background()

	logger, _ := zap.NewProduction()
	defer logger.Sync()
	zap.ReplaceGlobals(logger)

	A(ctx)
}

func A(ctx context.Context) {
	logger := zapx.Ctx(ctx)
	logger.Info("A")

	B(zapx.WithFields(ctx, zap.String("A", "a")))
}

func B(ctx context.Context) {
	logger := zapx.Ctx(ctx)
	logger.Info("B")

	C(zapx.With(ctx, logger.WithOptions(zap.Fields(zap.String("B", "b")))))
}

func C(ctx context.Context) {
	logger := zapx.Ctx(ctx)
	logger.Info("C")
}

{"level":"info","ts":1689501775.2534308,"caller":"zapx.go/main.go:22","msg":"A"}
{"level":"info","ts":1689501775.2534587,"caller":"zapx.go/main.go:29","msg":"B","A":"a"}
{"level":"info","ts":1689501775.2534641,"caller":"zapx.go/main.go:36","msg":"C","A":"a","B":"b"}

Dict

⚠ Deprecated: use zap.Dict instead. (go.uber.org/zap v1.26.0)

package main

import (
	"github.com/hhk7734/zapx.go"
	"go.uber.org/zap"
)

func main() {
	logger, _ := zap.NewProduction()
	defer logger.Sync()

	logger.Info("test",
		zapx.Dict("foo",
			zap.String("bar", "baz")))
}

{"level":"info","ts":1689501801.7570314,"caller":"zapx.go/main.go:12","msg":"test","foo":{"bar":"baz"}}

GormLogger

package main

import (
	"context"

	"github.com/hhk7734/zapx.go"
	"go.uber.org/zap"
	"gorm.io/driver/sqlite"
	"gorm.io/gorm"
)

type User struct {
	gorm.Model
	Name string
}

func main() {
	ctx := context.Background()

	cfg := zap.NewProductionConfig()
	cfg.Level.SetLevel(zap.DebugLevel)
	logger, _ := cfg.Build()
	defer logger.Sync()
	zap.ReplaceGlobals(logger)

	db, _ := gorm.Open(
		sqlite.Open("test.db"),
		&gorm.Config{
			Logger: zapx.DefaultGormLogger(),
		})

	db.Debug().AutoMigrate(&User{})

	ctx = zapx.WithFields(ctx, zap.String("test", "test"))
	db = db.WithContext(ctx)

	db.Debug().Create(&User{Name: "test"})
}

{"level":"debug","ts":1689501127.6352503,"caller":"zapx.go/main.go:32","msg":"trace: debug","elapsed":0.000024008,"rows":-1,"sql":"SELECT count(*) FROM sqlite_master WHERE type='table' AND name=\"users\""}
{"level":"debug","ts":1689501127.6410747,"caller":"zapx.go/main.go:32","msg":"trace: debug","elapsed":0.005701533,"rows":0,"sql":"CREATE TABLE `users` (`id` integer,`created_at` datetime,`updated_at` datetime,`deleted_at` datetime,`name` text,PRIMARY KEY (`id`))"}
{"level":"debug","ts":1689501127.6445901,"caller":"zapx.go/main.go:32","msg":"trace: debug","elapsed":0.003401466,"rows":0,"sql":"CREATE INDEX `idx_users_deleted_at` ON `users`(`deleted_at`)"}

{"level":"debug","ts":1689501127.6482286,"caller":"zapx.go/main.go:37","msg":"trace: debug","test":"test","elapsed":0.00357918,"rows":1,"sql":"INSERT INTO `users` (`created_at`,`updated_at`,`deleted_at`,`name`) VALUES (\"2023-07-16 18:52:07.644\",\"2023-07-16 18:52:07.644\",NULL,\"test\") RETURNING `id`"}

If you want to ignore ErrRecordNotFound, set IgnoreRecordNotFoundError to true.

	db, _ := gorm.Open(
		sqlite.Open("test.db"),
		&gorm.Config{
			Logger: &zapx.GormLogger{
				Config: zapx.Config{
					SlowThreshold:             200 * time.Millisecond,
					Colorful:                  false, // not support
					IgnoreRecordNotFoundError: true,
					ParameterizedQueries:      false,
					LogLevel:                  zapx.Warn,
				},
			},
		})

jq

alias log2jq="jq -R -r '. as \$line | try fromjson catch \$line'"

go run <path> 2>&1 | log2jq

Documentation

Index

• Constants
• Variables
• func Ctx(ctx context.Context) *zap.Logger
• func DefaultGormLogger() logger.Interface
• func With(parent context.Context, l *zap.Logger) context.Context
• func WithFields(parent context.Context, fs ...zap.Field) context.Context
• type Config
• type GormLogger
  • func (l GormLogger) Error(ctx context.Context, str string, args ...interface{})
  • func (l GormLogger) Info(ctx context.Context, str string, args ...interface{})
  • func (l *GormLogger) LogMode(level logger.LogLevel) logger.Interface
  • func (l GormLogger) ParamsFilter(ctx context.Context, sql string, params ...interface{}) (string, []interface{})
  • func (l GormLogger) Trace(ctx context.Context, begin time.Time, fc func() (string, int64), err error)
  • func (l GormLogger) Warn(ctx context.Context, str string, args ...interface{})

Constants

const (
	Silent = logger.Silent
	Error  = logger.Error
	Warn   = logger.Warn
	Info   = logger.Info
)

Variables

var Dict = zap.Dict

Deprecated: use zap.Dict instead. (go.uber.org/zap v1.26.0)

Functions

func Ctx

func Ctx(ctx context.Context) *zap.Logger

Ctx returns a logger from ctx. If no logger is found in ctx, it returns the global logger.

func DefaultGormLogger

func DefaultGormLogger() logger.Interface

func With

func With(parent context.Context, l *zap.Logger) context.Context

With returns a copy of parent with the given logger.

func WithFields

func WithFields(parent context.Context, fs ...zap.Field) context.Context

WithFields returns a copy of parent with a logger created by adding fs to the logger from parent.

Types

type Config

type Config = logger.Config

type GormLogger

type GormLogger struct {
	Config
}

GormLogger is gorm.logger.Interface implementation using zapx.Ctx. It is not support Colorful.

func (GormLogger) Error

func (l GormLogger) Error(ctx context.Context, str string, args ...interface{})

func (GormLogger) Info

func (l GormLogger) Info(ctx context.Context, str string, args ...interface{})

func (*GormLogger) LogMode

func (l *GormLogger) LogMode(level logger.LogLevel) logger.Interface

func (GormLogger) ParamsFilter

func (l GormLogger) ParamsFilter(ctx context.Context, sql string, params ...interface{}) (string, []interface{})

func (GormLogger) Trace

func (l GormLogger) Trace(ctx context.Context, begin time.Time, fc func() (string, int64), err error)

func (GormLogger) Warn

func (l GormLogger) Warn(ctx context.Context, str string, args ...interface{})