Merge pull request #1545 from ydb-platform/traceparent

Small broken change: Fixed `traceparent` header for tracing grpc requests + * Added method `ID()` into `spans.Span` interface

Author: asmyasnikov

CHANGELOG.md

@@ -1,3 +1,6 @@
+* Small broken change: added method `ID()` into `spans.Span` interface (need to implement in adapter) 
+* Fixed traceparent header for tracing grpc requests
+
 ## v3.90.0
 * Fixed closing of child driver with shared balancer
 

spans/driver.go

@@ -8,10 +8,24 @@ import (
 	"sync/atomic"
 
 	"github.com/ydb-platform/ydb-go-sdk/v3/internal/kv"
+	"github.com/ydb-platform/ydb-go-sdk/v3/internal/xstring"
 	"github.com/ydb-platform/ydb-go-sdk/v3/meta"
 	"github.com/ydb-platform/ydb-go-sdk/v3/trace"
 )
 
+func traceparent(traceID string, spanID string) string {
+	b := xstring.Buffer()
+	defer b.Free()
+
+	b.WriteString("00-")
+	b.WriteString(traceID)
+	b.WriteByte('-')
+	b.WriteString(spanID)
+	b.WriteString("-01")
+
+	return b.String()
+}
+
 // driver makes driver with publishing traces
 func driver(adapter Adapter) trace.Driver { //nolint:gocyclo,funlen
 	return trace.Driver{
@@ -56,9 +70,7 @@ func driver(adapter Adapter) trace.Driver { //nolint:gocyclo,funlen
 			if adapter.Details()&trace.DriverConnEvents == 0 {
 				return nil
 			}
-			if traceID, valid := adapter.SpanFromContext(*info.Context).TraceID(); valid {
-				*info.Context = meta.WithTraceParent(*info.Context, traceID)
-			}
+
 			start := childSpanWithReplaceCtx(
 				adapter,
 				info.Context,
@@ -67,6 +79,12 @@ func driver(adapter Adapter) trace.Driver { //nolint:gocyclo,funlen
 				kv.String("method", string(info.Method)),
 			)
 
+			if id, valid := start.ID(); valid {
+				if traceID, valid := start.TraceID(); valid {
+					*info.Context = meta.WithTraceParent(*info.Context, traceparent(traceID, id))
+				}
+			}
+
 			return func(info trace.DriverConnInvokeDoneInfo) {
 				fields := []KeyValue{
 					kv.String("opID", info.OpID),
@@ -101,8 +119,10 @@ func driver(adapter Adapter) trace.Driver { //nolint:gocyclo,funlen
 				kv.String("method", string(info.Method)),
 			)
 
-			if traceID, valid := start.TraceID(); valid {
-				*info.Context = meta.WithTraceParent(*info.Context, traceID)
+			if id, valid := start.ID(); valid {
+				if traceID, valid := start.TraceID(); valid {
+					*info.Context = meta.WithTraceParent(*info.Context, traceparent(traceID, id))
+				}
 			}
 
 			return func(info trace.DriverConnNewStreamDoneInfo) {
@@ -149,26 +169,28 @@ func driver(adapter Adapter) trace.Driver { //nolint:gocyclo,funlen
 			if adapter.Details()&trace.DriverConnStreamEvents == 0 {
 				return nil
 			}
-			start := childSpanWithReplaceCtx(
-				adapter,
-				info.Context,
-				info.Call.FunctionID(),
+
+			var (
+				call  = info.Call
+				start = adapter.SpanFromContext(*info.Context)
 			)
 
 			return func(info trace.DriverConnStreamCloseSendDoneInfo) {
-				finish(start, info.Error)
+				if info.Error != nil {
+					start.Log(call.FunctionID(), kv.Error(info.Error))
+				}
 			}
 		},
 		OnConnStreamFinish: func(info trace.DriverConnStreamFinishInfo) {
 			if adapter.Details()&trace.DriverConnStreamEvents == 0 {
 				return
 			}
-			start := childSpanWithReplaceCtx(
-				adapter,
-				&info.Context,
-				info.Call.FunctionID(),
+
+			var (
+				call     = info.Call
+				start    = adapter.SpanFromContext(info.Context)
+				counters = grpcStreamMsgCountersFromContext(info.Context)
 			)
-			counters := grpcStreamMsgCountersFromContext(info.Context)
 
 			attributes := make([]kv.KeyValue, 0, 2)
 			if counters != nil {
@@ -177,42 +199,47 @@ func driver(adapter Adapter) trace.Driver { //nolint:gocyclo,funlen
 					kv.Int64("sent_messages", counters.sentMessages()),
 				)
 			}
-			finish(start, info.Error, attributes...)
+
+			if info.Error != nil {
+				attributes = append(attributes, kv.Error(info.Error))
+			}
+
+			start.Log(call.FunctionID(), attributes...)
 		},
 		OnConnPark: func(info trace.DriverConnParkStartInfo) func(trace.DriverConnParkDoneInfo) {
 			if adapter.Details()&trace.DriverConnEvents == 0 {
 				return nil
 			}
-			start := childSpanWithReplaceCtx(
-				adapter,
-				info.Context,
-				info.Call.FunctionID(),
-				kv.String("address", safeAddress(info.Endpoint)),
+
+			var (
+				call  = info.Call
+				start = adapter.SpanFromContext(*info.Context)
 			)
 
 			return func(info trace.DriverConnParkDoneInfo) {
-				finish(
-					start,
-					info.Error,
-				)
+				if info.Error != nil {
+					start.Log(call.FunctionID(), kv.Error(info.Error))
+				} else {
+					start.Log(call.FunctionID())
+				}
 			}
 		},
 		OnConnClose: func(info trace.DriverConnCloseStartInfo) func(trace.DriverConnCloseDoneInfo) {
 			if adapter.Details()&trace.DriverConnEvents == 0 {
 				return nil
 			}
-			start := childSpanWithReplaceCtx(
-				adapter,
-				info.Context,
-				info.Call.FunctionID(),
-				kv.String("address", safeAddress(info.Endpoint)),
+
+			var (
+				call  = info.Call
+				start = adapter.SpanFromContext(*info.Context)
 			)
 
 			return func(info trace.DriverConnCloseDoneInfo) {
-				finish(
-					start,
-					info.Error,
-				)
+				if info.Error != nil {
+					start.Log(call.FunctionID(), kv.Error(info.Error))
+				} else {
+					start.Log(call.FunctionID())
+				}
 			}
 		},
 		OnConnBan: func(info trace.DriverConnBanStartInfo) func(trace.DriverConnBanDoneInfo) {

spans/driver_test.go

@@ -0,0 +1,17 @@
+package spans
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func BenchmarkTraceparent(b *testing.B) {
+	b.ReportAllocs()
+	for i := 0; i < b.N; i++ {
+		require.Equal(b,
+			"00-8e3790822789a6917883e08d0eeb783e-729d847ca290963e-00",
+			traceparent("8e3790822789a6917883e08d0eeb783e", "729d847ca290963e"),
+		)
+	}
+}

spans/spans.go

@@ -15,6 +15,7 @@ type (
 	//
 	// Experimental: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#experimental
 	Span interface {
+		ID() (_ string, valid bool)
 		TraceID() (_ string, valid bool)
 
 		Link(link Span, attributes ...KeyValue)