Skip to content
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

fix log doesn't show useful filename&lineno #1588

Closed
wants to merge 1 commit into from

Conversation

methane
Copy link
Member

@methane methane commented May 18, 2024

Description

In #1563, we added mc.log() helper function that wraps mc.cfg.Logger.Print().
But it broke log.Logger with log.Lshortfile flag. All logs shows connection.go:50.

We need to adjust calldepth.
We need to backport this to 1.8 branch or revert #1564 in the branch.

Checklist

  • Code compiles correctly
  • Created tests which fail without the change (if possible)
  • All tests passing
  • Extended the README / documentation, if necessary
  • Added myself / the copyright holder to the AUTHORS file

Copy link

coderabbitai bot commented May 18, 2024

Walkthrough

The errors.go file was updated to enhance logging capabilities. A Print method was added to the Logger interface, and a new stdLog type was introduced to wrap the standard log.Logger with an adjusted call depth. Additionally, the defaultLogger variable now uses the StdLogger function to initialize a Logger, improving flexibility and consistency in logging.

Changes

File Change Summary
errors.go Added Print(v ...any) to Logger interface, introduced stdLog type, and added StdLogger function to wrap log.Logger with adjusted call depth. Updated defaultLogger to use StdLogger.

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
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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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

@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

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between af8d793 and 59497de.
Files selected for processing (1)
  • errors.go (1 hunks)
Additional comments not posted (5)
errors.go (5)

40-40: Initialization of defaultLogger using StdLogger is correct and aligns with the PR objectives.


40-40: Addition of the Print method to the Logger interface supports the new logging functionality.


47-50: Definition of stdLog type is correct and necessary for the new logging functionality.


52-56: The Print method in stdLog correctly adjusts the call depth for logging, addressing the issue described in the PR.


58-61: The StdLogger function correctly creates a Logger instance with the necessary adjustments for logging.

@coveralls
Copy link

Coverage Status

coverage: 82.499% (+0.04%) from 82.462%
when pulling 59497de on methane:fix-callsite
into af8d793 on go-sql-driver:master.

@methane
Copy link
Member Author

methane commented Jun 3, 2024

I prefer #1589 over this because #1589 can show "filename:lineno" even for custom writers.

@methane methane closed this Jun 3, 2024
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