Merge pull request 'uniq labels' (#45) from imp into master

Reviewed-on: #45

go.mod

@@ -1,11 +1,10 @@
-module go.unistack.org/micro-tracer-opentracing/v3
+module go.unistack.org/micro-tracer-opentracing/v4
 
-go 1.21
+go 1.20
-
-toolchain go1.22.2
 
 require (
 	github.com/opentracing/opentracing-go v1.2.0
-	go.opentelemetry.io/otel v1.26.0
+	go.unistack.org/micro/v4 v4.0.10
-	go.unistack.org/micro/v3 v3.10.77
 )
+
+require github.com/stretchr/testify v1.8.3 // indirect

go.sum

@@ -1,19 +1,13 @@
 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/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
-github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
-github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
 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.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
+github.com/stretchr/testify v1.8.3 h1:RP3t2pwF7cMEbC1dqtB6poj3niw/9gnV4Cjg5oW5gtY=
-github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+github.com/stretchr/testify v1.8.3/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
-go.opentelemetry.io/otel v1.26.0 h1:LQwgL5s/1W7YiiRwxf03QGnWLb2HW4pLiAhaA5cZXBs=
+go.unistack.org/micro/v4 v4.0.10 h1:uKqED/n/zrJd4NGxm9OOUw26UMibgYFhf89MOTnM1go=
-go.opentelemetry.io/otel v1.26.0/go.mod h1:UmLkJHUAidDval2EICqBMbnAd0/m2vmpf/dAM+fvFs4=
+go.unistack.org/micro/v4 v4.0.10/go.mod h1:QT3gOIE4qGgBiQGm2Pad/62Sl5R53QfrgYHD448aX14=
-go.unistack.org/micro/v3 v3.10.77 h1:nn731y84q3S8a4UgpVdC/wN9cs30ruZeH81rKw6XcUc=
-go.unistack.org/micro/v3 v3.10.77/go.mod h1:erMgt3Bl7vQQ0e9UpQyR5NlLiZ9pKeEJ9+1tfYFaqUg=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
-gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

opentracing.go

@@ -7,10 +7,9 @@ import (
 
 	ot "github.com/opentracing/opentracing-go"
 	otlog "github.com/opentracing/opentracing-go/log"
-	"go.opentelemetry.io/otel/attribute"
+	"go.unistack.org/micro/v4/metadata"
-	"go.unistack.org/micro/v3/metadata"
+	"go.unistack.org/micro/v4/options"
-	"go.unistack.org/micro/v3/tracer"
+	"go.unistack.org/micro/v4/tracer"
-	rutil "go.unistack.org/micro/v3/util/reflect"
 )
 
 var _ tracer.Tracer = &otTracer{}
@@ -28,7 +27,7 @@ func (t *otTracer) Flush(ctx context.Context) error {
 	return nil
 }
 
-func (t *otTracer) Init(opts ...tracer.Option) error {
+func (t *otTracer) Init(opts ...options.Option) error {
 	for _, o := range opts {
 		o(&t.opts)
 	}
@@ -42,16 +41,8 @@ func (t *otTracer) Init(opts ...tracer.Option) error {
 	return nil
 }
 
-type spanContext interface {
+func (t *otTracer) Start(ctx context.Context, name string, opts ...options.Option) (context.Context, tracer.Span) {
-	TraceID() idStringer
-	SpanID() idStringer
-}
-
-func (t *otTracer) Start(ctx context.Context, name string, opts ...tracer.SpanOption) (context.Context, tracer.Span) {
 	options := tracer.NewSpanOptions(opts...)
-	if len(options.Labels)%2 != 0 {
-		options.Labels = options.Labels[:len(options.Labels)-1]
-	}
 	var span ot.Span
 	switch options.Kind {
 	case tracer.SpanKindUnspecified:
@@ -63,50 +54,15 @@ func (t *otTracer) Start(ctx context.Context, name string, opts ...tracer.SpanOp
 	case tracer.SpanKindServer, tracer.SpanKindConsumer:
 		ctx, span = t.startSpanFromIncomingContext(ctx, 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
-}
-
 type otSpan struct {
 	span      ot.Span
-	spanID    string
-	traceID   string
 	opts      tracer.SpanOptions
 	status    tracer.SpanStatus
 	statusMsg string
-	labels    []interface{}
-	finished  bool
-}
-
-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) {
@@ -122,61 +78,40 @@ func (os *otSpan) Tracer() tracer.Tracer {
 	return &otTracer{tracer: os.span.Tracer()}
 }
 
-func (os *otSpan) Finish(opts ...tracer.SpanOption) {
+func (os *otSpan) Finish(opts ...options.Option) {
-	if os.finished {
+	if len(os.opts.Labels)%2 != 0 {
-		return
+		os.opts.Labels = os.opts.Labels[:len(os.opts.Labels)-1]
 	}
-
+	os.opts.Labels = tracer.UniqLabels(os.opts.Labels)
-	options := os.opts
+	for idx := 0; idx < len(os.opts.Labels); idx += 2 {
-
+		switch os.opts.Labels[idx] {
-	options.Status = os.status
+		case "err":
-	options.StatusMsg = os.statusMsg
+			os.status = tracer.SpanStatusError
-	options.Labels = append(options.Labels, os.labels...)
+			os.statusMsg = fmt.Sprintf("%v", os.opts.Labels[idx+1])
-
+		case "error":
-	for _, o := range opts {
+			continue
-		o(&options)
+		case "X-Request-Id", "x-request-id":
-	}
+			os.span.SetTag("x-request-id", os.opts.Labels[idx+1])
-
+		case "rpc.call", "rpc.call_type", "rpc.flavor", "rpc.service", "rpc.method",
-	if !options.Record {
+			"sdk.database", "db.statement", "db.args", "db.query", "db.method",
-		return
+			"messaging.destination.name", "messaging.source.name":
-	}
+			os.span.SetTag(fmt.Sprintf("%v", os.opts.Labels[idx]), os.opts.Labels[idx+1])
-
+		default:
-	if len(options.Labels)%2 != 0 {
+			os.span.LogKV(os.opts.Labels[idx], os.opts.Labels[idx+1])
-		options.Labels = options.Labels[:len(options.Labels)-1]
-	}
-
-	l := len(options.Labels)
-	for idx := 0; idx < l; 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 {
-	if options.Status == tracer.SpanStatusError {
 		os.span.SetTag("error", true)
-		os.span.LogKV("error", options.StatusMsg)
+		os.span.LogKV("error", os.statusMsg)
 	}
-
+	os.span.SetTag("span.kind", os.opts.Kind)
-	os.span.SetTag("span.kind", options.Kind)
 	os.span.Finish()
-
-	os.finished = true
 }
 
-func (os *otSpan) AddEvent(name string, opts ...tracer.EventOption) {
+func (os *otSpan) AddEvent(name string, opts ...options.Option) {
 	os.span.LogFields(otlog.Event(name))
 }
 
-func (os *otSpan) AddLogs(kv ...interface{}) {
-	os.span.LogKV(kv...)
-}
-
 func (os *otSpan) Context() context.Context {
 	return ot.ContextWithSpan(context.Background(), os.span)
 }
@@ -194,14 +129,18 @@ func (os *otSpan) Kind() tracer.SpanKind {
 }
 
 func (os *otSpan) AddLabels(labels ...interface{}) {
-	os.labels = append(os.labels, labels...)
+	os.opts.Labels = append(os.opts.Labels, labels...)
 }
 
-func NewTracer(opts ...tracer.Option) *otTracer {
+func NewTracer(opts ...options.Option) *otTracer {
 	options := tracer.NewOptions(opts...)
 	return &otTracer{opts: options}
 }
 
+func spanFromContext(ctx context.Context) ot.Span {
+	return ot.SpanFromContext(ctx)
+}
+
 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...)

opentracing_test.go

@@ -2,60 +2,49 @@ package opentracing
 
 import (
 	"context"
-	"fmt"
+	"sync"
 	"testing"
 
-	"github.com/opentracing/opentracing-go/mocktracer"
+	opentracing "github.com/opentracing/opentracing-go"
-	"go.unistack.org/micro/v3/metadata"
+	"go.unistack.org/micro/v4/metadata"
-	"go.unistack.org/micro/v3/tracer"
 )
 
-func TestTraceID(t *testing.T) {
+func TestStartSpanFromIncomingContext(t *testing.T) {
-	md := metadata.New(1)
+	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()))
+	tracer := opentracing.GlobalTracer()
-	if err := tr.Init(); err != nil {
+
-		t.Fatal(err)
+	g.Add(8000)
+	cherr := make(chan error)
+	for i := 0; i < 8000; i++ {
+		go func() {
+			defer g.Done()
+			_, sp, err := startSpanFromIncomingContext(ctx, tracer, "test")
+			if err != nil {
+				cherr <- err
+			}
+			sp.Finish()
+		}()
 	}
 
-	var sp tracer.Span
+	for {
-
+		select {
-	ctx, sp = tr.Start(ctx, "test")
+		default:
-	if v := sp.TraceID(); v != "43" {
+			g.Wait()
-		t.Fatalf("invalid span trace id %#+v", v)
+			close(cherr)
-	}
+		case err, ok := <-cherr:
-	if v := sp.SpanID(); v != "44" {
+			if err != nil {
-		t.Fatalf("invalid span span id %#+v", v)
+				t.Fatal(err)
-	}
+			} else if !ok {
-}
+				return
-
+			}
-func TestTraceTags(t *testing.T) {
+		}
-	md := metadata.New(1)
-	ctx, cancel := context.WithCancel(context.Background())
-	defer cancel()
-	ctx = metadata.NewIncomingContext(ctx, md)
-
-	mtr := mocktracer.New()
-	tr := NewTracer(Tracer(mtr))
-	if err := tr.Init(); err != nil {
-		t.Fatal(err)
-	}
-
-	var sp tracer.Span
-
-	ctx, sp = tr.Start(ctx, "test", tracer.WithSpanLabels("key", "val", "odd"))
-	sp.Finish(tracer.WithSpanLabels("xkey", "xval"))
-	_ = ctx
-	msp := mtr.FinishedSpans()[0]
-
-	if "val" != fmt.Sprintf("%v", msp.Tags()["key"]) {
-		t.Fatal("mock span invalid")
-	}
-
-	if "xval" != fmt.Sprintf("%v", msp.Tags()["xkey"]) {
-		t.Fatalf("mock span invalid %#+v", msp)
 	}
 }

options.go

@@ -2,11 +2,11 @@ package opentracing
 
 import (
 	"github.com/opentracing/opentracing-go"
-	"go.unistack.org/micro/v3/tracer"
+	"go.unistack.org/micro/v4/options"
 )
 
 type tracerKey struct{}
 
-func Tracer(ot opentracing.Tracer) tracer.Option {
+func Tracer(ot opentracing.Tracer) options.Option {
-	return tracer.SetOption(tracerKey{}, ot)
+	return options.ContextOption(tracerKey{}, ot)
 }