RPC: align with naming best practices#3176
Merged
trask merged 7 commits intoopen-telemetry:mainfrom Dec 9, 2025
Merged
Conversation
This comment was marked as resolved.
This comment was marked as resolved.
lmolkova
commented
Dec 4, 2025
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
lmolkova
moved this from Untriaged
to Awaiting codeowners approval
in Semantic Conventions Triage
trask
approved these changes
Dec 5, 2025
Contributor
There was a problem hiding this comment.
Pull request overview
This PR aligns RPC semantic conventions with OpenTelemetry naming best practices by renaming attributes and enum values to follow consistent patterns. The changes improve clarity and consistency across the semantic conventions.
Key changes:
- Renames
rpc.systemtorpc.system.namewith updated enum values (e.g.,connect_rpc→connectrpc,apache_dubbo→dubbo) - Moves JSON-RPC-specific attributes to a dedicated
jsonrpc.*namespace - Properly deprecates old attributes with migration paths
Reviewed changes
Copilot reviewed 21 out of 21 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| model/rpc/registry.yaml | Renames rpc.system to rpc.system.name, updates enum values to remove underscores (dubbo, connectrpc), removes unsupported systems from enum |
| model/rpc/spans.yaml | Updates references from rpc.system to rpc.system.name and from rpc.jsonrpc.* to jsonrpc.* attributes |
| model/rpc/common.yaml | Updates reference from rpc.system to rpc.system.name |
| model/rpc/deprecated/registry-deprecated.yaml | Adds deprecated definitions for rpc.system, rpc.jsonrpc.request_id, and rpc.jsonrpc.version with proper migration paths |
| model/jsonrpc/registry.yaml | Creates new JSON-RPC attribute namespace with jsonrpc.request.id and jsonrpc.protocol.version |
| templates/registry/markdown/weaver.yaml | Adds JSONRPC acronym for proper documentation formatting |
| docs/rpc/*.md | Updates generated documentation with new attribute names and references |
| docs/registry/attributes/jsonrpc.md | Adds new documentation file for jsonrpc namespace |
| docs/registry/attributes/rpc.md | Updates RPC attribute documentation, moves deprecated attributes to dedicated section |
| docs/registry/attributes/README.md | Adds JSONRPC namespace to attribute registry index |
| docs/cloud-providers/aws-sdk.md, docs/db/dynamodb.md, docs/object-stores/s3.md | Marks rpc.system as deprecated (intentionally retained for AWS conventions) |
| areas.yaml, AREAS.md | Adds area:jsonrpc label to RPC semantic conventions area |
| .github/ISSUE_TEMPLATE/*.yaml | Adds area:jsonrpc option to issue templates |
| .chloggen/rpc-system-name.yaml | Adds changelog entry documenting breaking changes |
Co-authored-by: Copilot <[email protected]>
steverao
reviewed
Dec 5, 2025
AlbumenJ
approved these changes
Dec 5, 2025
matt-hensley
reviewed
Dec 8, 2025
matt-hensley
approved these changes
Dec 8, 2025
Co-authored-by: Matthew Hensley <[email protected]>
lmolkova
moved this from Awaiting codeowners approval
to Needs More Approval
in Semantic Conventions Triage
joaopgrassi
approved these changes
Dec 9, 2025
joaopgrassi
moved this from Needs More Approval
to Ready to be Merged
in Semantic Conventions Triage
github-project-automation
Bot
moved this from In Progress
to Done
in RPC Semantic Conventions Stability
Cirilla-zmh
pushed a commit
to Cirilla-zmh/semantic-conventions
that referenced
this pull request
Feb 3, 2026
Co-authored-by: Trask Stalnaker <[email protected]> Co-authored-by: Copilot <[email protected]> Co-authored-by: Matthew Hensley <[email protected]>
16 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #2703
See also: #2921
This PR:
rpc.systemtorpc.system.name. Note: it also updates enum members:connect_rpcis renamed toconnectrpcapache_dubbois renamed todubbojava_rmi,dotnet_wcf, andonc_rpcare not included in the new enum - we don't have proper conventions for them and can add them to the new enum later on.rpc.jsonrpc.request_idtojsonrpc.request.idandrpc.jsonrpc.versiontojsonrpc.protocol.versionAWS conventions are intentionally left with deprecated
rpc.system- #1545, AWS is not an RPC system and the assumption is that AWS conventions will eventually be fixed.