Change TraceID from UInt64 to UUID

Author: tonyredondo

agent/agent.go

@@ -352,7 +352,7 @@ func NewAgent(options ...Option) (*Agent, error) {
 
 	agent.tracer = tracer.NewWithOptions(tracer.Options{
 		Recorder: recorder,
-		ShouldSample: func(traceID uint64) bool {
+		ShouldSample: func(traceID uuid.UUID) bool {
 			return true
 		},
 		MaxLogsPerSpan: 10000,

agent/recorder.go

@@ -342,7 +342,7 @@ func (r *SpanRecorder) getPayloadComponents(span tracer.RawSpan) (PayloadSpan, [
 		}
 		events = append(events, PayloadEvent{
 			"context": map[string]interface{}{
-				"trace_id": fmt.Sprintf("%x", span.Context.TraceID),
+				"trace_id": span.Context.TraceID.String(),
 				"span_id":  fmt.Sprintf("%x", span.Context.SpanID),
 				"event_id": eventId.String(),
 			},

tracer/context.go

@@ -1,9 +1,11 @@
 package tracer
 
+import "github.com/google/uuid"
+
 // SpanContext holds the basic Span metadata.
 type SpanContext struct {
 	// A probabilistically unique identifier for a [multi-span] trace.
-	TraceID uint64
+	TraceID uuid.UUID
 
 	// A probabilistically unique identifier for a span.
 	SpanID uint64

tracer/propagation.go

@@ -1,6 +1,9 @@
 package tracer
 
-import opentracing "github.com/opentracing/opentracing-go"
+import (
+	"github.com/google/uuid"
+	opentracing "github.com/opentracing/opentracing-go"
+)
 
 type accessorPropagator struct {
 	tracer *tracerImpl
@@ -10,8 +13,8 @@ type accessorPropagator struct {
 // by types which have a means of storing the trace metadata and already know
 // how to serialize themselves (for example, protocol buffers).
 type DelegatingCarrier interface {
-	SetState(traceID, spanID uint64, sampled bool)
-	State() (traceID, spanID uint64, sampled bool)
+	SetState(traceID uuid.UUID, spanID uint64, sampled bool)
+	State() (traceID uuid.UUID, spanID uint64, sampled bool)
 	SetBaggageItem(key, value string)
 	GetBaggage(func(key, value string))
 }

tracer/propagation_env_var.go

@@ -2,6 +2,7 @@ package tracer
 
 import (
 	"fmt"
+	"github.com/google/uuid"
 	"github.com/opentracing/opentracing-go"
 	"os"
 	"strconv"
@@ -30,7 +31,7 @@ func (p *envVarPropagator) Inject(
 	if carrier == nil {
 		return opentracing.ErrInvalidCarrier
 	}
-	carrier.Set(fieldNameTraceID, strconv.FormatUint(sc.TraceID, 16))
+	carrier.Set(fieldNameTraceID, sc.TraceID.String())
 	carrier.Set(fieldNameSpanID, strconv.FormatUint(sc.SpanID, 16))
 	carrier.Set(fieldNameSampled, strconv.FormatBool(sc.Sampled))
 	for k, v := range sc.Baggage {
@@ -50,14 +51,15 @@ func (p *envVarPropagator) Extract(
 		return nil, opentracing.ErrInvalidCarrier
 	}
 	requiredFieldCount := 0
-	var traceID, spanID uint64
+	var traceID uuid.UUID
+	var spanID uint64
 	var sampled bool
 	var err error
 	decodedBaggage := make(map[string]string)
 	err = carrier.ForeachKey(func(k, v string) error {
 		switch strings.ToLower(k) {
 		case fieldNameTraceID:
-			traceID, err = strconv.ParseUint(v, 16, 64)
+			traceID, err = uuid.Parse(v)
 			if err != nil {
 				return opentracing.ErrSpanContextCorrupted
 			}

tracer/propagation_ot.go

@@ -3,6 +3,7 @@ package tracer
 import (
 	"encoding/binary"
 	"fmt"
+	"github.com/google/uuid"
 	"io"
 	"strconv"
 	"strings"
@@ -44,19 +45,22 @@ func (p *textMapPropagator) Inject(
 	if !ok {
 		return opentracing.ErrInvalidCarrier
 	}
-	carrier.Set(fieldNameTraceID, strconv.FormatUint(sc.TraceID, 16))
+
+	traceId := strings.ReplaceAll(sc.TraceID.String(), "-", "")
+
+	carrier.Set(fieldNameTraceID, traceId)
 	carrier.Set(fieldNameSpanID, strconv.FormatUint(sc.SpanID, 16))
 	carrier.Set(fieldNameSampled, strconv.FormatBool(sc.Sampled))
 
 	tpSampled := "00"
 	if sc.Sampled {
 		tpSampled = "01"
 	}
-	traceParentValue := fmt.Sprintf("%v-%032x-%016x-%v",
-		"00",       // Version 0
-		sc.TraceID, // 8bytes TraceId
-		sc.SpanID,  // 8bytes SpanId
-		tpSampled,  // 00 for not sampled, 01 for sampled
+	traceParentValue := fmt.Sprintf("%v-%v-%016x-%v",
+		"00",      // Version 0
+		traceId,   // 16bytes TraceId
+		sc.SpanID, // 8bytes SpanId
+		tpSampled, // 00 for not sampled, 01 for sampled
 	)
 	carrier.Set(traceParentKey, traceParentValue)
 
@@ -81,14 +85,15 @@ func (p *textMapPropagator) Extract(
 		return nil, opentracing.ErrInvalidCarrier
 	}
 	requiredFieldCount := 0
-	var traceID, spanID uint64
+	var traceID uuid.UUID
+	var spanID uint64
 	var sampled bool
 	var err error
 	decodedBaggage := make(map[string]string)
 	err = carrier.ForeachKey(func(k, v string) error {
 		switch strings.ToLower(k) {
 		case fieldNameTraceID:
-			traceID, err = strconv.ParseUint(v, 16, 64)
+			traceID, err = uuid.Parse(v)
 			if err != nil {
 				return opentracing.ErrSpanContextCorrupted
 			}
@@ -111,7 +116,7 @@ func (p *textMapPropagator) Extract(
 				return opentracing.ErrSpanContextCorrupted
 			}
 
-			traceID, err = strconv.ParseUint(traceParentArray[1][16:], 16, 64)
+			traceID, err = uuid.Parse(traceParentArray[1])
 			if err != nil {
 				return opentracing.ErrSpanContextCorrupted
 			}
@@ -174,7 +179,8 @@ func (p *binaryPropagator) Inject(
 	}
 
 	state := wire.TracerState{}
-	state.TraceId = sc.TraceID
+	bytes, _ := sc.TraceID.MarshalBinary()
+	state.TraceId = binary.LittleEndian.Uint64(bytes[8:])
 	state.SpanId = sc.SpanID
 	state.Sampled = sc.Sampled
 	state.BaggageItems = sc.Baggage
@@ -223,8 +229,11 @@ func (p *binaryPropagator) Extract(
 		return nil, opentracing.ErrSpanContextCorrupted
 	}
 
+	traceIdBytes := make([]byte, 16)
+	binary.LittleEndian.PutUint64(traceIdBytes, ctx.TraceId)
+	traceID, _ := uuid.FromBytes(traceIdBytes)
 	return SpanContext{
-		TraceID: ctx.TraceId,
+		TraceID: traceID,
 		SpanID:  ctx.SpanId,
 		Sampled: ctx.Sampled,
 		Baggage: ctx.BaggageItems,

tracer/tracer.go

@@ -1,6 +1,8 @@
 package tracer
 
 import (
+	"encoding/binary"
+	"github.com/google/uuid"
 	"time"
 
 	"github.com/go-errors/errors"
@@ -27,7 +29,7 @@ type Options struct {
 	//   func(traceID uint64) { return traceID % 64 == 0 }
 	//
 	// samples every 64th trace on average.
-	ShouldSample func(traceID uint64) bool
+	ShouldSample func(traceID uuid.UUID) bool
 	// TrimUnsampledSpans turns potentially expensive operations on unsampled
 	// Spans into no-ops. More precisely, tags and log events are silently
 	// discarded. If NewSpanEventListener is set, the callbacks will still fire.
@@ -100,7 +102,13 @@ type Options struct {
 // returned object with a Tracer.
 func DefaultOptions() Options {
 	return Options{
-		ShouldSample:   func(traceID uint64) bool { return traceID%64 == 0 },
+		ShouldSample: func(traceID uuid.UUID) bool {
+			bytes, err := traceID.MarshalBinary()
+			if err != nil {
+				return false
+			}
+			return binary.LittleEndian.Uint64(bytes[8:])%64 == 0
+		},
 		MaxLogsPerSpan: 100,
 	}
 }
@@ -195,7 +203,7 @@ ReferencesLoop:
 			break ReferencesLoop
 		}
 	}
-	if sp.raw.Context.TraceID == 0 {
+	if sp.raw.Context.TraceID == uuid.Nil {
 		// No parent Span found; allocate new trace and span ids and determine
 		// the Sampled status.
 		sp.raw.Context.TraceID, sp.raw.Context.SpanID = randomID2()

tracer/util.go

@@ -1,6 +1,7 @@
 package tracer
 
 import (
+	"github.com/google/uuid"
 	"math/rand"
 	"sync"
 	"time"
@@ -18,8 +19,8 @@ func randomID() uint64 {
 	return uint64(seededIDGen.Int63())
 }
 
-func randomID2() (uint64, uint64) {
+func randomID2() (uuid.UUID, uint64) {
 	seededIDLock.Lock()
 	defer seededIDLock.Unlock()
-	return uint64(seededIDGen.Int63()), uint64(seededIDGen.Int63())
+	return uuid.New(), uint64(seededIDGen.Int63())
 }