golang有用的库及工具 之 zap.Logger包的使用指南

zap.Logger 是go语言中相对日志库中性能最高的。那么如何开始使用?

不多说直接上代码:

import (
  "encoding/json"
  "fmt"
  "log"
  "go.uber.org/zap"
  "go.uber.org/zap/zapcore"
)
var Logger *zap.Logger
func InitLogger() {
  // 日志地址 "out.log" 自定义
  lp := Conf.Common.LogPath
  // 日志级别 DEBUG,ERROR, INFO
  lv := Conf.Common.LogLevel
  // 是否 DEBUG
  isDebug := true
  if Conf.Common.IsDebug != true {
   isDebug = false
  }
  initLogger(lp, lv, isDebug)
  log.SetFlags(log.Lmicroseconds | log.Lshortfile | log.LstdFlags)
}
func initLogger(lp string, lv string, isDebug bool) {
  var js string
  if isDebug {
   js = fmt.Sprintf(`{
   "level": "%s",
   "encoding": "json",
   "outputPaths": ["stdout"],
   "errorOutputPaths": ["stdout"]
   }`, lv)
  } else {
   js = fmt.Sprintf(`{
   "level": "%s",
   "encoding": "json",
   "outputPaths": ["%s"],
   "errorOutputPaths": ["%s"]
   }`, lv, lp, lp)
  }
  var cfg zap.Config
  if err := json.Unmarshal([]byte(js), &cfg); err != nil {
   panic(err)
  }
  cfg.EncoderConfig = zap.NewProductionEncoderConfig()
  cfg.EncoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder
  var err error
  Logger, err = cfg.Build()
  if err != nil {
   log.Fatal("init logger error: ", err)
  }
}

如何使用:

func TestInitLogger(t *testing.T) {
  InitLogger("out.log", "DEBUG", false)
  s := []string{
   "hello info",
   "hello error",
   "hello debug",
   "hello fatal",
  }
  Log.Info("info:", zap.String("s", s[0]))
  Log.Error("info:", zap.String("s", s[1]))
  Log.Debug("info:", zap.String("s", s[2]))
  Log.Fatal("info:", zap.String("s", s[3]))
}

输出:

{"level":"info","ts":"2017-10-25 13:45:42.332","caller":"logger/logger_test.go:16","msg":"info:","s":"hello info"}
{"level":"error","ts":"2017-10-25 13:45:42.396","caller":"logger/logger_test.go:17","msg":"info:","s":"hello error","stacktrace":"go.uber.org/zap.Stack\n\tD:/gopath/src/go.uber.org/zap/field.go:191\ngo.uber.org/zap.(*Logger).check\n\tD:/gopath/src/go.uber.org/zap/logger.go:301\ngo.uber.org/zap.(*Logger).Error\n\tD:/gopath/src/go.uber.org/zap/logger.go:202\ngithub.com/corego/hermes/logger.TestInitLogger\n\tD:/gopath/src/github.com/corego/hermes/logger/logger_test.go:17\ntesting.tRunner\n\tD:/Program Files (x86)/go/src/testing/testing.go:746"}
{"level":"debug","ts":"2017-10-25 13:45:42.396","caller":"logger/logger_test.go:18","msg":"info:","s":"hello debug"}
{"level":"fatal","ts":"2017-10-25 13:45:42.396","caller":"logger/logger_test.go:19","msg":"info:","s":"hello fatal","stacktrace":"go.uber.org/zap.Stack\n\tD:/gopath/src/go.uber.org/zap/field.go:191\ngo.uber.org/zap.(*Logger).check\n\tD:/gopath/src/go.uber.org/zap/logger.go:301\ngo.uber.org/zap.(*Logger).Fatal\n\tD:/gopath/src/go.uber.org/zap/logger.go:235\ngithub.com/corego/hermes/logger.TestInitLogger\n\tD:/gopath/src/github.com/corego/hermes/logger/logger_test.go:19\ntesting.tRunner\n\tD:/Program Files (x86)/go/src/testing/testing.go:746"}

拓展:Golang成长之路:使用Zap来做日志服务

我们在项目中,经常会记录一些数据信息到文件中,或者日志文件。

例如nginx会有nginx访问请求日志,使用golang的时候,我也想做一个这样的访问日志,所以我就找到了go的一个开源高效的日志库zap。

很多人也使用logrus或者go自带的Logger(支持的东西太少,性能一般),具体为啥最后选择了zap,是因为很多人说zap性能更高些,当然我自己没有测试过。

