Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Christian Neumüller <[email protected]>
  • Loading branch information
iNikem and Oberon00 committed Sep 1, 2020
1 parent f52e1ab commit 88b8432
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions specification/trace/sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -231,9 +231,9 @@ Thus, the SDK specification defines sets of possible requirements for

## TraceState manipulation

`TraceState` is a part of [`SpanContext`](./api.md#spancontext), represented by a list of key-values pairs and
`TraceState` is a part of [`SpanContext`](./api.md#spancontext), represented by a list of string key-values pairs and
formally defined by [W3C specification](https://www.w3.org/TR/trace-context/#tracestate-header).
Tracing SDK MUST provide at least the following mutation operations on `TraceState`:
Tracing SDK MUST provide at least the following operations on `TraceState` which return a new `TraceState` with the modifications applied:

* Update key value
* Add a new key/value pair
Expand All @@ -242,11 +242,11 @@ Tracing SDK MUST provide at least the following mutation operations on `TraceSta
These operations MUST follow rules described in [W3C specification](https://www.w3.org/TR/trace-context/#mutating-the-tracestate-field).

Please note, that as `SpanContext` is immutable, it is not possible to update `SpanContext` with a new `TraceState`.
Such changes then make sense only right before
[`SpanContext` propagation](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/context/api-propagators.md)
Such changes then make sense only right before
[`SpanContext` propagation](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/context/api-propagators.md)
or [telemetry data exporting](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/sdk.md#span-exporter).
In both cases `Propagators` and `SpanExporters` may modify `TraceState` before serializing it to the wire.
In both cases `Propagators` and `SpanExporters` may create a modified `TraceState` copy before serializing it to the wire.

## Span processor

Span processor is an interface which allows hooks for span start and end method
Expand Down

0 comments on commit 88b8432

Please sign in to comment.