Skip to content

docs: update for slog default backend and deprecations#42

Merged
ankurs merged 3 commits intomainfrom
docs/slog-backend-update
Mar 27, 2026
Merged

docs: update for slog default backend and deprecations#42
ankurs merged 3 commits intomainfrom
docs/slog-backend-update

Conversation

@ankurs
Copy link
Member

@ankurs ankurs commented Mar 27, 2026

Summary

  • Update Index.md structured logging feature to mention slog as the default backend
  • Update Packages.md log description with slog default, deprecation notices for gokit/logrus, and slog bridge mention
  • Add "Logging backends" section to howto/Log.md with backend comparison table, slog configuration example, slog bridge setup, and deprecation notice

Follows go-coldbrew/log#19 (slog backend + bridge, default switch).

Test plan

  • Verify pages render correctly on the Jekyll site

Summary by CodeRabbit

  • Documentation
    • Updated logging documentation to specify slog as the default backend
    • Added guidance on configuring and switching between logging backends
    • Documented the slog bridge for integrating third-party logging into ColdBrew's pipeline
    • Marked gokit and logrus backends as deprecated with migration guidance

- Index.md: update structured logging feature to mention slog as default
- Packages.md: update log description with slog default and deprecation notes
- howto/Log.md: add "Logging backends" section with backend table, slog
  configuration example, slog bridge setup, and deprecation notice
Copilot AI review requested due to automatic review settings March 27, 2026 13:55
@coderabbitai
Copy link

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 19 minutes and 9 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 19 minutes and 9 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: a885093a-32ad-4fda-a703-366406dc97ce

📥 Commits

Reviewing files that changed from the base of the PR and between fadd469 and 1ba9e6d.

📒 Files selected for processing (2)
  • Packages.md
  • howto/Log.md
📝 Walkthrough

Walkthrough

Documentation updates across three files establish slog as the default logging backend in ColdBrew, deprecate gokit and logrus backends, and provide configuration examples and migration guidance for third-party slog integration.

Changes

Cohort / File(s) Summary
Logging Backend Documentation Updates
Index.md, Packages.md, howto/Log.md
Updated feature and package descriptions to designate slog as the default logging backend. Added references to slog bridge for third-party integration, marked gokit and logrus as deprecated, and included practical configuration examples showing explicit backend setup and slog bridge routing.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 Hop along to slog we go,
Default backend steals the show,
Deprecated paths fade away,
ColdBrew's logging's here to stay! 🔍✨

🚥 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 pull request title accurately describes the main changes: updating documentation to reflect slog as the default backend and marking gokit/logrus as deprecated.
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/slog-backend-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

@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: 1

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

Inline comments:
In `@Index.md`:
- Line 29: The table row under "Structured Logging" in Index.md is inconsistent
with other docs; update the backend list so go-kit and logrus are marked as
deprecated to match howto/Log.md and Packages.md. Edit the row that currently
lists "slog (default), zap, go-kit, logrus" and change the labels for the two
deprecated backends (for example "go-kit (deprecated)" and "logrus
(deprecated)") or append a footnote/parenthetical deprecation note, keeping
"slog" as the default and preserving trace ID/context wording.
🪄 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: c4303b2c-3b8b-437f-85e4-1a9c9703e0d9

📥 Commits

Reviewing files that changed from the base of the PR and between fb73b97 and fadd469.

📒 Files selected for processing (3)
  • Index.md
  • Packages.md
  • howto/Log.md

Copy link
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 ColdBrew documentation to reflect slog as the default structured logging backend, and to document backend options plus deprecation status for older backends.

Changes:

  • Add a new “Logging backends” section to the logging how-to, including a backend comparison table and slog configuration/bridge examples.
  • Update the packages overview to describe slog as the default backend and call out deprecated backends plus the slog bridge.
  • Update the home page feature table to mention slog as the default structured logging backend and add a reference link.

Reviewed changes

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

File Description
howto/Log.md Adds backend comparison + slog configuration and bridge documentation, plus a deprecation note.
Packages.md Updates the logging package description to reflect slog default and bridge/deprecations.
Index.md Updates the structured logging feature blurb and adds a slog link reference.

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

ankurs and others added 2 commits March 27, 2026 22:02
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@ankurs ankurs merged commit 2f14004 into main Mar 27, 2026
7 checks passed
@ankurs ankurs deleted the docs/slog-backend-update branch March 27, 2026 14:04
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