formatter

nested-logrus-formatter

主要功能

1. 控制台输出与文件写入
2. 日志文件与行号定位，支持跳转
3. 支持GORM的日志接管，适配其日志的打印。github.com/aohanhongzhi/gormv2-logrus
4. 邮件报警
5. 飞书报警
6. http机器人报警

控制台输出与文件写入

日志文件与行号定位，支持跳转

支持GORM的日志接管，适配其日志的打印。

https://github.com/aohanhongzhi/gormv2-logrus

这里注意一个点，本来下面这行查询语句并不是日志记录语句，而是通过特殊栈查找，打印的该文件和行号，这样方便GORM定位与调试。

代码介绍

Human-readable log formatter, converts logrus fields to a nested structure:

Configuration:

type Formatter struct {
	// FieldsOrder - default: fields sorted alphabetically
	FieldsOrder []string

	// TimestampFormat - default: time.StampMilli = "Jan _2 15:04:05.000"
	TimestampFormat string

	// HideKeys - show [fieldValue] instead of [fieldKey:fieldValue]
	HideKeys bool

	// NoColors - disable colors
	NoColors bool

	// NoFieldsColors - apply colors only to the level, default is level + fields
	NoFieldsColors bool

	// NoFieldsSpace - no space between fields
	NoFieldsSpace bool

	// ShowFullLevel - show a full level [WARNING] instead of [WARN]
	ShowFullLevel bool

	// NoUppercaseLevel - no upper case for level value
	NoUppercaseLevel bool

	// TrimMessages - trim whitespaces on messages
	TrimMessages bool

	// CallerFirst - print caller info first
	CallerFirst bool

	// CustomCallerFormatter - set custom formatter for caller info
	CustomCallerFormatter func(*runtime.Frame) string
}

Usage

import (
	nested "github.com/antonfisher/nested-logrus-formatter"
	"github.com/sirupsen/logrus"
)

log := logrus.New()
log.SetFormatter(&nested.Formatter{
	HideKeys:    true,
	FieldsOrder: []string{"component", "category"},
})

log.Info("just info message")
// Output: Jan _2 15:04:05.000 [INFO] just info message

log.WithField("component", "rest").Warn("warn message")
// Output: Jan _2 15:04:05.000 [WARN] [rest] warn message

See more examples in the tests file.

Development

# run tests:
make test

# run demo:
make demo

GOPROXY=https://goproxy.cn,direct
或者
GOPROXY=https://goproxy.io,direct

新的使用方式

	nested "github.com/aohanhongzhi/nested-logrus-formatter"
	log "github.com/sirupsen/logrus"

    //手动初始化下就好了
    nested.LogInit(true)

	// -noConsole=true 在启动命令行加上这个，就可以实现线上不需要控制台输出，本地开发需要控制台。
	noConsole := flag.Bool("noConsole", false, "开发环境")
	flag.Parse()
	// 数据库配置
	gin.DefaultWriter = nested.LogInit(*noConsole)

配合gin使用

    gin.DefaultWriter = nested.LogInit(true)

配合gorm使用

github.com/aohanhongzhi/gormv2-logrus

	gormLogger := gormv2logrus.NewGormlog(gormv2logrus.WithLogrus(logrus.StandardLogger()))
	gormLogger.LogMode(logger.Warn)
	gormConfig := &gorm.Config{
		Logger: gormLogger,
		NamingStrategy: schema.NamingStrategy{
			TablePrefix:   "tb_",
			SingularTable: true,
		},
	}

	// 数据库配置
	var err error
	dsn := "username:password@tcp(mysq.host.com:3306)/km?charset=utf8mb4&parseTime=True&loc=Local"
	Gormdb, err = gorm.Open(
		mysql.New(mysql.Config{
			DSN:               dsn,
			DefaultStringSize: 256,
		}), gormConfig)
	if err != nil {
		panic("failed to connect database")
	}
	Gormdb.AutoMigrate(&model.NPCComputerInfo{})

输出颜色

发布

git tag v1.5.2
git push --tags 

本地调试

replace github.com/aohanhongzhi/nested-logrus-formatter => /home/eric/Project/Go/nested-logrus-formatter

Tag 专属日志

为不改变现有接口，新增可选能力：启用后，任一包含字段 tag 的日志将被“旁路”写入 ./log/tag/<tag>.log，原有日志流保持不变。

nested.LogInitWithLevel(false, "my-app", log.DebugLevel)
// 开启 tag 旁路写入能力
nested.EnableTagFileRouter()

// 任意位置打印带 tag 的日志
log.WithField("tag", "orders").Info("created order #1")
log.WithField("tag", "orders").Error("order failed")
// 也可以使用其他 tag
log.WithField("tag", "book").Warn("book warn")

说明：

• tag 文件路径：<初始化dir>/log/tag/<tag>.log
• 滚动策略（大小、保留天数、备份数）与主日志一致
• 异步写入，低开销；程序退出时会自动 Flush（也可手动调用 formatter.FlushAsyncHooks()）