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: monitor middleware reporting of CPU usage #2984

Merged
merged 2 commits into from
Jun 24, 2024
Merged

Conversation

nyufeng
Copy link

@nyufeng nyufeng commented Apr 24, 2024

Description

The monitPIDCPU should be consistent with the monitOSCPU and should be changed instantaneously rather than using the cumulative value since program startup

The value should be calculated based on the actual number of CPU cores, rather than a fixed value of 10.

Fixes #2978

Type of change

Please delete options that are not relevant.

  • Enhancement (improvement to existing features and functionality)

Checklist

Before you submit your pull request, please make sure you meet these requirements:

  • Followed the inspiration of the Express.js framework for new functionalities, making them similar in usage.
  • Conducted a self-review of the code and provided comments for complex or critical parts.
  • Updated the documentation in the /docs/ directory for Fiber's documentation.
  • Added or updated unit tests to validate the effectiveness of the changes or new features.
  • Ensured that new and existing unit tests pass locally with the changes.
  • Verified that any new dependencies are essential and have been agreed upon by the maintainers/community.
  • Aimed for optimal performance with minimal allocations in the new code.
  • Provided benchmarks for the new code to analyze and improve upon.

Commit formatting

Please use emojis in commit messages for an easy way to identify the purpose or intention of a commit. Check out the emoji cheatsheet here: CONTRIBUTING.md

Copy link

welcome bot commented Apr 24, 2024

Thanks for opening this pull request! 🎉 Please check out our contributing guidelines. If you need help or want to chat with us, join us on Discord https://gofiber.io/discord

Copy link
Contributor

coderabbitai bot commented Apr 24, 2024

Walkthrough

The monitor.go file in the middleware/monitor package was updated to improve CPU usage dynamics by modifying the updateStatistics function. A new parameter numcpu was added to better calculate CPU statistics considering the number of system CPUs.

Changes

File Change Summary
middleware/monitor/monitor.go Updated updateStatistics function to include numcpu parameter.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Monitor
    participant Process
    participant System

    User->>Monitor: Initialize monitor.New()
    Monitor->>Process: Retrieve process data
    Process->>Monitor: Provide process data
    Monitor->>System: Retrieve number of CPUs
    System-->>Monitor: Provide numcpu
    Monitor->>Monitor: Call updateStatistics(p, numcpu)
    Monitor->>User: Display dynamic CPU usage
Loading

Assessment against linked issues

Objective Addressed Explanation
Dynamically changing CPU usage like top for issue #2978

Poem

Our code's refreshed with a brighter view,
CPUs count in the stats so true.
Dynamic as the stars at night,
Monitor shines with newfound might.
🐰🚀


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.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @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.

@ReneWerner87 ReneWerner87 linked an issue Apr 25, 2024 that may be closed by this pull request
3 tasks
@ReneWerner87
Copy link
Member

thanks for the customization
our plan for v3 is to have the monitoring middleware in the contrib repository, because it has external dependencies and is not used as often as it should be in the core

we will then port your customizations over
for v2 we will probably not make a release anymore, unless a very critical bug is found

@gaby gaby changed the title monitPIDCPU should be transient, not persistent. fix: monitor middleware reporting of CPU usage Jun 24, 2024
@gaby
Copy link
Member

gaby commented Jun 24, 2024

@ReneWerner87 This can probably be merged, pending a new release

Copy link
Contributor

@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: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 232c0fa and 20de717.

Files selected for processing (1)
  • middleware/monitor/monitor.go (3 hunks)
Additional comments not posted (2)
middleware/monitor/monitor.go (2)

63-64: Optimization of CPU usage computation by using dynamic CPU count

The introduction of numcpu to calculate CPU usage dynamically is a sound change that aligns with the PR's objective to reflect real-time CPU usage more accurately. This adjustment ensures that the CPU usage is computed relative to the available CPU cores, which is a more accurate representation in multi-core environments.

Also applies to: 70-70


106-108: Refactor to improve clarity and reduce redundancy

The current implementation of the CPU usage calculation could be refactored to improve clarity and reduce redundancy. Specifically, the division by numcpu could be moved to a separate line to make it clear that it's a normalization step.
[REFACTOR_SUGGESTion]

- pidCPU, err := p.Percent(0)
- if err == nil {
-     monitPIDCPU.Store(pidCPU / float64(numcpu))
+ pidCPU, err := p.Percent(0)
+ if err == nil {
+     normalizedCPU := pidCPU / float64(numcpu)
+     monitPIDCPU.Store(normalizedCPU)
}

middleware/monitor/monitor.go Show resolved Hide resolved
@gaby gaby added the v2 label Jun 24, 2024
@ReneWerner87 ReneWerner87 merged commit 4262f5b into gofiber:v2 Jun 24, 2024
20 checks passed
Copy link

welcome bot commented Jun 24, 2024

Congrats on merging your first pull request! 🎉 We here at Fiber are proud of you! If you need help or want to chat with us, join us on Discord https://gofiber.io/discord

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

🐛 [Bug]: Middleware Monitor "CPU Usage" is a "static value".
3 participants