Skip to content

ensure info message is logged #1987

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 17, 2025
Merged

ensure info message is logged #1987

merged 1 commit into from
Jun 17, 2025

Conversation

motatoes
Copy link
Contributor

@motatoes motatoes commented Jun 17, 2025

Summary by CodeRabbit

  • Bug Fixes
    • Improved logging behavior so that messages are now logged as informational when exiting with code 0, and as errors for non-zero exit codes.

Copy link
Contributor

coderabbitai bot commented Jun 17, 2025

Walkthrough

The ReportErrorAndExit function in cli/pkg/usage/usage.go was updated to log messages at an informational level when the exit code is zero, and at an error level otherwise. The rest of the function's behavior, including sending the log record and exiting, remains unchanged.

Changes

File(s) Change Summary
cli/pkg/usage/usage.go Updated ReportErrorAndExit to log messages as info if exitCode is zero, error otherwise.

Poem

A rabbit logs with gentle might,
Info for a peaceful night,
Errors loud when things go wrong,
Exit codes decide the song.
With every hop, the logs are clear—
Zero calm, or trouble near!
🐇✨

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Post Copyable Unit Tests in Comment
  • Commit Unit Tests in branch fix/logrecord

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
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai auto-generate unit tests to generate unit tests for this 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.

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

PR Summary

Enhanced logging level consistency in cli/pkg/usage/usage.go by differentiating between success and error cases in the ReportErrorAndExit function.

  • Modified ReportErrorAndExit to use slog.Info for exitCode=0 (success) and slog.Error for non-zero codes (errors)
  • Potential function naming inconsistency as ReportErrorAndExit now handles both success and error cases

1 file reviewed, no comments
Edit PR Review Bot Settings | Greptile

Copy link
Contributor

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

🧹 Nitpick comments (2)
cli/pkg/usage/usage.go (2)

115-120: Consider structured, DRY logging and include exit code as an attribute

The conditional branching achieves the desired severity switch, but we now have two almost-identical calls that differ only by level.
You can eliminate this duplication and get richer telemetry by logging the exit code as an attribute:

- if exitCode == 0 {
-     slog.Info(message)
- } else {
-     slog.Error(message)
- }
+ l := slog.Info
+ if exitCode != 0 {
+     l = slog.Error
+ }
+ l("cli exit", "msg", message, "exitCode", exitCode)

This keeps the code DRY, makes the log record trivially machine-queryable, and surfaces the numeric exit code without having to parse the free-text message.


115-120: Function name no longer reflects behaviour when exitCode == 0

With the new branch, the function is now a general “log-and-exit” helper, not strictly an error reporter.

If callers are expected to invoke it for successful termination, renaming (e.g., ReportAndExit) or documenting the new semantics would avoid confusion for future readers.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5cd80d3 and ec4879a.

📒 Files selected for processing (1)
  • cli/pkg/usage/usage.go (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: Build
  • GitHub Check: Build
  • GitHub Check: Build
  • GitHub Check: Build
  • GitHub Check: Build
  • GitHub Check: Build
  • GitHub Check: Build

@motatoes motatoes merged commit f89f081 into develop Jun 17, 2025
12 checks passed
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.

1 participant