Refactor: Add observability enable flag, improve comments, remove unused config params, and enhance run function error logging. #689
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…servability enable flag, and enhance error logging in run function execution.
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the codebase to improve observability, configuration management, and code maintainability by removing unused parameters, enhancing comments, and improving error handling.
Key changes:
- Added observability enable flag and global meter functions in
crates/obs/src/global.rs - Removed unused configuration parameters (
external_address,console_rate_limit_enable,console_rate_limit_rpm,console_auth_timeout) - Enhanced error logging in the
runfunction and re-enabled DNS resolver initialization - Improved documentation with detailed function comments across multiple modules
Reviewed Changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/run.sh | Removed unused RUSTFS_EXTERNAL_ADDRESS environment variable |
| rustfs/src/server/http.rs | Refactored protocol detection logic and updated logging targets |
| rustfs/src/main.rs | Enhanced error handling for observability guard and run function; re-enabled DNS resolver |
| rustfs/src/config/mod.rs | Removed unused config parameters (external_address, console rate limiting, auth timeout) |
| rustfs/src/config/config_test.rs | Removed tests for deleted external_address configuration |
| rustfs/src/admin/console_test.rs | Removed tests for deleted external_address and updated test assertions |
| rustfs/src/admin/console.rs | Added documentation for static_handler, simplified function paths, increased body limit, updated 404 message |
| crates/utils/src/net.rs | Re-enabled custom DNS resolver usage in get_host_ip function |
| crates/obs/src/telemetry.rs | Set observability flags in init_telemetry function |
| crates/obs/src/global.rs | Added observability enable flag, meter name, and utility functions |
| crates/ecstore/src/global.rs | Renamed function, added comprehensive documentation, removed external port references |
| crates/config/src/constants/app.rs | Removed unused constants for sink file log and external address |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Type of Change
Related Issues
Summary of Changes
This PR enhances the observability module and improves code quality:
crates/obs/src/global.rsandcrates/obs/src/telemetry.rsfor better clarity and detail.config.rswithin theoptstruct to simplify the configuration structure.IS_OBSERVABILITY_ENABLEDincrates/obs/src/global.rsto check if observability is enabled, set ininit_telemetry.runfunction ofrustfs/src/main.rsto provide more detailed error information for debugging.These changes increase code maintainability and the reliability of the observability system.
Checklist
make pre-commitImpact
Additional Notes
Thank you for your contribution! Please ensure your PR follows the community standards (CODE_OF_CONDUCT.md) and sign the CLA if this is your first contribution.