Wego Web Framework | GitHub 开发文档 开发社区
快速入门
Web模块
ORM模块
其他模块

介绍

wego/klog用GO语言实现的一个高性能的结构化日志包,wego/klog用于生成统计型日志。主要特征:

1) wego/klog支持按照天或小时进行日志文件的滚动输出。
2) 采用基于buffer的文件输出方式,满足高性能输出日志。
3) 采用链式api来添加字段。

安装

go get github.com/haming123/wego/klog

快速上手


package main
import "github.com/haming123/wego/klog"
func main() {
	klog.InitEngine("./logs", klog.ROTATE_DAY);
	defer klog.Close()

	klog.NewLog("login").UserId("user_1").Add("login_type", "account`weixin").Output()
	klog.NewLog("index").ClientIP("127.0.0.1:666").Add("exe", 12).Output()
}

输出内容为:


_ctm=2021/12/02 11:44:02 `_tname=login `_uid=user_1 `login_type=weixin ` 
_ctm=2021/12/02 11:44:02 `_tname=index `_cip=127.0.0.1:666 `exe=12 ` 

日志格式以及常用字段

日志格式采用key=value的格式,字段之间采用" `"来分隔,日志行之间采用" \n" 来分隔,例如:


    k1=v1 `k2=v2 `...... \n
    k1=v1 `k2=v2 `...... \n

若字段的内容有"`"符号,则编码为"\`"。同样若字段的内容有"\n"符号,则编码为"\\n"。例如若_uid=hello`, 则日志输出为:


_ctm=2021/12/02 11:44:02 `_tname=demo `_uid=hello\` `login_type=test `.

klog在输出日志时自动添加了日志的创建时间:_ctm,例如:


_ctm=2021/12/02 11:44:02 `_tname=login `_uid=user_1 `login_type=weixin ` 

wego/klog内置了一下常用的字段:

1) _ctm:日志创建时间,必填字段
2) _etm:代码执行时间,可选字段
3) _tname:日志类型,必填字段,使用时可以看作为数据库的库表
4) _fname:可选字段,通常为接口的名称或页面的名称
5) _cip:可选字段,客户端的IP
6) _uid:可选字段,用户ID

代码的执行时间

wego/klog支持在日志中输出代码的执行时间:


package main
import (
	"github.com/haming123/wego/klog"
	"time"
)
func main() {
	var eng = klog.NewEngine("./logs", klog.ROTATE_HOUR)
	defer eng.Close()
	bet_time := time.Now()

	//代码逻辑开始
	//...
	//代码逻辑结束

	eng.NewLog("table_name").BeginTime(bet_time).UserId("user_name").Output()
}

输出内容为:


_ctm=2021/12/02 12:32:29 `_tname=table_name `_uid=user_name `_etm=2 `  

其中etm便是代码的执行时间(单位:毫秒)

性能指标


BenchmarkWriteLog-6      1223031		991.0 ns/op			5 allocs/op