Add OpenTracing compatibility section.

specification/compatibility/opentracing.md

@@ -0,0 +1,268 @@
+# OpenTracing Compatibility
+
+<details>
+<summary>Table of Contents</summary>
+
+* [Abstract](#abstract)
+* [Create an OpenTracing Tracer Shim](#create-an-opentracing-tracer-shim)
+* [Tracer Shim](#tracer-shim)
+ * [Inject](#inject)
+ * [Extract](#extract)
+* [Span Shim](#span-shim)
+ * [OpenTelemetry Span and SpanContext relationship](#opentelemetry-span-and-spancontext-relationship)
+ * [Get Context](#get-context)
+ * [Get Baggage Item](#get-baggage-item)
+ * [Set Baggage Item](#set-baggage-item)
+ * [Set Tag](#set-tag)
+ * [Log](#log)
+ * [Finish](#finish)
+ * [SpanContext Shim](#spancontext-shim)
+ * [Get Baggage Items](#get-baggage-items)
+* [ScopeManager Shim](#scopemanager-shim)
+ * [Activate a Span](#activate-a-span)
+ * [Get the active Span](#get-the-active-span)
+* [Semantic conventions mapping](#semantic-conventions-mapping)
+
+</details>
+
+## Abstract
+
+The OpenTelemetry project aims to provide backwards compatibility with the
+[OpenTracing](https://opentracing.io) project in order to ease migration of
+instrumented codebases.
+
+This functionality will be provided as a bridge layer implementing the
+[OpenTracing API](https:/opentracing/specification) using the
+OpenTelemetry API. This layer MUST NOT rely on implementation specific details
+of any SDK.
+
+More specifically, the intention is to allow OpenTracing instrumentation to be
+recorded using OpenTelemetry. This Shim Layer MUST NOT publicly expose any
+upstream OpenTelemetry API.
+
+This functionality MUST be defined in its own OpenTracing Shim Layer, not in the
+OpenTracing nor the OpenTelemetry API or SDK.
+
+The OpenTracing Shim and the OpenTelemetry API/SDK are expected to be consumed
+simultaneously in a running service, in order to ease migration from the former
+to the latter.
+
+## Create an OpenTracing Tracer Shim
+
+This operation is used to create a new OpenTracing `Tracer`:
+
+This operation MUST accept the following parameters:
+
+- An OpenTelemetry `Tracer`, used to create `Span`s.
+- A set of OpenTelemetry `Propagator`s of the supported types, used to perform
+ context injection and extraction. Usually these are the global
+ `Composite Propagator`s.
+
+The API MUST return an OpenTracing `Tracer`.
+
+## Tracer Shim
+
+### Inject
+
+Parameters:
+
+- A `SpanContext`.
+- A `Format` descriptor.
+- A carrier.
+
+Inject the underlying OpenTelemetry `Span` and `Bagagge` using the registered
+OpenTelemetry `Propagator`s:
+
+- `TEXT_MAP` and `HTTP_HEADERS` formats MUST use the registered OpenTelemetry
+ `HTTPTextPropagator`, if any.
+
+Errors MUST NOT be raised if the specified `Format` is `BINARY`.
+
+### Extract
+
+Parameters:
+
+- A `Format` descriptor.
+- A carrier.
+
+Extract OpenTelemetry `Span` and `Baggage` from a carrier using the registered
+OpenTelemetry `Propagator`s:
+
+- `TEXT_MAP` and `HTTP_HEADERS` formats MUST use the registered OpenTelemetry
+ `HTTPTextPropagator`, if any.
+
+Returns a `SpanContext` Shim with the underlying extracted OpenTelemetry
+`Span` and `Baggage`, or null if either the `Format` is `BINARY` or
+no value could be extracted.
+
+## Span Shim
+
+The OpenTracing `Span` operations MUST be implemented using underlying OpenTelemetry `Span`
+and `Baggage` values through a `SpanContext` Shim.
+
+In order to satisfy the OpenTracing `Span` requirements:
+
+- The associated `SpanContext` Shim object will contain an OpenTelemetry `SpanContext`
+ and a `Baggage`. The `SpanContext` Shim MUST be immutable and MUST be
+ replaced every time baggage is updated through [Set Baggage Item](#set-baggage-item).
+- An underlying OpenTelemetry `Span` MUST be associated with only one
+ `SpanContext` Shim at a time. This is done in order to keep its linked `Baggage`
+ consistent across all execution units at all times.
+
+This is a simple graphical representation of the mentioned objects:
+
+```
+ Span Shim
+ +- OpenTelemetry Span
+ +- SpanContext Shim
+ +- OpenTelemetry SpanContext
+ +- OpenTelemetry Baggage
+```
+
+The OpenTelemetry `Span` in `Span` Shim is also used to get and set
+its currently associated `SpanContext` Shim. See
+[OpenTelemetry Span and SpanContext relationship](#opentelemetry-span-and-spancontext-relationship).
+
+The `Log` operations MUST be implemented using the OpenTelemetry
+`Span`'s `Add Events` operations.
+
+The `Set Tag` operations MUST be implemented using the OpenTelemetry
+`Span`'s `Set Attributes` operations.
+
+### OpenTelemetry Span and SpanContext relationship
+
+A given OpenTelemetry `Span` MUST be associated with only one
+`SpanContext` Shim at all times for all execution units, in order
+to keep any linked `Baggage` consistent across all execution
+units at all times.
+
+An example of this scenario is having an OpenTracing `Span` have its
+[Set Baggage Item](#set-baggage-item) operation called from two different
+execution units (e.g. threads), and afterwards have its [Context](#get-context)
+fetched in order to [iterate over its baggage values](#get-baggage-items).
+
+Getting and setting the currently associated `SpanContext` for a specified
+OpenTelemetry `Span` MUST be safe to call from different execution units.
+
+Managing this relationship is an implementation detail. It can be implemented,
+for example, with the help of a global synchronized dictionary, or with an
+additional attribute in OpenTelemetry `Span` objects for dynamic languages.
+
+### Get Context
+
+Returns the [associated](#opentelemetry-span-and-spancontext-relationship)
+`SpanContext` Shim.
+
+### Get Baggage Item
+
+Parameters:
+
+- The baggage key, a string.
+
+Returns a value for the specified key in the OpenTelemetry `Baggage` of the
+associated `SpanContext` Shim or null if none exists.
+
+This is accomplished by getting the
+[associated](#opentelemetry-span-and-spancontext-relationship)
+`SpanContext` Shim and do a lookup for the specified key in the OpenTelemetry
+`Baggage` instance.
+
+### Set Baggage Item
+
+Parameters:
+
+- The baggage key, a string.
+- The baggage value, a string.
+
+Creates a new `SpanContext` Shim with a new OpenTelemetry `Baggage` containing
+the specified `Baggage` key/value pair. The resulting `SpanContext` Shim is then
+[associated](#opentelemetry-span-and-spancontext-relationship) to the underlying
+OpenTelemetry `Span`.
+
+### Set Tag
+
+Parameters:
+
+- The tag key, a string.
+- The tag value, which must be either a string, a boolean value, or a numeric type.
+
+Calls `Set Attribute` on the underlying OpenTelemetry `Span` with the specified
+key/value pair.
+
+The value MUST be [mapped](#semantic-conventions-mapping) to the respective
+OpenTelemetry `Attribute`, or converted to a string if the value type is not supported.
+
+If the type of the specified value is not supported, the value MUST be converted
+to a string.
+
+### Log
+
+Parameters:
+
+- A set of key/value pairs, where keys must be strings, and the values may have
+ any type.
+
+Calls `Add Event` on the underlying OpenTelemetry `Span` with the specified
+key/value pair set.
+
+The `Add Event`'s `name` parameter MUST be the value with the `event` key in
+the pair set, or else fallback to use the `log` literal string.
+
+The set of values MUST be [mapped](#semantic-conventions-mapping) to the respective
+OpenTelemetry `Attribute`, or converted to a string if the value type is not supported.
+
+If an explicit timestamp is specified, a conversion MUST be done to match the
+OpenTracing and OpenTelemetry units.
+
+### Finish
+
+Calls `End` on the underlying OpenTelemetry `Span`.
+
+If an explicit timestamp is specified, a conversion MUST be done to match the
+OpenTracing and OpenTelemetry units.
+
+### SpanContext Shim
+
+The `SpanContext` Shim MUST contain the associated `Span` and `Baggage` values.
+
+This object MUST be immutable.
+
+#### Get Baggage Items
+
+Returns a dictionary, collection, or iterator (depending on the requirements of the OpenTracing API for a specific language)
+backed by the associated OpenTelemetry `Baggage` values.
+
+## ScopeManager Shim
+
+For OpenTracing languages implementing the `ScopeManager` interface, its operations
+MUST be implemented using the OpenTelemetry Context Propagation API in order
+to get and set active `Context` instances.
+
+### Activate a Span
+
+Parameters:
+
+- A `Span`.
+
+Gets the [associated](#opentelemetry-span-and-spancontext-relationship)
+`SpanContext` Shim for the specified `Span` and puts its OpenTelemetry
+`SpanContext` and `Bagagge` in a new `Context`, which is then set as the
+currently active instance.
+
+### Get the active Span
+
+Gets the active OpenTelemetry `Span` and returns a `Span` Shim wrapping it.
+
+The API MUST return null if none exist.
+
+## Semantic Conventions Mapping
+
+The OpenTracing Shim MUST map certain elements when calling the underlying
+OpenTelemetry API.
+
+[OpenTracing Span Tags](https:/opentracing/specification/blob/master/semantic_conventions.md#standard-span-tags-and-log-fields):
+
+- `error` maps to [StatusCode](../trace/api.md##set-status):
+ - `true` maps to `Error`.
+ - `false` maps to `Ok`.
+ - no value being set maps to `Unset`.