gofiber / contrib

🧬 Repository for third party middlewares with dependencies
https://docs.gofiber.io/contrib/
MIT License
226 stars 119 forks source link

feat: add monitor #1171

Closed Redish101 closed 2 months ago

Redish101 commented 2 months ago

Description

Migrate monitor middleware from fiber v2 to v3. See at gofiber/fiber#3125

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The recent changes introduce a structured approach to managing release notes and system monitoring within a GitHub repository. A new YAML configuration file, .github/release-drafter-monitor.yml, has been created to define templates for release notes, including versioning, changelog categories, and contributor exclusions. This configuration facilitates automated tracking and filtering of changes, enhancing clarity in communication. Additionally, a GitHub Actions workflow named "Release Drafter Casbin" has been implemented to automate the drafting of release notes based on changes detected in the 'monitor/**' directory.

Several new Go files have been added to implement a middleware for monitoring system metrics using the Fiber web framework. This includes a configuration structure, a web-based interface for displaying metrics, and middleware for collecting and responding with system statistics. Each component is designed to work together, ensuring that the monitoring system is robust and user-friendly.

Changes

Files Change Summary
.github/release-drafter-monitor.yml Introduced YAML configuration for release notes management, including templates and categories.
.github/workflows/release-drafter-monitor.yml Added GitHub Actions workflow to automate release note drafting based on changes in the monitor directory.
monitor/README.md Created comprehensive documentation for the monitor component, including installation and usage details.
monitor/config.go Defined configuration structure for middleware with default settings and validation.
monitor/index.go Implemented web interface for monitoring metrics, including dynamic HTML and JavaScript updates.
monitor/monitor.go Developed middleware for monitoring system statistics, including CPU and RAM usage.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Middleware
    participant Metrics
    participant Config

    User->>Middleware: Request Metrics
    Middleware->>Config: Retrieve Configuration
    Config-->>Middleware: Return Config
    Middleware->>Metrics: Update Statistics
    Metrics-->>Middleware: Return Metrics Data
    Middleware-->>User: Respond with Metrics

🐇 In the meadow, changes bloom,
A drafter’s song dispels the gloom.
With metrics bright and notes so clear,
We hop along, spreading cheer!
Let’s celebrate this joyful day,
For every change, we leap and play! 🌼✨


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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
Redish101 commented 2 months ago

@gaby Sorry, these changes should be committed to the v3-beta branch. Please refer to PR #1172