Merge pull request 'move to micro v4' (#40) from v4 into master

Reviewed-on: #40

go.mod

@@ -1,9 +1,14 @@
-module go.unistack.org/micro-tracer-opentracing/v3
+module go.unistack.org/micro-tracer-opentracing/v4
 
 go 1.20
 
 require (
 	github.com/opentracing/opentracing-go v1.2.0
-	go.opentelemetry.io/otel v1.24.0
-	go.unistack.org/micro/v3 v3.10.43
+	go.unistack.org/micro/v4 v4.0.1
+)
+
+require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/stretchr/testify v1.5.1 // indirect
+	gopkg.in/yaml.v2 v2.4.0 // indirect
 )

go.sum

@@ -1,15 +1,17 @@
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
-github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/opentracing/opentracing-go v1.2.0 h1:uEJPy/1a5RIPAJ0Ov+OIO8OxWu77jEv+1B0VhjKrZUs=
 github.com/opentracing/opentracing-go v1.2.0/go.mod h1:GxEUsuufX4nBwe+T+Wl9TAgYrxe9dPLANfrWvHYVTgc=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
-github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk=
-go.opentelemetry.io/otel v1.24.0 h1:0LAOdjNmQeSTzGBzduGe/rU4tZhMwL5rWgtp9Ku5Jfo=
-go.opentelemetry.io/otel v1.24.0/go.mod h1:W7b9Ozg4nkF5tWI5zsXkaKKDjdVjpD4oAt9Qi/MArHo=
-go.unistack.org/micro/v3 v3.10.43 h1:GjUgu1lSKrhIov67jZQg6hUVUw0xZ6+ub8s6JRu6uj4=
-go.unistack.org/micro/v3 v3.10.43/go.mod h1:CSmEf5ddmft94MyKHnUSMM0W5dpmmTVbgImbgQWV5Ak=
-gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+github.com/stretchr/testify v1.5.1 h1:nOGnQDM7FYENwehXlg/kFVnos3rEvtKTjRvOWSzb6H4=
+github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA=
+go.unistack.org/micro/v4 v4.0.1 h1:xo1IxbVfgh8i0eY0VeYa3cbb13u5n/Mxnp3FOgWD4Jo=
+go.unistack.org/micro/v4 v4.0.1/go.mod h1:p/J5UcSJjfHsWGT31uKoghQ5rUQZzQJBAFy+Z4+ZVMs=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=
+gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=

opentracing.go

@@ -3,38 +3,31 @@ package opentracing
 import (
 	"context"
 	"errors"
-	"fmt"
 
-	ot "github.com/opentracing/opentracing-go"
-	otlog "github.com/opentracing/opentracing-go/log"
-	"go.opentelemetry.io/otel/attribute"
-	"go.unistack.org/micro/v3/metadata"
-	"go.unistack.org/micro/v3/tracer"
-	rutil "go.unistack.org/micro/v3/util/reflect"
+	"github.com/opentracing/opentracing-go"
+	"github.com/opentracing/opentracing-go/log"
+	"go.unistack.org/micro/v4/metadata"
+	"go.unistack.org/micro/v4/tracer"
 )
 
 var _ tracer.Tracer = &otTracer{}
 
 type otTracer struct {
 	opts   tracer.Options
-	tracer ot.Tracer
+	tracer opentracing.Tracer
 }
 
