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

log: add "filename:line" prefix by ourself #1589

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

methane
Copy link
Member

@methane methane commented May 19, 2024

#1563 broke the filename:lineno prefix in the log message by introducing a helper function.
This commit adds the "filename:line" prefix in the helper function instead of log.Lshortfile option to show correct filename:lineno.

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

go-sql-driver#1563 broke the filename:lineno prefix in the log
message by introducing a helper function.
This commit adds the "filename:line" prefix in the helper function
instead of log.Lshortfile option to show correct filename:lineno.
Copy link

coderabbitai bot commented May 19, 2024

Walkthrough

The MySQL connection code now provides enhanced logging with file name and line number details for better debugging. The log method within the mysqlConn struct has been updated to incorporate this information using runtime.Caller and fmt packages. This change aims to improve the clarity and context of log messages for easier troubleshooting.

Changes

File Change Summary
connection.go The log function in the mysqlConn struct has been modified to include file name and line number information in the log output.

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: 2

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between af8d793 and 961210b.
Files selected for processing (2)
  • connection.go (2 hunks)
  • errors.go (1 hunks)
Files skipped from review due to trivial changes (1)
  • errors.go
Additional Context Used
GitHub Check Runs (25)
test (ubuntu-latest, 1.20, 8.0) failure (5)

connection.go: [failure] 55-55:
undefined: pos


connection.go: [failure] 56-56:
undefined: pos


connection.go: [failure] 57-57:
undefined: pos


connection.go: [failure] 62-62:
too many arguments in call to mc.cfg.Logger.Print

test (ubuntu-latest, 1.21, 8.0) failure (5)

connection.go: [failure] 55-55:
undefined: pos


connection.go: [failure] 56-56:
undefined: pos


connection.go: [failure] 57-57:
undefined: pos


connection.go: [failure] 62-62:
too many arguments in call to mc.cfg.Logger.Print

test (windows-latest, 1.22, mariadb-10.6) failure (5)

connection.go: [failure] 55-55:
undefined: pos


connection.go: [failure] 56-56:
undefined: pos


connection.go: [failure] 57-57:
undefined: pos


connection.go: [failure] 62-62:
too many arguments in call to mc.cfg.Logger.Print

test (windows-latest, 1.22, mariadb-10.11) failure (5)

connection.go: [failure] 55-55:
undefined: pos


connection.go: [failure] 56-56:
undefined: pos


connection.go: [failure] 57-57:
undefined: pos


connection.go: [failure] 62-62:
too many arguments in call to mc.cfg.Logger.Print

test (windows-latest, 1.22, mariadb-11.1) failure (5)

connection.go: [failure] 55-55:
undefined: pos


connection.go: [failure] 56-56:
undefined: pos


connection.go: [failure] 57-57:
undefined: pos


connection.go: [failure] 62-62:
too many arguments in call to mc.cfg.Logger.Print

test (windows-latest, 1.22, 5.7) failure (5)

connection.go: [failure] 55-55:
undefined: pos


connection.go: [failure] 56-56:
undefined: pos


connection.go: [failure] 57-57:
undefined: pos


connection.go: [failure] 62-62:
too many arguments in call to mc.cfg.Logger.Print

test (windows-latest, 1.22, 8.3) failure (5)

connection.go: [failure] 55-55:
undefined: pos


connection.go: [failure] 56-56:
undefined: pos


connection.go: [failure] 57-57:
undefined: pos


connection.go: [failure] 62-62:
too many arguments in call to mc.cfg.Logger.Print

test (windows-latest, 1.22, 8.0) failure (5)

connection.go: [failure] 55-55:
undefined: pos


connection.go: [failure] 56-56:
undefined: pos


connection.go: [failure] 57-57:
undefined: pos


connection.go: [failure] 62-62:
too many arguments in call to mc.cfg.Logger.Print

test (macos-latest, 1.22, mariadb-10.5) failure (5)

connection.go: [failure] 55-55:
undefined: pos


connection.go: [failure] 56-56:
undefined: pos


connection.go: [failure] 57-57:
undefined: pos


connection.go: [failure] 62-62:
too many arguments in call to mc.cfg.Logger.Print

test (macos-latest, 1.22, mariadb-10.6) failure (5)

connection.go: [failure] 55-55:
undefined: pos


connection.go: [failure] 56-56:
undefined: pos


connection.go: [failure] 57-57:
undefined: pos


connection.go: [failure] 62-62:
too many arguments in call to mc.cfg.Logger.Print

test (macos-latest, 1.22, mariadb-10.11) failure (5)

connection.go: [failure] 55-55:
undefined: pos


connection.go: [failure] 56-56:
undefined: pos


connection.go: [failure] 57-57:
undefined: pos


connection.go: [failure] 62-62:
too many arguments in call to mc.cfg.Logger.Print

test (macos-latest, 1.22, mariadb-11.1) failure (5)

connection.go: [failure] 55-55:
undefined: pos


connection.go: [failure] 56-56:
undefined: pos


connection.go: [failure] 57-57:
undefined: pos


