Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Specify IsValid and IsRemote as required #914

Merged
merged 4 commits into from
Sep 3, 2020
Merged

Specify IsValid and IsRemote as required #914

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1269dea
Clarify IsValid and IsRemote as required
arminru Sep 2, 2020
8709c39
Merge branch 'master' into clarify-isvalid-isremote
arminru Sep 2, 2020
8a5cf4b
Add changelog entry
arminru Sep 2, 2020
c05165e
Merge branch 'master' into clarify-isvalid-isremote
arminru Sep 3, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we really need a changelog entry for such clarifications?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't add one at first but then thought it couldn't hurt to make SIG maintainers aware of it, just in case they interpreted it differently in the past. Not all have filled out the compliance matrix yet and adding the entry was easier than inspecting the missing repos.

([#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
View file
Open in desktop
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
Copy link
Member

@Oberon00 Oberon00 Sep 2, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we just add the sentence "The API MUST provide all operations specified in the following subsections" instead?


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