-
Notifications
You must be signed in to change notification settings - Fork 701
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: fully compatible with opentracing (#1170)
* feat: record error for otel * add jaeger propagation * add SetTextMapPropagator * fix opentracing compatible * simplify tracer
- Loading branch information
Showing
7 changed files
with
225 additions
and
48 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,177 @@ | ||
| package xtrace | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "fmt" | ||
| "strconv" | ||
| "strings" | ||
|
|
||
| "go.opentelemetry.io/otel/propagation" | ||
| "go.opentelemetry.io/otel/trace" | ||
| ) | ||
|
|
||
| const ( | ||
| jaegerHeader = "x-dy-traceid" | ||
| separator = ":" | ||
| traceID128bitsWidth = 128 / 4 | ||
| spanIDWidth = 64 / 4 | ||
|
|
||
| idPaddingChar = "0" | ||
|
|
||
| flagsDebug = 0x02 | ||
| flagsSampled = 0x01 | ||
| flagsNotSampled = 0x00 | ||
|
|
||
| deprecatedParentSpanID = "0" | ||
| ) | ||
|
|
||
| var ( | ||
| empty = trace.SpanContext{} | ||
|
|
||
| errMalformedTraceContextVal = errors.New("header value of uber-trace-id should contain four different part separated by : ") | ||
| errInvalidTraceIDLength = errors.New("invalid trace id length, must be either 16 or 32") | ||
| errMalformedTraceID = errors.New("cannot decode trace id from header, should be a string of hex, lowercase trace id can't be all zero") | ||
| errInvalidSpanIDLength = errors.New("invalid span id length, must be 16") | ||
| errMalformedSpanID = errors.New("cannot decode span id from header, should be a string of hex, lowercase span id can't be all zero") | ||
| errMalformedFlag = errors.New("cannot decode flag") | ||
| ) | ||
|
|
||
| // Jaeger propagator serializes SpanContext to/from Jaeger Headers | ||
| // | ||
| // Jaeger format: | ||
| // | ||
| // uber-trace-id: {trace-id}:{span-id}:{parent-span-id}:{flags}. | ||
| type Jaeger struct{} | ||
|
|
||
| var _ propagation.TextMapPropagator = &Jaeger{} | ||
|
|
||
| // Inject injects a context to the carrier following jaeger format. | ||
| // The parent span ID is set to an dummy parent span id as the most implementations do. | ||
| func (jaeger Jaeger) Inject(ctx context.Context, carrier propagation.TextMapCarrier) { | ||
| sc := trace.SpanFromContext(ctx).SpanContext() | ||
| headers := []string{} | ||
| if !sc.TraceID().IsValid() || !sc.SpanID().IsValid() { | ||
| return | ||
| } | ||
| headers = append(headers, sc.TraceID().String(), sc.SpanID().String(), deprecatedParentSpanID) | ||
| if debugFromContext(ctx) { | ||
| headers = append(headers, fmt.Sprintf("%x", flagsDebug|flagsSampled)) | ||
| } else if sc.IsSampled() { | ||
| headers = append(headers, fmt.Sprintf("%x", flagsSampled)) | ||
| } else { | ||
| headers = append(headers, fmt.Sprintf("%x", flagsNotSampled)) | ||
| } | ||
|
|
||
| carrier.Set(jaegerHeader, strings.Join(headers, separator)) | ||
| } | ||
|
|
||
| // Extract extracts a context from the carrier if it contains Jaeger headers. | ||
| func (jaeger Jaeger) Extract(ctx context.Context, carrier propagation.TextMapCarrier) context.Context { | ||
| // extract tracing information | ||
| if h := carrier.Get(jaegerHeader); h != "" { | ||
| ctx, sc, err := extract(ctx, h) | ||
| if err == nil && sc.IsValid() { | ||
| return trace.ContextWithRemoteSpanContext(ctx, sc) | ||
| } | ||
| } | ||
|
|
||
| return ctx | ||
| } | ||
|
|
||
| func extract(ctx context.Context, headerVal string) (context.Context, trace.SpanContext, error) { | ||
| var ( | ||
| scc = trace.SpanContextConfig{} | ||
| err error | ||
| ) | ||
|
|
||
| parts := strings.Split(headerVal, separator) | ||
| if len(parts) != 4 { | ||
| return ctx, empty, errMalformedTraceContextVal | ||
| } | ||
|
|
||
| // extract trace ID | ||
| if parts[0] != "" { | ||
| id := parts[0] | ||
| if len(id) > traceID128bitsWidth { | ||
| return ctx, empty, errInvalidTraceIDLength | ||
| } | ||
| // padding when length is less than 32 | ||
| if len(id) < traceID128bitsWidth { | ||
| padCharCount := traceID128bitsWidth - len(id) | ||
| id = strings.Repeat(idPaddingChar, padCharCount) + id | ||
| } | ||
| scc.TraceID, err = trace.TraceIDFromHex(id) | ||
| if err != nil { | ||
| return ctx, empty, errMalformedTraceID | ||
| } | ||
| } | ||
|
|
||
| // extract span ID | ||
| if parts[1] != "" { | ||
| id := parts[1] | ||
| if len(id) > spanIDWidth { | ||
| return ctx, empty, errInvalidSpanIDLength | ||
| } | ||
| // padding when length is less than 16 | ||
| if len(id) < spanIDWidth { | ||
| padCharCount := spanIDWidth - len(id) | ||
| id = strings.Repeat(idPaddingChar, padCharCount) + id | ||
| } | ||
| scc.SpanID, err = trace.SpanIDFromHex(id) | ||
| if err != nil { | ||
| return ctx, empty, errMalformedSpanID | ||
| } | ||
| } | ||
|
|
||
| // skip third part as it is deprecated | ||
|
|
||
| // extract flag | ||
| if parts[3] != "" { | ||
| flagStr := parts[3] | ||
| flag, err := strconv.ParseInt(flagStr, 16, 64) | ||
| if err != nil { | ||
| return ctx, empty, errMalformedFlag | ||
| } | ||
| if flag&flagsSampled == flagsSampled { | ||
| // if sample bit is set, we check if debug bit is also set | ||
| if flag&flagsDebug == flagsDebug { | ||
| scc.TraceFlags |= trace.FlagsSampled | ||
| ctx = withDebug(ctx, true) | ||
| } else { | ||
| scc.TraceFlags |= trace.FlagsSampled | ||
| } | ||
| } | ||
| // ignore other bit, including firehose since we don't have corresponding flag in trace context. | ||
| } | ||
| return ctx, trace.NewSpanContext(scc), nil | ||
| } | ||
|
|
||
| // Fields returns the Jaeger header key whose value is set with Inject. | ||
| func (jaeger Jaeger) Fields() []string { | ||
| return []string{jaegerHeader} | ||
| } | ||
|
|
||
| type jaegerKeyType int | ||
|
|
||
| const ( | ||
| debugKey jaegerKeyType = iota | ||
| ) | ||
|
|
||
| // withDebug returns a copy of parent with debug set as the debug flag value . | ||
| func withDebug(parent context.Context, debug bool) context.Context { | ||
| return context.WithValue(parent, debugKey, debug) | ||
| } | ||
|
|
||
| // debugFromContext returns the debug value stored in ctx. | ||
| // | ||
| // If no debug value is stored in ctx false is returned. | ||
| func debugFromContext(ctx context.Context) bool { | ||
| if ctx == nil { | ||
| return false | ||
| } | ||
| if debug, ok := ctx.Value(debugKey).(bool); ok { | ||
| return debug | ||
| } | ||
| return false | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.