-
Notifications
You must be signed in to change notification settings - Fork 291
Consolidate RPC metadata attributes #3169
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR consolidates protocol-specific RPC metadata attributes into common, generic RPC attributes. The change promotes reusability across different RPC protocols by renaming rpc.grpc.request.metadata, rpc.connect_rpc.request.metadata to rpc.request.metadata, and their corresponding response metadata attributes to rpc.response.metadata. This is a breaking change that simplifies the semantic conventions and reduces duplication.
Key changes:
- Created new generic
rpc.request.metadataandrpc.response.metadataattributes in the main RPC registry - Deprecated the four protocol-specific metadata attributes (gRPC and Connect RPC variants)
- Updated all span definitions and documentation to reference the new generic attributes
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
model/rpc/registry.yaml |
Added new generic rpc.request.metadata and rpc.response.metadata attributes with proper type, stability, brief, note, and examples; removed the protocol-specific variants |
model/rpc/spans.yaml |
Updated attribute references in Connect RPC and gRPC span definitions (client and server) to use the new generic metadata attributes |
model/rpc/deprecated/registry-deprecated.yaml |
Added deprecation entries for all four protocol-specific metadata attributes with proper renamed_to references |
docs/rpc/grpc.md |
Updated documentation tables and footnotes to reference the new generic RPC metadata attributes instead of gRPC-specific ones |
docs/rpc/connect-rpc.md |
Updated documentation tables and footnotes to reference the new generic RPC metadata attributes; also fixed example value formatting inconsistency (string to array) |
docs/registry/attributes/rpc.md |
Updated attribute registry to show new generic metadata attributes and moved deprecated attributes to the deprecated section |
.chloggen/rpc-metadata.yaml |
Added changelog entry documenting this breaking change |
d5146c8 to
36b76e5
Compare
Fixes #2869
Rename
rpc.grpc.request.metadataandrpc.connect_rpc.request.metadatatorpc.request.metadatarpc.grpc.response.metadataandrpc.connect_rpc.response.metadatatorpc.response.metadata