| 1 |
// Copyright The OpenTelemetry Authors |
| 2 |
// SPDX-License-Identifier: Apache-2.0 |
| 3 |
|
| 4 |
package propagation // import "go.opentelemetry.io/otel/propagation" |
| 5 |
|
| 6 |
import ( |
| 7 |
"context" |
| 8 |
|
| 9 |
"go.opentelemetry.io/otel/baggage" |
| 10 |
"go.opentelemetry.io/otel/internal/errorhandler" |
| 11 |
) |
| 12 |
|
| 13 |
const ( |
| 14 |
baggageHeader = "baggage" |
| 15 |
|
| 16 |
// W3C Baggage specification limits. |
| 17 |
// https://www.w3.org/TR/baggage/#limits |
| 18 |
maxMembers = 64 |
| 19 |
) |
| 20 |
|
| 21 |
// Baggage is a propagator that supports the W3C Baggage format. |
| 22 |
// |
| 23 |
// This propagates user-defined baggage associated with a trace. The complete |
| 24 |
// specification is defined at https://www.w3.org/TR/baggage/. |
| 25 |
type Baggage struct{} |
| 26 |
|
| 27 |
var _ TextMapPropagator = Baggage{} |
| 28 |
|
| 29 |
// Inject sets baggage key-values from ctx into the carrier. |
| 30 |
func (Baggage) Inject(ctx context.Context, carrier TextMapCarrier) { |
| 31 |
bStr := baggage.FromContext(ctx).String() |
| 32 |
if bStr != "" { |
| 33 |
carrier.Set(baggageHeader, bStr) |
| 34 |
} |
| 35 |
} |
| 36 |
|
| 37 |
// Extract returns a copy of parent with the baggage from the carrier added. |
| 38 |
// If carrier implements [ValuesGetter] (e.g. [HeaderCarrier]), Values is invoked |
| 39 |
// for multiple values extraction. Otherwise, Get is called. |
| 40 |
func (Baggage) Extract(parent context.Context, carrier TextMapCarrier) context.Context { |
| 41 |
if multiCarrier, ok := carrier.(ValuesGetter); ok { |
| 42 |
return extractMultiBaggage(parent, multiCarrier) |
| 43 |
} |
| 44 |
return extractSingleBaggage(parent, carrier) |
| 45 |
} |
| 46 |
|
| 47 |
// Fields returns the keys who's values are set with Inject. |
| 48 |
func (Baggage) Fields() []string { |
| 49 |
return []string{baggageHeader} |
| 50 |
} |
| 51 |
|
| 52 |
func extractSingleBaggage(parent context.Context, carrier TextMapCarrier) context.Context { |
| 53 |
bStr := carrier.Get(baggageHeader) |
| 54 |
if bStr == "" { |
| 55 |
return parent |
| 56 |
} |
| 57 |
|
| 58 |
bag, err := baggage.Parse(bStr) |
| 59 |
if err != nil { |
| 60 |
errorhandler.GetErrorHandler().Handle(err) |
| 61 |
} |
| 62 |
if bag.Len() == 0 { |
| 63 |
return parent |
| 64 |
} |
| 65 |
return baggage.ContextWithBaggage(parent, bag) |
| 66 |
} |
| 67 |
|
| 68 |
func extractMultiBaggage(parent context.Context, carrier ValuesGetter) context.Context { |
| 69 |
bVals := carrier.Values(baggageHeader) |
| 70 |
if len(bVals) == 0 { |
| 71 |
return parent |
| 72 |
} |
| 73 |
|
| 74 |
var members []baggage.Member |
| 75 |
for _, bStr := range bVals { |
| 76 |
currBag, err := baggage.Parse(bStr) |
| 77 |
if err != nil { |
| 78 |
errorhandler.GetErrorHandler().Handle(err) |
| 79 |
} |
| 80 |
if currBag.Len() == 0 { |
| 81 |
continue |
| 82 |
} |
| 83 |
members = append(members, currBag.Members()...) |
| 84 |
if len(members) >= maxMembers { |
| 85 |
break |
| 86 |
} |
| 87 |
} |
| 88 |
|
| 89 |
b, err := baggage.New(members...) |
| 90 |
if err != nil { |
| 91 |
errorhandler.GetErrorHandler().Handle(err) |
| 92 |
} |
| 93 |
if b.Len() == 0 { |
| 94 |
return parent |
| 95 |
} |
| 96 |
return baggage.ContextWithBaggage(parent, b) |
| 97 |
} |