docs: update for OTEL migration — remove OpenTracing references#44
docs: update for OTEL migration — remove OpenTracing references#44
Conversation
- 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
There was a problem hiding this comment.
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_BRIDGEdocumentation 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
otelgrpcstats 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.
|
Warning Rate limit exceeded
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 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. 📝 WalkthroughWalkthroughDocumentation 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
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Summary
Update docs to reflect the OTEL migration across all packages.
Changes
UseOpenTracingBridgeas deprecated in struct docs and code examplesOTLP_USE_OPENTRACING_BRIDGEdefault tofalse, mark deprecatedFollows go-coldbrew/core#51 and go-coldbrew/core#52.
Summary by CodeRabbit