go 微服务框架 kratos 日志库使用方法及原理探究

已于 2024-05-24 23:01:08 修改
阅读量1.1k 收藏 25
点赞数 8
文章标签： golang 开发语言 后端 kratos 日志打印 zap zap日志库
于 2024-05-24 21:09:22 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/longchanghua_enshi/article/details/139182780
版权

一、Kratos 日志设计理念

kratos 日志库相关的官方文档：日志 | Kratos

Kratos的日志库主要有如下特性：

  • Logger用于对接各种日志库或日志平台，可以用现成的或者自己实现
  • Helper是在您的项目代码中实际需要调用的，用于在业务代码里打日志
  • Filter用于对输出日志进行过滤或魔改（通常用于日志脱敏）
  • Valuer用于绑定一些全局的固定值或动态值（比如时间戳、traceID或者实例id之类的东西）到输出日志中

Logger统一了日志的接入方式，Helper接口统一的日志库的调用方式。

二、Kratos 使用标准内置日志库的方法

1、打印日志到控制台的步骤 

①导入kratos日志包

import "github.com/go-kratos/kratos/v2/log"

//若导入失败，则需先获取包
go get github.com/go-kratos/kratos/v2/log

②使用 kratos 内置标准输出创建日志对象 

logger := log.NewStdLogger(os.Stdout)

③用 Log 方法打印日志，需要传入日志级别 

logger.Log(log.LevelInfo, "msg", "logger.Log 打印的日志")

 ④为了简化写日志时需传入的参数，kratos 用 Helper 对 Logger 进行了包装，建议用新建 helper 对象写日志，方法如下：

//对 logger 进行包装，简化写日志时需传入的参数
h := log.NewHelper(logger)

//写入信息级别的日志
h.Info("使用 kratos 内置标准输出记录的日志")

//写入错误级别的日志
h.Errorf("用户名【%s】不存在", "张三")

 ⑤可通过 log.With() 方法绑定全局字段到 Vauler，用来打印全局信息到日志中

//通过 log.With 方法绑定全局字段到 Vauler，用来打印全局信息到日志中
logger = log.With(logger,
	"ts", log.DefaultTimestamp,
	"caller", log.DefaultCaller,
	"trace_id", tracing.TraceID(),
	"span_id", tracing.SpanID(),
)
h = log.NewHelper(logger)
h.Info("绑定了全局信息到日志中")

⑥用 log.NewFilter() 方法对日志输出进行过滤

// 日志过滤，显示特定级别的日志，或对敏感信息脱敏
h = log.NewHelper(
	log.NewFilter(logger,
		// 按等级过滤
		//log.FilterLevel(log.LevelError),

		// 按key遮蔽
		log.FilterKey("username"),

		// 按value遮蔽
		log.FilterValue("hello"),
	),
)
h.Warn("warn log")
h.Infow("password", "123456")
//日志中 kratos 会变为 ***
h.Infow("username", "kratos")
//日志中 hello 会变为 ***
h.Info("hello")

 效果演示：

 完整代码：

package main

import (
	"os"

	"github.com/go-kratos/kratos/v2"
	"github.com/go-kratos/kratos/v2/log"
	"github.com/go-kratos/kratos/v2/middleware/tracing"
	"github.com/go-kratos/kratos/v2/transport/http"
)

