Compare commits

..

No commits in common. "master" and "v4.0.0" have entirely different histories.

7 changed files with 109 additions and 228 deletions

View File

@ -12,7 +12,7 @@ jobs:
- name: setup - name: setup
uses: actions/setup-go@v3 uses: actions/setup-go@v3
with: with:
go-version: 1.21 go-version: 1.17
- name: checkout - name: checkout
uses: actions/checkout@v3 uses: actions/checkout@v3
- name: cache - name: cache

View File

@ -12,7 +12,7 @@ jobs:
- name: setup - name: setup
uses: actions/setup-go@v3 uses: actions/setup-go@v3
with: with:
go-version: 1.20 go-version: 1.17
- name: checkout - name: checkout
uses: actions/checkout@v3 uses: actions/checkout@v3
- name: cache - name: cache

8
go.mod
View File

@ -4,7 +4,11 @@ go 1.20
require ( require (
github.com/opentracing/opentracing-go v1.2.0 github.com/opentracing/opentracing-go v1.2.0
go.unistack.org/micro/v4 v4.0.13 go.unistack.org/micro/v4 v4.0.1
) )
require github.com/stretchr/testify v1.8.3 // indirect 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
)

14
go.sum
View File

@ -1,13 +1,17 @@
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= 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 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
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 h1:uEJPy/1a5RIPAJ0Ov+OIO8OxWu77jEv+1B0VhjKrZUs=
github.com/opentracing/opentracing-go v1.2.0/go.mod h1:GxEUsuufX4nBwe+T+Wl9TAgYrxe9dPLANfrWvHYVTgc= 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 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= 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/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.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
github.com/stretchr/testify v1.8.3 h1:RP3t2pwF7cMEbC1dqtB6poj3niw/9gnV4Cjg5oW5gtY= github.com/stretchr/testify v1.5.1 h1:nOGnQDM7FYENwehXlg/kFVnos3rEvtKTjRvOWSzb6H4=
github.com/stretchr/testify v1.8.3/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo= github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA=
go.unistack.org/micro/v4 v4.0.13 h1:wyprk+KNAv/zR6bri6p6ucmXcJ9WyZ/vzru4zjPd8dA= go.unistack.org/micro/v4 v4.0.1 h1:xo1IxbVfgh8i0eY0VeYa3cbb13u5n/Mxnp3FOgWD4Jo=
go.unistack.org/micro/v4 v4.0.13/go.mod h1:ZDgU9931vm2l7X6RN/6UuwRIVp24GRdmQ7dKmegArk4= go.unistack.org/micro/v4 v4.0.1/go.mod h1:p/J5UcSJjfHsWGT31uKoghQ5rUQZzQJBAFy+Z4+ZVMs=
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= 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=

View File

