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

Add yaml semantic conventions for Messaging #926

Merged
merged 3 commits into from
Sep 29, 2020

Conversation

thisthat
Copy link
Member

@thisthat thisthat commented Sep 7, 2020

Changes

Updated Messaging semantic convention to the YAML format.

Related issues #547

@thisthat thisthat requested review from a team as code owners September 7, 2020 10:40
@arminru arminru linked an issue Sep 8, 2020 that may be closed by this pull request
semantic_conventions/trace/messaging.yaml Outdated Show resolved Hide resolved
semantic_conventions/trace/messaging.yaml Outdated Show resolved Hide resolved
@Oberon00 Oberon00 added area:semantic-conventions Related to semantic conventions spec:trace Related to the specification/trace directory labels Sep 9, 2020
@thisthat
Copy link
Member Author

@open-telemetry/specs-approvers please have a look!

|---|---|---|---|---|
| `messaging.system` | string | A string identifying the messaging system. | `kafka`<br>`rabbitmq`<br>`activemq` | Yes |
| `messaging.destination` | string | The message destination name. This might be equal to the span name but is required nevertheless. | `MyQueue`<br>`MyTopic` | Yes |
| `messaging.destination_kind` | string enum | The kind of message destination | `queue` | Conditional [1] |
Copy link
Member

Choose a reason for hiding this comment

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

Is it not quite clear what does string enum mean. Perhaps just say string since it is already clarifies in the footnote that it must be one of the predefined values?

Copy link
Member Author

Choose a reason for hiding this comment

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

Since this requires changes in the tool, I've opened open-telemetry/build-tools#9

<!-- semconv messaging.consumer -->
| Attribute | Type | Description | Example | Required |
|---|---|---|---|---|
| `messaging.operation` | string enum | A string identifying the kind of message consumption as defined in the [Operation names](#operation-names) section above. If the operation is "send", this attribute MUST NOT be set, since the operation can be inferred from the span kind in that case. | `receive` | No |
Copy link
Member

Choose a reason for hiding this comment

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

Same here, I think simply string is good enough as the type since possible values are clarified below.

Copy link
Member

Choose a reason for hiding this comment

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

I concede that it is redundant but I think it's OK to call this out in the type. Maybe string (fixed) would be more clear?

Copy link
Member Author

Choose a reason for hiding this comment

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

@tigrannajaryan
Copy link
Member

Note for triagers: this does not change the meaning of the spec, it should be considered an editorial change, so should be OK to merged after freeze.

@arminru arminru added the release:allowed-for-ga Editorial changes that can still be added before GA since they don't require action by SIGs label Sep 29, 2020
@arminru
Copy link
Member

arminru commented Sep 29, 2020

Merging this editorial change which introduces YAML representations for the existing semantic conventions.
The string enum wording will be adapted in open-telemetry/build-tools#9.

@arminru arminru merged commit dc5b511 into open-telemetry:master Sep 29, 2020
@arminru arminru deleted the yaml-messaging branch September 29, 2020 12:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:semantic-conventions Related to semantic conventions release:allowed-for-ga Editorial changes that can still be added before GA since they don't require action by SIGs spec:trace Related to the specification/trace directory
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Proposal: Define semantic conventions in JSON/YAML
5 participants