Skip to content

Commit

Permalink
Clarify that IsValid and IsRemote are APIs on SpanContext (#771)
Browse files Browse the repository at this point in the history
Signed-off-by: Bogdan Drutu <bogdandrutu@gmail.com>
  • Loading branch information
bogdandrutu committed Aug 11, 2020
1 parent 9064c67 commit 090296f
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions specification/trace/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ Table of Contents
* [Tracer](#tracer)
* [Tracer operations](#tracer-operations)
* [SpanContext](#spancontext)
* [IsValid](#isvalid)
* [IsRemote](#isremote)
* [Span](#span)
* [Span creation](#span-creation)
* [Determining the Parent Span from a Context](#determining-the-parent-span-from-a-context)
Expand Down Expand Up @@ -179,10 +181,14 @@ systems to participate in the same trace. Please review the [W3C
specification](https://www.w3.org/TR/trace-context/#tracestate-header) for
details on this field.

`IsValid` is a boolean flag which returns true if the SpanContext has a non-zero
TraceID and a non-zero SpanID.
### IsValid

`IsRemote` is a boolean which is true if the SpanContext was
An API that returns a boolean value, which is `true` if the SpanContext has a
non-zero TraceID and a non-zero SpanID.

### IsRemote

An API that returns a boolean value, which is `true` if the SpanContext was
propagated from a remote parent. When extracting a `SpanContext` through the
[Propagators API](../context/api-propagators.md#propagators-api), its `IsRemote`
flag MUST be set to true, whereas the SpanContext of any child spans MUST have
Expand Down

0 comments on commit 090296f

Please sign in to comment.