refactor: skip unwanted logs

[julienrbrt]

Summary by CodeRabbit

• New Features

  • Added functionality to skip unwanted logs from PebbleDB.
  • Introduced a new logging mechanism to enhance logging control.

• Bug Fixes

  • Implemented checks for empty keys and nil values in database operations, ensuring appropriate error handling.

• Documentation

  • Updated changelog to reflect the new version entry and changes made.

[coderabbitai]

Walkthrough

The pull request introduces version 1.1.1 of the project, focusing on improvements to PebbleDB logging and synchronization mechanisms. A new fatalLogger type is implemented in pebble.go to manage log output more effectively, allowing better control over internal logging. The changes include modifications to database write options, enhanced error handling for key operations, and the ability to skip unwanted logs from PebbleDB.

Changes

File	Change Summary
CHANGELOG.md	Added version 1.1.1 entry with note about skipping unwanted PebbleDB logs
pebble.go	- Added fatalLogger type to control logging - Implemented Fatalf and Infof methods for custom logging - Modified write options with conditional sync behavior - Added key and value validation checks

Sequence Diagram

sequenceDiagram
    participant App
    participant PebbleDB
    participant Logger
    
    App->>PebbleDB: Initialize DB
    PebbleDB->>Logger: Set custom fatalLogger
    App->>PebbleDB: Perform database operation
    alt Sync Required
        PebbleDB->>PebbleDB: Force disk sync
    end
    PebbleDB-->>App: Operation result

Loading

Poem

🐰 A Rabbit's Ode to Quiet Logs 🐰

In PebbleDB's noisy domain,
A logger hops to calm the strain,
Silencing chatter, sync with grace,
Our database dances at its pace!
Logs whisper soft, no more loud din,
A coding rabbit's subtle win! 🚀

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

pebble.go (2)

75-75: LGTM: Good separation of logging concerns

The addition of fatalLogger to prevent PebbleDB's internal logs from interfering with the application's logging system is a clean architectural solution. This ensures proper separation between database and application logging.

---

496-504: Add documentation and address unused parameters

While the implementation effectively achieves the goal of selective logging, consider these improvements:

1. Add documentation explaining the selective logging strategy
2. Address the unused parameters in Infof

Apply this diff to improve the implementation:

 type fatalLogger struct {
     pebble.Logger
 }
 
+// Fatalf implements pebble.Logger interface, forwarding fatal logs to the default logger
 func (*fatalLogger) Fatalf(format string, args ...interface{}) {
     pebble.DefaultLogger.Fatalf(format, args...)
 }
 
-func (*fatalLogger) Infof(format string, args ...interface{}) {}
+// Infof implements pebble.Logger interface, intentionally suppressing info logs
+func (*fatalLogger) Infof(_ string, _ ...interface{}) {}

🧰 Tools

🪛 GitHub Check: golangci

[failure] 504-504:
unused-parameter: parameter 'format' seems to be unused, consider removing or renaming it as _ (revive)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0ed17d4 and 20888e7.

📒 Files selected for processing (2)

• CHANGELOG.md (1 hunks)
• pebble.go (2 hunks)

✅ Files skipped from review due to trivial changes (1)

• CHANGELOG.md

🧰 Additional context used

🪛 GitHub Check: golangci

pebble.go

[failure] 504-504:
unused-parameter: parameter 'format' seems to be unused, consider removing or renaming it as _ (revive)

[testinginprod]

lgtm