func main() {
	//使用 kratos 内置标准输出创建日志对象
	logger := log.NewStdLogger(os.Stdout)
	// 用 Log 方法打印日志，需要传入日志级别，不建议使用这种方式，而建议使用 helper 打印日志
	logger.Log(log.LevelInfo, "msg", "logger.Log 打印的日志")
	//对 logger 进行包装，简化写日志时需传入的参数
	h := log.NewHelper(logger)
	//写入信息级别的日志
	h.Info("使用 kratos 内置标准输出记录的日志")
	//写入错误级别的日志
	h.Errorf("用户名【%s】不存在", "张三")

	// 通过 log.With 方法绑定全局字段到 Vauler，用来打印全局信息到日志中
	logger = log.With(logger,
		"ts", log.DefaultTimestamp,
		"caller", log.DefaultCaller,
		"trace_id", tracing.TraceID(),
		"span_id", tracing.SpanID(),
	)
	h = log.NewHelper(logger)
	h.Info("绑定了全局信息到日志中")

	// 日志过滤，显示特定级别的日志，或对敏感信息脱敏
	h = log.NewHelper(
		log.NewFilter(logger,
			// 按等级过滤
			//log.FilterLevel(log.LevelError),

			// 按key遮蔽
			log.FilterKey("username"),

			// 按value遮蔽
			log.FilterValue("hello"),
		),
	)
	h.Warn("warn log")
	h.Infow("password", "123456")
	//日志中 kratos 会变为 ***
	h.Infow("username", "kratos")
	//日志中 hello 会变为 ***
	h.Info("hello")


	//创建 kratos http server 及 app
	httpSrv := http.NewServer(
		http.Address(":8080"),
	)

	app := kratos.New(
		kratos.Name("测试log"),
		kratos.Server(
			httpSrv,
		),
	)

	if err := app.Run(); err != nil {
		log.Fatal(err)
	}
}

2、将日志写入到本地文件的方法

 ① 通过 os.OpenFile 新建文件，获取到 os.File 对象

f, err := os.OpenFile("../test.log", os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0666)
if err != nil {
	return
}

② 通过 log.NewStdLogger(w io.Writer) 新建 logger 时，传入上述 os.File 对象 f

//输出到控制台，传入os.Stdout；输出到文件，则传文件指针
logger := log.NewStdLogger(f)

注意：os.File 实现了  io.Writer 接口的 Write(p []byte) (n int, err error) 方法，所以能将 f 作为输入参数传入 log.NewStdLogger() 函数

③用 log.NewHelper 包装 logger，并打印日志

h1 := log.NewHelper(logger1)
h1.Info("输出到日志文件中的日志信息")

效果演示：

代码实现：

package main

import (
	"os"

	"github.com/go-kratos/kratos/v2"
	"github.com/go-kratos/kratos/v2/log"
	"github.com/go-kratos/kratos/v2/transport/http"
)

func main() {
	
	// 通过 log.NewStdLogger(w io.Writer) 中的 io.Writer 设置日志输出方式
	// 将日志输出到 test.log 文件
	f, err := os.OpenFile("../test.log", os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0666)
	if err != nil {
		return
	}
	logger1 := log.NewStdLogger(f)
	h1 := log.NewHelper(logger1)
	h1.Info("输出到日志文件中的日志信息")

	//创建 kratos http server 及 app
	httpSrv := http.NewServer(
		http.Address(":8080"),
	)

	app := kratos.New(
		kratos.Name("测试log"),
		kratos.Server(
			httpSrv,
		),
	)

	if err := app.Run(); err != nil {
		log.Fatal(err)
	}
}

三、 zap 日志库的使用方法

1、zap简介

Zap 是 uber 用 go 语言实现的超快、结构化、分级的日志记录库，性能极高，比其他结构化日志记录包快4-10倍。日志记录结构化，以JSON等格式输出。

有关详细介绍见：zap package - go.uber.org/zap - Go Packages

2、使用方法

①安装 zap 包

go get -u go.uber.org/zap

②导入 zap 包

import "go.uber.org/zap"

③用 NewProduction 等方法创建 zap 日志对象

// 创建 zap 日志对象
zaplogger, _ := zap.NewProduction()
defer logger.Sync()

 ④调用 Info、Error 等方法打印日志

//使用 zap 写日志
zaplogger.Info("failed to fetch URL",
	zap.String("url", "http://dddd.com"),
	zap.Int("attempt", 3),
	zap.Duration("backoff", time.Second),
)

效果演示：

 完整代码：

