Add specs on DistributedContext and propagation. (#97)

* Add specs on DistributedContext and propagation.

* Clarify DistributedContext only includes entries.

* Fix typos.

* Apply suggestions.

* Copy the description to terminology.

* Example on propagation across boundaries.
This commit is contained in:
Yang Song 2019-06-11 14:53:04 -07:00 committed by Sergey Kanzhelev
parent db519d6220
commit a57bf6a3e3
1 changed files with 9 additions and 0 deletions

View File

@ -108,6 +108,15 @@ TODO: Describe metrics terminology https://github.com/open-telemetry/opentelemet
## DistributedContext
**DistributedContext** is an abstract data type that represents collection of entries.
Each key of **DistributedContext** is associated with exactly one value. **DistributedContext** is serializable,
to facilitate propagating it not only inside the process but also across process boundaries.
**DistributedContext** is used to annotate telemetry with the name:value pair **Entry**.
Those values can be used to add dimension to the metric or additional contest properties to logs and traces.
**DistributedContext** is a recommended name but languages can have more language-specific names like **dctx**.
### Entry
An **Entry** is used to label anything that is associated with a specific operation,