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

Add documentation requirement for adding attributes at span creation #2383

Merged
merged 6 commits into from
Mar 3, 2022
Merged

Add documentation requirement for adding attributes at span creation #2383

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a4b1b69
Add documentation requirement for adding attributes at span creation
pyohannes Feb 25, 2022
ebbcdb5
Adding changelog entry
pyohannes Feb 25, 2022
258f447
Update specification/trace/api.md
pyohannes Mar 1, 2022
986f7a8
Add documentation requirement to spec compliance matrix
pyohannes Mar 1, 2022
6c2be03
Update spec-compliance-matrix.md
pyohannes Mar 2, 2022
fe71e1b
Merge branch 'main' into doc-requirement-attributes
bogdandrutu Mar 3, 2022
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 @@ -14,6 +14,8 @@ release.
- Introduce the concept of Instrumentation Scope to replace/extend Instrumentation
Library. The Tracer is now associated with Instrumentation Scope
([#2276](https://github.com/open-telemetry/opentelemetry-specification/pull/2276)).
- Add documentation REQUIREMENT for adding attributes at span creation.
pyohannes marked this conversation as resolved.
Show resolved Hide resolved
([#2383](https://github.com/open-telemetry/opentelemetry-specification/pull/2383)).

### Metrics

Expand Down
5 changes: 3 additions & 2 deletions specification/trace/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -367,8 +367,9 @@ The API MUST accept the following parameters:
description](sdk.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.
The API documentation MUST state that adding attributes at span creation is preferred
to calling `SetAttribute` later, as samplers can only consider information
already present during span creation.

- `Link`s - an ordered sequence of Links, see API definition [here](#specifying-links).
- `Start timestamp`, default to current time. This argument SHOULD only be set
Expand Down