package main

import (
	"time"

	kzap "github.com/go-kratos/kratos/contrib/log/zap/v2"
	"github.com/go-kratos/kratos/v2"
	"github.com/go-kratos/kratos/v2/log"
	"github.com/go-kratos/kratos/v2/transport/http"
	"go.uber.org/zap"
)

func main() {
	// 创建 zap 日志对象，并打印日志
	zaplogger, _ := zap.NewProduction()
	defer zaplogger.Sync()
	//使用 zap 写日志
	zaplogger.Info("failed to fetch URL",
		zap.String("url", "http://dddd.com"),
		zap.Int("attempt", 3),
		zap.Duration("backoff", time.Second))


	httpSrv := http.NewServer(
		http.Address(":8080"),
	)

	app := kratos.New(
		kratos.Name("测试log"),
		kratos.Server(
			httpSrv,
		),
	)

	if err := app.Run(); err != nil {
		log.Fatal(err)
	}
}

⑤如果需要将日志输出到文件，则使用如下方法：

package main

import (
	"os"

	kzap "github.com/go-kratos/kratos/contrib/log/zap/v2"
	"github.com/go-kratos/kratos/v2"
	"github.com/go-kratos/kratos/v2/log"
	"github.com/go-kratos/kratos/v2/transport/http"
	"go.uber.org/zap"
	"go.uber.org/zap/zapcore"
)

func main() {
	// 配置Encoder
	encoder := zapcore.NewJSONEncoder(zap.NewProductionEncoderConfig())

	// 配置 WriteSyncer，将日志写入文件
	f, err := os.OpenFile("zaptest.log", os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0666)
	if err != nil {
		panic(err)
	}
	defer f.Close()

	writeSyncer := zapcore.AddSync(f)

	// 设置LogLevel
	level := zap.NewAtomicLevelAt(zapcore.InfoLevel)

	// 创建Core
	core := zapcore.NewCore(encoder, writeSyncer, level)

	// 构建Logger
	zaplogger := zap.New(core)
	logger := kzap.NewLogger(zaplogger)

	// 将 zap 日志对象适配到 kratos 的日志库，以便直接使用 kratos 的日志方法
	h := log.NewHelper(logger)
	h.Info("msg", "kratos适配的zap, 写入日志到文件")

	httpSrv := http.NewServer(
		http.Address(":8080"),
	)

	app := kratos.New(
		kratos.Name("测试log"),
		kratos.Server(
			httpSrv,
		),
	)

	if err := app.Run(); err != nil {
		log.Fatal(err)
	}
}

 效果演示：

四、Kratos 适配 zap 日志库的方法

kratos 在 contrib/log  实现好了一些插件，用于适配目前常用的日志库。

  • std 标准输出，Kratos内置
  • fluent 输出到fluentd
  • zap 适配了uber的zap日志库
  • aliyun 输出到阿里云日志

使用方法：

①安装 kratos 的 zap 适配包

go get github.com/go-kratos/kratos/contrib/log/zap/v2

②导入 zap 适配包

import (
	kzap "github.com/go-kratos/kratos/contrib/log/zap/v2"
)

 ③创建 zap 日志对象

// 创建 zap 日志对象，并打印日志
zaplogger, _ := zap.NewProduction()
defer zaplogger.Sync()

④调用函数 NewLogger(zlog *zap.Logger) 将创建的 zap 日志对象适配到 kratos 的日志操作对象

// 将 zap 日志对象适配到 kratos 的日志库，以便直接使用 kratos 的日志方法
logger := kzap.NewLogger(zaplogger)

 ⑤调用函数 log.NewHelper 将 logger 进行包装，简化日志写入操作

h := log.NewHelper(logger)
h.Info("kratos适配的zap日志库")

效果演示：

代码实现：

package main

