GoFrame 框架：日志配置管理

lsekfe

　安装

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

简述概念
　　rk-boot 使用如下两个库管理日志。
　　·zap 管理日志实例
　　· lumberjack 管理日志滚动
　　rk-boot 定义了两种日志类型，会在后面详细介绍，这里先做个简短介绍。
　　· ZapLogger: 标准日志，用于记录 Error, Info 等。
　　· EventLogger: JSON 或者 Console 格式，用于记录 Event，例如 RPC 请求。
　　快速开始
　　在这个例子中，我们会试着改变 zap 日志的路径和格式。
　　1.创建 boot.yaml

---
　　zapLogger:
　　  - name: zap-log                        # Required
　　    zap:
　　      encoding: json                     # Optional, options: console, json
　　      outputPaths: ["logs/zap.log"]      # Optional
　　gf:
　　  - name: greeter
　　    port: 8080
　　    enabled: true

　2.创建 main.go
　　往 zap-log 日志实例中写个日志。

1. // Copyright (c) 2021 rookie-ninja
   
2. 　　//
   
3. 　　// Use of this source code is governed by an Apache-style
   
4. 　　// license that can be found in the LICENSE file.
   
5. 　　package main
   
6. 　　import (
   
7. 　　"context"
   
8. 　　"github.com/rookie-ninja/rk-boot"
   
9. 　　_ "github.com/rookie-ninja/rk-boot/gf"
   
10. 　　)
    
11. 　　func main() {
    
12. 　　// Create a new boot instance.
    
13. 　　boot := rkboot.NewBoot()
    
14. 　　// Bootstrap
    
15. 　　boot.Bootstrap(context.Background())
    
16. 　　// Write zap log
    
17. 　　boot.GetZapLoggerEntry("zap-log").GetLogger().Info("This is zap-log")
    
18. 　　// Wait for shutdown sig
    
19. 　　boot.WaitForShutdownSig(context.Background())
    
20. 　　}

复制代码

　3.验证
　　文件夹结构

1. 　├── boot.yaml
   
2. 　　├── go.mod
   
3. 　　├── go.sum
   
4. 　　├── logs
   
5. 　　│   └── zap.log
   
6. 　　└── main.go

复制代码

　日志输出

1. 　　{"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: json                       # Optional, options: console, json
　　    outputPaths: ["logs/event.log"]      # Optional
　　gf:
　　  - name: greeter
　　    port: 8080
　　    enabled: true

　2.创建 main.go
　　往 event-log 实例中写入日志。

1. package main
   
2. 　　import (
   
3. 　　"context"
   
4. 　　"github.com/rookie-ninja/rk-boot"
   
5. 　　"github.com/rookie-ninja/rk-entry/entry"
   
6. 　　)
   
7. 　　func main() {
   
8. 　　// Create a new boot instance.
   
9. 　　boot := rkboot.NewBoot()
   
10. 　　// Bootstrap
    
11. 　　boot.Bootstrap(context.Background())
    
12. 　　// Write event log
    
13. 　　helper := boot.GetEventLoggerEntry("event-log").GetEventHelper()
    
14. 　　event := helper.Start("demo-event")
    
15. 　　event.AddPair("key", "value")
    
16. 　　helper.Finish(event)
    
17. 　　// Wait for shutdown sig
    
18. 　　boot.WaitForShutdownSig(context.Background())
    
19. 　　}

复制代码

3.启动 main.go

　　$ go run main.go

4.验证
　　文件夹结构

1. ├── boot.yaml
   
2. 　　├── go.mod
   
3. 　　├── go.sum
   
4. 　　├── logs
   
5. 　　│   └── event.log
   
6. 　　└── main.go

复制代码

日志内容

1. {"endTime": "2022-01-18T22:18:44.926+0800", "startTime": "2022-01-18T22:18:44.926+0800", "elapsedNano": 746, "timezone": "CST", "ids": {"eventId":"2aaea6f5-c7ac-4245-ac50-857726f3ede4"}, "app": {"appName":"rk","appVersion":"","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 实例的一个封装。

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

复制代码

　如何在 boot.yaml 里配置 ZapLoggerEntry?
　　ZapLoggerEntry 完全兼容 zap 和 lumberjack 的 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 来访问。

1. 　boot := rkboot.NewBoot()
   
2. 　　// Access entry
   
3. 　　boot.GetZapLoggerEntry("zap-logger")
   
4. 　　// Access zap logger
   
5. 　　boot.GetZapLoggerEntry("zap-logger").GetLogger()
   
6. 　　// Access zap logger config
   
7. 　　boot.GetZapLoggerEntry("zap-logger").GetLoggerConfig()
   
8. 　　// Access lumberjack config
   
9. 　　boot.GetZapLoggerEntry("zap-logger").GetLumberjackConfig()

复制代码

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

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

复制代码

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

例子

------------------------------------------------------------------------
　　endTime=2021-11-27T02:30:27.670807+08:00
　　startTime=2021-11-27T02:30:27.670745+08:00
　　elapsedNano=62536
　　timezone=CST
　　ids={"eventId":"4bd9e16b-2b29-4773-8908-66c860bf6754"}
　　app={"appName":"gf-demo","appVersion":"master-f948c90","entryName":"greeter","entryType":"GfEntry"}
　　env={"arch":"amd64","az":"*","domain":"*","hostname":"lark.local","localIP":"10.8.0.6","os":"darwin","realm":"*","region":"*"}
　　payloads={"apiMethod":"GET","apiPath":"/rk/v1/healthy","apiProtocol":"HTTP/1.1","apiQuery":"","userAgent":"curl/7.64.1"}
　　error={}
　　counters={}
　　pairs={}
　　timing={}
　　remoteAddr=localhost:61726
　　operation=/rk/v1/healthy
　　resCode=200
　　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 来访问。

1. 　boot := rkboot.NewBoot()
   
2. 　　// Access entry
   
3. 　　boot.GetEventLoggerEntry("event-logger")
   
4. 　　// Access event factory
   
5. 　　boot.GetEventLoggerEntry("event-logger").GetEventFactory()
   
6. 　　// Access event helper
   
7. 　　boot.GetEventLoggerEntry("event-logger").GetEventHelper()
   
8. 　　// Access lumberjack config
   
9. 　　boot.GetEventLoggerEntry("event-logger").GetLumberjackConfig()

复制代码

　如何使用 Event?
　　Event 是一个 interface，包含了若干方法，请参考：Event
　　常用方法：

1. 　boot := rkboot.NewBoot()
   
2. 　　// Get EventHelper to create Event instance
   
3. 　　helper := boot.GetEventLoggerEntry("event-log").GetEventHelper()
   
4. 　　// Start and finish event
   
5. 　　event := helper.Start("demo-event")
   
6. 　　helper.Finish(event)
   
7. 　　// Add K/V
   
8. 　　event.AddPair("key", "value")
   
9. 　　// Start and end timer
   
10. 　　event.StartTimer("my-timer")
    
11. 　　event.EndTimer("my-timer")
    
12. 　　// Set counter
    
13. 　　event.SetCounter("my-counter", 1)

复制代码