Skip to content

Commit

Permalink
Rename TraceOptions to TraceFlags to be w3c compatible (open-telemetr…
Browse files Browse the repository at this point in the history
…y#234)

* Rename TraceOptions to TraceFlags to be w3c compatible

Signed-off-by: Bogdan Drutu <[email protected]>

* Fix more TraceOptions and rename recorded with sampled

Signed-off-by: Bogdan Drutu <[email protected]>
  • Loading branch information
bogdandrutu authored Sep 7, 2019
1 parent 4b667c4 commit 14d15ff
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
10 changes: 5 additions & 5 deletions specification/api-tracing.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ propagated along side of a distributed context. `SpanContext`s are immutable.
The OpenTelemetry `SpanContext` representation conforms to the [w3c TraceContext
specification](https://www.w3.org/TR/trace-context/). It contains two
identifiers - a `TraceId` and a `SpanId` - along with a set of common
`TraceOptions` and system-specific `TraceState` values. `SpanContext` is
`TraceFlags` and system-specific `TraceState` values. `SpanContext` is
represented as an interface, in order to be serializable into a wider variety of
trace context wire formats.

Expand All @@ -177,10 +177,10 @@ non-zero byte.
`SpanId` A valid span identifier is an 8-byte array with at least one non-zero
byte.

`TraceOptions` contain details about the trace. Unlike Tracestate values,
TraceOptions are present in all traces. Currently, the only TraceOption is a
boolean `recorded`
[flag](https://www.w3.org/TR/trace-context/#recorded-flag-00000001).
`TraceFlags` contain details about the trace. Unlike Tracestate values,
TraceFlags are present in all traces. Currently, the only `TraceFlags` is a
boolean `sampled`
[flag](https://www.w3.org/TR/trace-context/#trace-flags).

`Tracestate` carries system-specific configuration data, represented as a list
of key-value pairs. TraceState allows multiple tracing systems to participate in
Expand Down
2 changes: 1 addition & 1 deletion specification/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ propagated from parent to child **Spans**.
practically sufficient probability by being made as 8 randomly generated
bytes. When passed to a child Span this identifier becomes the parent span id
for the child **Span**.
- **TraceOptions** represents the options for a trace. It is represented as 1
- **TraceFlags** represents the options for a trace. It is represented as 1
byte (bitmap).
- Sampling bit - Bit to represent whether trace is sampled or not (mask
`0x1`).
Expand Down

0 comments on commit 14d15ff

Please sign in to comment.