micro-tracer-opentracing/opentracing.go
Vasiliy Tolstov 89f75e0431
Some checks failed
build / test (push) Failing after 26s
build / lint (push) Successful in 25s
codeql / analyze (go) (push) Failing after 49s
improve tracing
Signed-off-by: Vasiliy Tolstov <v.tolstov@unistack.org>
2024-07-22 23:39:22 +03:00

385 lines
8.5 KiB
Go

package opentracing
import (
"context"
"errors"
"strings"
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"
)
var _ tracer.Tracer = &otTracer{}
type otTracer struct {
opts tracer.Options
tracer ot.Tracer
}
func (t *otTracer) Name() string {
return t.opts.Name
}
func (t *otTracer) Flush(ctx context.Context) error {
return nil
}
func (t *otTracer) Init(opts ...tracer.Option) error {
for _, o := range opts {
o(&t.opts)
}
if tr, ok := t.opts.Context.Value(tracerKey{}).(ot.Tracer); ok {
t.tracer = tr
} else {
return errors.New("Tracer option missing")
}
return nil
}
type otSpanContext interface {
TraceID() idStringer
SpanID() idStringer
}
type jSpanContext interface {
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]
}
for _, fn := range t.opts.ContextAttrFuncs {
options.Labels = append(options.Labels, fn(ctx)...)
}
var span ot.Span
switch options.Kind {
case tracer.SpanKindUnspecified:
ctx, span = t.startSpanFromAny(ctx, name)
case tracer.SpanKindInternal:
ctx, span = t.startSpanFromContext(ctx, name)
case tracer.SpanKindClient, tracer.SpanKindProducer:
ctx, span = t.startSpanFromOutgoingContext(ctx, name)
case tracer.SpanKindServer, tracer.SpanKindConsumer:
ctx, span = t.startSpanFromIncomingContext(ctx, name)
}
sp := &otSpan{span: span, opts: options}
spctx := span.Context()
var traceID, spanID, parentID string
if v, ok := spctx.(otSpanContext); ok {
traceID = v.TraceID().String()
spanID = v.SpanID().String()
} else {
carrier := make(map[string]string, 1)
_ = span.Tracer().Inject(spctx, ot.TextMap, ot.TextMapCarrier(carrier))
for k, v := range carrier {
switch k {
case "mockpfx-ids-sampled":
continue
case "mockpfx-ids-spanid":
spanID = v
case "mockpfx-ids-traceid":
traceID = v
default: // reasonable default
p := strings.Split(v, ":")
traceID = p[0]
spanID = p[1]
parentID = p[2]
case "uber-trace-id": // jaeger trace span
p := strings.Split(v, ":")
traceID = p[0]
spanID = p[1]
parentID = p[2]
}
}
}
sp.traceID = traceID
sp.spanID = spanID
sp.parentID = parentID
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
parentID 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) ParentID() string {
return os.parentID
}
func (os *otSpan) SetStatus(st tracer.SpanStatus, msg string) {
os.status = st
os.statusMsg = msg
}
func (os *otSpan) Status() (tracer.SpanStatus, string) {
return os.status, os.statusMsg
}
func (os *otSpan) Tracer() tracer.Tracer {
return &otTracer{tracer: os.span.Tracer()}
}
func (os *otSpan) Finish(opts ...tracer.SpanOption) {
if os.finished {
return
}
options := os.opts
options.Status = os.status
options.StatusMsg = os.statusMsg
options.Labels = append(options.Labels, os.labels...)
for _, o := range opts {
o(&options)
}
if !options.Record {
return
}
if len(options.Labels)%2 != 0 {
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 options.Status == tracer.SpanStatusError {
os.span.SetTag("error", true)
os.span.LogKV("error", options.StatusMsg)
}
os.span.SetTag("span.kind", options.Kind)
os.span.Finish()
os.finished = true
}
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...)
}
func (os *otSpan) Context() context.Context {
return ot.ContextWithSpan(context.Background(), os.span)
}
func (os *otSpan) SetName(name string) {
os.span = os.span.SetOperationName(name)
}
func (os *otSpan) SetLabels(labels ...interface{}) {
os.opts.Labels = labels
}
func (os *otSpan) Kind() tracer.SpanKind {
return os.opts.Kind
}
func (os *otSpan) AddLabels(labels ...interface{}) {
os.labels = append(os.labels, labels...)
}
func NewTracer(opts ...tracer.Option) *otTracer {
options := tracer.NewOptions(opts...)
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 (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)
sp := t.tracer.StartSpan(name, opts...)
if err := sp.Tracer().Inject(sp.Context(), ot.TextMap, ot.TextMapCarrier(md)); err != nil {
return nil, nil
}
ctx = ot.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
}
}
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 parentCtx != nil {
opts = append(opts, ot.ChildOf(parentCtx))
}
}
nmd := metadata.Copy(md)
smd := metadata.New(1)
sp := t.tracer.StartSpan(name, opts...)
if err := sp.Tracer().Inject(sp.Context(), ot.TextMap, ot.TextMapCarrier(smd)); err != nil {
return nil, nil
}
for k, v := range smd {
nmd.Set(k, v)
}
ctx = metadata.NewOutgoingContext(ot.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
}
}
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 parentCtx != nil {
opts = append(opts, ot.ChildOf(parentCtx))
}
}
nmd := metadata.Copy(md)
smd := metadata.New(1)
sp := t.tracer.StartSpan(name, opts...)
if err := sp.Tracer().Inject(sp.Context(), ot.TextMap, ot.TextMapCarrier(smd)); err != nil {
return nil, nil
}
for k, v := range smd {
nmd.Set(k, v)
}
ctx = metadata.NewIncomingContext(ot.ContextWithSpan(ctx, sp), nmd)
return ctx, sp
}