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 rabbitmq to semantic conventions yaml #1651

Merged
merged 6 commits into from
Apr 27, 2021

Conversation

blumamir
Copy link
Member

In trace semantic conventions markdown there is a section about rabbitmq with attribute messaging.rabbitmq.routing_key.
This attribute is not reflected in the messaging.yaml file here.

opentelemetry-js auto-generate the attributes from this yaml, thus it is currently missing

@blumamir
Copy link
Member Author

I think the docfx check failure is not related to this PR:

docfx not installed. An error occurred during installation:
 The remote server returned an error: (503) Server Unavailable. Service Unavailable
docfx package files install completed. Performing other installation steps.

@arminru
Copy link
Member

arminru commented Apr 27, 2021

Good catch, thank you!

Please make sure to reference this new group in https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/messaging.md#rabbitmq and run the markdown generator as documented here: https://github.com/open-telemetry/opentelemetry-specification/tree/main/semantic_conventions.
This way, we can also remove the sentence "The routing key MUST be provided to the attribute messaging.rabbitmq.routing_key, unless it is empty." from the prose.

@arminru
Copy link
Member

arminru commented Apr 27, 2021

I think the docfx check failure is not related to this PR:

docfx not installed. An error occurred during installation:
 The remote server returned an error: (503) Server Unavailable. Service Unavailable
docfx package files install completed. Performing other installation steps.

Indeed. I re-ran the job and now it's passing. Apparently Chocolatey was down before.

@blumamir blumamir requested a review from a team April 27, 2021 11:55
@blumamir
Copy link
Member Author

Good catch, thank you!

Please make sure to reference this new group in https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/messaging.md#rabbitmq and run the markdown generator as documented here: https://github.com/open-telemetry/opentelemetry-specification/tree/main/semantic_conventions.
This way, we can also remove the sentence "The routing key MUST be provided to the attribute messaging.rabbitmq.routing_key, unless it is empty." from the prose.

Done. Thank you for the review and for pointing me to the relevant documentation.
Great automation 👍

Copy link
Member

@arminru arminru left a comment

Choose a reason for hiding this comment

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

Please also add an entry in CHANGELOG.md that this already specified key is now also defined in the respective YAML file.

semantic_conventions/trace/messaging.yaml Outdated Show resolved Hide resolved
@blumamir
Copy link
Member Author

Please also add an entry in CHANGELOG.md that this already specified key is now also defined in the respective YAML file.

done

@SergeyKanzhelev
Copy link
Member

this PR is uncontroversial as it only changes from text to yaml, not the semantic. And got a lot of approvals fast. Merging

@SergeyKanzhelev SergeyKanzhelev merged commit 5a19b53 into open-telemetry:main Apr 27, 2021
carlosalberto pushed a commit to carlosalberto/opentelemetry-specification that referenced this pull request Oct 31, 2024
* add rabbitmq to semantic conventions yaml

* add example for rabbitmq routing key

* messaging.rabbitmq - use required syntax

* messaging.rabbitmq generate markdown table from yaml

* update changelog with adding rabbitmq to yaml

Co-authored-by: Bogdan Drutu <[email protected]>
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.

5 participants