Golang Gin框架中间件插件rk-gin实现日志监控认证链路追踪功能

rk-gin是一个为Gin框架提供中间件和服务器配置注入的插件，它属于rk-boot家族的一部分。通过YAML文件配置，可以快速启用日志、监控、认证和链路追踪等功能。

架构

快速入门

以下示例展示了如何通过YAML配置启动一个包含以下功能的微服务：

• Gin服务器
• Swagger UI
• 文档
• 通用服务
• Prometheus指标（中间件）
• 日志（中间件）
• 元数据（中间件）

1. 安装

go get github.com/rookie-ninja/rk-gin/v2

2. 创建boot.yaml

---
gin:
  - name: greeter                     # 必填
    port: 8080                        # 必填
    enabled: true                     # 必填
    commonService:                    # 可选
      enabled: true                   # 可选，默认: false
    sw:                               # 可选
      enabled: true                   # 可选，默认: false
    docs:                             # 可选
      enabled: true                   # 可选，默认: false
    prom:
      enabled: true                   # 可选，默认: false
    middleware:
      logging:
        enabled: true
      prom:
        enabled: true
      meta:
        enabled: true

3. 创建main.go

// 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"
	"embed"
	_ "embed"
	"fmt"
	"github.com/gin-gonic/gin"
	"github.com/rookie-ninja/rk-entry/v2/entry"
	"github.com/rookie-ninja/rk-gin/v2/boot"
	"net/http"
)

// 使用embed.FS嵌入文件
//go:embed docs
var docsFS embed.FS

func init() {
	rkentry.GlobalAppCtx.AddEmbedFS(rkentry.SWEntryType, "greeter", &docsFS)
}

//go:embed boot.yaml
var boot []byte

// @title RK Swagger for Gin
// @version 1.0
// @description This is a greeter service with rk-boot.
func main() {
	// 预加载入口
	rkentry.BootstrapPreloadEntryYAML(boot)

	// 从boot配置注册Gin入口
	res := rkgin.RegisterGinEntryYAML(boot)

	// 获取GinEntry
	ginEntry := res["greeter"].(*rkgin.GinEntry)
	ginEntry.Router.GET("/v1/greeter", Greeter)

	// 启动Gin入口
	ginEntry.Bootstrap(context.Background())

	// 等待关闭信号
	rkentry.GlobalAppCtx.WaitForShutdownSig()

	// 中断Gin入口
	ginEntry.Interrupt(context.Background())
}

// Greeter handler
// @Summary Greeter service
// @Id 1
// @version 1.0
// @produce application/json
// @Param name query string true "Input name"
// @Success 200 {object} GreeterResponse
// @Router /v1/greeter [get]
func Greeter(ctx *gin.Context) {
	ctx.JSON(http.StatusOK, &GreeterResponse{
		Message: fmt.Sprintf("Hello %s!", ctx.Query("name")),
	})
}

type GreeterResponse struct {
	Message string
}

4. 启动服务器

$ go run main.go

5. 验证

5.1 Gin服务器

测试通用服务：

$ curl localhost:8080/rk/v1/ready
{
  "ready": true
}

$ curl localhost:8080/rk/v1/alive
{
  "alive": true
}

5.2 Swagger UI

默认情况下，我们可以通过http://localhost:8080/sw访问Swagger UI。

5.3 文档UI

默认情况下，我们可以通过http://localhost:8080/docs访问文档UI。

5.4 Prometheus指标

默认情况下，我们可以通过http://localhost:8080/metrics访问Prometheus客户端。

5.5 日志

默认情况下，我们启用了zap日志记录器和事件日志记录器，编码类型为[console]。也支持[json]和[flatten]编码类型。

5.6 元数据

默认情况下，我们会将一些元数据发送回客户端，包括带有header的网关。

5.7 发送请求

我们注册了/v1/greeter API，让我们验证一下：

$ curl -vs "localhost:8080/v1/greeter?name=rk-dev"
*   Trying ::1...
* TCP_NODELAY set
* Connected to localhost (::1) port 8080 (#0)
> GET /v1/greeter?name=rk-dev HTTP/1.1
> Host: localhost:8080
> User-Agent: curl/7.64.1
> Accept: */*
> 
< HTTP/1.1 200 OK
< Content-Type: application/json; charset=utf-8
< X-Request-Id: a96ab531-e28f-47ca-a082-fc3f8ef14187
< X-Rk-App-Name: rk
< X-Rk-App-Unix-Time: 2021-12-28T02:22:03.289469+08:00
< X-Rk-Received-Time: 2021-12-28T02:22:03.289469+08:00
< Date: Mon, 27 Dec 2021 18:22:03 GMT
< Content-Length: 27
< 
* Connection #0 to host localhost left intact
{"Message":"Hello rk-dev!"}

5.8 RPC日志

标准输出中会打印以下日志：

------------------------------------------------------------------------
endTime=2021-12-28T02:22:03.289585+08:00
startTime=2021-12-28T02:22:03.289457+08:00
elapsedNano=128210
timezone=CST
ids={"eventId":"a96ab531-e28f-47ca-a082-fc3f8ef14187","requestId":"a96ab531-e28f-47ca-a082-fc3f8ef14187"}
app={"appName":"rk","appVersion":"","entryName":"greeter","entryType":"GinEntry"}
env={"arch":"amd64","az":"*","domain":"*","hostname":"lark.local","localIP":"10.8.0.2","os":"darwin","realm":"*","region":"*"}
payloads={"apiMethod":"GET","apiPath":"/v1/greeter","apiProtocol":"HTTP/1.1","apiQuery":"name=rk-dev","userAgent":"curl/7.64.1"}
error={}
counters={}
pairs={}
timing={}
remoteAddr=localhost:54028
operation=/v1/greeter
resCode=200
eventStatus=Ended
EOE

5.9 RPC Prometheus指标

Prometheus客户端会自动注册到/metrics端点。

访问http://localhost:8080/metrics

支持的功能

用户可以按需启用以下任何功能！没有强制绑定！

支持的中间件

所有中间件都可以通过YAML或代码配置。用户可以按需启用以下任何中间件！没有强制绑定！

YAML选项

用户可以同时启动多个gin-gonic/gin实例。请确保使用不同的端口和名称。

完整的YAML配置选项请参考文档中的详细说明。