Specify the initial propagators requirements. (open-telemetry#735)

* Specify the initial propagators requirements. * Do not require the SDK to include the B3 protocol. * Update specification/trace/api.md Co-authored-by: Reiley Yang <[email protected]> * Update specification/correlationcontext/api.md Co-authored-by: Reiley Yang <[email protected]> * Remove the CorrelationContext propagator requirement. * Make TraceContext optional in the API. * Update the propagators location. * Fix typo. Co-authored-by: Reiley Yang <[email protected]>
carlosalberto · Aug 5, 2020 · a6d06ed · a6d06ed
1 parent 3a36c1a
commit a6d06ed
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 0 deletions.
diff --git a/specification/context/api-propagators.md b/specification/context/api-propagators.md
@@ -21,6 +21,7 @@ Table of Contents
       - [Get](#get)
 - [Composite Propagator](#composite-propagator)
 - [Global Propagators](#global-propagators)
+- [Propagators Distribution](#propagators-distribution)
 
 </details>
 
@@ -266,3 +267,14 @@ Sets the global `Propagator` instance.
 Required parameters:
 
 - A `Propagator`. This usually will be a composite instance.
+
+## Propagators Distribution
+
+`Propagator`s implementing officially supported protocols such as
+[B3 Propagation Specification](https://github.com/openzipkin/b3-propagation)
+MUST be maintained by the OpenTelemetry organization and MUST be distributed as
+OpenTelemetry extension packages.
+
+Additional `Propagator`s implementing vendor-specific protocols such as
+AWS X-Ray trace header protocol are encouraged to be maintained and distributed by
+their respective vendors.
diff --git a/specification/correlationcontext/api.md b/specification/correlationcontext/api.md
@@ -136,3 +136,4 @@ otcorrelations: user=foo%40example.com,name=Example%20Name
 
 If a new name/value pair is added and its name is the same as an existing name, than the new pair MUST take precedence. The value
 is replaced with the added value (regardless if it is locally generated or received from a remote peer).
+
diff --git a/specification/trace/api.md b/specification/trace/api.md
@@ -36,6 +36,7 @@ Table of Contents
   * [GetIsOk](#getisok)
 * [SpanKind](#spankind)
 * [Concurrency](#concurrency)
+* [Included Propagators](#included-propagators)
 
 </details>
 
@@ -687,3 +688,9 @@ implementer of these events.
 **Link** - Links are immutable and is safe to be used concurrently. Lazy
 initialized links must be thread safe. This is the responsibility of the
 implementer of these links.
+
+## Included Propagators
+
+The API layer MAY include the following `Propagator`s:
+
+* A `HTTPTextPropagator` implementing the [W3C TraceContext Specification](https://www.w3.org/TR/trace-context/).
Original file line number	Diff line number	Diff line change
Expand Up		@@ -136,3 +136,4 @@ otcorrelations: user=foo%40example.com,name=Example%20Name

		If a new name/value pair is added and its name is the same as an existing name, than the new pair MUST take precedence. The value
		is replaced with the added value (regardless if it is locally generated or received from a remote peer).