1、安装zap

go get -u go.uber.org/zap

如果没反应,可能需要配置下代理,

go env -w GOPROXY=https://goproxy.cn

然后在执行安装的命令。

2、简单实例(默认配置)

Zap提供了两种类型的日志记录器—Sugared Logger和Logger。

package main
import (
  "go.uber.org/zap"
  "time"
)

func main() {
  // zap.NewDevelopment 格式化输出
  logger, _ := zap.NewDevelopment()
  defer logger.Sync()
  logger.Info("测试",
    zap.String("url", "http://www.baidu.com"),
    zap.Int("attempt", 3),
    zap.Duration("backoff", time.Second),
  )

  // zap.NewProduction json序列化输出
  logger, _ := zap.NewProduction()
  defer logger.Sync()
  logger.Info("测试",
    zap.String("url", "http://www.baidu.com"),
    zap.Int("attempt", 3),
    zap.Duration("backoff", time.Second),
  )
}

3、自定义配置

封装好一个logger包

package logger
import (
  "go.uber.org/zap"
  "go.uber.org/zap/zapcore"
  "time"
  "fmt"
)

var sugarLogger *zap.SugaredLogger

//格式化日期
func formatEncodeTime(t time.Time, enc zapcore.PrimitiveArrayEncoder) {
 enc.AppendString(fmt.Sprintf("%d-%02d-%02d %02d:%02d:%02d", t.Year(), t.Month(), t.Day(), t.Hour(), t.Minute(), t.Second()))
}

func InitConfig() *zap.SugaredLogger {
  encoderConfig := zapcore.EncoderConfig{
    TimeKey:    "ts",
    LevelKey:    "level",
    NameKey:    "logger",
    CallerKey:   "caller",
    MessageKey:   "msg",
    StacktraceKey: "stacktrace",
    LineEnding:   zapcore.DefaultLineEnding,
    EncodeLevel:  zapcore.LowercaseLevelEncoder, // 小写编码器
    EncodeTime:   formatEncodeTime,    //时间格式
    EncodeDuration: zapcore.SecondsDurationEncoder,
    EncodeCaller:  zapcore.FullCallerEncoder,   // 全路径编码器
  }

  // 设置日志级别(默认info级别,可以根据需要设置级别)
  atom := zap.NewAtomicLevelAt(zap.InfoLevel)

  config := zap.Config{
    Level:      atom,                        // 日志级别
    Development:   true,                        // 开发模式,堆栈跟踪
    Encoding:     "json",                       // 输出格式 console 或 json
    EncoderConfig:  encoderConfig,                    // 编码器配置
    OutputPaths:   []string{"stdout", '需要写入文件的路径'},       // 日志写入文件的地址
    ErrorOutputPaths: []string{"stderr", '需要写入文件的路径'},   // 将系统内的error记录到文件的地址
  }

  // 构建日志
  logger, _ := config.Build()
  sugarLogger = logger.Sugar()
  return sugarLogger
}

func Debug(args ...interface{}) {
 sugarLogger.Debug(args...)
}

func Debugf(template string, args ...interface{}) {
 sugarLogger.Debugf(template, args...)
}

func Info(args ...interface{}) {
 sugarLogger.Info(args...)
}

func Infof(template string, args ...interface{}) {
 sugarLogger.Infof(template, args...)
}

func Infow(template string, args ...interface{}) {
 sugarLogger.Infow(template, args...)
}

func Warn(args ...interface{}) {
 sugarLogger.Warn(args...)
}

func Warnf(template string, args ...interface{}) {
 sugarLogger.Warnf(template, args...)
}

func Error(args ...interface{}) {
 sugarLogger.Error(args...)
}

func Errorf(template string, args ...interface{}) {
 sugarLogger.Errorf(template, args...)
}

func DPanic(args ...interface{}) {
 sugarLogger.DPanic(args...)
}

func DPanicf(template string, args ...interface{}) {
 sugarLogger.DPanicf(template, args...)
}

func Panic(args ...interface{}) {
 sugarLogger.Panic(args...)
}

func Panicf(template string, args ...interface{}) {
 sugarLogger.Panicf(template, args...)
}

func Fatal(args ...interface{}) {
 sugarLogger.Fatal(args...)
}

func Fatalf(template string, args ...interface{}) {
 sugarLogger.Fatalf(template, args...)
}

EncoderConfig配置说明

MessageKey:输入信息的key名

