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

Defined additional semantic convention attribute names #383

Conversation

kbrockhoff
Copy link
Member

Resolves #362

@Oberon00
Copy link
Member

I recommend splitting this PR up, e.g. the messaging changes probably deserve their own PR.

@@ -0,0 +1,43 @@
# Semantic conventions for events
Copy link
Member

@Oberon00 Oberon00 Dec 12, 2019

Choose a reason for hiding this comment

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

I would put the events to the places they belong to, e.g. message events to messaging conventions, error to general conventions, etc.

We also have status, name and attributes already bundled together and grpc has events right with the other conventions too.

Copy link
Member Author

Choose a reason for hiding this comment

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

Message events apply to all types of remote calls, not only gRPC.


Event `"name"` MUST be `"error"`.

Error events MAY be associated with a tracing span or recorded independently.
Copy link
Member

Choose a reason for hiding this comment

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

How can events be recorded independently? I do not think OpenTelemetry currently has a concept of free-standing event. AFAIK this is something that is planned to be added, but does not exist yet.
The API specification currently defines Events that can be associated with Spans: https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/api-tracing.md#add-events

Copy link
Member Author

Choose a reason for hiding this comment

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

Removed


| Attribute name | Notes and examples | Required? |
| :------------- | :----------------------------------------------------------- | --------- |
| `component` | Denotes the type of the span and needs to be `"bus"`. | Yes |
Copy link
Member

Choose a reason for hiding this comment

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

There is a proposal to remove "component" attribute: #336
Comments on that issue are welcome.

Copy link
Member Author

Choose a reason for hiding this comment

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

Removed

Copy link
Contributor

@jmacd jmacd left a comment

Choose a reason for hiding this comment

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

It's a lot of different things to put in one PR. I wonder if the message_bus conventions should go in one PR, the Events conventions in another PR, the General Identity conventions in a PR, and then everything else in a cleanup PR?

The stuff about Events conventions raised some questions for me, but I'm worried about a lengthy PR thread w/ so much else in flight.

@kbrockhoff
Copy link
Member Author

I will split up this pull request into multiple requests.

@kbrockhoff kbrockhoff closed this Dec 17, 2019
@kbrockhoff kbrockhoff deleted the misc-semantic-conventions-#362 branch January 22, 2020 22:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Miscellaneous additional semantic convention attribute names
4 participants