GRPC: 如何合理管理日志配置?-阿里云开发者社区

开发者社区> 尹东勋> 正文

GRPC: 如何合理管理日志配置?

简介: 本文介绍如何在 gRPC 场景下使用日志。将使用 rk-boot 来管理日志配置。
+关注继续查看

介绍

本文介绍如何在 gRPC 场景下使用日志。将使用 rk-boot 来管理日志配置。

有什么使用场景?

  • 日志自动滚动
  • 分成多个日志文件
  • 日志格式修改
  • 等等

请访问如下地址获取完整教程:

安装

go get github.com/rookie-ninja/rk-boot

简述概念

rk-boot 使用如下两个库管理日志。

rk-boot 定义了两种日志类型,会在后面详细介绍,这里先做个简短介绍。

  • ZapLogger: 标准日志,用于记录 Error, Info 等。
  • EventLogger: JSON 或者 Console 格式,用于记录 Event,例如 RPC 请求。

快速开始

在这个例子中,我们会试着改变 zap 日志的路径和格式。

1.创建 boot.yaml

---
zapLogger:
  - name: zap-log                      # Required
    zap:
      encoding: json
      outputPaths: ["logs/zap.log"]
grpc:
  - name: greeter
    port: 8080
    enabled: true

2.创建 main.go

往 zap-log 日志实例中写个日志。

package main

import (
    "context"
    "github.com/rookie-ninja/rk-boot"
    "github.com/rookie-ninja/rk-entry/entry"
)

func main() {
    // Create a new boot instance.
    boot := rkboot.NewBoot()

    // Bootstrap
    boot.Bootstrap(context.Background())

    // Write zap log
    rkentry.GlobalAppCtx.GetZapLoggerEntry("zap-log").GetLogger().Info("This is zap-log")

    // Wait for shutdown sig
    boot.WaitForShutdownSig(context.Background())
}

3.启动 main.go

$ go run main.go

4.验证

文件夹结构以及日志内容。

├── boot.yaml
├── go.mod
├── go.sum
├── logs
│   └── zap.log
└── main.go
{"level":"INFO","ts":"2021-10-21T02:10:09.279+0800","msg":"This is zap-log"}

配置 EventLogger

上面的例子中,我们配置了 zap 日志,这回我们修改一下 EventLogger。

1.创建 boot.yaml

---
eventLogger:
  - name: event-log                 # Required
    encoding: console
    outputPaths: ["logs/event.log"]
grpc:
  - name: greeter
    port: 8080
    enabled: true

2.创建 main.go

往 event-log 实例中写入日志。

package main

import (
    "context"
    "github.com/rookie-ninja/rk-boot"
    "github.com/rookie-ninja/rk-entry/entry"
)

func main() {
    // Create a new boot instance.
    boot := rkboot.NewBoot()

    // Bootstrap
    boot.Bootstrap(context.Background())

    // Write event log
    helper := rkentry.GlobalAppCtx.GetEventLoggerEntry("event-log").GetEventHelper()
    event := helper.Start("demo-event")
    event.AddPair("key", "value")
    helper.Finish(event)

    // Wait for shutdown sig
    boot.WaitForShutdownSig(context.Background())
}

3.启动 main.go

$ go run main.go

4.验证

文件夹结构以及日志内容。

├── boot.yaml
├── go.mod
├── go.sum
├── logs
│   └── event.log
└── main.go
{"endTime": "2021-10-21T02:22:58.118+0800", "startTime": "2021-10-21T02:22:58.118+0800", "elapsedNano": 409, "timezone": "CST", "ids": {"eventId":"510a050f-c31e-4f50-8d6e-3b836ba1ef17"}, "app": {"appName":"demo","appVersion":"master-7d51358","entryName":"","entryType":""}, "env": {"arch":"amd64","az":"*","domain":"*","hostname":"lark.local","localIP":"10.8.0.2","os":"darwin","realm":"*","region":"*"}, "payloads": {}, "error": {}, "counters": {}, "pairs": {"key":"value"}, "timing": {}, "remoteAddr": "localhost", "operation": "demo-event", "eventStatus": "Ended", "resCode": "OK"}

概念

上面的例子中,我们尝试了 ZapLogger 和 EventLogger。接下来我们看看 rk-boot 是如何实现的,并且怎么使用。

架构

ZapLoggerEntry

ZapLoggerEntry 是 zap 实例的一个封装。

// ZapLoggerEntry contains bellow fields.
// 1: EntryName: Name of entry.
// 2: EntryType: Type of entry which is ZapLoggerEntryType.
// 3: EntryDescription: Description of ZapLoggerEntry.
// 4: Logger: zap.Logger which was initialized at the beginning.
// 5: LoggerConfig: zap.Logger config which was initialized at the beginning which is not accessible after initialization..
// 6: LumberjackConfig: lumberjack.Logger which was initialized at the beginning.
type ZapLoggerEntry struct {
    EntryName        string             `yaml:"entryName" json:"entryName"`
    EntryType        string             `yaml:"entryType" json:"entryType"`
    EntryDescription string             `yaml:"entryDescription" json:"entryDescription"`
    Logger           *zap.Logger        `yaml:"-" json:"-"`
    LoggerConfig     *zap.Config        `yaml:"zapConfig" json:"zapConfig"`
    LumberjackConfig *lumberjack.Logger `yaml:"lumberjackConfig" json:"lumberjackConfig"`
}

