GRPC: 如何添加 API Tracing(调用链)监控拦截器/中间件?-阿里云开发者社区

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

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

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

介绍

本文将介绍如何在 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

快速开始

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"
)

// 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}
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.2.6
    github.com/rookie-ninja/rk-grpc v1.2.6
    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启动调用链拦截器booleanfalse
grpc.interceptors.tracingTelemetry.exporter.file.enabled启动文件输出booleanfalse
grpc.interceptors.tracingTelemetry.exporter.file.outputPath输出文件路径stringstdout
grpc.interceptors.tracingTelemetry.exporter.jaeger.agent.enabledjaeger agent 作为数据输出booleanfalse
grpc.interceptors.tracingTelemetry.exporter.jaeger.agent.hostjaeger agent 地址stringlocalhost
grpc.interceptors.tracingTelemetry.exporter.jaeger.agent.portjaeger agent 端口int6831
grpc.interceptors.tracingTelemetry.exporter.jaeger.collector.enabledjaeger collector 作为数据输出booleanfalse
grpc.interceptors.tracingTelemetry.exporter.jaeger.collector.endpointjaeger collector 地址stringhttp://localhost:16368/api/trace
grpc.interceptors.tracingTelemetry.exporter.jaeger.collector.usernamejaeger collector 用户名string""
grpc.interceptors.tracingTelemetry.exporter.jaeger.collector.passwordjaeger collector 密码string""

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

相关文章
IoT平台实现RRPC同步调用最佳实战
满足云端下发指令给设备端,同时需要设备端返回响应结果的场景
5159 0
API网关监控配置
在API网关开放API服务后,如何保障服务的稳定性,怎么能够实时监控API的情况?及时处理API服务异常,是API开放者关注的重点。本文将主要介绍API网关提供的API监控报警功能,通过简单的配置,即可帮助您实现API的监控报警。
5418 0
服务调用监控工具
     公司最近要做一个服务监控的工具,包括 调用次数、成功率、响应时长、失败明细等信息,正好还在用阿里的edas,想着通过api的方式全都搞定了,可是公司用的专有云,没有监控的api,只能从头来做了。
1194 0
+关注
尹东勋
点目科技创始人
62
文章
0
问答
文章排行榜
最热
最新
相关电子书
更多
文娱运维技术
立即下载
《SaaS模式云原生数据仓库应用场景实践》
立即下载
《看见新力量:二》电子书
立即下载