connection.go: [failure] 62-62:
too many arguments in call to mc.cfg.Logger.Print

test (macos-latest, 1.22, mariadb-11.3) failure (5)

connection.go: [failure] 55-55:
undefined: pos


connection.go: [failure] 56-56:
undefined: pos


connection.go: [failure] 57-57:
undefined: pos


connection.go: [failure] 62-62:
too many arguments in call to mc.cfg.Logger.Print

test (macos-latest, 1.22, 5.7) failure (5)

connection.go: [failure] 55-55:
undefined: pos


connection.go: [failure] 56-56:
undefined: pos


connection.go: [failure] 57-57:
undefined: pos


connection.go: [failure] 62-62:
too many arguments in call to mc.cfg.Logger.Print

test (macos-latest, 1.22, 8.3) failure (5)

connection.go: [failure] 55-55:
undefined: pos


connection.go: [failure] 56-56:
undefined: pos


connection.go: [failure] 57-57:
undefined: pos


connection.go: [failure] 62-62:
too many arguments in call to mc.cfg.Logger.Print

test (macos-latest, 1.22, 8.0) failure (5)

connection.go: [failure] 55-55:
undefined: pos


connection.go: [failure] 56-56:
undefined: pos


connection.go: [failure] 57-57:
undefined: pos


connection.go: [failure] 62-62:
too many arguments in call to mc.cfg.Logger.Print

test (ubuntu-latest, 1.22, mariadb-10.5) failure (5)

connection.go: [failure] 55-55:
undefined: pos


connection.go: [failure] 56-56:
undefined: pos


connection.go: [failure] 57-57:
undefined: pos


connection.go: [failure] 62-62:
too many arguments in call to mc.cfg.Logger.Print

test (ubuntu-latest, 1.22, mariadb-10.6) failure (5)

connection.go: [failure] 55-55:
undefined: pos


connection.go: [failure] 56-56:
undefined: pos


connection.go: [failure] 57-57:
undefined: pos


connection.go: [failure] 62-62:
too many arguments in call to mc.cfg.Logger.Print

test (ubuntu-latest, 1.22, mariadb-10.11) failure (5)

connection.go: [failure] 55-55:
undefined: pos


connection.go: [failure] 56-56:
undefined: pos


connection.go: [failure] 57-57:
undefined: pos


connection.go: [failure] 62-62:
too many arguments in call to mc.cfg.Logger.Print

test (ubuntu-latest, 1.22, mariadb-11.1) failure (5)

connection.go: [failure] 55-55:
undefined: pos


connection.go: [failure] 56-56:
undefined: pos


connection.go: [failure] 57-57:
undefined: pos


connection.go: [failure] 62-62:
too many arguments in call to mc.cfg.Logger.Print

test (ubuntu-latest, 1.22, mariadb-11.3) failure (5)

connection.go: [failure] 55-55:
undefined: pos


connection.go: [failure] 56-56:
undefined: pos


connection.go: [failure] 57-57:
undefined: pos


connection.go: [failure] 62-62:
too many arguments in call to mc.cfg.Logger.Print

test (ubuntu-latest, 1.22, 5.7) failure (5)

connection.go: [failure] 55-55:
undefined: pos


connection.go: [failure] 56-56:
undefined: pos


connection.go: [failure] 57-57:
undefined: pos


connection.go: [failure] 62-62:
too many arguments in call to mc.cfg.Logger.Print

test (ubuntu-latest, 1.22, 8.3) failure (5)

connection.go: [failure] 55-55:
undefined: pos


connection.go: [failure] 56-56:
undefined: pos


connection.go: [failure] 57-57:
undefined: pos


connection.go: [failure] 62-62:
too many arguments in call to mc.cfg.Logger.Print

test (ubuntu-latest, 1.22, 8.0) failure (5)

connection.go: [failure] 55-55:
undefined: pos


connection.go: [failure] 56-56:
undefined: pos


connection.go: [failure] 57-57:
undefined: pos


connection.go: [failure] 62-62:
too many arguments in call to mc.cfg.Logger.Print

lint failure (10)

connection.go: [failure] 55-55:
undefined: pos


connection.go: [failure] 56-56:
undefined: pos


connection.go: [failure] 57-57:
undefined: pos


connection.go: [failure] 62-62:
too many arguments in call to mc.cfg.Logger.Print


connection.go: [failure] 55-55:
undefined: pos


connection.go: [failure] 56-56:
undefined: pos


connection.go: [failure] 57-57:
undefined: pos


connection.go: [failure] 62-62:
too many arguments in call to mc.cfg.Logger.Print

connection.go Outdated Show resolved Hide resolved
connection.go Outdated Show resolved Hide resolved
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 961210b and 80e2d8f.
Files selected for processing (1)
  • connection.go (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • connection.go

@coveralls
Copy link

Coverage Status

coverage: 82.494% (+0.03%) from 82.462%
when pulling 80e2d8f on methane:log-add-prefix
into af8d793 on go-sql-driver:master.

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.

None yet

2 participants