traefik/vendor/github.com/uber/jaeger-client-go/propagation.go

310 lines
9.9 KiB
Go
Raw Normal View History

2018-08-01 11:52:03 +00:00
// Copyright (c) 2017 Uber Technologies, Inc.
2018-01-10 16:48:04 +00:00
//
2018-08-01 11:52:03 +00:00
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
2018-01-10 16:48:04 +00:00
//
2018-08-01 11:52:03 +00:00
// http://www.apache.org/licenses/LICENSE-2.0
2018-01-10 16:48:04 +00:00
//
2018-08-01 11:52:03 +00:00
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
2018-01-10 16:48:04 +00:00
package jaeger
import (
"bytes"
"encoding/binary"
"fmt"
"io"
"log"
"net/url"
"strings"
"sync"
opentracing "github.com/opentracing/opentracing-go"
)
// Injector is responsible for injecting SpanContext instances in a manner suitable
// for propagation via a format-specific "carrier" object. Typically the
// injection will take place across an RPC boundary, but message queues and
// other IPC mechanisms are also reasonable places to use an Injector.
type Injector interface {
// Inject takes `SpanContext` and injects it into `carrier`. The actual type
// of `carrier` depends on the `format` passed to `Tracer.Inject()`.
//
// Implementations may return opentracing.ErrInvalidCarrier or any other
// implementation-specific error if injection fails.
Inject(ctx SpanContext, carrier interface{}) error
}
// Extractor is responsible for extracting SpanContext instances from a
// format-specific "carrier" object. Typically the extraction will take place
// on the server side of an RPC boundary, but message queues and other IPC
// mechanisms are also reasonable places to use an Extractor.
type Extractor interface {
// Extract decodes a SpanContext instance from the given `carrier`,
// or (nil, opentracing.ErrSpanContextNotFound) if no context could
// be found in the `carrier`.
Extract(carrier interface{}) (SpanContext, error)
}
2019-04-05 09:58:06 +00:00
// TextMapPropagator is a combined Injector and Extractor for TextMap format
type TextMapPropagator struct {
2018-08-01 11:52:03 +00:00
headerKeys *HeadersConfig
metrics Metrics
2018-01-10 16:48:04 +00:00
encodeValue func(string) string
decodeValue func(string) string
}
2019-04-05 09:58:06 +00:00
// NewTextMapPropagator creates a combined Injector and Extractor for TextMap format
func NewTextMapPropagator(headerKeys *HeadersConfig, metrics Metrics) *TextMapPropagator {
return &TextMapPropagator{
2018-08-01 11:52:03 +00:00
headerKeys: headerKeys,
metrics: metrics,
2018-01-10 16:48:04 +00:00
encodeValue: func(val string) string {
return val
},
decodeValue: func(val string) string {
return val
},
}
}
2019-04-05 09:58:06 +00:00
// NewHTTPHeaderPropagator creates a combined Injector and Extractor for HTTPHeaders format
func NewHTTPHeaderPropagator(headerKeys *HeadersConfig, metrics Metrics) *TextMapPropagator {
return &TextMapPropagator{
2018-08-01 11:52:03 +00:00
headerKeys: headerKeys,
metrics: metrics,
2018-01-10 16:48:04 +00:00
encodeValue: func(val string) string {
return url.QueryEscape(val)
},
decodeValue: func(val string) string {
// ignore decoding errors, cannot do anything about them
if v, err := url.QueryUnescape(val); err == nil {
return v
}
return val
},
}
}
2019-04-05 09:58:06 +00:00
// BinaryPropagator is a combined Injector and Extractor for Binary format
type BinaryPropagator struct {
2018-01-10 16:48:04 +00:00
tracer *Tracer
buffers sync.Pool
}
2019-04-05 09:58:06 +00:00
// NewBinaryPropagator creates a combined Injector and Extractor for Binary format
func NewBinaryPropagator(tracer *Tracer) *BinaryPropagator {
return &BinaryPropagator{
2018-01-10 16:48:04 +00:00
tracer: tracer,
buffers: sync.Pool{New: func() interface{} { return &bytes.Buffer{} }},
}
}
2019-04-05 09:58:06 +00:00
// Inject implements Injector of TextMapPropagator
func (p *TextMapPropagator) Inject(
2018-01-10 16:48:04 +00:00
sc SpanContext,
abstractCarrier interface{},
) error {
textMapWriter, ok := abstractCarrier.(opentracing.TextMapWriter)
if !ok {
return opentracing.ErrInvalidCarrier
}
// Do not encode the string with trace context to avoid accidental double-encoding
// if people are using opentracing < 0.10.0. Our colon-separated representation
// of the trace context is already safe for HTTP headers.
2018-08-01 11:52:03 +00:00
textMapWriter.Set(p.headerKeys.TraceContextHeaderName, sc.String())
2018-01-10 16:48:04 +00:00
for k, v := range sc.baggage {
2018-08-01 11:52:03 +00:00
safeKey := p.addBaggageKeyPrefix(k)
2018-01-10 16:48:04 +00:00
safeVal := p.encodeValue(v)
textMapWriter.Set(safeKey, safeVal)
}
return nil
}
2019-04-05 09:58:06 +00:00
// Extract implements Extractor of TextMapPropagator
func (p *TextMapPropagator) Extract(abstractCarrier interface{}) (SpanContext, error) {
2018-01-10 16:48:04 +00:00
textMapReader, ok := abstractCarrier.(opentracing.TextMapReader)
if !ok {
return emptyContext, opentracing.ErrInvalidCarrier
}
var ctx SpanContext
var baggage map[string]string
err := textMapReader.ForeachKey(func(rawKey, value string) error {
key := strings.ToLower(rawKey) // TODO not necessary for plain TextMap
2018-08-01 11:52:03 +00:00
if key == p.headerKeys.TraceContextHeaderName {
2018-01-10 16:48:04 +00:00
var err error
safeVal := p.decodeValue(value)
if ctx, err = ContextFromString(safeVal); err != nil {
return err
}
2018-08-01 11:52:03 +00:00
} else if key == p.headerKeys.JaegerDebugHeader {
2018-01-10 16:48:04 +00:00
ctx.debugID = p.decodeValue(value)
2018-08-01 11:52:03 +00:00
} else if key == p.headerKeys.JaegerBaggageHeader {
2018-01-10 16:48:04 +00:00
if baggage == nil {
baggage = make(map[string]string)
}
2018-08-01 11:52:03 +00:00
for k, v := range p.parseCommaSeparatedMap(value) {
2018-01-10 16:48:04 +00:00
baggage[k] = v
}
2018-08-01 11:52:03 +00:00
} else if strings.HasPrefix(key, p.headerKeys.TraceBaggageHeaderPrefix) {
2018-01-10 16:48:04 +00:00
if baggage == nil {
baggage = make(map[string]string)
}
2018-08-01 11:52:03 +00:00
safeKey := p.removeBaggageKeyPrefix(key)
2018-01-10 16:48:04 +00:00
safeVal := p.decodeValue(value)
baggage[safeKey] = safeVal
}
return nil
})
if err != nil {
2018-08-01 11:52:03 +00:00
p.metrics.DecodingErrors.Inc(1)
2018-01-10 16:48:04 +00:00
return emptyContext, err
}
if !ctx.traceID.IsValid() && ctx.debugID == "" && len(baggage) == 0 {
return emptyContext, opentracing.ErrSpanContextNotFound
}
ctx.baggage = baggage
return ctx, nil
}
2019-04-05 09:58:06 +00:00
// Inject implements Injector of BinaryPropagator
func (p *BinaryPropagator) Inject(
2018-01-10 16:48:04 +00:00
sc SpanContext,
abstractCarrier interface{},
) error {
carrier, ok := abstractCarrier.(io.Writer)
if !ok {
return opentracing.ErrInvalidCarrier
}
// Handle the tracer context
if err := binary.Write(carrier, binary.BigEndian, sc.traceID); err != nil {
return err
}
if err := binary.Write(carrier, binary.BigEndian, sc.spanID); err != nil {
return err
}
if err := binary.Write(carrier, binary.BigEndian, sc.parentID); err != nil {
return err
}
if err := binary.Write(carrier, binary.BigEndian, sc.flags); err != nil {
return err
}
// Handle the baggage items
if err := binary.Write(carrier, binary.BigEndian, int32(len(sc.baggage))); err != nil {
return err
}
for k, v := range sc.baggage {
if err := binary.Write(carrier, binary.BigEndian, int32(len(k))); err != nil {
return err
}
io.WriteString(carrier, k)
if err := binary.Write(carrier, binary.BigEndian, int32(len(v))); err != nil {
return err
}
io.WriteString(carrier, v)
}
return nil
}
2019-04-05 09:58:06 +00:00
// Extract implements Extractor of BinaryPropagator
func (p *BinaryPropagator) Extract(abstractCarrier interface{}) (SpanContext, error) {
2018-01-10 16:48:04 +00:00
carrier, ok := abstractCarrier.(io.Reader)
if !ok {
return emptyContext, opentracing.ErrInvalidCarrier
}
var ctx SpanContext
if err := binary.Read(carrier, binary.BigEndian, &ctx.traceID); err != nil {
return emptyContext, opentracing.ErrSpanContextCorrupted
}
if err := binary.Read(carrier, binary.BigEndian, &ctx.spanID); err != nil {
return emptyContext, opentracing.ErrSpanContextCorrupted
}
if err := binary.Read(carrier, binary.BigEndian, &ctx.parentID); err != nil {
return emptyContext, opentracing.ErrSpanContextCorrupted
}
if err := binary.Read(carrier, binary.BigEndian, &ctx.flags); err != nil {
return emptyContext, opentracing.ErrSpanContextCorrupted
}
// Handle the baggage items
var numBaggage int32
if err := binary.Read(carrier, binary.BigEndian, &numBaggage); err != nil {
return emptyContext, opentracing.ErrSpanContextCorrupted
}
if iNumBaggage := int(numBaggage); iNumBaggage > 0 {
ctx.baggage = make(map[string]string, iNumBaggage)
buf := p.buffers.Get().(*bytes.Buffer)
defer p.buffers.Put(buf)
var keyLen, valLen int32
for i := 0; i < iNumBaggage; i++ {
if err := binary.Read(carrier, binary.BigEndian, &keyLen); err != nil {
return emptyContext, opentracing.ErrSpanContextCorrupted
}
buf.Reset()
buf.Grow(int(keyLen))
if n, err := io.CopyN(buf, carrier, int64(keyLen)); err != nil || int32(n) != keyLen {
return emptyContext, opentracing.ErrSpanContextCorrupted
}
key := buf.String()
if err := binary.Read(carrier, binary.BigEndian, &valLen); err != nil {
return emptyContext, opentracing.ErrSpanContextCorrupted
}
buf.Reset()
buf.Grow(int(valLen))
if n, err := io.CopyN(buf, carrier, int64(valLen)); err != nil || int32(n) != valLen {
return emptyContext, opentracing.ErrSpanContextCorrupted
}
ctx.baggage[key] = buf.String()
}
}
return ctx, nil
}
// Converts a comma separated key value pair list into a map
// e.g. key1=value1, key2=value2, key3 = value3
// is converted to map[string]string { "key1" : "value1",
// "key2" : "value2",
// "key3" : "value3" }
2019-04-05 09:58:06 +00:00
func (p *TextMapPropagator) parseCommaSeparatedMap(value string) map[string]string {
2018-01-10 16:48:04 +00:00
baggage := make(map[string]string)
value, err := url.QueryUnescape(value)
if err != nil {
log.Printf("Unable to unescape %s, %v", value, err)
return baggage
}
for _, kvpair := range strings.Split(value, ",") {
kv := strings.Split(strings.TrimSpace(kvpair), "=")
if len(kv) == 2 {
baggage[kv[0]] = kv[1]
} else {
2018-08-01 11:52:03 +00:00
log.Printf("Malformed value passed in for %s", p.headerKeys.JaegerBaggageHeader)
2018-01-10 16:48:04 +00:00
}
}
return baggage
}
// Converts a baggage item key into an http header format,
// by prepending TraceBaggageHeaderPrefix and encoding the key string
2019-04-05 09:58:06 +00:00
func (p *TextMapPropagator) addBaggageKeyPrefix(key string) string {
2018-01-10 16:48:04 +00:00
// TODO encodeBaggageKeyAsHeader add caching and escaping
2018-08-01 11:52:03 +00:00
return fmt.Sprintf("%v%v", p.headerKeys.TraceBaggageHeaderPrefix, key)
2018-01-10 16:48:04 +00:00
}
2019-04-05 09:58:06 +00:00
func (p *TextMapPropagator) removeBaggageKeyPrefix(key string) string {
2018-01-10 16:48:04 +00:00
// TODO decodeBaggageHeaderKey add caching and escaping
2018-08-01 11:52:03 +00:00
return key[len(p.headerKeys.TraceBaggageHeaderPrefix):]
2018-01-10 16:48:04 +00:00
}