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 OpenCensus migration plan #3015

Merged
merged 8 commits into from
Jan 17, 2023
Merged

Conversation

dashpole
Copy link
Contributor

@dashpole dashpole commented Dec 6, 2022

Part of #1175

Supersedes #2730.

Follow-up to #2979

Changes

Motivation

We have defined what OpenCensus metric and trace bridges, but don't have anywhere with recommendations on how to use them to migrate from OpenCensus to OpenTelemetry. This adds a description of how users and library authors can migrate to OpenTelemetry.

Removed

  • OpenCensus TextFormat Propagator: Not needed, as it is equivalent to the OpenTelemetry W3c TraceContext propagator.
  • B3 Context propagator for OpenCensus: Not needed, as b3 compatibility is already specified elsewhere, and is not OC-specific.
  • Semantic convention mapping for http: Bridges should not attempt to translate semantic conventions. Either way, metrics will need to be migrated. Translation makes bridges more complex, likely to be wrong, and may not be consistent with the latest OTel semantic conventions.

Added

  • Migration Guide: For end-users, operators, and instrumentation library maintainers. It describes how to use the components proposed below to migrate from OC to OTel.

Changed

  • BinaryPropagation for gRPC: Some languages (golang) can implement a BinaryPropagator as a TextMapPropagator. Other languages cannot do that. For languages that cannot implement a BinaryPropagator as a TextMapPropagator, add BinaryPropagation as an option on gRPC instrumentation.

The alternative to adding OC binary propagation directly to grpc instrumentation would be to introduce a binary propagator interface (similar to TextMapPropagator) in OTel. Given that this is just for a migration, that likely isn't an appropriately scoped change.

@dashpole dashpole requested review from a team December 6, 2022 19:10
@dashpole dashpole force-pushed the oc_migration_plan branch 2 times, most recently from 291de01 to 5489276 Compare December 6, 2022 19:40
@dashpole
Copy link
Contributor Author

dashpole commented Dec 6, 2022

cc @jack-berg @reyang @jsuereth @jmacd

specification/compatibility/opencensus.md Outdated Show resolved Hide resolved
specification/compatibility/opencensus.md Outdated Show resolved Hide resolved
specification/compatibility/opencensus.md Outdated Show resolved Hide resolved
@github-actions
Copy link

This PR was marked stale due to lack of activity. It will be closed in 7 days.

@github-actions github-actions bot added the Stale label Dec 22, 2022
@github-actions
Copy link

Closed as inactive. Feel free to reopen if this PR is still being worked on.

@github-actions
Copy link

github-actions bot commented Jan 6, 2023

This PR was marked stale due to lack of activity. It will be closed in 7 days.

@github-actions github-actions bot added the Stale label Jan 6, 2023
@MrAlias MrAlias removed the Stale label Jan 12, 2023
@dashpole dashpole force-pushed the oc_migration_plan branch 2 times, most recently from 787d805 to 6f22e56 Compare January 12, 2023 16:37
@dashpole dashpole requested review from MrAlias and jack-berg and removed request for MrAlias January 12, 2023 19:00
@carlosalberto
Copy link
Contributor

@dashpole Changelog entry please. Otherwise it looks we are ready to go.

@dashpole
Copy link
Contributor Author

Changelog entry please. Otherwise it looks we are ready to go.

@carlosalberto Done

@reyang reyang merged commit 25f75bf into open-telemetry:main Jan 17, 2023
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.

7 participants