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

methane · 2024-05-19T03:12:03Z

#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.

coderabbitai · 2024-05-19T03:12:09Z

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.

coderabbitai

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

coderabbitai

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 · 2024-05-19T03:42:56Z

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

shogo82148

LGTM

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. (cherry picked from commit 2f7015e)

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [github.com/go-sql-driver/mysql](https://github.com/go-sql-driver/mysql) | require | minor | `v1.8.1` -> `v1.9.1` | --- ### Release Notes <details> <summary>go-sql-driver/mysql (github.com/go-sql-driver/mysql)</summary> ### [`v1.9.1`](https://github.com/go-sql-driver/mysql/blob/HEAD/CHANGELOG.md#v191-2025-03-21) [Compare Source](go-sql-driver/mysql@v1.9.0...v1.9.1) ##### Major Changes - Add Charset() option. ([#1679](go-sql-driver/mysql#1679)) ##### Bugfixes - go.mod: fix go version format ([#1682](go-sql-driver/mysql#1682)) - Fix FormatDSN missing ConnectionAttributes ([#1619](go-sql-driver/mysql#1619)) ### [`v1.9.0`](https://github.com/go-sql-driver/mysql/blob/HEAD/CHANGELOG.md#v190-2025-02-18) [Compare Source](go-sql-driver/mysql@v1.8.1...v1.9.0) ##### Major Changes - Implement zlib compression. ([#1487](go-sql-driver/mysql#1487)) - Supported Go version is updated to Go 1.21+. ([#1639](go-sql-driver/mysql#1639)) - Add support for VECTOR type introduced in MySQL 9.0. ([#1609](go-sql-driver/mysql#1609)) - Config object can have custom dial function. ([#1527](go-sql-driver/mysql#1527)) ##### Bugfixes - Fix auth errors when username/password are too long. ([#1625](go-sql-driver/mysql#1625)) - Check if MySQL supports CLIENT_CONNECT_ATTRS before sending client attributes. ([#1640](go-sql-driver/mysql#1640)) - Fix auth switch request handling. ([#1666](go-sql-driver/mysql#1666)) ##### Other changes - Add "filename:line" prefix to log in go-mysql. Custom loggers now show it. ([#1589](go-sql-driver/mysql#1589)) - Improve error handling. It reduces the "busy buffer" errors. ([#1595](go-sql-driver/mysql#1595), [#1601](go-sql-driver/mysql#1601), [#1641](go-sql-driver/mysql#1641)) - Use `strconv.Atoi` to parse max_allowed_packet. ([#1661](go-sql-driver/mysql#1661)) - `rejectReadOnly` option now handles ER_READ_ONLY_MODE (1290) error too. ([#1660](go-sql-driver/mysql#1660)) </details> --- ### Configuration 📅 **Schedule**: Branch creation - "* 0-3 * * *" (UTC), Automerge - "* 0-3 * * *" (UTC). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/7293 Reviewed-by: Earl Warren <[email protected]> Co-authored-by: Renovate Bot <[email protected]> Co-committed-by: Renovate Bot <[email protected]>

log: add "filename:line" prefix by ourself

961210b

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.

coderabbitai bot reviewed May 19, 2024

View reviewed changes

connection.go Outdated Show resolved Hide resolved

connection.go Outdated Show resolved Hide resolved

fixup

80e2d8f

coderabbitai bot reviewed May 19, 2024

View reviewed changes

methane mentioned this pull request Jun 3, 2024

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

Closed

5 tasks

methane requested a review from shogo82148 June 3, 2024 11:46

shogo82148 approved these changes Jun 4, 2024

View reviewed changes

methane merged commit 2f7015e into go-sql-driver:master Jun 4, 2024
32 checks passed

methane deleted the log-add-prefix branch June 4, 2024 10:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

methane commented May 19, 2024 •

edited

Loading

coderabbitai bot commented May 19, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

coderabbitai bot left a comment

coveralls commented May 19, 2024

shogo82148 left a comment

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

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

Conversation

methane commented May 19, 2024 • edited Loading

Checklist

coderabbitai bot commented May 19, 2024 • edited Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

coveralls commented May 19, 2024

shogo82148 left a comment

Choose a reason for hiding this comment

methane commented May 19, 2024 •

edited

Loading

coderabbitai bot commented May 19, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)