search

galacean / effects-runtime

It can load and render cool animation effects
https://galacean.antgroup.com/effects/
MIT License
324 stars 8 forks source link

feat: 增加性能监测插件 #544

Closed Sruimeng closed 2 months ago

Sruimeng commented 2 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

This commit establishes the @galacean/effects-plugin-stats, creating a comprehensive framework for monitoring and visualizing performance statistics in WebGL applications. It includes key components such as licensing, documentation, demo HTML pages, and TypeScript configurations. Essential classes like Core, EffectsStats, and Monitor are introduced to facilitate real-time performance tracking, enhancing the developer experience and promoting better performance analysis.

Changes

File Path Change Summary
plugin-packages/stats/LICENSE Added MIT License file to clarify usage rights and conditions.
plugin-packages/stats/README.md Introduced README documenting "Galacean Effects Stats" for user guidance.
plugin-packages/stats/demo/*.html Added demo HTML files showcasing plugin functionality with usage examples.
plugin-packages/stats/demo/src/simple.ts Implemented a TypeScript module to initialize and manage a Player instance with scene loading capabilities.
plugin-packages/stats/tsconfig.json Created TypeScript configuration file for the stats package, extending from a base configuration.
plugin-packages/stats/package.json Established metadata and scripts for the @galacean/effects-plugin-stats package, defining dependencies and build commands.
plugin-packages/stats/rollup.config.js Added Rollup configuration for building the package in multiple formats.
plugin-packages/stats/src/*.ts Introduced multiple classes (Core, EffectsStats, DrawCallHook, etc.) for performance tracking and monitoring in WebGL.
plugin-packages/stats/src/index.ts Created an index file to re-export members from effects-stats, simplifying imports.
plugin-packages/stats/src/monitor.ts Implemented a Monitor class for real-time display of WebGL performance metrics.
plugin-packages/stats/src/stats-component.ts Added StatsComponent for integrating monitoring capabilities within the rendering pipeline.
plugin-packages/stats/typedoc.json Configured TypeDoc settings for generating project documentation based on source files.
plugin-packages/stats/vite.config.js Created Vite configuration for development and demo applications, enhancing build and server functionalities.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DemoPage
    participant Monitor
    participant Core

    User->>DemoPage: Open demo
    DemoPage->>Monitor: Initialize
    Monitor->>Core: Set up performance tracking
    Core-->>Monitor: Performance data ready
    Monitor->>DemoPage: Display metrics

🐇 In fields so wide, I hop and play,
With stats and hooks to brighten the day.
Performance tracked, in colors so bright,
Galacean effects, a wondrous sight!
Hooray for the code, let’s dance and cheer,
For metrics and magic are finally here! 🎉

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