通過OpenTelemetry為應用埋點並上報鏈路資料至Managed Service for OpenTelemetry後,Managed Service for OpenTelemetry即可開始監控應用,您可以查看應用拓撲、調用鏈路、異常事務、慢事務和SQL分析等一系列監控資料。本文介紹如何使用OpenTelemetry Go SDK進行手動埋點並上報資料。
ARMS應用監控針對Golang語言提供了商業化版本的自研探針,提供了無侵入的埋點能力,擁有更加豐富的功能和更高的穩定性。詳細資料,請參見開始監控Golang應用。
前提條件
背景資訊
OpenTelemetry Go SDK提供了Go語言的分布式鏈路追蹤能力,您可以直接使用OTLP gRPC或者HTTP協議向鏈路追蹤服務端上報資料。
OpenTelemetry提供了若干半自動埋點外掛程式(無需手動建立Span,只需要在代碼中使用這些外掛程式提供的API),支援為常見的架構自動建立Span。支援的架構列表請參見OpenTelemetry官方文檔。
樣本Demo
使用gRPC協議上報
添加OpenTelemetry Go依賴。
go get go.opentelemetry.io/otel go get go.opentelemetry.io/otel/trace go get go.opentelemetry.io/otel/sdk go get go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc // otlp grpc
初始化OpenTelemetry Go SDK。
您可以選擇通過OpenTelemetry SDK直接上報或通過開源OpenTelemetry Collector轉寄。
如果選擇直接上報,請將otelAgentAddr和xtraceToken替換為前提條件擷取的存取點和鑒權Token。
如果選擇使用OpenTelemetry Collector轉寄,請將otelAgentAddr替換為您本地部署的服務地址,並刪除Header資訊。
func initProvider() func() { ctx := context.Background() otelAgentAddr, xtraceToken, ok := common.ObtainXTraceInfo() if !ok { log.Fatalf("Cannot init OpenTelemetry, exit") os.Exit(-1) } headers := map[string]string{"Authentication": xtraceToken} //將xtraceToken替換為前提條件中擷取的鑒權Token。 traceClient := otlptracegrpc.NewClient( otlptracegrpc.WithInsecure(), otlptracegrpc.WithEndpoint(otelAgentAddr), //將otelAgentAddr替換為前提條件中擷取的存取點。 otlptracegrpc.WithHeaders(headers), otlptracegrpc.WithDialOption(grpc.WithBlock())) log.Println("start to connect to server") traceExp, err := otlptrace.New(ctx, traceClient) handleErr(err, "Failed to create the collector trace exporter") res, err := resource.New(ctx, resource.WithFromEnv(), resource.WithProcess(), resource.WithTelemetrySDK(), resource.WithHost(), resource.WithAttributes( // 在可觀測鏈路 OpenTelemetry 版後端顯示的服務名稱。 semconv.ServiceNameKey.String(common.ServerServiceName), semconv.HostNameKey.String(common.ServerServiceHostName), ), ) handleErr(err, "failed to create resource") bsp := sdktrace.NewBatchSpanProcessor(traceExp) tracerProvider := sdktrace.NewTracerProvider( sdktrace.WithSampler(sdktrace.AlwaysSample()), sdktrace.WithResource(res), sdktrace.WithSpanProcessor(bsp), ) // 設定全域propagator為tracecontext(預設不設定)。 otel.SetTextMapPropagator(propagation.TraceContext{}) otel.SetTracerProvider(tracerProvider) return func() { cxt, cancel := context.WithTimeout(ctx, time.Second) defer cancel() if err := traceExp.Shutdown(cxt); err != nil { otel.Handle(err) } } }
添加埋點。
shutdown := initProvider() defer shutdown() //meter := global.Meter("demo-server-meter") serverAttribute := attribute.String("server-attribute", "foo") fmt.Println("start to gen chars for trace data") initTraceDemoData() fmt.Println("gen trace data done") tracer := otel.Tracer(common.TraceInstrumentationName) // 在OpenTelemetry中建立一個handler。 handler := http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) { // 類比延遲 var sleep int64 switch modulus := time.Now().Unix() % 5; modulus { case 0: sleep = rng.Int63n(2000) case 1: sleep = rng.Int63n(15) case 2: sleep = rng.Int63n(917) case 3: sleep = rng.Int63n(87) case 4: sleep = rng.Int63n(1173) } ctx := req.Context() span := trace.SpanFromContext(ctx) span.SetAttributes(serverAttribute) actionChild(tracer, ctx, sleep) w.Write([]byte("Hello World")) }) wrappedHandler := otelhttp.NewHandler(handler, "/hello") http.Handle("/hello", wrappedHandler) http.ListenAndServe(":7080", nil)
啟動應用程式。
go run main.go
登入ARMS控制台後,在 頁面選擇目標應用,查看鏈路資料。
說明語言列顯示表徵圖的應用為接入應用監控的應用,顯示-表徵圖的應用為接入可觀測鏈路 OpenTelemetry 版的應用。
使用HTTP協議上報
添加OpenTelemetry Go依賴。
go get go.opentelemetry.io/otel go get go.opentelemetry.io/otel/trace go get go.opentelemetry.io/otel/sdk go get go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp // otlp http
初始化OpenTelemetry Go SDK,其中Endpoint和URLPath需替換為前提條件中擷取的存取點資訊。
您可以選擇通過OpenTelemetry SDK直接上報或通過開源OpenTelemetry Collector轉寄。
如果選擇直接上報,請將Endpoint和URLPath替換為前提條件擷取的存取點資訊。
如果選擇使用OpenTelemetry Collector轉寄,請將Endpoint替換為您本地部署的服務地址,並刪除Header資訊。
func initProvider() func() { ctx := context.Background() traceClientHttp := otlptracehttp.NewClient( otlptracehttp.WithEndpoint("127.0.XX.XX:8080"), //Endpoint需替換為前提條件中擷取的存取點資訊。 otlptracehttp.WithURLPath("/adapt_xxxxx/api/otlp/traces"), //URLPath需替換為前提條件中擷取的存取點資訊。 otlptracehttp.WithInsecure()) otlptracehttp.WithCompression(1) traceExp, err := otlptrace.New(ctx, traceClientHttp) handleErr(err, "Failed to create the collector trace exporter") res, err := resource.New(ctx, resource.WithFromEnv(), resource.WithProcess(), resource.WithTelemetrySDK(), resource.WithHost(), resource.WithAttributes( // 在可觀測鏈路 OpenTelemetry 版後端顯示的服務名稱。 semconv.ServiceNameKey.String(common.ClientServiceName), semconv.HostNameKey.String(common.ClientServiceHostName), ), ) handleErr(err, "failed to create resource") bsp := sdktrace.NewBatchSpanProcessor(traceExp) tracerProvider := sdktrace.NewTracerProvider( sdktrace.WithSampler(sdktrace.AlwaysSample()), sdktrace.WithResource(res), sdktrace.WithSpanProcessor(bsp), ) // 設定全域propagator為tracecontext(預設不設定)。 otel.SetTextMapPropagator(propagation.TraceContext{}) otel.SetTracerProvider(tracerProvider) log.Println("OTEL init success") return func() { cxt, cancel := context.WithTimeout(ctx, time.Second) defer cancel() if err := traceExp.Shutdown(cxt); err != nil { otel.Handle(err) } } }
添加埋點。
tracer := otel.Tracer(common.TraceInstrumentationName) method, _ := baggage.NewMember("method", "repl") client, _ := baggage.NewMember("client", "cli") bag, _ := baggage.New(method, client) defaultCtx := baggage.ContextWithBaggage(context.Background(), bag) for { ctx, span := tracer.Start(defaultCtx, "ExecuteRequest") makeRequest(ctx) span.End() time.Sleep(time.Duration(1) * time.Second) }
啟動應用程式。
go run main.go
登入ARMS控制台後,在 頁面選擇目標應用,查看鏈路資料。
說明語言列顯示表徵圖的應用為接入應用監控的應用,顯示-表徵圖的應用為接入可觀測鏈路 OpenTelemetry 版的應用。