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

BREAKING: Change span statuses for gRPC server spans #3333

Merged
merged 18 commits into from
Apr 3, 2023
Merged

BREAKING: Change span statuses for gRPC server spans #3333

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
87de648
Refine Span Status sementic convention for gRPC Server
pellared Mar 22, 2023
ca5e625
Update changelog
pellared Mar 22, 2023
a923389
Merge branch 'main' into align-grpc-semcov-with-http
pellared Mar 22, 2023
c396a99
Update rpc.md
pellared Mar 22, 2023
404b71a
Other statuses remain unset for server spans
pellared Mar 22, 2023
0931d36
Add table and add missing DEADLINE_EXCEEDED
pellared Mar 22, 2023
ba9f868
Merge branch 'main' into align-grpc-semcov-with-http
pellared Mar 22, 2023
0ec0e59
Keep only the table
pellared Mar 22, 2023
2d4782f
Update specification/trace/semantic_conventions/rpc.md
pellared Mar 22, 2023
ba7ea96
Update rpc.md
pellared Mar 22, 2023
4198031
Merge branch 'main' into align-grpc-semcov-with-http
pellared Mar 22, 2023
82a3ac2
Merge branch 'main' into align-grpc-semcov-with-http
pellared Mar 27, 2023
6af87d7
Merge branch 'main' into align-grpc-semcov-with-http
pellared Mar 28, 2023
22c4849
Merge branch 'main' into align-grpc-semcov-with-http
pellared Mar 29, 2023
a8bbdbf
Merge branch 'main' into align-grpc-semcov-with-http
pellared Mar 30, 2023
36debea
Revert UNIMPLEMNTED to Error
pellared Mar 30, 2023
765f440
Merge branch 'main' into align-grpc-semcov-with-http
pellared Mar 30, 2023
e71d83e
Merge branch 'main' into align-grpc-semcov-with-http
pellared Apr 3, 2023
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 @@ -37,6 +37,8 @@ release.
([#3271](https://github.com/open-telemetry/opentelemetry-specification/pull/3271))
- BREAKING: remove `messaging.destination.kind` and `messaging.source.kind`.
([#3214](https://github.com/open-telemetry/opentelemetry-specification/pull/3214))
- BREAKING: Change span statuses for gRPC server spans.
([#3333](https://github.com/open-telemetry/opentelemetry-specification/pull/3333))

### Compatibility

Expand Down
35 changes: 34 additions & 1 deletion specification/trace/semantic_conventions/rpc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,40 @@ For remote procedure calls via [gRPC][], additional conventions are described in

### gRPC Status

The [Span Status](../api.md#set-status) MUST be left unset for an `OK` gRPC status code, and set to `Error` for all others.
For `SpanKind.CLIENT` spans, the [Span Status](../api.md#set-status)
MUST be left unset for an `OK` gRPC status code, and set to `Error` for all others.

For `SpanKind.SERVER` spans, the [Span Status](../api.md#set-status) MUST be set
to `Error` for the [gRPC status codes](https://github.com/grpc/grpc/blob/v1.33.2/doc/statuscodes.md)
listed below (for other codes it MUST be left unset).

- `UNKNOWN`
- `DEADLINE_EXCEEDED`
- `INTERNAL`
- `UNAVAILABLE`
- `DATA_LOSS`
pellared marked this conversation as resolved.
Show resolved Hide resolved
tigrannajaryan marked this conversation as resolved.
Show resolved Hide resolved

This is summarized in the table below.

| gRPC Status Number | gRPC Status Code | `SpanKind.SERVER` Span Status | `SpanKind.CLIENT` Span Status |
pellared marked this conversation as resolved.
Show resolved Hide resolved
|---|---|---|---|
| `0` | OK | unset | unset |
| `1` | CANCELLED | unset | `Error` |
| `2` | UNKNOWN | `Error` | `Error` |
| `3` | INVALID_ARGUMENT | unset | `Error` |
| `4` | DEADLINE_EXCEEDED | `Error` | `Error` |
| `5` | NOT_FOUND | unset | `Error` |
| `6` | ALREADY_EXISTS | unset | `Error` |
| `7` | PERMISSION_DENIED | unset | `Error` |
| `8` | RESOURCE_EXHAUSTED | unset| `Error` |
| `9` | FAILED_PRECONDITION | unset | `Error` |
| `10` | ABORTED | unset | `Error` |
| `11` | OUT_OF_RANGE | unset | `Error` |
| `12` | UNIMPLEMENTED | unset | `Error` |
| `13` | INTERNAL | `Error` | `Error` |
| `14` | UNAVAILABLE | `Error` | `Error` |
| `15` | DATA_LOSS | `Error` | `Error` |
| `16` | UNAUTHENTICATED | unset | `Error` |

### gRPC Request and Response Metadata

Expand Down