2424
2525## Overview
2626
27- ` Baggage ` is used to annotate telemetry, adding context and information to
28- metrics, traces, and logs. It is a set of name/value pairs describing
29- user-defined properties. Each name in ` Baggage ` MUST be associated with
30- exactly one value.
27+ ` Baggage ` is a set of application-defined properties contextually associated
28+ with a distributed request or workflow execution (see also the [ W3C Baggage
29+ Specification] [ w3c ] ). Baggage can be used, among other things, to annotate
30+ telemetry, adding contextual information to metrics, traces, and logs.
31+
32+ In OpenTelemetry ` Baggage ` is represented as a set of name/value pairs
33+ describing user-defined properties. Each name in ` Baggage ` MUST be associated
34+ with _ exactly one value_ . This is more restrictive than the [ W3C Baggage
35+ Specification, § 3.2.1.1] ( https://www.w3.org/TR/baggage/#baggage-string )
36+ which allows duplicate entries for a given name.
3137
3238The Baggage API consists of:
3339
34- - the ` Baggage `
40+ - the ` Baggage ` as a logical container
3541- functions to interact with the ` Baggage ` in a ` Context `
3642
3743The functions described here are one way to approach interacting with the
@@ -146,7 +152,7 @@ reasons.
146152
147153The API layer or an extension package MUST include the following ` Propagator ` s:
148154
149- * A ` TextMapPropagator ` implementing the [ W3C Baggage Specification] ( https://www.w3.org/TR/baggage ) .
155+ * A ` TextMapPropagator ` implementing the [ W3C Baggage Specification] [ w3c ] .
150156
151157See [ Propagators Distribution] ( ../context/api-propagators.md#propagators-distribution )
152158for how propagators are to be distributed.
@@ -165,3 +171,5 @@ additional requirements these operations need to follow.
165171If a new name/value pair is added and its name is the same as an existing name,
166172than the new pair MUST take precedence. The value is replaced with the added
167173value (regardless if it is locally generated or received from a remote peer).
174+
175+ [ w3c ] : https://www.w3.org/TR/baggage
0 commit comments