Skip to content

Commit 090296f

Browse files
authored
Clarify that IsValid and IsRemote are APIs on SpanContext (open-telemetry#771)
Signed-off-by: Bogdan Drutu <bogdandrutu@gmail.com>
1 parent 9064c67 commit 090296f

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

specification/trace/api.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ Table of Contents
1414
* [Tracer](#tracer)
1515
* [Tracer operations](#tracer-operations)
1616
* [SpanContext](#spancontext)
17+
* [IsValid](#isvalid)
18+
* [IsRemote](#isremote)
1719
* [Span](#span)
1820
* [Span creation](#span-creation)
1921
* [Determining the Parent Span from a Context](#determining-the-parent-span-from-a-context)
@@ -179,10 +181,14 @@ systems to participate in the same trace. Please review the [W3C
179181
specification](https://www.w3.org/TR/trace-context/#tracestate-header) for
180182
details on this field.
181183

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

185-
`IsRemote` is a boolean which is true if the SpanContext was
186+
An API that returns a boolean value, which is `true` if the SpanContext has a
187+
non-zero TraceID and a non-zero SpanID.
188+
189+
### IsRemote
190+
191+
An API that returns a boolean value, which is `true` if the SpanContext was
186192
propagated from a remote parent. When extracting a `SpanContext` through the
187193
[Propagators API](../context/api-propagators.md#propagators-api), its `IsRemote`
188194
flag MUST be set to true, whereas the SpanContext of any child spans MUST have

0 commit comments

Comments
 (0)