search

junhaoliao / iCtrl

A Simple VNC + SSH Shell + SFTP Client
https://ictrl.ca
Other
169 stars 14 forks source link

Feature/log rotation handler #41

Closed Nuovaxu closed 2 weeks ago

Nuovaxu commented 2 weeks ago

This PR implements log rotation with enhanced stream management and backup handling for log files. When a log file reaches a specified size, the current stream is safely finalized, and a new log file is created seamlessly.

Summary by CodeRabbit

coderabbitai[bot] commented 2 weeks ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The changes in this pull request include the addition of a new submodule, "clp-loglib-py", to the .gitmodules file, enhancing the project's dependency management. Additionally, extensive logging functionality has been integrated across multiple files, including the DBProfile, LocalProfile, and various feature modules, improving error handling and operational traceability. The logging enhancements include the introduction of a custom RotatingCLPFileHandler for managing log files with rotation and compression capabilities. Other modifications involve updates to response handling in several route files to utilize Flask's jsonify for better JSON response formatting.

Changes

File Path Change Summary
.gitmodules Added submodule clp-loglib-py with path and URL.
application/Profile/DBProfile.py Enhanced logging and error handling; added a logger; updated methods to include logging statements.
application/Profile/LocalProfile.py Introduced logging for error handling and operational feedback.
application/__init__.py Enhanced logging setup; added error handling for Flask app initialization; updated profile loading logic.
application/features/Audio.py Added logging in Audio and AudioWebSocket classes for connection handling.
application/features/Connection.py Introduced logging for connection operations in ForwardServerHandler and Connection classes.
application/features/SFTP.py Added logging for various SFTP operations.
application/features/Term.py Enhanced logging in Term and TermWebSocket classes for connection and message handling.
application/features/VNC.py Added logging for operations in VNC class and websocket proxy thread.
application/features/mywebsockify.py Introduced logging for SSL certificate generation and authentication processes.
application/features/vncpasswd.py Added logging for password handling operations.
application/logger.py Introduced RotatingCLPFileHandler for file size-based log rotation.
application/paths.py Enhanced logging for directory creation and error handling for unsupported OS.
application/routes/audio.py Updated start_audio to use jsonify instead of json.dumps.
application/routes/common.py Updated handle_session to use jsonify; improved error handling in create_connection.
application/routes/sftp.py Updated sftp_ls to use jsonify for response formatting.
application/routes/term.py Updated start_terminal to use jsonify for response formatting.
application/routes/vnc.py Updated start_vnc to use jsonify for response formatting.
application/utils.py Enhanced logging for various utility functions.
clp-loglib-py New commit reference added for subproject without functional changes.
ictrl_be.py Minor modification to app.run(); removed newline at end of file.
log_config.yaml Updated logging configuration to use file handlers instead of console; added rotation settings.
remotehandler.py Introduced functionality for S3 file uploads, including multipart uploads and integrity checks.
test.py New file for reading log entries from a compressed file using CLPFileReader.

Poem

🐇 In the land of code where rabbits hop,
New logs are added, we never stop!
With submodules sprouting like spring flowers,
Our code now sings through the coding hours.
So let’s celebrate with a joyful cheer,
For every change brings us closer, my dear! 🌼

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 , 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` 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://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.