Skip to content

docs: update tracing docs for Jaeger client removal#43

Merged
ankurs merged 2 commits intomainfrom
docs/jaeger-to-otel
Mar 27, 2026
Merged

docs: update tracing docs for Jaeger client removal#43
ankurs merged 2 commits intomainfrom
docs/jaeger-to-otel

Conversation

@ankurs
Copy link
Copy Markdown
Member

@ankurs ankurs commented Mar 27, 2026

Summary

Update docs to reflect that the Jaeger client library has been removed from ColdBrew core. Tracing is now exclusively via OpenTelemetry OTLP.

  • Index.md: clarify OTEL as primary, Jaeger as an OTLP-compatible backend
  • Packages.md: update tracing description
  • howto/Tracing.md: remove Jaeger as a direct backend
  • integrations.md: rename section to "OTLP-compatible backends"
  • config-reference.md: clarify Jaeger example uses OTLP

Part of go-coldbrew/core#50.

- Index.md: clarify OTEL as primary, Jaeger as OTLP backend
- Packages.md: update tracing description
- howto/Tracing.md: remove Jaeger as direct backend, clarify OTLP
- integrations.md: rename Jaeger section to OTLP-compatible backends
- config-reference.md: clarify Jaeger example uses OTLP

Part of Jaeger client removal (go-coldbrew/core#50).
Copilot AI review requested due to automatic review settings March 27, 2026 14:16
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Mar 27, 2026

Warning

Rate limit exceeded

@ankurs has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 5 minutes and 54 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 5 minutes and 54 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: 8c44ce96-682b-46c6-8655-75a3e6a7e38d

📥 Commits

Reviewing files that changed from the base of the PR and between 2f14004 and 5166d01.

📒 Files selected for processing (5)
  • Index.md
  • Packages.md
  • config-reference.md
  • howto/Tracing.md
  • integrations.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/jaeger-to-otel

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.

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 ColdBrew documentation to reflect removal of the Jaeger client from core and clarify that tracing is now done via OpenTelemetry OTLP (with Jaeger positioned as an OTLP-compatible backend).

Changes:

  • Reframes Jaeger as an OTLP-compatible backend and updates tracing descriptions accordingly.
  • Updates tracing how-to overview/examples to remove Jaeger as a direct backend option.
  • Clarifies the Jaeger local-dev configuration example as “via OTLP”.

Reviewed changes

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

Show a summary per file
File Description
Index.md Updates homepage feature blurb to emphasize OTLP-compatible backends (including Jaeger).
Packages.md Updates package-level tracing description to OTLP-compatible backends via OpenTelemetry.
howto/Tracing.md Removes Jaeger from page description and reframes tracing as OpenTelemetry OTLP + New Relic.
integrations.md Renames/rewrites Jaeger section to position it among OTLP-compatible backends.
config-reference.md Clarifies the Jaeger local development example is via OTLP.
Comments suppressed due to low confidence (1)

integrations.md:199

  • The section title now suggests this covers any OTLP-compatible backend, but the configuration text/example is still framed specifically around Jaeger ("To send traces to Jaeger…" / "Jaeger collector"). Consider either keeping the heading scoped to Jaeger (e.g., "Jaeger (via OTLP)") or updating the config text to be backend-agnostic and optionally adding brief notes/examples for other backends mentioned (Tempo/Honeycomb).
## Jaeger / OTLP-compatible backends

[Jaeger] is an open-source distributed tracing system. ColdBrew supports Jaeger (and any OTLP-compatible backend like Grafana Tempo, Honeycomb, etc.) through the OpenTelemetry OTLP exporter.

### Configuring

To send traces to Jaeger, configure the OTLP endpoint to point to your Jaeger collector:

```go

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

Comment thread Packages.md Outdated
Comment thread howto/Tracing.md Outdated
@ankurs ankurs merged commit c910cfb into main Mar 27, 2026
6 checks passed
@ankurs ankurs deleted the docs/jaeger-to-otel branch March 27, 2026 14:30
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