通过 gRPC-Jaeger 拦截器上报

最近更新时间:2024-05-29 17:15:22

我的收藏
本文将为您介绍如何使用 gRPC-Jaeger 拦截器上报 Go 应用数据。

操作步骤

步骤1:获取接入点和 Token

1. 登录 腾讯云可观测平台 控制台。
2. 在左侧菜单栏中选择应用性能监控 > 应用监控,单击应用列表 > 接入应用
3. 在右侧弹出的数据接入抽屉框中,单击 Go 语言。
4. 接入 Go 应用页面,选择您所要接入的地域以及业务系统
5. 选择接入协议类型Jaeger
6. 上报方式选择您所想要的上报方式,获取您的接入点Token
说明:
内网上报:使用此上报方式,您的服务需运行在腾讯云 VPC。通过 VPC 直接联通,在避免外网通信的安全风险同时,可以节省上报流量开销。
外网上报:当您的服务部署在本地或非腾讯云 VPC 内,可以通过此方式上报数据。请注意外网通信存在安全风险,同时也会造成一定上报流量费用。

步骤2:安装 Jaeger Agent

1. 下载 Jaeger Agent
2. 在控制台执行以下命令启动 Agent。
nohup ./jaeger-agent --reporter.grpc.host-port={{collectorRPCHostPort}} --agent.tags=token={{token}}


步骤3:选择上报端类型上报应用数据

选择上报端类型,通过 gRPC-Jaeger 拦截器上报 Go 应用数据:

服务端配置

1. 在服务端侧引入 opentracing-contrib/go-grpc 埋点依赖。
依赖路径: github.com/opentracing-contrib/go-grpc
版本要求: ≥ v0.0.0-20210225150812-73cb765af46e
2. 配置 Jaeger,创建 Trace 对象。示例如下:
cfg := &jaegerConfig.Configuration{
ServiceName: grpcServerName, //对其发起请求的的调用链,叫什么服务
Sampler: &jaegerConfig.SamplerConfig{ //采样策略的配置
Type: "const",
Param: 1,
},
Reporter: &jaegerConfig.ReporterConfig{ //配置客户端如何上报trace信息,所有字段都是可选的
LogSpans: true,
LocalAgentHostPort: endPoint,
},
//Token配置
Tags: []opentracing.Tag{ //设置tag,token等信息可存于此
opentracing.Tag{Key: "token", Value: token}, //设置token
},
}
tracer, closer, err := cfg.NewTracer(jaegerConfig.Logger(jaeger.StdLogger)) //根据配置得到tracer

3. 配置拦截器。
s := grpc.NewServer(grpc.UnaryInterceptor(otgrpc.OpenTracingServerInterceptor(tracer)))
4. 启动 Server 服务。
// 在gRPC服务器处注册我们的服务
pb.RegisterHelloTraceServer(s, &server{})
if err := s.Serve(lis); err != nil {
log.Fatalf("failed to serve: %v", err)
}
完整代码如下:
// Copyright © 2019-2020 Tencent Co., Ltd.

// This file is part of tencent project.
// Do not copy, cite, or distribute without the express
// permission from Cloud Monitor group.

package grpcdemo

import (
"context"
"fmt"
"github.com/opentracing/opentracing-go"
"github.com/uber/jaeger-client-go"
jaegerConfig "github.com/uber/jaeger-client-go/config"
"log"
"net"

"github.com/opentracing-contrib/go-grpc"
"google.golang.org/grpc"
)

const (
// 服务名 服务唯一标示,服务指标聚合过滤依据。
grpcServerName = "demo-grpc-server"
serverPort = ":9090"
)

// server is used to implement proto.HelloTraceServer.
type server struct {
UnimplementedHelloTraceServer
}

// SayHello implements proto.HelloTraceServer
func (s *server) SayHello(ctx context.Context, in *TraceRequest) (*TraceResponse, error) {
log.Printf("Received: %v", in.GetName())
return &TraceResponse{Message: "Hello " + in.GetName()}, nil
}

