zdpgo_zap

README

zdpgo_zap

基于zap二次封装的日志库

功能

• 持久化日志
• json日志
• 区分测试环境和生产环境
• 全局日志
• 日志备份

版本日志

• 版本0.1.0：2022年1月30日
• 版本0.1.1：2022年1月30日
• 版本0.2.0：2022年2月10日 新增日志备份功能
• 版本0.2.1：2022年2月10日 新增自动创建日志目录功能
• 版本0.2.2：2022年2月11日 将日志对象开放给外部使用
• 版本0.2.3：2022年2月11日 bug修复
• 版本1.0.0：2022年3月8日 优化日志方法

常用方法

• Info 记录info类型的日志
• Debug 记录debug类型的日志
• Warning 记录warning类型的日志
• Error 记录error类型的日志
• Panic 记录panic类型的日志
• Fatal 记录fatal类型的日志

快速入门

package main

import "github.com/zhangdapeng520/zdpgo_zap"

func main() {
	l := zdpgo_zap.New(zdpgo_zap.ZapConfig{
		Debug:        true,
		OpenGlobal:   true,
		OpenFileName: false,
	})
	l.Debug("debug日志", "a", 111, "b", 22.22, "c", true, "d", "bbb")
	l.Info("info日志", "a", 111, "b", 22.22, "c", true, "d", "bbb")
	l.Warning("warning日志", "a", 111, "b", 22.22, "c", true, "d", "bbb")
	l.Error("error日志", "a", 111, "b", 22.22, "c", true, "d", "bbb")
}

创建日志的便捷方式

func TestZap_Debug(t *testing.T) {
l := NewDebug()
l.Debug("日志。。。")
l.Info("日志。。。")
l.Warning("日志。。。")
l.Error("日志。。。")
}

func TestZap_Product(t *testing.T) {
l := NewProduct()
l.Debug("日志。。。")
l.Info("日志。。。")
l.Warning("日志。。。")
l.Error("日志。。。")
}

Documentation

Index

• Variables
• type Zap
  • func New(config ZapConfig) *Zap
  • func NewDebug() *Zap
  • func NewProduct() *Zap
• type ZapConfig

Variables

var (
	Debug   func(msg string, args ...interface{})
	Info    func(msg string, args ...interface{})
	Warning func(msg string, args ...interface{})
	Error   func(msg string, args ...interface{})
	Panic   func(msg string, args ...interface{})
	Fatal   func(msg string, args ...interface{})
)

全局日志

Types

type Zap

type Zap struct {
	Log   *zap.Logger        // 日志对象
	Sugar *zap.SugaredLogger // sugar日志对象

	// 日志方法
	Debug   func(msg string, args ...interface{})
	Info    func(msg string, args ...interface{})
	Warning func(msg string, args ...interface{})
	Error   func(msg string, args ...interface{})
	Panic   func(msg string, args ...interface{})
	Fatal   func(msg string, args ...interface{})
	// contains filtered or unexported fields
}

Zap zap日志核心对象

func New

func New(config ZapConfig) *Zap

New 创建zap实例

func NewDebug

func NewDebug() *Zap

NewDebug 创建debug环境下的日志

func NewProduct

func NewProduct() *Zap

NewProduct 创建生产环境下的日志

type ZapConfig

type ZapConfig struct {
	Debug        bool   `mapstructure:"debug" json:"debug"`                   // 是否为debug模式
	OpenJsonLog  bool   `mapstructure:"open_json_log" json:"open_json_log"`   // 是否开启json日志格式
	OpenGlobal   bool   `mapstructure:"open_global" json:"open_global"`       // 是否开启全局日志
	OpenFileName bool   `mapstructure:"open_file_name" json:"open_file_name"` // 是否输出文件名和行号
	LogFilePath  string `mapstructure:"log_file_path" json:"log_file_path"`   // 日志路径
	MaxSize      uint   `mapstructure:"max_size" json:"max_size"`             // 日志最大保存多少M
	MaxBackups   uint   `mapstructure:"max_backups" json:"max_backups"`       // 日志保留多少个备份
	MaxAge       uint   `mapstructure:"max_age" json:"max_age"`               // 最多保留多少个日志
	Compress     bool   `mapstructure:"compress" json:"compress"`             // 是否压缩
}

ZapConfig zap日志配置核心对象