GoFrame 框架（rk-boot）：实现分布式日志追踪

原创

尹东勋

发布于 2022-01-22 02:21:06

6310

发布于 2022-01-22 02:21:06

文章被收录于专栏：开源 & 技术分享

介绍

通过一个完整例子，基于 gogf/gf 框架实现分布式日志追踪。

什么是 API 日志追踪？
一个 API 请求会跨多个微服务，我们希望通过一个唯一的 ID 检索到整个链路的日志。

我们将会使用 rk-boot 来启动 gogf/gf 微服务。

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

https://rkdocs.netlify.app/cn

安装

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

快速开始

我们会创建 /v1/greeter API 进行验证，同时开启 logging, meta 和 tracing 中间件以达到目的。

1. 创建 bootA.yaml & serverA.go

ServerA 监听 1949 端口，并且发送请求给 ServerB。

我们通过 rkgfctx.InjectSpanToNewContext() 方法把 Tracing 信息注入到 Context 中，发送给 ServerB。

---
gf:
  - name: greeter                   # Required
    port: 1949                      # Required
    enabled: true                   # Required
    interceptors:
      loggingZap:
        enabled: true               # Optional, enable logging interceptor
      meta:
        enabled: true               # Optional, enable meta interceptor
      tracingTelemetry:
        enabled: true               # Optional, enable tracing interceptor

// Copyright (c) 2021 rookie-ninja
//
// Use of this source code is governed by an Apache-style
// license that can be found in the LICENSE file.

package main

import (
	"context"
	"github.com/gogf/gf/v2/net/ghttp"
	"github.com/rookie-ninja/rk-boot"
	"github.com/rookie-ninja/rk-boot/gf"
	"github.com/rookie-ninja/rk-gf/interceptor/context"
	"net/http"
)

// Application entrance.
func main() {
	// Create a new boot instance.
	boot := rkboot.NewBoot(rkboot.WithBootConfigPath("bootA.yaml"))

	// Register handler
	entry := rkbootgf.GetGfEntry("greeter")
	entry.Server.BindHandler("/v1/greeter", GreeterA)

	// Bootstrap
	boot.Bootstrap(context.TODO())

	boot.WaitForShutdownSig(context.TODO())
}

// GreeterA will add trace info into context and call serverB
func GreeterA(ctx *ghttp.Request) {
	// Call serverB at 2008
	req, _ := http.NewRequest(http.MethodGet, "http://localhost:2008/v1/greeter", nil)

	// Inject current trace information into context
	rkgfctx.InjectSpanToHttpRequest(ctx, req)

	// Call server
	http.DefaultClient.Do(req)

	ctx.Response.WriteHeader(http.StatusOK)
	ctx.Response.Write("Hello from serverA!")
}

2. 创建 bootB.yaml & serverB.go

ServerB 监听 2008 端口。

---
gf:
  - name: greeter                   # Required
    port: 2008                      # Required
    enabled: true                   # Required
    interceptors:
      loggingZap:
        enabled: true               # Optional, enable logging interceptor
      meta:
        enabled: true               # Optional, enable meta interceptor
      tracingTelemetry:
        enabled: true               # Optional, enable tracing interceptor

// Copyright (c) 2021 rookie-ninja
//
// Use of this source code is governed by an Apache-style
// license that can be found in the LICENSE file.

package main

import (
	"context"
	"github.com/gogf/gf/v2/net/ghttp"
	"github.com/rookie-ninja/rk-boot"
	"github.com/rookie-ninja/rk-boot/gf"
	"net/http"
)

// Application entrance.
func main() {
	// Create a new boot instance.
	boot := rkboot.NewBoot(rkboot.WithBootConfigPath("bootB.yaml"))

	// Register handler
	entry := rkbootgf.GetGfEntry("greeter")
	entry.Server.BindHandler("/v1/greeter", GreeterB)

	// Bootstrap
	boot.Bootstrap(context.TODO())

	boot.WaitForShutdownSig(context.TODO())
}

