Skip to content

Add RPC migration doc#3224

Merged
lmolkova merged 7 commits intoopen-telemetry:mainfrom
trask:rpc-migration-doc
Jan 28, 2026
Merged

Add RPC migration doc#3224
lmolkova merged 7 commits intoopen-telemetry:mainfrom
trask:rpc-migration-doc

Conversation

@trask
Copy link
Member

@trask trask commented Dec 16, 2025

Resolves #3204

Marking as ready to start reviewing but will wait to merge until after #3223 is merged and that change incorporated.

@trask trask force-pushed the rpc-migration-doc branch from 6198eab to 5e3c4b7 Compare December 17, 2025 00:01
@trask trask force-pushed the rpc-migration-doc branch from 5e3c4b7 to 413bf2b Compare December 17, 2025 00:14
@trask trask marked this pull request as ready for review December 17, 2025 00:28
@trask trask requested review from a team as code owners December 17, 2025 00:28
@trask trask requested a review from Copilot December 17, 2025 00:30
Copy link
Contributor

Copilot AI left a 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 adds a comprehensive migration guide to help users transition from experimental RPC semantic conventions (v1.37.0) to the upcoming stable version. The document follows established patterns from HTTP and database migration guides, providing a structured approach for instrumentation maintainers to implement backward-compatible upgrades.

Key Changes:

  • Added detailed RPC migration documentation covering span attributes, metrics, and their respective changes
  • Documented the OTEL_SEMCONV_STABILITY_OPT_IN environment variable pattern for phased rollout
  • Included comprehensive change tables for attribute renames, new attributes, and deprecated metrics
  • Added changelog entry for the enhancement

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 7 comments.

File Description
docs/non-normative/rpc-migration.md New migration guide documenting changes to RPC semantic conventions including attribute renames (e.g., rpc.systemrpc.system.name), metric name changes (e.g., rpc.server.durationrpc.server.call.duration), unit changes (ms → s), and deprecated metrics
.chloggen/rpc-migration-doc.yaml Changelog entry for the RPC migration guide enhancement

@github-actions
Copy link

github-actions bot commented Jan 2, 2026

This PR has been labeled as stale due to lack of activity. It will be automatically closed if there is no further activity over the next 7 days.

@github-actions github-actions bot added the Stale label Jan 2, 2026
@lmolkova lmolkova removed the Stale label Jan 2, 2026
@trask trask force-pushed the rpc-migration-doc branch from 4ad1c6f to dc7ec75 Compare January 8, 2026 01:48
@zeitlinger
Copy link
Member

Implementation issue for Java: open-telemetry/opentelemetry-java-instrumentation#15871

@zeitlinger
Copy link
Member

zeitlinger commented Jan 16, 2026

what is the expected behavior of span attributes with rpc/dup

  • rpc.method: com.example.ExampleService/exampleMethod or exampleMethod?
  • add network.type? (removed)
  • add error.type? (added)

For DB stabilization, we added all, but there is no conflict:

https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/a8b98646fa53116db6d22d5b26b293bd0b1ad5af/instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/db/DbClientAttributesExtractor.java#L97-L117

@zeitlinger
Copy link
Member

network.protocol.name is not conditional on being different from http - is this intentionally being different from https://github.com/thompson-tomo/semantic-conventions/blob/main/docs/http/http-spans.md#http-client-span ?

@trask
Copy link
Member Author

trask commented Jan 16, 2026

what is the expected behavior of span attributes with rpc/dup

rpc/dup should give priority to stable semconv over old semconv where there are conflicts

@kamphaus
Copy link
Contributor

Should docs/rpc/README.md be updated to include a link to docs/non-normative/rpc-migration.md similar to the HTTP readme?

For help migrating from non-stable to stable conventions, see [the migration guide](../non-normative/rpc-migration.md).

@joaopgrassi joaopgrassi moved this from Needs More Approval to Ready to be Merged in Semantic Conventions Triage Jan 27, 2026
@lmolkova lmolkova added this pull request to the merge queue Jan 28, 2026
Merged via the queue into open-telemetry:main with commit a74d33d Jan 28, 2026
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:rpc enhancement New feature or request

Development

Successfully merging this pull request may close these issues.

RPC: add migration guide

6 participants