Span Status: only set description for ERROR status code. #1673
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
owais
requested review from
lzchen and
hectorhdzg
and removed request for
a team
owais
force-pushed
the
status-code-description
branch
2 times, most recently
from
9c03467
to
d418c60
Compare
codeboten
approved these changes
Mar 6, 2021
owais
force-pushed
the
status-code-description
branch
6 times, most recently
from
8819f18
to
85855e3
Compare
srikanthccv
approved these changes
Mar 6, 2021
CHANGELOG.md
Outdated
| @@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), | |||
| and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). | |||
|
|
|||
| ## [Unreleased](https://github.com/open-telemetry/opentelemetry-python/compare/v0.18b0...HEAD) | |||
| - Status now only sets `description` when `status_code` is set to `StatusCode.ERROR` | |||
| ([#1673])(https://github.com/open-telemetry/opentelemetry-python/pull/1673) | |||
There was a problem hiding this comment.
You may want to move this to ##Changed section.
Suggested change
| ([#1673])(https://github.com/open-telemetry/opentelemetry-python/pull/1673) | |
| ([#1673](https://github.com/open-telemetry/opentelemetry-python/pull/1673)) |
owais
force-pushed
the
status-code-description
branch
from
85855e3
to
bdba710
Compare
lzchen
reviewed
Mar 8, 2021
| self._description = description | ||
| return | ||
|
|
||
| if status_code != StatusCode.ERROR: |
There was a problem hiding this comment.
Should we use is not for enums?
lzchen
approved these changes
Mar 8, 2021
According to the spec: > Description MUST only be used with the Error StatusCode value. > An empty Description is equivalent with a not present one. https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/api.md#set-status This commit updates the `Status` implementation to comply with the spec.
owais
force-pushed
the
status-code-description
branch
from
276e8b3
to
dc32b31
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
According to the spec:
https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/api.md#set-status
This commit updates the
Statusimplementation to comply with the spec.Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
Does This PR Require a Contrib Repo Change?
opentelemetry-api/oropentelemetry-sdk/Yes, https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/api.md#set-status
Checklist: