feat: Migrate Monitor Middleware

[redish101]

Description

Migrate monitor middleware from fiber v2 to v3.

Summary by CodeRabbit

• New Features

  • Introduced a comprehensive monitoring middleware for the Fiber web framework, enabling real-time tracking of system metrics.
  • Added customizable options for the monitoring interface, including title, refresh interval, and custom HTML.
  • Implemented a web-based dashboard displaying CPU usage, memory usage, and response times with dynamic updates.

• Documentation

  • Updated README to include implementation details and configuration options for the new monitoring middleware.

[coderabbitai[bot]]

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The changes introduce a new monitor middleware for the Fiber web framework, which includes comprehensive documentation in monitor/README.md. It features a configuration structure in monitor/config.go, allowing customization of settings such as title and refresh interval. The middleware is implemented in monitor/monitor.go, which collects system metrics and serves them as JSON or HTML based on the request type. Additional files include monitor/assertions.go for testing utilities and monitor/config_test.go and monitor/monitor_test.go for unit tests, ensuring robust functionality and reliability.

Changes

Files	Change Summary
monitor/README.md	Added documentation for the monitor middleware, including installation and configuration details.
monitor/config.go	Introduced Config struct for middleware configuration, including default values and customization options.
monitor/assertions.go	Added AssertEqual function for testing value equality with detailed error reporting.
monitor/config_test.go	Implemented unit tests for configuration management, covering default values and customization scenarios.
monitor/monitor.go	Created middleware for collecting and serving system metrics, including stats structures and JSON responses.
monitor/monitor_test.go	Introduced tests for monitoring functionality, validating responses and performance under various conditions.
README.md	Added a new entry for the Monitor middleware in the documentation, including a link to its README file.

Poem

In the meadow, I hop and play,
With metrics bright, we track the day.
The Fiber's strong, the stats are clear,
A dashboard shines, bringing us cheer!
So let’s monitor, with joy we sing,
For every byte and every spring! 🐇📊

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 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 or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

[redish101]

Few comments. You are also missing the workflow files. See .github/workflows.

Thank you for the reminder. By the way, should I add test cases for these changes? If so, please understand that I have been quite busy lately, so it might take me a few days to complete the test cases.

[gaby]

Few comments. You are also missing the workflow files. See .github/workflows.

Thank you for the reminder. By the way, should I add test cases for these changes? If so, please understand that I have been quite busy lately, so it might take me a few days to complete the test cases.

@Redish101 Use the same unit-tests it had before

You can find them here: https://github.com/gofiber/fiber/tree/v2/middleware/monitor

config_test.go and monitor_test.go

You also have to add the test-monitor.yml in the workflows directory

[redish101]

Few comments. You are also missing the workflow files. See .github/workflows.

Thank you for the reminder. By the way, should I add test cases for these changes? If so, please understand that I have been quite busy lately, so it might take me a few days to complete the test cases.

@Redish101 Use the same unit-tests it had before

You can find them here: https://github.com/gofiber/fiber/tree/v2/middleware/monitor

config_test.go and monitor_test.go

You also have to add the test-monitor.yml in the workflows directory

Well, I will add test cases these days.

[redish101]

Few comments. You are also missing the workflow files. See .github/workflows.

Thank you for the reminder. By the way, should I add test cases for these changes? If so, please understand that I have been quite busy lately, so it might take me a few days to complete the test cases.

@Redish101 Use the same unit-tests it had before

You can find them here: https://github.com/gofiber/fiber/tree/v2/middleware/monitor

config_test.go and monitor_test.go

You also have to add the test-monitor.yml in the workflows directory

@gaby I have migrated the test cases from v2 and completed the CI integration. However, some of the test util functions provided by v2 are used here. I feel that these parts might be reused in this repository in the future. Should these util functions be refactored for reuse?

[gaby]

@Redish101 Target branch should be main. Let me see if it lets me change it

[gaby]

Tests are failing because both Fiber and Fasthttp only support the latest 2 versions of Golang.

[gaby]

@gofiber/maintainers this is ready for review