GRPC: 如何添加 API 日志拦截器/中间件？_腾讯云代理,腾讯云代理商,腾讯云优惠折扣-深圳航网科技有限公司

| 2019-05-17

介绍

本文将介绍如何在 gRPC 微服务中添加 API 日志拦截器/中间件。

什么是日志拦截器/中间件？

日志拦截器会对每一个 API 请求记录日志。

我们将会使用 rk-boot 来启动 gRPC 服务。

请访问如下地址获取完整教程：https://rkdev.info/cn

https://rkdocs.netlify.app/cn (备用)

安装

快速开始

rk-boot 默认集成如下两个开源库。

uber-go/zap 作为底层的日志库。

logrus 作为日志滚动。

1.创建 boot.yaml

为了验证，我们同时启动了 commonService。commonService 里包含了一系列通用 API。

详情: CommonService

grpc 默认会启动 grpc-gateway 来提供 Restful API 服务。在验证的时候，我们可以直接发送 Restful 请求。

2.创建 main.go

3.文件夹结构

3.验证

发送请求

验证日志

默认输出到 stdout（控制台）。

下面的日志格式来自 rk-query ，用户也可以选择 JSON 格式，我们稍后会介绍。

修改日志格式

我们可以通过修改 boot.yaml 来修改日志格式。

目前支持 json 和 console 两种格式，默认为 console。

通过修改 eventLoggerEncoding 的值为 json，我们可以把日志的输出为 JSON 格式。

修改日志路径

通过修改 eventLoggerOutputPaths 的值，可以指定输出路径。

日志默认在 1GB 之后，进行切割，并压缩。

概念

验证了日志拦截器，我们来具体讲一下 rk-boot 提供的日志拦截器都有哪些功能。

我们需要提前了解两个概念。

EventLogger

ZapLogger

ZapLogger

EventLogger

RK 启动器把每一个 RPC 请求视作 Event，并且使用 rk-query 中的 Event 类型来记录日志。

字段	详情
endTime	结束时间
startTime	开始时间
elapsedNano	Event 时间开销（Nanoseconds）
timezone	时区
ids	包含 eventId, requestId 和 traceId。如果原数据拦截器被启动，或者 event.SetRequest() 被用户调用，新的 RequestId 将会被使用，同时 eventId 与 requestId 会一模一样。如果调用链拦截器被启动，traceId 将会被记录。
app	包含 appName, appVersion, entryName, entryType。
env	包含 arch, az, domain, hostname, localIP, os, realm, region. realm, region, az, domain 字段。这些字段来自系统环境变量（REALM，REGION，AZ，DOMAIN）。 "*" 代表环境变量为空。
payloads	包含 RPC 相关信息。
error	包含错误。
counters	通过 event.SetCounter() 来操作。
pairs	通过 event.AddPair() 来操作。
timing	通过 event.StartTimer() 和 event.EndTimer() 来操作。
remoteAddr	RPC 远程地址。
operation	RPC 名字。
resCode	RPC 返回码。
eventStatus	Ended 或者 InProgress

日志拦截器选项

名字	描述	类型	默认值
grpc.interceptors.loggingZap.enabled	启动日志拦截器	boolean	false
grpc.interceptors.loggingZap.zapLoggerEncoding	日志格式：json 或者 console	string	console
grpc.interceptors.loggingZap.zapLoggerOutputPaths	日志文件路径	[]string	stdout
grpc.interceptors.loggingZap.eventLoggerEncoding	日志格式：json 或者 console	string	console
grpc.interceptors.loggingZap.eventLoggerOutputPaths	日志文件路径	[]string	false