LevelKey:输出日志级别的key名

TimeKey:输出时间的key名

NameKey CallerKey StacktraceKey跟以上类似,看名字就知道

LineEnding:每行的分隔符。基本zapcore.DefaultLineEnding 即"\n"

EncodeLevel:基本zapcore.LowercaseLevelEncoder。将日志级别字符串转化为小写

EncodeTime:输出的时间格式

EncodeDuration:一般zapcore.SecondsDurationEncoder,执行消耗的时间转化成浮点型的秒

EncodeCaller:一般zapcore.ShortCallerEncoder,以包/文件:行号 格式化调用堆栈

EncodeName:可选值。

使用案例

package main
import (
 "logger"//导入写好的包(具体需要改为自己写的路径)
)

func main() {
 //初始化日志配置
 logger.InitConfig()

 //写入文件
 logger.Infow("access_log",
 "code", 200,
 "ip", 192.168.1.1,
 "Method", "POST",
 "url", "www.baidu.com",
 "latencyTime(ms)", 1000,
 )
}

好了,这就是自己捣鼓的zap使用方法,希望能给大家一个参考,也希望大家多多支持我们。如有错误或未考虑完全的地方,望不吝赐教。

(0)

相关推荐

  • golang 使用time包获取时间戳与日期格式化操作

    Time包定义的类型 Time: 时间类型, 包含了秒和纳秒以及 Location Month: type Month int 月份. 定义了十二个月的常量 const ( January Month = 1 + iota February March April May June July August September October November December ) Weekday 类型: type Weekday int 周 定义了一周的七天 const ( Sunday Wee

  • golang return省略用法说明

    golang函数如果返回值定义了变量,return后边必须跟着表达式或者值 func main() { fmt.Println("-------", test()) } func test() (n string) { n = "hello" return } 如果没有定义变量,return必须显示地返回对象 func main() { fmt.Println("-------", test()) } func test() string { n

  • golang的time包:秒、毫秒、纳秒时间戳输出方式

    菜鸟的时候只知道时间戳有10位.13位.还有好长位数的. 入坑久了才明白 10位数的时间戳是以 秒 为单位: 13位数的时间戳是以 毫秒 为单位: 19位数的时间戳是以 纳秒 为单位: golang中可以这样写: package main import ( "time" "fmt" ) func main() { fmt.Printf("时间戳(秒):%v;\n", time.Now().Unix()) fmt.Printf("时间戳(

  • golang 输出重定向:fmt Log,子进程Log,第三方库logrus的详解

    独立 fmt Log输出重定向 golang的fmt包的输出函数 Println.Printf.PrintStack等,默认将打印输出到os.Stdout.错误打印输出到os.Stderr,os.Stdout 和 os.Stderr 默认值 /dev/stdout /dev/stderr 设备. //代码摘自:golang封装包 -> /lib/golang/src/os var ( Stdin = NewFile(uintptr(syscall.Stdin), "/dev/stdin&q

  • 使用Lumberjack+zap进行日志切割归档操作

    使用Lumberjack+zap进行日志切割归档 为了添加日志切割归档功能,我们将使用第三方库Lumberjack来实现. 安装 执行下面的命令安装Lumberjack go get -u github.com/natefinch/lumberjack zap logger中加入Lumberjack 要在zap中加入Lumberjack支持,我们需要修改WriteSyncer代码.我们将按照下面的代码修改getLogWriter()函数: func getLogWriter() zapcore.

  • golang有用的库及工具 之 zap.Logger包的使用指南

    zap.Logger 是go语言中相对日志库中性能最高的.那么如何开始使用? 不多说直接上代码: import ( "encoding/json" "fmt" "log" "go.uber.org/zap" "go.uber.org/zap/zapcore" ) var Logger *zap.Logger func InitLogger() { // 日志地址 "out.log" 自定

  • Golang 基于 flag 库实现一个简单命令行工具

    目录 前言 flag 库 FlagSet 需求拆解 实现 weather flag 天气数据打印 获取源数据 数据转换 运行效果 小结 前言 Golang 标准库中的 flag 库提供了解析命令行选项的能力,我们可以基于此来开发命令行工具. 假设我们想做一个命令行工具,我们通过参数提供[城市],它自动能够返回当前这个[城市]的天气状况.这样一个简单的需求,今天我们就来试一下,看怎样实现. flag 库 Package flag implements command-line flag parsi

  • golang xorm 自定义日志记录器之使用zap实现日志输出、切割日志(最新)

    目录 1.准备并下载好需要的包 2. 连接postgresql数据库 3. zap日志工具 4.实现xorm 自定义日志记录器 5.使用 完整代码 参考文档 1.准备并下载好需要的包 xorm.io/xorm xorm.io/core go.uber.org/zap gopkg.in/natefinch/lumberjack.v2  用于切割zap github.com/lib/pq  本文使用postgresql数据库 2. 连接postgresql数据库 // 创建pg数据库连接 func

  • Go日常开发常用第三方库和工具介绍

    这里我主要将这些库分为两类: 业务开发 基础工具开发 业务开发 首先是业务开发,主要包含了 web.数据库.Redis 等. Gin ️️️️️ 首先是 Gin,一款 HTTP 框架,使用简单.性能优秀.资料众多:你还在犹豫选择哪款框架时,那就选择它吧,基本没错. 当然和它配套的 github.com/swaggo/gin-… swagger 工具也是刚需:利用它可以生成 swagger 文档. GORM ️️️️️ GORM 也没啥好说的,如果你喜欢 orm 的方式操作数据库,那就选它吧:同样

  • 卡巴病毒库备份工具 专用版!

    卡巴病毒库备份工具 专用版! 每次GHOST还原系统后,最麻烦的恐怕就是等待更新病毒库了,而且那个卡巴,可能是 身体不太好,升级真的是太慢太慢了,呵呵! 所以自己就写了这个卡巴病毒库更新软件,网上也有相关软件,可是感觉用着不爽,呵呵,大家感觉那个舒服就用那个吧! 点击下载

  • 2018年Python值得关注的开源库、工具和开发者(总结篇)

    1.开源库 Web 领域:Sanic https://github.com/channelcat/sanic 这个库的名字和之前一个很火的梗有关,有人在 youtube 上画 Sonic 那个蓝色小人,结果一本正经的画出了下面这货,给它起名叫 Sanic,还配了一句话是 Gotta go faster. 这个库和 Flask 类似,但是比它快很多,速度能在测试中达到每秒 36000 次请求.在2017年的 Star 增长数几乎是翻了一倍.Gotta go faster! 环境与包管理:Pipen

  • Golang开发Go依赖管理工具dep安装验证实现过程

    目录 Go依赖管理工具 环境要求 目前版本 安装 验证 初始化 默认初始化 优先从$GOPATH初始化 Gopkg.toml Gopkg.lock 常用命令 dep ensure dep ensure -add dep ensure -update Go依赖管理工具 Go dependency management tool 环境要求 Golang >= 1.9Dep 目前版本 dep: version : devel build date : git hash : go version : g

  • golang连接sqlx库的操作使用指南

    目录 安装sqlx 基本使用 连接数据库 查询 插入.更新和删除 NamedExec NamedQuery 事务操作 sqlx.In的批量插入示例 表结构 结构体 bindvars(绑定变量) 自己拼接语句实现批量插入 使用sqlx.In实现批量插入 使用NamedExec实现批量插入 sqlx.In的查询示例 in查询 in查询和FIND_IN_SET函数 sqlx库使用指南 在项目中我们通常可能会使用database/sql连接MySQL数据库.本文借助使用sqlx实现批量插入数据的例子,介

  • golang连接redis库及基本操作示例过程

    目录 Redis介绍 Redis支持的数据结构 Redis应用场景 准备Redis环境 go-redis库 安装 连接 V8新版本相关 连接Redis哨兵模式 连接Redis集群 基本使用 HVals set/get示例 zset示例 根据前缀获取Key 执行自定义命令 按通配符删除key Pipeline 事务 Watch Redis介绍 Redis是一个开源的内存数据库,Redis提供了多种不同类型的数据结构,很多业务场景下的问题都可以很自然地映射到这些数据结构上.除此之外,通过复制.持久化

  • Golang使用ini库读取配置详情

    目录 go-ini的分区 go-ini的安装 ini文件的格式 读取ini文件的配置项 直接加在ini文件,通过方法读取 定义结构体来存放配置项,将配置项映射到结构体中 父子分区 两份关键代码 go-ini的分区 go-ini的多个配置项通过分区(section)来划分.有默认(空)分区和命名的分区,没有给分区命名就是默认分区,默认分区必须写在任何一个命名分区的上边.每个配置项通过换行来区分. go-ini的安装 go-ini/ini是GitHub上的一个代码库,和其他golang库一样,通过g

随机推荐