本文演示如何将Kitex应用接入ARMS链路追踪。

前提条件

已开通ARMS链路追踪

背景信息

CloudWeGo-Kitex是字节跳动开源的Golang微服务RPC框架,具有高性能、强可扩展的主要特点。其默认支持Thrift、Kitex Protobuf和gRPC消息协议,且支持丰富服务治理能力及扩展能力。

步骤一:接入Kitex

在您的Kitex应用中,添加如下代码。


import (
    "github.com/kitex-contrib/obs-opentelemetry/provider"
    "github.com/kitex-contrib/obs-opentelemetry/tracing"
    // ...
)

func main() {
    // 省略部分初始化代码
    // **接入OpenTelemetry,默认从环境变量配置**
    p := provider.NewOpenTelemetryProvider(
        provider.WithServiceName(constants.NoteServiceName),
        provider.WithEnableMetrics(false),
    )
    defer p.Shutdown(context.Background())

    Init()
    svr := note.NewServer(new(NoteServiceImpl),
        server.WithServerBasicInfo(&rpcinfo.EndpointBasicInfo{ServiceName: constants.NoteServiceName}), // server name
        // ...
        // **注入tracing到server实例中**
        server.WithSuite(tracing.NewServerSuite()),
    )
    err = svr.Run()
    if err != nil {
        klog.Fatal(err)
    }
}

步骤二:部署应用

  1. 如果您使用的是ACK服务,可以在容器服务管理控制台目标集群的工作负载 > 无状态页面创建Deployment。具体操作,请参见创建无状态工作负载Deployment
  2. 获取链路追踪接入点信息。
    1. ARMS控制台左侧导航栏单击接入中心
    2. 开源监控系统区域单击OpenTelemetry
    3. 接入OpenTelemetry面板选择对应的应用语言,然后获取接入点Endpoint和Authentication。
      链路追踪鉴权token
  3. 配置如下环境变量,从而上报数据到ARMS链路追踪。
    Key 说明 示例值
    OTEL_EXPORTER_OTLP_TRACES_ENDPOINT Trace上报的Endpoint。 http://tracing-analysis-dc-zb.aliyuncs.com:8090
    OTEL_EXPORTER_OTLP_TRACES_HEADERS OTEL上报会带上的Header,用于鉴权。 authentication=cx0xxxxx@285xxxxx_cx0xxxxx@53xxxxx

验证

启动应用并引入流量后,在ARMS控制台应用监控 > 应用列表页面选择新创建的应用,查看链路数据。