如何在 boot.yaml 里配置 ZapLoggerEntry?

ZapLoggerEntry 完全兼容 zaplumberjack 的 YAML 结构。
用户可以根据需求,配置多个 ZapLogger 实例,并且通过 name 来访问。

完整配置:

---
zapLogger:
  - name: zap-logger                      # Required
    description: "Description of entry"   # Optional
    zap:
      level: info                         # Optional, default: info, options: [debug, DEBUG, info, INFO, warn, WARN, dpanic, DPANIC, panic, PANIC, fatal, FATAL]
      development: true                   # Optional, default: true
      disableCaller: false                # Optional, default: false
      disableStacktrace: true             # Optional, default: true
      sampling:                           # Optional, default: empty map
        initial: 0
        thereafter: 0
      encoding: console                   # Optional, default: "console", options: [console, json]
      encoderConfig:
        messageKey: "msg"                 # Optional, default: "msg"
        levelKey: "level"                 # Optional, default: "level"
        timeKey: "ts"                     # Optional, default: "ts"
        nameKey: "logger"                 # Optional, default: "logger"
        callerKey: "caller"               # Optional, default: "caller"
        functionKey: ""                   # Optional, default: ""
        stacktraceKey: "stacktrace"       # Optional, default: "stacktrace"
        lineEnding: "\n"                  # Optional, default: "\n"
        levelEncoder: "capitalColor"      # Optional, default: "capitalColor", options: [capital, capitalColor, color, lowercase]
        timeEncoder: "iso8601"            # Optional, default: "iso8601", options: [rfc3339nano, RFC3339Nano, rfc3339, RFC3339, iso8601, ISO8601, millis, nanos]
        durationEncoder: "string"         # Optional, default: "string", options: [string, nanos, ms]
        callerEncoder: ""                 # Optional, default: ""
        nameEncoder: ""                   # Optional, default: ""
        consoleSeparator: ""              # Optional, default: ""
      outputPaths: [ "stdout" ]           # Optional, default: ["stdout"], stdout would be replaced if specified
      errorOutputPaths: [ "stderr" ]      # Optional, default: ["stderr"], stderr would be replaced if specified
      initialFields:                      # Optional, default: empty map
        key: "value"
    lumberjack:                           # Optional
      filename: "rkapp-event.log"         # Optional, default: It uses <processname>-lumberjack.log in os.TempDir() if empty.
      maxsize: 1024                       # Optional, default: 1024 (MB)
      maxage: 7                           # Optional, default: 7 (days)
      maxbackups: 3                       # Optional, default: 3 (days)
      localtime: true                     # Optional, default: true
      compress: true                      # Optional, default: true

如何在代码里获取 ZapLogger?

通过 name 来访问。

// Access entry
rkentry.GlobalAppCtx.GetZapLoggerEntry("zap-logger")

// Access zap logger
rkentry.GlobalAppCtx.GetZapLoggerEntry("zap-logger").GetLogger()

// Access zap logger config
rkentry.GlobalAppCtx.GetZapLoggerEntry("zap-logger").GetLoggerConfig()

// Access lumberjack config
rkentry.GlobalAppCtx.GetZapLoggerEntry("zap-logger").GetLumberjackConfig()

EventLoggerEntry

rk-boot 把每一个 RPC 请求看作一个 Event,并且使用 rk-query 中的 Event 类型来记录日志。

// EventLoggerEntry contains bellow fields.
// 1: EntryName: Name of entry.
// 2: EntryType: Type of entry which is EventLoggerEntryType.
// 3: EntryDescription: Description of EventLoggerEntry.
// 4: EventFactory: rkquery.EventFactory was initialized at the beginning.
// 5: EventHelper: rkquery.EventHelper was initialized at the beginning.
// 6: LoggerConfig: zap.Config which was initialized at the beginning which is not accessible after initialization.
// 7: LumberjackConfig: lumberjack.Logger which was initialized at the beginning.
type EventLoggerEntry struct {
    EntryName        string                `yaml:"entryName" json:"entryName"`
    EntryType        string                `yaml:"entryType" json:"entryType"`
    EntryDescription string                `yaml:"entryDescription" json:"entryDescription"`
    EventFactory     *rkquery.EventFactory `yaml:"-" json:"-"`
    EventHelper      *rkquery.EventHelper  `yaml:"-" json:"-"`
    LoggerConfig     *zap.Config           `yaml:"zapConfig" json:"zapConfig"`
    LumberjackConfig *lumberjack.Logger    `yaml:"lumberjackConfig" json:"lumberjackConfig"`
}

EventLogger 字段

