From 14d15ff2a0118f93dfd56ab491b822367bd17d57 Mon Sep 17 00:00:00 2001 From: Bogdan Drutu Date: Sat, 7 Sep 2019 13:33:18 -0700 Subject: [PATCH] Rename TraceOptions to TraceFlags to be w3c compatible (#234) * Rename TraceOptions to TraceFlags to be w3c compatible Signed-off-by: Bogdan Drutu * Fix more TraceOptions and rename recorded with sampled Signed-off-by: Bogdan Drutu --- specification/api-tracing.md | 10 +++++----- specification/overview.md | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/specification/api-tracing.md b/specification/api-tracing.md index 7b7fa11e7ba..3f9e3a4a7bc 100644 --- a/specification/api-tracing.md +++ b/specification/api-tracing.md @@ -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. @@ -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 diff --git a/specification/overview.md b/specification/overview.md index 1ff4e1015ac..a084c376d91 100644 --- a/specification/overview.md +++ b/specification/overview.md @@ -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`).