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

Update status serialization for Zipkin (was: Remove mention of gRPC status codes) #1186

Merged
merged 3 commits into from
Nov 9, 2020
Merged

Update status serialization for Zipkin (was: Remove mention of gRPC status codes) #1186

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ec24c11
Remove mention of gRPC status codes
iNikem Nov 3, 2020
2ee01ef
Convert status only if it is not UNSET
iNikem Nov 3, 2020
f4b6f52
Update specification/trace/sdk_exporters/zipkin.md
iNikem Nov 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
8 changes: 3 additions & 5 deletions specification/trace/sdk_exporters/zipkin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,18 +138,16 @@ TBD: add examples

### Status

Span `Status` MUST be reported as a key-value pair in `tags` to Zipkin.
Span `Status` MUST be reported as a key-value pair in `tags` to Zipkin, unless it is `UNSET`.
In the latter case it MUST NOT be reported.
Copy link
Member

Choose a reason for hiding this comment

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

I think we still want to report a non-empty message even if the code is UNSET. But someone knowledgeable about Zipkin should probably review.

Copy link
Member

Choose a reason for hiding this comment

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

No reason to do that, unnecessary bytes on the wire.


The following table defines the OpenTelemetry `Status` to Zipkin `tags` mapping.

| Status|Tag Key| Tag Value |
|--|--|--|
|Code | `otel.status_code` | Name of the code, for example: `OK` |
|Code | `otel.status_code` | Name of the code, either `OK` or `ERROR`. MUST NOT be set if the code is `UNSET`. |
|Message *(optional)* | `otel.status_description` | `{message}` |

The `otel.status_code` tag value MUST follow the [Standard GRPC Code
Names](https://github.com/grpc/grpc/blob/master/doc/statuscodes.md).

### Events

OpenTelemetry `Event` has an optional `Attribute`(s) which is not supported by
Expand Down