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

[ISSUE #2317]🤡Remove broker crate dependeces of log crate🧑‍💻 #2318

Merged
merged 1 commit into from
Jan 18, 2025

Conversation

mxsm
Copy link
Owner

@mxsm mxsm commented Jan 18, 2025

Which Issue(s) This PR Fixes(Closes)

Fixes #2317

Brief Description

How Did You Test This Change?

Summary by CodeRabbit

  • Refactor
    • Migrated logging framework from log crate to tracing crate across multiple files in the RocketMQ broker
    • Removed log crate dependency from project configuration

Copy link
Contributor

coderabbitai bot commented Jan 18, 2025

Walkthrough

This pull request focuses on transitioning the logging mechanism in the RocketMQ broker crate from the log crate to the tracing crate. The changes involve removing the log dependency from Cargo.toml and updating import statements and logging macros in multiple source files to use tracing instead. The modifications are primarily centered on replacing logging calls while maintaining the existing logging behavior and code structure.

Changes

File Change Summary
rocketmq-broker/Cargo.toml Removed log = "0.4.25" dependency
rocketmq-broker/src/broker_bootstrap.rs Replaced log::info import with tracing::info
rocketmq-broker/src/failover/escape_bridge.rs Replaced log::warn! macros with tracing::warn! macros

Assessment against linked issues

Objective Addressed Explanation
Remove broker crate dependencies on log crate [#2317]

Possibly related PRs

Suggested labels

refactor♻️, enhancement⚡️, auto merge, ready to review, waiting-review, AI review first, rocketmq-broker crate

Suggested reviewers

  • TeslaRustor
  • SpaceXCN
  • rocketmq-rust-bot

Poem

🚀 Logging's dance, a framework's shift
From log to tracing, code's gentle drift
Macros transformed, dependencies shed
A rabbit's refactor, smoothly led! 🐰✨


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between da8ed2b and ff2267e.

⛔ Files ignored due to path filters (1)
  • Cargo.lock is excluded by !**/*.lock
📒 Files selected for processing (3)
  • rocketmq-broker/Cargo.toml (0 hunks)
  • rocketmq-broker/src/broker_bootstrap.rs (1 hunks)
  • rocketmq-broker/src/failover/escape_bridge.rs (2 hunks)
💤 Files with no reviewable changes (1)
  • rocketmq-broker/Cargo.toml
⏰ Context from checks skipped due to timeout of 90000ms (9)
  • GitHub Check: build (windows-latest, nightly)
  • GitHub Check: build (windows-latest, stable)
  • GitHub Check: build (macos-latest, nightly)
  • GitHub Check: build (macos-latest, stable)
  • GitHub Check: test
  • GitHub Check: build (ubuntu-latest, nightly)
  • GitHub Check: build
  • GitHub Check: auto-approve
  • GitHub Check: build (ubuntu-latest, stable)
🔇 Additional comments (4)
rocketmq-broker/src/broker_bootstrap.rs (1)

23-23: LGTM! Successful transition to tracing crate.

The import change from log::info to tracing::info is correctly implemented, maintaining consistent logging functionality while transitioning to the structured logging framework.

rocketmq-broker/src/failover/escape_bridge.rs (3)

504-507: LGTM! Logging statement correctly uses tracing.

The warning log for null message result is properly transitioned to use the tracing crate's warn! macro while maintaining the original logging format and content.


Line range hint 517-524: LGTM! Logging statement correctly uses tracing.

The warning log for message retrieval failure is properly transitioned to use the tracing crate's warn! macro while maintaining the original logging format and content.


Line range hint 1-1: Verify complete removal of log crate dependencies.

Let's ensure there are no remaining references to the log crate in the codebase.


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>, please review it.
    • 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 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 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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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. (Beta)
  • @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.

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.

@rocketmq-rust-bot
Copy link
Collaborator

🔊@mxsm 🚀Thanks for your contribution🎉!

💡CodeRabbit(AI) will review your code first🔥!

Note

🚨The code review suggestions from CodeRabbit are to be used as a reference only, and the PR submitter can decide whether to make changes based on their own judgment. Ultimately, the project management personnel will conduct the final code review💥.

Copy link

codecov bot commented Jan 18, 2025

Codecov Report

Attention: Patch coverage is 0% with 2 lines in your changes missing coverage. Please review.

Project coverage is 28.28%. Comparing base (da8ed2b) to head (ff2267e).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
rocketmq-broker/src/failover/escape_bridge.rs 0.00% 2 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2318   +/-   ##
=======================================
  Coverage   28.28%   28.28%           
=======================================
  Files         504      504           
  Lines       72422    72422           
=======================================
  Hits        20485    20485           
  Misses      51937    51937           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@rocketmq-rust-bot rocketmq-rust-bot left a comment

Choose a reason for hiding this comment

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

LGTM

@rocketmq-rust-bot rocketmq-rust-bot merged commit a117a4d into main Jan 18, 2025
24 of 25 checks passed
@rocketmq-rust-bot rocketmq-rust-bot added approved PR has approved and removed ready to review waiting-review waiting review this PR labels Jan 18, 2025
@mxsm mxsm deleted the op-2317 branch January 18, 2025 10:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
AI review first Ai review pr first approved PR has approved auto merge enhancement⚡️ New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Enhancement⚡️] Remove broker crate dependeces of log crate
3 participants