add wrapper method to call mc.cfg.Logger #1563
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
WalkthroughThe recent modifications involve consolidating logging operations across several files ( Changes
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files selected for processing (4)
- auth.go (1 hunks)
- connection.go (9 hunks)
- packets.go (12 hunks)
- statement.go (2 hunks)
Additional comments: 25
statement.go (2)
- 54-54: The change to use
stmt.mc.log(ErrInvalidConn)centralizes logging, which is a good practice. Ensure that thelogmethod inmysqlConnis implemented to handle various log message types effectively.- 98-98: Similar to the change in the
Execmethod, usingstmt.mc.log(ErrInvalidConn)here centralizes logging. Ensure thelogmethod inmysqlConnhandles different types of log messages effectively.auth.go (1)
- 341-341: Changing to use
mc.log("unknown auth plugin:", plugin)centralizes logging, which is beneficial. Ensure thelogmethod inmysqlConncan handle string concatenation and variable logging effectively.connection.go (10)
- 48-51: The introduction of the
logmethod inmysqlConncentralizes logging, which is a good practice. Ensure thatmc.cfg.Loggeris always properly initialized and supports the- 118-118: Using
mc.log(ErrInvalidConn)centralizes logging, enhancing maintainability. Ensure that log messages retain necessary context for clarity.- 160-160: Centralizing logging with
mc.log(err)is beneficial. Verify that error contexts are preserved in log messages for effective debugging.- 177-177: The use of
mc.log(ErrInvalidConn)for logging is consistent with the centralization effort. Ensure log messages are clear and provide sufficient context.- 184-184: Logging errors with
mc.log(err)helps centralize logging. Check that the log method effectively handles different types of errors.- 218-218: Centralizing logging to
mc.log(err)is a good practice. Ensure that the log messages are informative and maintain context.- 310-310: Using
mc.log(ErrInvalidConn)for logging centralizes the logging mechanism. Confirm that all necessary context is included in log messages.- 370-370: The change to use
mc.log(ErrInvalidConn)for logging is consistent with centralizing logging. Ensure that log messages are clear and contextual.- 465-465: Centralizing logging with
mc.log(ErrInvalidConn)is beneficial. Verify that the log method handles context and clarity in log messages effectively.- 674-674: Using
mc.log("closing bad idle connection: ", err)centralizes logging. Ensure that the log method can handle concatenation of strings and variables effectively.packets.go (12)
- 37-37: The introduction of the
logmethod in themysqlConnstruct for logging errors is a positive change, enhancing the maintainability and consistency of logging throughout the codebase.- 60-60: Using the
logmethod for logging malformed packet errors before closing the connection is consistent with the PR's objective to centralize logging. This change improves code readability and maintainability.- 74-74: The use of the
logmethod for error logging here follows the PR's goal of centralizing logging. This approach simplifies the process of modifying logging behavior in the future.- 137-137: Logging the malformed packet error using the new
logmethod before cleanup is in line with the PR's objectives. It ensures that logging is handled in a consistent manner across the codebase.- 147-147: Applying the
logmethod for error logging in this context is appropriate and aligns with the PR's aim to centralize and standardize logging practices within the project.- 305-305: The use of the
logmethod for logging errors when unable to take a buffer is consistent with the PR's goal. It centralizes logging, making it easier to manage and modify logging behavior.- 395-395: Employing the
logmethod for error logging in this scenario adheres to the PR's objective of centralizing logging. This change enhances the code's maintainability.- 415-415: Utilizing the
logmethod for logging errors when a buffer cannot be taken aligns with the PR's aim to centralize logging. This contributes to a more maintainable and consistent codebase.- 434-434: The application of the
logmethod for error logging here is in line with the PR's objectives. It centralizes logging, facilitating easier future modifications to logging behavior.- 455-455: Using the
logmethod for error logging in this context supports the PR's goal of centralizing logging. This approach simplifies logging management across the codebase.- 997-997: The use of the
logmethod for logging errors when a buffer cannot be taken is consistent with the PR's objectives. It centralizes logging, enhancing code maintainability.- 1196-1196: Employing the
logmethod for error logging in this scenario adheres to the PR's aim of centralizing logging. This change contributes to a more maintainable codebase.
methane
added a commit
to methane/mysql
that referenced
this pull request
Mar 16, 2024
(cherry picked from commit 1a64773)
5 tasks
methane
added a commit
to methane/mysql
that referenced
this pull request
May 19, 2024
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.
5 tasks
methane
added a commit
that referenced
this pull request
Jun 4, 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.
methane
added a commit
to methane/mysql
that referenced
this pull request
Jun 4, 2024
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)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This is just a code cleanup. I will backport this to 1.8 too.
Checklist
Summary by CodeRabbit