Skip to content

docs: update for OTEL migration — remove OpenTracing references#44

Merged
ankurs merged 2 commits intomainfrom
docs/otel-migration-updates
Mar 28, 2026
Merged

docs: update for OTEL migration — remove OpenTracing references#44
ankurs merged 2 commits intomainfrom
docs/otel-migration-updates

Conversation

@ankurs
Copy link
Copy Markdown
Member

@ankurs ankurs commented Mar 28, 2026

Summary

Update docs to reflect the OTEL migration across all packages.

Changes

  • howto/Tracing.md: Remove OpenTracing baggage reference, clarify correlation ID fallback
  • integrations.md: Mark UseOpenTracingBridge as deprecated in struct docs and code examples
  • architecture.md: Update server interceptor chain (removed OpenTracing interceptor, added note about OTEL stats handler), update client chain, update context propagation diagram
  • config-reference.md: Flip OTLP_USE_OPENTRACING_BRIDGE default to false, mark deprecated

Follows go-coldbrew/core#51 and go-coldbrew/core#52.

Summary by CodeRabbit

  • Documentation
    • Updated architecture and tracing documentation to reflect changes in instrumentation handling
    • Marked OpenTracing compatibility bridge as deprecated with updated configuration defaults
    • Clarified OpenTelemetry tracing behavior and fallback mechanisms for trace ID correlation

- howto/Tracing.md: remove OpenTracing baggage reference
- integrations.md: mark UseOpenTracingBridge as deprecated in examples
- architecture.md: update interceptor chain (OTEL via stats handler,
  not interceptor), update client chain, update context propagation
- config-reference.md: flip default to false, mark deprecated
Copilot AI review requested due to automatic review settings March 28, 2026 09:55
Copy link
Copy Markdown
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

Updates the documentation set to reflect the OpenTelemetry (OTEL) migration by removing/softening remaining OpenTracing references and documenting the new tracing integration points.

Changes:

  • Deprecates the UseOpenTracingBridge / OTLP_USE_OPENTRACING_BRIDGE documentation and updates examples to avoid enabling it by default.
  • Updates tracing docs to remove the OpenTracing baggage mention and clarify trace/correlation ID behavior.
  • Updates architecture docs to reflect OTEL span creation/propagation via otelgrpc stats handlers rather than interceptor chain entries.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File Description
integrations.md Marks UseOpenTracingBridge as deprecated and comments it out in examples.
howto/Tracing.md Updates trace ID explanation to remove OpenTracing baggage reference and describe OTEL-related behavior.
config-reference.md Flips OTLP_USE_OPENTRACING_BRIDGE documented default to false and marks it deprecated.
architecture.md Updates interceptor chain and context propagation docs to reflect OTEL gRPC stats handler usage.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread howto/Tracing.md Outdated
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Mar 28, 2026

Warning

Rate limit exceeded

@ankurs has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 10 minutes and 46 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 10 minutes and 46 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 7855ef3c-1ba8-40e2-a3e5-e62182f6ef46

📥 Commits

Reviewing files that changed from the base of the PR and between 8241adb and 421dbd1.

📒 Files selected for processing (1)
  • howto/Tracing.md
📝 Walkthrough

Walkthrough

Documentation updates removing OpenTracing from interceptor chains and replacing with gRPC stats handler references. Deprecates OpenTracing bridge configuration, updates OTEL trace ID defaults, and revises diagrams reflecting new tracing flow architecture.

Changes

Cohort / File(s) Summary
Interceptor Chain & Tracing Architecture
architecture.md
Removes OpenTracing from server and client interceptor chains; documents OTEL tracing as handled by gRPC stats handler; updates interceptor diagrams and renumbers steps accordingly.
OpenTracing Bridge Deprecation
config-reference.md, integrations.md
Updates OTLP_USE_OPENTRACING_BRIDGE default from true to false and marks as deprecated; removes explicit bridge usage from example configurations with clarifying comments.
ColdBrew Trace ID & OTEL Integration
howto/Tracing.md
Reclassifies ColdBrew's trace ID as "application-level correlation ID"; removes outdated OpenTracing baggage reference; clarifies fallback to OTEL span's trace ID when unset.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

  • go-coldbrew/docs.coldbrew.cloud#40: Both PRs modify gRPC interceptor chain documentation in architecture.md, removing/renumbering OpenTracing entries and updating OTEL tracing placement.

Poem

🐰 No more OpenTracing in the chain so deep,
gRPC stats handlers the vigil now keep,
OTEL steps forward, deprecated the old,
A cleaner architecture, more modern and bold! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely summarizes the main change: updating documentation to remove OpenTracing references as part of an OTEL migration.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/otel-migration-updates

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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.

2 participants