import (
	kzap "github.com/go-kratos/kratos/contrib/log/zap/v2"
	"github.com/go-kratos/kratos/v2"
	"github.com/go-kratos/kratos/v2/log"
	"github.com/go-kratos/kratos/v2/transport/http"
	"go.uber.org/zap"
)

func main() {
	// 创建 zap 日志对象，并打印日志
	zaplogger, _ := zap.NewProduction()
	defer zaplogger.Sync()

	// 将 zap 日志对象适配到 kratos 的日志库，以便直接使用 kratos 的日志方法
	logger := kzap.NewLogger(zaplogger)
	h := log.NewHelper(logger)
	h.Info("kratos适配的zap日志库")

	httpSrv := http.NewServer(
		http.Address(":8080"),
	)

	app := kratos.New(
		kratos.Name("测试log"),
		kratos.Server(
			httpSrv,
		),
	)

	if err := app.Run(); err != nil {
		log.Fatal(err)
	}
}

五、Kratos 适配第三方日志库的实现原理

kratos 底层日志接口 Logger，可用于快速适配各种日志库到框架中来，仅需要实现一个最简单的Log方法。

// Logger is a logger interface.
type Logger interface {
	Log(level Level, keyvals ...interface{}) error
}

 以适配 uber 的 zap 日志库为例，kratos 在 contrib/log/zap/zap.go 中定义了新的日志结构体 Logger，并实现了方法 Log(level log.Level, keyvals ...interface{}) error。其源码如下：

package zap

import (
	"fmt"

	"go.uber.org/zap"

	"github.com/go-kratos/kratos/v2/log"
)

var _ log.Logger = (*Logger)(nil)

type Logger struct {
	log    *zap.Logger
	msgKey string
}

type Option func(*Logger)

// WithMessageKey with message key.
func WithMessageKey(key string) Option {
	return func(l *Logger) {
		l.msgKey = key
	}
}

func NewLogger(zlog *zap.Logger) *Logger {
	return &Logger{
		log:    zlog,
		msgKey: log.DefaultMessageKey,
	}
}

func (l *Logger) Log(level log.Level, keyvals ...interface{}) error {
	var (
		msg    = ""
		keylen = len(keyvals)
	)
	if keylen == 0 || keylen%2 != 0 {
		l.log.Warn(fmt.Sprint("Keyvalues must appear in pairs: ", keyvals))
		return nil
	}

	data := make([]zap.Field, 0, (keylen/2)+1)
	for i := 0; i < keylen; i += 2 {
		if keyvals[i].(string) == l.msgKey {
			msg, _ = keyvals[i+1].(string)
			continue
		}
		data = append(data, zap.Any(fmt.Sprint(keyvals[i]), keyvals[i+1]))
	}

	switch level {
	case log.LevelDebug:
		l.log.Debug(msg, data...)
	case log.LevelInfo:
		l.log.Info(msg, data...)
	case log.LevelWarn:
		l.log.Warn(msg, data...)
	case log.LevelError:
		l.log.Error(msg, data...)
	case log.LevelFatal:
		l.log.Fatal(msg, data...)
	}
	return nil
}

func (l *Logger) Sync() error {
	return l.log.Sync()
}

func (l *Logger) Close() error {
	return l.Sync()
}