@ -3,40 +3,31 @@ package opentracing
import ( import (
"context" "context"
"errors" "errors"
"fmt"
ot "github.com/opentracing/opentracing-go" "github.com/opentracing/opentracing-go"
otlog "github.com/opentracing/opentracing-go/log" "github.com/opentracing/opentracing-go/log"
"go.unistack.org/micro/v4/metadata" "go.unistack.org/micro/v4/metadata"
"go.unistack.org/micro/v4/options"
"go.unistack.org/micro/v4/tracer" "go.unistack.org/micro/v4/tracer"
rutil "go.unistack.org/micro/v4/util/reflect"
) )
var _ tracer.Tracer = &otTracer{} var _ tracer.Tracer = &otTracer{}
type otTracer struct { type otTracer struct {
opts tracer.Options opts tracer.Options
tracer ot.Tracer tracer opentracing.Tracer
} }
func (t *otTracer) Name() string { func (ot *otTracer) Name() string {
return t.opts.Name return ot.opts.Name
} }
func (t *otTracer) Flush(ctx context.Context) error { func (ot *otTracer) Init(opts ...tracer.Option) error {
return nil
}
func (t *otTracer) Init(opts ...options.Option) error {
for _, o := range opts { for _, o := range opts {
if err := o(&t.opts); err != nil { o(&ot.opts)
return err
}
} }
if tr, ok := t.opts.Context.Value(tracerKey{}).(ot.Tracer); ok { if tr, ok := ot.opts.Context.Value(tracerKey{}).(opentracing.Tracer); ok {
t.tracer = tr ot.tracer = tr
} else { } else {
return errors.New("Tracer option missing") return errors.New("Tracer option missing")
} }
@ -44,69 +35,32 @@ func (t *otTracer) Init(opts ...options.Option) error {
return nil return nil
} }
type spanContext interface { func (ot *otTracer) Start(ctx context.Context, name string, opts ...tracer.SpanOption) (context.Context, tracer.Span) {
TraceID() idStringer
SpanID() idStringer
}
func (t *otTracer) Start(ctx context.Context, name string, opts ...options.Option) (context.Context, tracer.Span) {
options := tracer.NewSpanOptions(opts...) options := tracer.NewSpanOptions(opts...)
var span ot.Span var span opentracing.Span
switch options.Kind { switch options.Kind {
case tracer.SpanKindUnspecified: case tracer.SpanKindInternal, tracer.SpanKindUnspecified:
ctx, span = t.startSpanFromAny(ctx, name) ctx, span = ot.startSpanFromContext(ctx, name)
case tracer.SpanKindInternal:
ctx, span = t.startSpanFromContext(ctx, name)
case tracer.SpanKindClient, tracer.SpanKindProducer: case tracer.SpanKindClient, tracer.SpanKindProducer:
ctx, span = t.startSpanFromOutgoingContext(ctx, name) ctx, span = ot.startSpanFromOutgoingContext(ctx, name)
case tracer.SpanKindServer, tracer.SpanKindConsumer: case tracer.SpanKindServer, tracer.SpanKindConsumer:
ctx, span = t.startSpanFromIncomingContext(ctx, name) ctx, span = ot.startSpanFromIncomingContext(ctx, ot.tracer, name)
} }
return ctx, &otSpan{span: span, opts: options}
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 { type otSpan struct {
span ot.Span span opentracing.Span
spanID string
traceID string
opts tracer.SpanOptions opts tracer.SpanOptions
status tracer.SpanStatus status tracer.SpanStatus
statusMsg string 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) { func (os *otSpan) SetStatus(st tracer.SpanStatus, msg string) {
switch st {
case tracer.SpanStatusError:
os.span.SetTag("error", true)
}
os.status = st os.status = st
os.statusMsg = msg os.statusMsg = msg
} }
@ -119,54 +73,19 @@ func (os *otSpan) Tracer() tracer.Tracer {
return &otTracer{tracer: os.span.Tracer()} return &otTracer{tracer: os.span.Tracer()}
} }
func (os *otSpan) AddLogs(kv ...interface{}) { func (os *otSpan) Finish(opts ...tracer.SpanOption) {
os.span.LogKV(kv...) if len(os.opts.Labels) > 0 {
os.span.LogKV(os.opts.Labels...)
} }
func (os *otSpan) Finish(opts ...options.Option) {
if len(os.opts.Labels)%2 != 0 {
os.opts.Labels = os.opts.Labels[:len(os.opts.Labels)-1]
}
os.opts.Labels = tracer.UniqLabels(os.opts.Labels)
for idx := 0; idx < len(os.opts.Labels); idx += 2 {
k, ok := os.opts.Labels[idx].(string)
if !ok {
continue
}
v, ok := os.opts.Labels[idx+1].(string)
if !ok {
v = fmt.Sprintf("%v", os.opts.Labels[idx+1])
}
switch k {
case "err":
os.status = tracer.SpanStatusError
os.statusMsg = v
case "error":
continue
case "X-Request-Id", "x-request-id":
os.span.SetTag("x-request-id", v)
case "rpc.call", "rpc.call_type", "rpc.flavor", "rpc.service", "rpc.method",
"sdk.database", "db.statement", "db.args", "db.query", "db.method",
"messaging.destination.name", "messaging.source.name", "messaging.operation":
os.span.SetTag(k, v)
default:
os.span.LogKV(k, v)
}
}
if os.status == tracer.SpanStatusError {
os.span.SetTag("error", true)
os.span.LogKV("error", os.statusMsg)
}
os.span.SetTag("span.kind", os.opts.Kind)
os.span.Finish() os.span.Finish()
} }
func (os *otSpan) AddEvent(name string, opts ...options.Option) { func (os *otSpan) AddEvent(name string, opts ...tracer.EventOption) {
os.span.LogFields(otlog.Event(name)) os.span.LogFields(log.Event(name))
} }
func (os *otSpan) Context() context.Context { 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) { func (os *otSpan) SetName(name string) {
@ -185,142 +104,80 @@ func (os *otSpan) AddLabels(labels ...interface{}) {
os.opts.Labels = append(os.opts.Labels, labels...) os.opts.Labels = append(os.opts.Labels, labels...)
} }
func NewTracer(opts ...options.Option) *otTracer { func NewTracer(opts ...tracer.Option) *otTracer {
options := tracer.NewOptions(opts...) options := tracer.NewOptions(opts...)
return &otTracer{opts: options} return &otTracer{opts: options}
} }
func (t *otTracer) startSpanFromAny(ctx context.Context, name string, opts ...ot.StartSpanOption) (context.Context, ot.Span) { func spanFromContext(ctx context.Context) opentracing.Span {
if tracerSpan, ok := tracer.SpanFromContext(ctx); ok && tracerSpan != nil { return opentracing.SpanFromContext(ctx)
return t.startSpanFromContext(ctx, name, opts...)
} }
if otSpan := ot.SpanFromContext(ctx); otSpan != nil { func (ot *otTracer) startSpanFromContext(ctx context.Context, name string, opts ...opentracing.StartSpanOption) (context.Context, opentracing.Span) {
return t.startSpanFromContext(ctx, name, opts...) if parentSpan := opentracing.SpanFromContext(ctx); parentSpan != nil {
} opts = append(opts, opentracing.ChildOf(parentSpan.Context()))
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 (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()))
} }
md := metadata.New(1) md := metadata.New(1)
sp := t.tracer.StartSpan(name, opts...) sp := ot.tracer.StartSpan(name, opts...)
if err := sp.Tracer().Inject(sp.Context(), ot.TextMap, ot.TextMapCarrier(md)); err != nil { if err := sp.Tracer().Inject(sp.Context(), opentracing.TextMap, opentracing.TextMapCarrier(md)); err != nil {
return nil, nil return nil, nil
} }
ctx = ot.ContextWithSpan(ctx, sp) ctx = opentracing.ContextWithSpan(ctx, sp)
return ctx, sp return ctx, sp
} }
func (t *otTracer) startSpanFromOutgoingContext(ctx context.Context, name string, opts ...ot.StartSpanOption) (context.Context, ot.Span) { func (ot *otTracer) startSpanFromOutgoingContext(ctx context.Context, name string, opts ...opentracing.StartSpanOption) (context.Context, opentracing.Span) {
var parentSpan ot.Span var parentCtx opentracing.SpanContext
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
}
}
md, ok := metadata.FromOutgoingContext(ctx) 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 ok && md != nil {
if spanCtx, err := t.tracer.Extract(ot.TextMap, ot.TextMapCarrier(md)); err == nil && ok { if spanCtx, err := ot.tracer.Extract(opentracing.TextMap, opentracing.TextMapCarrier(md)); err == nil && ok {
parentCtx = spanCtx parentCtx = spanCtx
} }
} }
if parentCtx != nil { if parentCtx != nil {
opts = append(opts, ot.ChildOf(parentCtx)) opts = append(opts, opentracing.ChildOf(parentCtx))
}
} }
nmd := metadata.Copy(md) nmd := metadata.Copy(md)
sp := t.tracer.StartSpan(name, opts...) sp := ot.tracer.StartSpan(name, opts...)
if err := sp.Tracer().Inject(sp.Context(), ot.TextMap, ot.TextMapCarrier(nmd)); err != nil { if err := sp.Tracer().Inject(sp.Context(), opentracing.TextMap, opentracing.TextMapCarrier(nmd)); err != nil {
return nil, nil return nil, nil
} }
ctx = metadata.NewOutgoingContext(ot.ContextWithSpan(ctx, sp), nmd) ctx = metadata.NewOutgoingContext(opentracing.ContextWithSpan(ctx, sp), nmd)
return ctx, sp return ctx, sp
} }
func (t *otTracer) startSpanFromIncomingContext(ctx context.Context, name string, opts ...ot.StartSpanOption) (context.Context, ot.Span) { func (ot *otTracer) startSpanFromIncomingContext(ctx context.Context, tracer opentracing.Tracer, name string, opts ...opentracing.StartSpanOption) (context.Context, opentracing.Span) {
var parentSpan ot.Span var parentCtx opentracing.SpanContext
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
}
}
md, ok := metadata.FromIncomingContext(ctx) 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 ok && md != nil {
if spanCtx, err := t.tracer.Extract(ot.TextMap, ot.TextMapCarrier(md)); err == nil { if spanCtx, err := tracer.Extract(opentracing.TextMap, opentracing.TextMapCarrier(md)); err == nil {
parentCtx = spanCtx parentCtx = spanCtx
} }
} }
if parentCtx != nil { if parentCtx != nil {
opts = append(opts, ot.ChildOf(parentCtx)) opts = append(opts, opentracing.ChildOf(parentCtx))
}
} }
nmd := metadata.Copy(md) nmd := metadata.Copy(md)
sp := t.tracer.StartSpan(name, opts...) sp := tracer.StartSpan(name, opts...)
if err := sp.Tracer().Inject(sp.Context(), ot.TextMap, ot.TextMapCarrier(nmd)); err != nil { if err := sp.Tracer().Inject(sp.Context(), opentracing.TextMap, opentracing.TextMapCarrier(nmd)); err != nil {
return nil, nil return nil, nil
} }
ctx = metadata.NewIncomingContext(ot.ContextWithSpan(ctx, sp), nmd) ctx = metadata.NewIncomingContext(opentracing.ContextWithSpan(ctx, sp), nmd)
return ctx, sp return ctx, sp
} }

View File

@ -2,31 +2,47 @@ package opentracing
import ( import (
"context" "context"
"sync"
"testing" "testing"
"github.com/opentracing/opentracing-go/mocktracer" opentracing "github.com/opentracing/opentracing-go"
"go.unistack.org/micro/v4/metadata" "go.unistack.org/micro/v4/metadata"
"go.unistack.org/micro/v4/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()) ctx, cancel := context.WithCancel(context.Background())
defer cancel() defer cancel()
ctx = metadata.NewIncomingContext(ctx, md) ctx = metadata.NewIncomingContext(ctx, md)
tr := NewTracer(Tracer(mocktracer.New())) tracer := opentracing.GlobalTracer()
if err := tr.Init(); err != nil { 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()
}()
}
for {
select {
default:
g.Wait()
close(cherr)
case err, ok := <-cherr:
if err != nil {
t.Fatal(err) t.Fatal(err)
} } else if !ok {
return
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)
} }
} }

View File

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