Skip to content

Commit

Permalink
Specify IsValid and IsRemote as required (#914)
Browse files Browse the repository at this point in the history
  • Loading branch information
arminru committed Sep 3, 2020
1 parent 4b69d90 commit 6b7b2ab
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@ Updates:
([#611](https://github.com/open-telemetry/opentelemetry-specification/pull/611))
- Version attributes no longer have a prefix such as semver:
([#873](https://github.com/open-telemetry/opentelemetry-specification/pull/873))
- Explicitly specify the SpanContext APIs IsValid and IsRemote as required
([#914](https://github.com/open-telemetry/opentelemetry-specification/pull/914))

## v0.6.0 (07-01-2020)

Expand Down
13 changes: 6 additions & 7 deletions specification/trace/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -195,16 +195,15 @@ The API should not expose details about how they are internally stored.

### IsValid

An API that returns a boolean value, which is `true` if the SpanContext has a
non-zero TraceID and a non-zero SpanID.
An API called `IsValid`, that returns a boolean value, which is `true` if the SpanContext has a
non-zero TraceID and a non-zero SpanID, MUST be provided.

### 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
it set to false.
An API called `IsRemote`, that returns a boolean value, which is `true` if the SpanContext was
propagated from a remote parent, MUST be provided.
When extracting a `SpanContext` through the [Propagators API](../context/api-propagators.md#propagators-api),
`IsRemote` MUST return true, whereas for the SpanContext of any child spans it MUST return false.

## Span

Expand Down

0 comments on commit 6b7b2ab

Please sign in to comment.