// GreeterB will add trace info into context and call serverB
func GreeterB(ctx *ghttp.Request) {
	ctx.Response.WriteHeader(http.StatusOK)
	ctx.Response.Write("Hello from serverB!")
}

3. 文件夹结构

.
├── bootA.yaml
├── bootB.yaml
├── go.mod
├── go.sum
├── serverA.go
└── serverB.go

0 directories, 6 files

4. 启动 ServerA & ServerB

$ go run serverA.go
$ go run serverB.go

5. 往 ServerA 发送请求

$ curl localhost:1949/v1/greeter
Hello from serverA!

6. 验证日志

两个服务的日志中，会有同样的 traceId，不同的 requestId。

我们可以通过 grep traceId 来追踪 RPC。

ServerA

------------------------------------------------------------------------
endTime=2022-01-22T02:11:19.946305+08:00
...
ids={"eventId":"4092f609-bc5d-4b61-abef-7910f417fc36","requestId":"4092f609-bc5d-4b61-abef-7910f417fc36","traceId":"bb272da5fbf68182037bd7a3bdcb8a8b"}
...
operation=/v1/greeter
resCode=200
eventStatus=Ended
EOE

ServerB

------------------------------------------------------------------------
endTime=2022-01-22T02:11:19.946091+08:00
...
ids={"eventId":"dbb4b360-86f8-4dfe-aa4c-ef8dae5686d8","requestId":"dbb4b360-86f8-4dfe-aa4c-ef8dae5686d8","traceId":"bb272da5fbf68182037bd7a3bdcb8a8b"}
...
operation=/v1/greeter
resCode=200
eventStatus=Ended
EOE

概念

当我们没有使用例如 jaeger 调用链服务的时候，我们希望通过日志来追踪分布式系统里的 RPC 请求。

rk-boot 的中间件会通过 openTelemetry 库来向日志写入 traceId 来追踪 RPC。

当启动了日志中间件，原数据中间件，调用链中间件的时候，中间件会往日志里写入如下三种 ID。

EventId

当启动了日志中间件，EventId 会自动生成。

---
gf:
  - name: greeter                   # Required
    port: 1949                      # Required
    enabled: true                   # Required
    interceptors:
      loggingZap:
        enabled: true

------------------------------------------------------------------------
...
ids={"eventId":"cd617f0c-2d93-45e1-bef0-95c89972530d"}
...

RequestId

当启动了日志中间件和原数据中间件，RequestId 和 EventId 会自动生成，并且这两个 ID 会一致。

---
gf:
  - name: greeter                   # Required
    port: 1949                      # Required
    enabled: true                   # Required
    interceptors:
      loggingZap:
        enabled: true
      meta:
        enabled: true

------------------------------------------------------------------------
...
ids={"eventId":"8226ba9b-424e-4e19-ba63-d37ca69028b3","requestId":"8226ba9b-424e-4e19-ba63-d37ca69028b3"}
...

即使用户覆盖了 RequestId，EventId 也会保持一致。

rkgfctx.AddHeaderToClient(ctx, rkmid.HeaderRequestId, "overridden-request-id")

------------------------------------------------------------------------
...
ids={"eventId":"overridden-request-id","requestId":"overridden-request-id"}
...

TraceId

当启动了调用链中间件，traceId 会自动生成。

---
gf:
  - name: greeter                   # Required
    port: 1949                      # Required
    enabled: true                   # Required
    interceptors:
      loggingZap:
        enabled: true
      meta:
        enabled: true
      tracingTelemetry:
        enabled: true

------------------------------------------------------------------------
...
ids={"eventId":"dd19cf9a-c7be-486c-b29d-7af777a78ebe","requestId":"dd19cf9a-c7be-486c-b29d-7af777a78ebe","traceId":"316a7b475ff500a76bfcd6147036951c"}
...

原创声明：本文系作者授权腾讯云开发者社区发表，未经许可，不得转载。

如有侵权，请联系 cloudcommunity@tencent.com 删除。

微服务