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.

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

Add note that users SHOULD use Span creation attributes. #358

Merged
Merged
Changes from all commits
Commits
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
13 changes: 9 additions & 4 deletions specification/api-tracing.md
Original file line number Diff line number Diff line change
Expand Up @@ -243,10 +243,15 @@ The API MUST accept the following parameters:
root `Span`. API MAY also have an option for implicit parent context
extraction from the current context as a default behavior.
- [`SpanKind`](#spankind), default to `SpanKind.Internal` if not specified.
- `Attribute`s - similar API with [Span::SetAttributes](#set-attributes). These
attributes will be used to make a sampling decision as noted in [sampling
description](sdk-tracing.md#sampling). Empty list will be assumed if not
specified.
- `Attribute`s - A collection of key-value pairs, with the same semantics as
the ones settable with [Span::SetAttributes](#set-attributes). Additionally,
these attributes may be used to make a sampling decision as noted in [sampling
description](sdk-tracing.md#sampling). An empty collection will be assumed if
not specified.

Whenever possible, users SHOULD set any already known attributes at span creation
instead of calling `SetAttribute` later.

- `Link`s - see API definition [here](#add-links). Empty list will be assumed if
not specified.
- `Start timestamp`, default to current time. This argument SHOULD only be set
Expand Down