-func (t *otTracer) Name() string {
-	return t.opts.Name
+func (ot *otTracer) Name() string {
+	return ot.opts.Name
 }
 
-func (t *otTracer) Flush(ctx context.Context) error {
-	return nil
-}
-
-func (t *otTracer) Init(opts ...tracer.Option) error {
+func (ot *otTracer) Init(opts ...tracer.Option) error {
 	for _, o := range opts {
-		o(&t.opts)
+		o(&ot.opts)
 	}
 
-	if tr, ok := t.opts.Context.Value(tracerKey{}).(ot.Tracer); ok {
-		t.tracer = tr
+	if tr, ok := ot.opts.Context.Value(tracerKey{}).(opentracing.Tracer); ok {
+		ot.tracer = tr
 	} else {
 		return errors.New("Tracer option missing")
 	}
@@ -42,69 +35,32 @@ func (t *otTracer) Init(opts ...tracer.Option) error {
 	return nil
 }
 
-type spanContext interface {
-	TraceID() idStringer
-	SpanID() idStringer
-}
-
-func (t *otTracer) Start(ctx context.Context, name string, opts ...tracer.SpanOption) (context.Context, tracer.Span) {
+func (ot *otTracer) Start(ctx context.Context, name string, opts ...tracer.SpanOption) (context.Context, tracer.Span) {
 	options := tracer.NewSpanOptions(opts...)
-	var span ot.Span
+	var span opentracing.Span
 	switch options.Kind {
-	case tracer.SpanKindUnspecified:
-		ctx, span = t.startSpanFromAny(ctx, name)
-	case tracer.SpanKindInternal:
-		ctx, span = t.startSpanFromContext(ctx, name)
+	case tracer.SpanKindInternal, tracer.SpanKindUnspecified:
+		ctx, span = ot.startSpanFromContext(ctx, name)
 	case tracer.SpanKindClient, tracer.SpanKindProducer:
-		ctx, span = t.startSpanFromOutgoingContext(ctx, name)
+		ctx, span = ot.startSpanFromOutgoingContext(ctx, name)
 	case tracer.SpanKindServer, tracer.SpanKindConsumer:
-		ctx, span = t.startSpanFromIncomingContext(ctx, name)
+		ctx, span = ot.startSpanFromIncomingContext(ctx, ot.tracer, name)
 	}
-
-	sp := &otSpan{span: span, opts: options}
-
-	spctx := span.Context()
-	if v, ok := spctx.(spanContext); ok {
-		sp.traceID = v.TraceID().String()
-		sp.spanID = v.SpanID().String()
-	} else {
-		if val, err := rutil.StructFieldByName(spctx, "TraceID"); err == nil {
-			sp.traceID = fmt.Sprintf("%v", val)
-		}
-		if val, err := rutil.StructFieldByName(spctx, "SpanID"); err == nil {
-			sp.spanID = fmt.Sprintf("%v", val)
-		}
-	}
-
-	return tracer.NewSpanContext(ctx, sp), sp
-}
-
-type idStringer struct {
-	s string
-}
-
-func (s idStringer) String() string {
-	return s.s
+	return ctx, &otSpan{span: span, opts: options}
 }
 
 type otSpan struct {
-	span      ot.Span
-	spanID    string
-	traceID   string
+	span      opentracing.Span
 	opts      tracer.SpanOptions
 	status    tracer.SpanStatus
 	statusMsg string
 }
 
-func (os *otSpan) TraceID() string {
-	return os.traceID
-}
-
-func (os *otSpan) SpanID() string {
-	return os.spanID
-}
-
 func (os *otSpan) SetStatus(st tracer.SpanStatus, msg string) {
+	switch st {
+	case tracer.SpanStatusError:
+		os.span.SetTag("error", true)
+	}
 	os.status = st
 	os.statusMsg = msg
 }
@@ -118,42 +74,18 @@ func (os *otSpan) Tracer() tracer.Tracer {
 }
 
 func (os *otSpan) Finish(opts ...tracer.SpanOption) {
-	options := os.opts
-	for _, o := range opts {
-		o(&options)
+	if len(os.opts.Labels) > 0 {
+		os.span.LogKV(os.opts.Labels...)
 	}
-
-	l := len(options.Labels)
-	for idx := 0; idx < len(options.Labels); idx++ {
-		switch lt := options.Labels[idx].(type) {
-		case attribute.KeyValue:
-			os.span.SetTag(string(lt.Key), lt.Value.AsInterface())
-		case string:
-			if l < idx+1 {
-				os.span.SetTag(lt, options.Labels[idx+1])
-				idx++
-			}
-		}
-	}
-
-	if os.status == tracer.SpanStatusError {
-		os.span.SetTag("error", true)
-		os.span.LogKV("error", os.statusMsg)
-	}
-	os.span.SetTag("span.kind", options.Kind)
 	os.span.Finish()
 }
 
 func (os *otSpan) AddEvent(name string, opts ...tracer.EventOption) {
-	os.span.LogFields(otlog.Event(name))
-}
-
-func (os *otSpan) AddLogs(kv ...interface{}) {
-	os.span.LogKV(kv...)
+	os.span.LogFields(log.Event(name))
 }
 
 func (os *otSpan) Context() context.Context {
-	return ot.ContextWithSpan(context.Background(), os.span)
+	return opentracing.ContextWithSpan(context.Background(), os.span)
 }
 
 func (os *otSpan) SetName(name string) {
@@ -169,18 +101,7 @@ func (os *otSpan) Kind() tracer.SpanKind {
 }
 
 func (os *otSpan) AddLabels(labels ...interface{}) {
-	l := len(labels)
-	for idx := 0; idx < len(labels); idx++ {
-		switch lt := labels[idx].(type) {
-		case attribute.KeyValue:
-			os.span.SetTag(string(lt.Key), lt.Value.AsInterface())
-		case string:
-			if l < idx+1 {
-				os.span.SetTag(lt, labels[idx+1])
-				idx++
-			}
-		}
-	}
+	os.opts.Labels = append(os.opts.Labels, labels...)
 }
 
 func NewTracer(opts ...tracer.Option) *otTracer {
@@ -188,137 +109,75 @@ func NewTracer(opts ...tracer.Option) *otTracer {
 	return &otTracer{opts: options}
 }
 
-func (t *otTracer) startSpanFromAny(ctx context.Context, name string, opts ...ot.StartSpanOption) (context.Context, ot.Span) {
-	if tracerSpan, ok := tracer.SpanFromContext(ctx); ok && tracerSpan != nil {
-		return t.startSpanFromContext(ctx, name, opts...)
-	}
-
-	if otSpan := ot.SpanFromContext(ctx); otSpan != nil {
-		return t.startSpanFromContext(ctx, name, opts...)
-	}
-
-	if md, ok := metadata.FromIncomingContext(ctx); ok && md != nil {
-		return t.startSpanFromIncomingContext(ctx, name, opts...)
-	}
-
-	if md, ok := metadata.FromOutgoingContext(ctx); ok && md != nil {
-		return t.startSpanFromOutgoingContext(ctx, name, opts...)
-	}
-
-	return t.startSpanFromContext(ctx, name, opts...)
+func spanFromContext(ctx context.Context) opentracing.Span {
+	return opentracing.SpanFromContext(ctx)
 }
 
-func (t *otTracer) startSpanFromContext(ctx context.Context, name string, opts ...ot.StartSpanOption) (context.Context, ot.Span) {
-	var parentSpan ot.Span
-	if tracerSpan, ok := tracer.SpanFromContext(ctx); ok && tracerSpan != nil {
-		if sp, ok := tracerSpan.(*otSpan); ok {
-			parentSpan = sp.span
-		}
-	}
-	if parentSpan == nil {
-		if otSpan := ot.SpanFromContext(ctx); otSpan != nil {
-			parentSpan = otSpan
-		}
-	}
-
-	if parentSpan != nil {
-		opts = append(opts, ot.ChildOf(parentSpan.Context()))
+func (ot *otTracer) startSpanFromContext(ctx context.Context, name string, opts ...opentracing.StartSpanOption) (context.Context, opentracing.Span) {
+	if parentSpan := opentracing.SpanFromContext(ctx); parentSpan != nil {
+		opts = append(opts, opentracing.ChildOf(parentSpan.Context()))
 	}
 
 	md := metadata.New(1)
 
-	sp := t.tracer.StartSpan(name, opts...)
-	if err := sp.Tracer().Inject(sp.Context(), ot.TextMap, ot.TextMapCarrier(md)); err != nil {
+	sp := ot.tracer.StartSpan(name, opts...)
+	if err := sp.Tracer().Inject(sp.Context(), opentracing.TextMap, opentracing.TextMapCarrier(md)); err != nil {
 		return nil, nil
 	}
 
-	ctx = ot.ContextWithSpan(ctx, sp)
+	ctx = opentracing.ContextWithSpan(ctx, sp)
 
 	return ctx, sp
 }
 
-func (t *otTracer) startSpanFromOutgoingContext(ctx context.Context, name string, opts ...ot.StartSpanOption) (context.Context, ot.Span) {
-	var parentSpan ot.Span
-	if tracerSpan, ok := tracer.SpanFromContext(ctx); ok && tracerSpan != nil {
-		if sp, ok := tracerSpan.(*otSpan); ok {
-			parentSpan = sp.span
-		}
-	}
-	if parentSpan == nil {
-		if otSpan := ot.SpanFromContext(ctx); otSpan != nil {
-			parentSpan = otSpan
-		}
-	}
+func (ot *otTracer) startSpanFromOutgoingContext(ctx context.Context, name string, opts ...opentracing.StartSpanOption) (context.Context, opentracing.Span) {
+	var parentCtx opentracing.SpanContext
 
 	md, ok := metadata.FromOutgoingContext(ctx)
-
-	if parentSpan != nil {
-		opts = append(opts, ot.ChildOf(parentSpan.Context()))
-	} else {
-		var parentCtx ot.SpanContext
-
-		if ok && md != nil {
-			if spanCtx, err := t.tracer.Extract(ot.TextMap, ot.TextMapCarrier(md)); err == nil && ok {
-				parentCtx = spanCtx
-			}
+	if ok && md != nil {
+		if spanCtx, err := ot.tracer.Extract(opentracing.TextMap, opentracing.TextMapCarrier(md)); err == nil && ok {
+			parentCtx = spanCtx
 		}
+	}
 
-		if parentCtx != nil {
-			opts = append(opts, ot.ChildOf(parentCtx))
-		}
+	if parentCtx != nil {
+		opts = append(opts, opentracing.ChildOf(parentCtx))
 	}
 
 	nmd := metadata.Copy(md)
 
-	sp := t.tracer.StartSpan(name, opts...)
-	if err := sp.Tracer().Inject(sp.Context(), ot.TextMap, ot.TextMapCarrier(nmd)); err != nil {
+	sp := ot.tracer.StartSpan(name, opts...)
+	if err := sp.Tracer().Inject(sp.Context(), opentracing.TextMap, opentracing.TextMapCarrier(nmd)); err != nil {
 		return nil, nil
 	}
 
-	ctx = metadata.NewOutgoingContext(ot.ContextWithSpan(ctx, sp), nmd)
+	ctx = metadata.NewOutgoingContext(opentracing.ContextWithSpan(ctx, sp), nmd)
 
 	return ctx, sp
 }
 
-func (t *otTracer) startSpanFromIncomingContext(ctx context.Context, name string, opts ...ot.StartSpanOption) (context.Context, ot.Span) {
-	var parentSpan ot.Span
-	if tracerSpan, ok := tracer.SpanFromContext(ctx); ok && tracerSpan != nil {
-		if sp, ok := tracerSpan.(*otSpan); ok {
-			parentSpan = sp.span
-		}
-	}
-	if parentSpan == nil {
-		if otSpan := ot.SpanFromContext(ctx); otSpan != nil {
-			parentSpan = otSpan
-		}
-	}
+func (ot *otTracer) startSpanFromIncomingContext(ctx context.Context, tracer opentracing.Tracer, name string, opts ...opentracing.StartSpanOption) (context.Context, opentracing.Span) {
+	var parentCtx opentracing.SpanContext
 
 	md, ok := metadata.FromIncomingContext(ctx)
-
-	if parentSpan != nil {
-		opts = append(opts, ot.ChildOf(parentSpan.Context()))
-	} else {
-		var parentCtx ot.SpanContext
-
-		if ok && md != nil {
-			if spanCtx, err := t.tracer.Extract(ot.TextMap, ot.TextMapCarrier(md)); err == nil {
-				parentCtx = spanCtx
-			}
+	if ok && md != nil {
+		if spanCtx, err := tracer.Extract(opentracing.TextMap, opentracing.TextMapCarrier(md)); err == nil {
+			parentCtx = spanCtx
 		}
+	}
 
-		if parentCtx != nil {
-			opts = append(opts, ot.ChildOf(parentCtx))
-		}
+	if parentCtx != nil {
+		opts = append(opts, opentracing.ChildOf(parentCtx))
 	}
 
 	nmd := metadata.Copy(md)
 
-	sp := t.tracer.StartSpan(name, opts...)
-	if err := sp.Tracer().Inject(sp.Context(), ot.TextMap, ot.TextMapCarrier(nmd)); err != nil {
+	sp := tracer.StartSpan(name, opts...)
+	if err := sp.Tracer().Inject(sp.Context(), opentracing.TextMap, opentracing.TextMapCarrier(nmd)); err != nil {
 		return nil, nil
 	}
 
-	ctx = metadata.NewIncomingContext(ot.ContextWithSpan(ctx, sp), nmd)
+	ctx = metadata.NewIncomingContext(opentracing.ContextWithSpan(ctx, sp), nmd)
 
 	return ctx, sp
 }

opentracing_test.go

@@ -2,31 +2,47 @@ package opentracing
 
 import (
 	"context"
+	"sync"
 	"testing"
 
-	"github.com/opentracing/opentracing-go/mocktracer"
-	"go.unistack.org/micro/v3/metadata"
-	"go.unistack.org/micro/v3/tracer"
+	opentracing "github.com/opentracing/opentracing-go"
+	"go.unistack.org/micro/v4/metadata"
 )
 
-func TestTraceID(t *testing.T) {
-	md := metadata.New(1)
+func TestStartSpanFromIncomingContext(t *testing.T) {
+	md := metadata.New(2)
+	md.Set("key", "val")
+
+	var g sync.WaitGroup
+
 	ctx, cancel := context.WithCancel(context.Background())
 	defer cancel()
 	ctx = metadata.NewIncomingContext(ctx, md)
 
-	tr := NewTracer(Tracer(mocktracer.New()))
-	if err := tr.Init(); err != nil {
-		t.Fatal(err)
+	tracer := opentracing.GlobalTracer()
+	ot := &otTracer{tracer: tracer}
+
+	g.Add(8000)
+	cherr := make(chan error)
+	for i := 0; i < 8000; i++ {
+		go func() {
+			defer g.Done()
+			_, sp := ot.startSpanFromIncomingContext(ctx, tracer, "test")
+			sp.Finish()
+		}()
 	}
 
-	var sp tracer.Span
-
-	ctx, sp = tr.Start(ctx, "test")
-	if v := sp.TraceID(); v != "43" {
-		t.Fatalf("invalid span trace id %#+v", v)
-	}
-	if v := sp.SpanID(); v != "44" {
-		t.Fatalf("invalid span span id %#+v", v)
+	for {
+		select {
+		default:
+			g.Wait()
+			close(cherr)
+		case err, ok := <-cherr:
+			if err != nil {
+				t.Fatal(err)
+			} else if !ok {
+				return
+			}
+		}
 	}
 }

options.go

@@ -2,7 +2,7 @@ package opentracing
 
 import (
 	"github.com/opentracing/opentracing-go"
-	"go.unistack.org/micro/v3/tracer"
+	"go.unistack.org/micro/v4/tracer"
 )
 
 type tracerKey struct{}