gRPC: 如何添加 API Tracing(调用链)监控拦截器/中间件？

原创

尹东勋

修改于 2021-12-13 00:16:01

9810

修改于 2021-12-13 00:16:01

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

介绍

本文将介绍如何在 gRPC 微服务中添加 API Tracing(调用链)拦截器/中间件。也就是可以在 jaeger 里做的 API 监控。

什么是 API Tracing(调用链)拦截器/中间件？Tracing(调用链)拦截器会对每一个 API 请求记录 Tracing 数据，用户可以使用类似 Jaeger 工具查看。

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

请访问如下地址获取完整教程：https://rkdev.info/cn https://rkdocs.netlify.app/cn (备用)

安装

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

快速开始

rk-boot 默认会使用 OpenTelemetry-CNCF 来处理 Tracing。

1.创建 boot.yaml

为了验证，我们启动了 commonService，commonService 里包含了一系列常用 API，例如 /rk/v1/healthy。

---
grpc:
  - name: greeter                   # Name of grpc entry
    port: 8080                         # Port of grpc entry
    enabled: true                     # Enable grpc entry
    commonService:
      enabled: true                   # Enable common service for testing
    interceptors:
      tracingTelemetry:
        enabled: true                 # Enable tracing interceptor/middleware
        exporter:
          jaeger:
            agent:
              enabled: true           # Export to jaeger agent

2.创建 main.go

package main

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

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

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

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

3.文件夹结构

$ tree
.
├── boot.yaml
├── go.mod
├── go.sum
└── main.go

0 directories, 4 files

4.本地启动 jaeger

$ docker run -d --name jaeger \
    -e COLLECTOR_ZIPKIN_HOST_PORT=:9411 \
    -p 5775:5775/udp \
    -p 6831:6831/udp \
    -p 6832:6832/udp \
    -p 5778:5778 \
    -p 16686:16686 \
    -p 14268:14268 \
    -p 14250:14250 \
    -p 9411:9411 \
    jaegertracing/all-in-one:1.23

5.启动 main.go

$ go run main.go

6.验证

发送请求

$ curl -X GET localhost:8080/rk/v1/healthy
{"healthy":true}

访问 jaeger 主页: http://localhost:16686/

rk-boot 会使用 go.mod 文件中的 module 后缀来命名 Service。举例: 如果你的 go.mod 文件内容如下，则 Service 名字就是 rk-demo

module github.com/rookie-ninja/rk-demo

go 1.16

require (
	github.com/grpc-ecosystem/grpc-gateway/v2 v2.5.0
	github.com/rookie-ninja/rk-boot v1.4.0
	github.com/rookie-ninja/rk-grpc v1.2.15
	google.golang.org/grpc v1.38.0
	google.golang.org/protobuf v1.26.0
)

输出到 Stdout

可以通过修改 boot.yaml 文件来修改输出路径，比如 STDOUT。

boot.yaml

---
grpc:
  - name: greeter                   # Name of grpc entry
    port: 8080                         # Port of grpc entry
    enabled: true                     # Enable grpc entry
    commonService:
      enabled: true                   # Enable common service for testing
    interceptors:
      tracingTelemetry:
        enabled: true
        exporter:
          file:
            enabled: true
            outputPath: "stdout"    # Output to stdout

输出到文件

可以通过修改 boot.yaml 文件来保存 Tracing 信息到文件。

boot.yaml

---
grpc:
  - name: greeter                             # Name of grpc entry
    port: 8080                                   # Port of grpc entry
    enabled: true                               # Enable grpc entry
    commonService:
      enabled: true                             # Enable common service for testing
    interceptors:
      tracingTelemetry:
        enabled: true
        exporter:
          file:
            enabled: true
            outputPath: "logs/tracing.log"    # Log to files

选项

名字	描述	类型	默认值
grpc.interceptors.tracingTelemetry.enabled	启动调用链拦截器	boolean	false
grpc.interceptors.tracingTelemetry.exporter.file.enabled	启动文件输出	boolean	false
grpc.interceptors.tracingTelemetry.exporter.file.outputPath	输出文件路径	string	stdout
grpc.interceptors.tracingTelemetry.exporter.jaeger.agent.enabled	jaeger agent 作为数据输出	boolean	false
grpc.interceptors.tracingTelemetry.exporter.jaeger.agent.host	jaeger agent 地址	string	localhost
grpc.interceptors.tracingTelemetry.exporter.jaeger.agent.port	jaeger agent 端口	int	6831
grpc.interceptors.tracingTelemetry.exporter.jaeger.collector.enabled	jaeger collector 作为数据输出	boolean	false
grpc.interceptors.tracingTelemetry.exporter.jaeger.collector.endpoint	jaeger collector 地址	string	http://localhost:16368/api/trace
grpc.interceptors.tracingTelemetry.exporter.jaeger.collector.username	jaeger collector 用户名	string	""
grpc.interceptors.tracingTelemetry.exporter.jaeger.collector.password	jaeger collector 密码	string	""