龙门吹雪
关注
  • 8
    点赞
  • 踩
  • 25
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
Go-简单的Go日志框架
08-13
本log只是一个框架，并不处理log实际的输出 具体的输出实现由dirver完成(driver是实现log.FormatWriter的对象)
golog:Go的简单日志记录框架
05-17
golog 作者：Manoj Dayaram，陈志刚 除了回文之外，golog是Go的简单日志记录框架，它利用Go的并发功能，例如通道和go例程。 本质上，所有日志消息都发送到单个全局通道，并且单个go例程在该通道上侦听并写入其接收的所有内容。 这样可以确保所有日志都写入序列化的序列，而无需过多的锁定。 入门 入门非常容易。 只需创建一个新的记录器并添加您要登录的处理器即可。 import "golog" ... console := golog.NewConsoleProcessor(golog.LOG_INFO, verboseBoolean) // only log messages more important than or equal to info. logger := golog.NewLogger("some prefix here: ") logger
go语言日志框架——logrus
尚墨1111的博客
08-04 4301
go日志输出工具logrus
Kratos日志
游学四方的博客
11-23 1404
一.如何在kratos框架中使用 参考官方文档中描述，为了方便业务自适配不同的 log 接入使用，Logger 只包含了最简单的 Log 接口。当业务需要在 Kratos 框架内部使用自定义的 log的时候，只需要简单实现方法即可。日志库较为公用建议放在kit基础库中方便其他微服务引用。在kratos日志中，很多时候是输出到控制台的，但是实践中更多的是为了打印到文本中。 1.实现log接口并配置zap日志库编码 package log import ( "fmt" "time" "github.c
golang——工程组件logrus日志记录框架（结构化记录，支持文件切割，hook）
qq_43058348的博客
10-21 742
golang日志记录框架logrus
go微服务框架kratos学习笔记三(构建单独的http或者rpc demo项目)
01-08
文章目录go微服务框架kratos学习笔记三(构建单独的http或者grpc demo项目)grpchttp go微服务框架kratos学习笔记三(构建单独的http或者grpc demo项目) 前面两篇跑通了demo项目，和大概了解了kratos demo整体结构，本...
B站微服务框架kratos开发文档PDF版
09-05
《B站微服务框架kratos开发文档》是针对B站（bilibili）开源的Go语言微服务框架——Kratos的详细技术指南。Kratos框架是为了解决现代互联网服务在设计、开发和运维过程中遇到的挑战而创建的，它提供了全面的微服务...
B站微服务框架Kratos详细教程(3)-中间件 示例项目源码
09-08
**中间件在B站微服务框架Kratos中的应用** 在微服务架构中，中间件扮演着至关重要的角色，它能够提供各种服务级别的功能，如日志记录、性能监控、限流、熔断、认证和授权等。B站的开源微服务框架Kratos，作为一个...
B站微服务框架Kratos详细教程(5)-gRPC 示例项目源码
09-10
Kratos是Go语言实现的高可用、高性能的微服务框架，适用于构建复杂的分布式系统。gRPC是一个高性能、开源和通用的RPC框架，面向移动和HTTP/2设计，基于ProtoBuf(Protocol Buffers)定义服务，提供了强大的服务发现和...
B站微服务框架Kratos详细教程(7)-数据库示例项目源码
12-16
1. Kratos：Kratos是由B站（Bilibili）开发的Go语言微服务框架，旨在提供一套完整的微服务解决方案，包括服务治理、性能优化、容错处理、监控等能力。 2. B站微服务框架：Bilibili为了自身业务发展而构建的微服务...
golang日志框架之logrus的使用
09-18
主要介绍了golang日志框架之logrus的使用，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
golang日志处理库go-logger.zip
07-17
go-logger 是golang 的日志库 ，基于对golang内置log的封装。用法类似java日志工具包log4j 打印日志有5个方法 Debug，Info，Warn, Error ,Fatal  日志级别由低到高设置日志级别的方法为：logger.SetLevel() 如：logger.SetLevel(logger.WARN)则：logger.Debug(....),logger.Info(...) 日志不会打出，而  logger.Warn(...),logger.Error(...),logger.Fatal(...)日志会打出。设置日志级别的参数有7个，分别为：ALL，DEB
Go-Kratos是bilibili开源的一套Go微服务框架包含大量微服务相关框架及工具。
08-13
Kratos是bilibili开源的一套Go微服务框架，包含大量微服务相关框架及工具。
【golang】源码层面学习日志框架logrus 01
yqs的博客
09-11 529
可以看到New为我们返回了一个默认的Logger对象，也就是说直接通过包名.Info这样子打印日志，其实用的是logrus里默认的一个Logger对象（这也就意味着我们后面可以自定义logger对象）。发现默认的logger打印级别是info，这也就意味着info以下的级别日志是不打印的，这也就解释了为什么刚刚输出那里没有trace和debug信息。也就是logrus.Info()最后会变成调用Loger对象里的Log()方法，并将InfoLevel常数传入，直觉告诉我们接下来的级别判断就在这个方法里面。
2024年Go最全golang日志框架之logrus，0基础学Golang
最新发布
2401_84924864的博客
05-17 760
logrus的一个很致命的问题就是没有提供文件名和行号，这在大型项目中通过日志定位问题时有诸多不便。的调用者开始，到记录日志的生成代码之间，大概有8到11层左右，所有我们在hook中循环第8到11层调用栈应该可以找到日志记录的生产代码。logrus最令人心动的功能就是其可扩展的HOOK机制了，通过在初始化时为logrus添加hook，logrus可以实现各种扩展功能。函数可以返回当前goroutine调用栈中的文件名，行号，函数信息等，参数skip表示表示返回的栈帧的层次，0表示。进行日志本地文件分割。
golang常用库之-日志框架包 zap库、go-log 库、golong 日志框架选型 logrus还是uber zap？
西京刀客
05-31 1240
在 Go 项目开发中，我们可以通过修改一些优秀的开源日志包，来实现项目的日志包。Go 生态中有很多优秀的开源日志包，例如标准库 log 包、glog、logrus、zap、seelog、zerolog、log15、apex/log、go-logging 等。其中，用得比较多的是标准库 log 包、glog、logrus 和 zap。
go-admin框架分析（3）—日志系统
lsjweiyi的博客
02-23 1217
代码地址：https://gitee.com/lsjWeiYi/go-admin/tree/logger/ logger分支 go-admin的日志系统看起来很详细，真的是整个流程的每个过程都有记录，而且他贯穿了整个框架，它封装了非常多的模块。里面都和日志系统强耦合。 优点： 丰富的日志，对复杂系统的运维非常有帮助。 开发人员无需关注http请求和数据库操作的日志记录，只需要关注业务 对于分布式系统，能够做到同一请求的日志唯一ID追踪。 缺点： 耦合在整个框架中，无法单独剥离下来 也许会占用系统的
Golang log日志以及日志框架logrus
啊阿啊啊啊杨的博客
06-13 2004
logrus是目前github上star数量最多的日志库。logrus功能强大，性能高效，而且具备高度灵活性，logrus是一个可插拔的，结构化的日志框架，提供了自定义插件的功能，如docker prometheus等，都是用了logrus来记录日志。
Kratos、go-zero、kitex、Goyek那个架构最好
06-12
这个问题很难回答，因为每个微服务框架都有自己的优缺点，选择适合自己的框架需要考虑多个方面，比如性能、易用性、可扩展性等等。 Kratos是由B站开发的一个基于Go Micro的微服务框架，它提供了自动化代码生成、服务治理、中间件扩展等功能，适合快速开发微服务应用。 go-zero是由知乎开发的一个基于Go Micro的微服务框架，它支持自动化代码生成、服务治理、中间件扩展等功能，同时还提供了RPC和HTTP两种API风格。 kitex是由腾讯开发的一个基于Go Micro的高性能微服务框架，它支持多种协议和传输方式，具有较好的性能和稳定性。 Goyek是由小红书开发的一个基于Go Micro的微服务框架，它支持自动化代码生成、服务治理、中间件扩展等功能，同时还提供了HTTP和GraphQL两种API风格。 总的来说，这些框架都有自己的特点和优点，选择哪个框架需要根据自己的需求进行权衡和选择。如果你需要一个高性能的微服务框架，可以考虑选择kitex；如果你需要一个易用性好的微服务框架，可以考虑选择Kratos或go-zero；如果你需要一个支持GraphQL的微服务框架，可以选择Goyek。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值