我们可以看到 EventLogger 打印出来的日志里,包含字段,介绍一下这些字段。

字段详情
endTime结束时间
startTime开始时间
elapsedNanoEvent 时间开销(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() 来操作。
remoteAddrRPC 远程地址。
operationRPC 名字。
resCodeRPC 返回码。
eventStatusEnded 或者 InProgress

例子

------------------------------------------------------------------------
endTime=2021-07-10T03:00:12.153392+08:00
startTime=2021-07-10T03:00:12.153261+08:00
elapsedNano=130727
timezone=CST
ids={"eventId":"c9a1f6b0-b9ec-4e46-9ed4-238c3c6759ab","requestId":"c9a1f6b0-b9ec-4e46-9ed4-238c3c6759ab","traceId":"5441ff5c3855f03b573e95d81139123b"}
app={"appName":"rk-demo","appVersion":"master-f414049","entryName":"greeter","entryType":"GrpcEntry"}
env={"arch":"amd64","az":"*","domain":"*","hostname":"lark.local","localIP":"10.8.0.2","os":"darwin","realm":"*","region":"*"}
payloads={"grpcMethod":"Greeter","grpcService":"api.v1.Greeter","grpcType":"unaryServer","gwMethod":"GET","gwPath":"/v1/greeter","gwScheme":"http","gwUserAgent":"curl/7.64.1"}
error={}
counters={}
pairs={}
timing={}
remoteAddr=localhost:59631
operation=/api.v1.Greeter/Greeter
resCode=OK
eventStatus=Ended
EOE

如何在 boot.yaml 里配置 EventLoggerEntry?

EventLoggerEntry 将会把 Application 名字注入到 Event 中。启动器会从 go.mod 文件中提取 Application 名字。 如果没有 go.mod 文件,启动器会使用默认的名字。

用户可以根据需求,配置多个 EventLogger 实例,并且通过 name 来访问。

完整配置:

---
eventLogger:
  - name: event-logger                 # Required
    description: "This is description" # Optional
    encoding: console                  # Optional, default: console, options: console and json
    outputPaths: ["stdout"]            # Optional
    lumberjack:                        # Optional
      filename: "rkapp-event.log"      # Optional, default: It uses <processname>-lumberjack.log in os.TempDir() if empty.
      maxsize: 1024                    # Optional, default: 1024 (MB)
      maxage: 7                        # Optional, default: 7 (days)
      maxbackups: 3                    # Optional, default: 3 (days)
      localtime: true                  # Optional, default: true
      compress: true                   # Optional, default: true

如何在代码里获取 EventLogger?

通过 name 来访问。

// Access entry
rkentry.GlobalAppCtx.GetEventLoggerEntry("event-logger")

// Access event factory
rkentry.GlobalAppCtx.GetEventLoggerEntry("event-logger").GetEventFactory()

// Access event helper
rkentry.GlobalAppCtx.GetEventLoggerEntry("event-logger").GetEventHelper()

// Access lumberjack config
rkentry.GlobalAppCtx.GetEventLoggerEntry("event-logger").GetLumberjackConfig()

如何使用 Event?

Event 是一个 interface,包含了若干方法,请参考:Event

常用方法:

// Get EventHelper to create Event instance
helper := rkentry.GlobalAppCtx.GetEventLoggerEntry("event-log").GetEventHelper()

// Start and finish event
event := helper.Start("demo-event")
helper.Finish(event)

// Add K/V
event.AddPair("key", "value")

// Start and end timer
event.StartTimer("my-timer")
event.EndTimer("my-timer")

// Set counter
event.SetCounter("my-counter", 1)

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
RHEL5下的OpenVZ安装与配置
[root@localhost ~]# cd /etc/yumyum/ yum.conf yum.repos.d/ [root@localhost ~]# cd /etc/yum.
556 0
Keepalived 日志配置与启动配置
在Redhat系统下,可以使用下面的方法将keepalived的日志输出到/var/log/下的某个文件里:  1.将keepalived日志输出到local0:  vim /etc/sysconfig/keepalived  KEEPALIVED_OPTIONS="-D -d -S 0"  2.
1669 0
Rhel5.5配置Centos yum源
ruiy哥,抛砖引玉 当你使用rhel系统时,[大部分数据库中心及政府企业选择linux服务器时通常考虑采购的版本一般不外乎是Rhel红帽及Suse,理由你懂的EcoSystem!]你没有一个红帽网络公司订阅,你是没法使用Rhel上的yum功能,yum是红帽Linux在线更新安装软件的工具,前面提到的红帽网络订阅即RHN是一项收费的服务项目。
1062 0
5月安全新品播课(1)|混合云下割裂的Web安全管理挑战如何破?
阿里云WAF推出混合云安全解决方案,实现多云环境下的统一管理
263 0
+关注
尹东勋
点目科技创始人
61
文章
0
问答
文章排行榜
最热
最新
相关电子书
更多
文娱运维技术
立即下载
《SaaS模式云原生数据仓库应用场景实践》
立即下载
《看见新力量:二》电子书
立即下载