通過Jaeger為應用埋點并上報鏈路數據至可觀測鏈路 OpenTelemetry 版后,可觀測鏈路 OpenTelemetry 版即可開始監控應用,您可以查看應用拓撲、調用鏈路、異常事務、慢事務和SQL分析等一系列監控數據。本文介紹如何使用Jaeger SDK和Jaeger Agent埋點并上報Go應用數據。
為獲得更豐富的功能、更先進的鏈路追蹤能力,以及最佳使用體驗,建議您使用OpenTelemetry協議將應用接入可觀測鏈路 OpenTelemetry 版。我們為您提供了詳細的OpenTelemetry接入指南和最佳實踐,幫助您快速上手可觀測鏈路 OpenTelemetry 版。更多信息,請參見接入應用。
ARMS應用監控針對Golang語言提供了商業化版本的自研探針,提供了無侵入的埋點能力,擁有更加豐富的功能和更高的穩定性。詳細信息,請參見開始監控Golang應用。
前提條件
新版控制臺
登錄可觀測鏈路 OpenTelemetry 版控制臺,在左側導航欄單擊接入中心。
在開源框架區域單擊Jaeger卡片。
在彈出的Jaeger面板中選擇數據需要上報的地域。
說明初次接入的地域將會自動進行資源初始化。
選擇連接方式和上報方式,然后復制接入點信息。
連接方式:若您的服務部署在阿里云上,且所屬地域與選擇的接入地域一致,推薦使用阿里云內網方式,否則選擇公網方式。
上報方式:根據客戶端支持的協議類型選擇HTTP或gRPC協議上報數據。
舊版控制臺
在左側導航欄單擊集群配置,然后在右側頁面單擊接入點信息頁簽。
在頁面頂部選擇需要接入的地域,然后在集群信息區域打開顯示Token開關。
在客戶端采集工具區域單擊Jaeger。
在相關信息列中,獲取接入點信息。
說明如果應用部署于阿里云生產環境,則選擇阿里云VPC網絡接入點,否則選擇公網接入點。
背景信息
不通過Jaeger Agent而直接上報數據的原理如下圖所示。
通過Jaeger Agent上報數據的原理如下圖所示。
方式一:通過Jaeger SDK上報數據
此處以依賴管理工具Go Modules為例,您可以通過Jaeger SDK埋點直接將數據上報到可觀測鏈路 OpenTelemetry 版服務端。若使用其他依賴管理工具,請按實際情況操作。
go get github.com/uber/jaeger-client-go
創建Tracer對象。
說明請將
<endpoint>
替換成可觀測鏈路 OpenTelemetry 版控制臺接入點信息頁面上相應客戶端和相應地域的接入點。關于獲取接入點信息的方法,請參見本文前提條件。func NewJaegerTracer(service string) (opentracing.Tracer, io.Closer) { sender := transport.NewHTTPTransport( // 設置網關,網關因地域而異。 "<endpoint>", ) tracer, closer:= jaeger.NewTracer(service, jaeger.NewConstSampler(true), jaeger.NewRemoteReporter(sender)) return tracer, closer }
創建span實例對象和數據透傳。
如果沒有parentSpan:
// 創建Span。 span := tracer.StartSpan("myspan") // 設置Tag。 clientSpan.SetTag("mytag", "123") // 透傳traceId。 tracer.Inject(span.Context(), opentracing.HTTPHeaders, opentracing.HTTPHeadersCarrier(req.Header)) ... defer span.Finish()
如果有parentSpan:
// 從HTTP/RPC對象解析出spanCtx。 spanCtx, _ := tracer.Extract(opentracing.HTTPHeaders, opentracing.HTTPHeadersCarrier(r.Header)) span := tracer.StartSpan("myspan", opentracing.ChildOf(spanCtx)) ... defer span.Finish()
更多詳細使用方法,請參見Go Doc。
方式二:通過Jaeger Agent上報數據
啟動Jaeger Agent。具體操作,請參見安裝Jaeger Agent。
go get github.com/uber/jaeger-client-go
創建Tracer對象。
func NewJaegerTracer(serviceName string) (opentracing.Tracer, io.Closer) { sender, _ := jaeger.NewUDPTransport("",0) tracer, closer:= jaeger.NewTracer(serviceName, jaeger.NewConstSampler(true), jaeger.NewRemoteReporter(sender)) return tracer, closer }
創建span實例對象和數據透傳。
如果沒有parentSpan:
// 創建Span。 span := tracer.StartSpan("myspan") // 設置Tag。 clientSpan.SetTag("mytag", "123") // 透傳traceId。 tracer.Inject(span.Context(), opentracing.HTTPHeaders, opentracing.HTTPHeadersCarrier(req.Header)) ... defer span.Finish()
如果有parentSpan:
// 從HTTP/RPC對象解析出spanCtx。 spanCtx, _ := tracer.Extract(opentracing.HTTPHeaders, opentracing.HTTPHeadersCarrier(r.Header)) span := tracer.StartSpan("myspan", opentracing.ChildOf(spanCtx)) ... defer span.Finish()
更多詳細使用方法,請參見Go Doc。
使用示例
通過Jaeger SDK直接上報
獲取接入點信息。具體操作方法,請參見本文前提條件。
運行以下命令,下載示例文件。
wget https://arms-apm-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/demo/tracing-demo.zip && unzip tracing-demo.zip
打開示例文件夾中的examples/settings.go文件,配置TracingAnalysisEndpoint,將圖示①替換為步驟1中獲取的接入點信息。
使用
go mod tidy
命令整理依賴。使用
go run tracingdemo
命令運行示例。
通過Jaeger Agent上報
獲取接入點信息。具體操作方法,請參見本文前提條件。
運行以下命令,下載示例文件。
wget https://arms-apm-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/demo/tracing-demo.zip && unzip tracing-demo.zip
啟動Jaeger Agent。具體操作,請參見安裝Jaeger Agent。
打開示例文件夾中的examples/settings.go文件,將
AgentSwitch
修改為true
。使用
go mod tidy
命令整理依賴。使用
go run tracingdemo
命令運行示例。
常見問題
Q:在運行過程中,為什么會出現以下報錯?
2021/06/28 21:11:54 ERROR: error when flushing the buffer: error from collector: 403
A:出現上述報錯,說明輸入的接入點信息不正確。請更正并重試。