// StartServer
func StartServer() {
cfg := &jaegerConfig.Configuration{
ServiceName: grpcServerName, //对其发起请求的的调用链,叫什么服务
Sampler: &jaegerConfig.SamplerConfig{ //采样策略的配置
Type: "const",
Param: 1,
},
Reporter: &jaegerConfig.ReporterConfig{ //配置客户端如何上报trace信息,所有字段都是可选的
LogSpans: true,
LocalAgentHostPort: endPoint,
},
//Token配置
Tags: []opentracing.Tag{ //设置tag,token等信息可存于此
opentracing.Tag{Key: "token", Value: token}, //设置token
},
}
tracer, closer, err := cfg.NewTracer(jaegerConfig.Logger(jaeger.StdLogger)) //根据配置得到tracer
defer closer.Close()
if err != nil {
panic(fmt.Sprintf("ERROR: fail init Jaeger: %v\\n", err))
}
lis, err := net.Listen("tcp", serverPort)
if err != nil {
log.Fatalf("failed to listen: %v", err)
}
s := grpc.NewServer(grpc.UnaryInterceptor(otgrpc.OpenTracingServerInterceptor(tracer)))

// 在gRPC服务器处注册我们的服务
RegisterHelloTraceServer(s, &server{})
if err := s.Serve(lis); err != nil {
log.Fatalf("failed to serve: %v", err)
}
}



客户端配置

1. 客户端侧由于需要模拟 HTTP 请求,引入 opentracing-contrib/go-stdlib/nethttp依赖。
依赖路径:github.com/opentracing-contrib/go-stdlib/nethttp
版本要求: ≥ v1.0.0
2. 配置 Jaeger,创建 Trace 对象。
cfg := &jaegerConfig.Configuration{
ServiceName: grpcClientName, //对其发起请求的的调用链,叫什么服务
Sampler: &jaegerConfig.SamplerConfig{ //采样策略的配置
Type: "const",
Param: 1,
},
Reporter: &jaegerConfig.ReporterConfig{ //配置客户端如何上报trace信息,所有字段都是可选的
LogSpans: true,
LocalAgentHostPort: endPoint,
},
//Token配置
Tags: []opentracing.Tag{ //设置tag,token等信息可存于此
opentracing.Tag{Key: "token", Value: token}, //设置token
},
}
tracer, closer, err := cfg.NewTracer(jaegerConfig.Logger(jaeger.StdLogger)) //根据配置得到tracer

3. 建立连接,配置拦截器。
// 向服务端建立连接,配置拦截器
conn, err := grpc.Dial(serverAddress, grpc.WithInsecure(), grpc.WithBlock(),
grpc.WithUnaryInterceptor(otgrpc.OpenTracingClientInterceptor(tracer)))

4. 进行 gRPC 调用,验证是否接入成功。 完整代码如下:
// Copyright © 2019-2020 Tencent Co., Ltd.

// This file is part of tencent project.
// Do not copy, cite, or distribute without the express
// permission from Cloud Monitor group.

package grpcdemo

import (
"context"
"fmt"
"github.com/opentracing-contrib/go-grpc"
"github.com/opentracing/opentracing-go"
"github.com/uber/jaeger-client-go"
jaegerConfig "github.com/uber/jaeger-client-go/config"
"google.golang.org/grpc"
"log"
"time"
)

const (
// 服务名 服务唯一标示,服务指标聚合过滤依据。
grpcClientName = "demo-grpc-client"
defaultName = "TAW Tracing"
serverAddress = "localhost:9090"
endPoint = "xxxxx:6831" // 本地agent地址
token = "abc"
)

// StartClient
func StartClient() {
cfg := &jaegerConfig.Configuration{
ServiceName: grpcClientName, //对其发起请求的的调用链,叫什么服务
Sampler: &jaegerConfig.SamplerConfig{ //采样策略的配置
Type: "const",
Param: 1,
},
Reporter: &jaegerConfig.ReporterConfig{ //配置客户端如何上报trace信息,所有字段都是可选的
LogSpans: true,
LocalAgentHostPort: endPoint,
},
//Token配置
Tags: []opentracing.Tag{ //设置tag,token等信息可存于此
opentracing.Tag{Key: "token", Value: token}, //设置token
},
}
tracer, closer, err := cfg.NewTracer(jaegerConfig.Logger(jaeger.StdLogger)) //根据配置得到tracer
defer closer.Close()
if err != nil {
panic(fmt.Sprintf("ERROR: fail init Jaeger: %v\\n", err))
}
// 向服务端建立链接,配置拦截器
conn, err := grpc.Dial(serverAddress, grpc.WithInsecure(), grpc.WithBlock(),
grpc.WithUnaryInterceptor(otgrpc.OpenTracingClientInterceptor(tracer)))
if err != nil {
log.Fatalf("did not connect: %v", err)
}
defer conn.Close()

//
c := NewHelloTraceClient(conn)
ctx, cancel := context.WithTimeout(context.Background(), time.Second)
defer cancel()
// 发起RPC调用
r, err := c.SayHello(ctx, &TraceRequest{Name: defaultName})
if err != nil {
log.Fatalf("could not greet: %v", err)
}
log.Printf("RPC Client receive: %s", r.GetMessage())
}