Skip to content

docs: update Prometheus interceptor package name after Phase 4 migration#40

Merged
ankurs merged 2 commits intomainfrom
fix/phase4-docs-update
Mar 26, 2026
Merged

docs: update Prometheus interceptor package name after Phase 4 migration#40
ankurs merged 2 commits intomainfrom
fix/phase4-docs-update

Conversation

@ankurs
Copy link
Copy Markdown
Member

@ankurs ankurs commented Mar 26, 2026

Summary

  • Update interceptor chain table: Prometheus package grpc_prometheusinterceptors (metrics now managed internally)

Test plan

  • npx playwright test

Summary by CodeRabbit

  • Documentation
    • Removed the “Context Tags” stage from the documented interceptor chain, renumbered subsequent steps, and updated diagrams to reflect the simplified request-processing flow.
    • Updated external library reference to use the v2 module path.

The Prometheus gRPC metrics are now managed internally by the
interceptors package (via providers/prometheus), not the standalone
grpc_prometheus package.
Copilot AI review requested due to automatic review settings March 26, 2026 04:20
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Mar 26, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: d7f0ec1e-3025-4c2f-acd5-e85a7548d323

📥 Commits

Reviewing files that changed from the base of the PR and between 9ab39b2 and d4edc10.

📒 Files selected for processing (3)
  • Index.md
  • howto/Debugging.md
  • integrations.md
✅ Files skipped from review due to trivial changes (3)
  • integrations.md
  • howto/Debugging.md
  • Index.md

📝 Walkthrough

Walkthrough

Removed the "Context Tags (grpc_ctxtags)" step from the documented gRPC server interceptor chain and renumbered subsequent interceptors; updated the interceptor table and request-lifecycle diagram, and replaced go-grpc-middleware links with the v2 module path where present.

Changes

Cohort / File(s) Summary
Interceptor chain docs & diagrams
architecture.md, howto/Debugging.md, index.md
Removed "Context Tags (grpc_ctxtags)" from the interceptor sequence and renumbered subsequent steps (OpenTracing/OpenTelemetry now step 3, Prometheus step 4, Error Notification step 5, New Relic step 6, Panic Recovery step 7). Updated interceptor table and request-lifecycle diagram accordingly.
Go-grpc-middleware link updates
integrations.md
Replaced non-versioned github.com/grpc-ecosystem/go-grpc-middleware link with the v2 module path github.com/grpc-ecosystem/go-grpc-middleware/v2.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

Poem

🐰 A tag hopped off the chain today,
Steps shifted softly into play,
Diagrams tidy, links set right,
I nibbled docs by moonlit light,
Hooray for tidy rails of code — hip hop hooray!

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Title check ⚠️ Warning The title refers to updating the Prometheus interceptor package name after Phase 4 migration, but the actual changes focus on removing the Context Tags interceptor step and renumbering the chain, with only secondary updates to go-grpc-middleware links. Revise the title to better reflect the primary changes: something like 'docs: remove Context Tags interceptor and renumber chain after Phase 4 migration' would more accurately represent the main scope of the changeset.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
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 fix/phase4-docs-update

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 Phase 4 interceptor/middleware packaging changes, specifically around where Prometheus metrics are implemented.

Changes:

  • Update the documented Prometheus interceptor package from grpc_prometheus to interceptors.
  • Update the interceptor chain diagram/table ordering (including removal of the Context Tags entry).

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

Comment thread architecture.md
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@architecture.md`:
- Around line 157-161: The PR changes remove the "Context Tags (grpc_ctxtags)"
interceptor from the documented chain and renumbers subsequent items (e.g., the
list entries including "OpenTracing / OpenTelemetry", "Prometheus Metrics",
"Error Notification (Sentry/Rollbar)", "New Relic Transaction", "Panic
Recovery"), but the title and description only reference the Prometheus package
rename; update the PR title and description to explicitly state that "Context
Tags (grpc_ctxtags)" was removed from the interceptor chain and that the
remaining interceptors were renumbered, and include a brief rationale and list
of the new order so reviewers can see the full scope of the change.
- Around line 203-207: Documentation is inconsistent: the interceptor chain in
the "Debugging" section and the Index still lists the old 8-step chain including
"Context Tags" while architecture.md now presents a 7-step chain without it.
Edit the Debugging section that enumerates the interceptor chain and the Index
entry that references "Context Tags" to remove the "Context Tags" step, renumber
the list to a 7-step sequence, and copy the exact step names and brief
descriptions from architecture.md so both docs match the new interceptor order
and wording.
- Line 203: Replace the package name for the OpenTracing interceptor entry that
currently reads `grpc_opentracing` with `interceptors` so it matches the rest of
the interceptor entries; locate the table row referencing "OpenTracing" (the
entry that shows `grpc_opentracing`) and update the package column to
`interceptors` to reflect the ColdBrew-provided interceptor implementation.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 25c4e240-5d36-4fe3-a188-81c9b823a264

📥 Commits

Reviewing files that changed from the base of the PR and between d4912c6 and 9ab39b2.

📒 Files selected for processing (1)
  • architecture.md

Comment thread architecture.md
Comment thread architecture.md
Comment thread architecture.md
…leware links to v2

- Remove 'Context Tags' step from Debugging.md interceptor chain (8→7 steps)
- Remove 'Context Tags' from Index.md ASCII diagram
- Update go-grpc-middleware links to v2 in Index.md and integrations.md
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