refactor: expose `DatanodeBuilder::build_object_store_manager()` and `MitoConfig::sanitize()`

zyy17 commented 1 week ago

I hereby agree to the terms of the GreptimeDB CLA.

Refer to a related PR or issue link (optional)

What's changed and what's your intention?

Some minor refactoring:

Expose DatanodeBuilder::build_object_store_manager()

The scenario is the following code:

...
let object_storage_manager =
        datanode::datanode::DatanodeBuilder::build_object_store_manager(&storage_config)
            .await
            .context(BuildObjectStoreManagerSnafu)?;
...
let compaction_region = open_compaction_region(
                &open_region_request,
                &self.mito_config,
                object_storage_manager.clone(),
            )
...

Expose MitoConfig::sanitize() to initialize Mito config outside the crate;

~~2. Set default value for intermediate_path instead of empty value(it will failed to create a access layer if using open_compaction_region() with default Mito config) (cc @zhongzc);~~

Checklist

[ ] I have written the necessary rustdoc comments.
[ ] I have added the necessary unit tests and integration tests.
[ ] This PR requires documentation updates.

Summary by CodeRabbit

New Features
- Set a default data home directory for file storage, enhancing ease of configuration.
- Updated intermediate path configurations to use the default data home directory across various components.
Documentation
- Revised configuration documentation to reflect changes in default paths.
Configuration
- Updated example configuration files to include the new default paths for intermediate storage.

coderabbitai[bot] commented 1 week ago

[!WARNING]

Rate limit exceeded

@zyy17 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 45 minutes and 4 seconds before requesting another review.

How to resolve this issue?
After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?
CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.

Commits
Files that changed from the base of the PR and between 2256eb16f49eadebf45ab7cb84883a13ebc6b1e2 and ff46a5a14748a3908267c3d71ec2af048f9cdaf9.

Walkthrough

The recent updates introduce a new constant, DEFAULT_DATA_HOME, set to "/tmp/greptimedb", standardizing the default storage path across multiple configuration files and modules. Key configurations and default paths within DataNode options, InvertedIndexConfig, and various example configuration files have been modified to use this constant, promoting consistency and centralized configuration management.

Changes

Files/Paths	Change Summaries
`src/common/config/src/lib.rs`	Introduced and exported new constant `DEFAULT_DATA_HOME` as `"/tmp/greptimedb"`.
`src/datanode/src/config.rs`	Updated `StorageConfig` to use `common_config::DEFAULT_DATA_HOME` and modified functions to align with this update.
`src/.../datanode.rs`	Adjusted imports to include `StorageConfig`.
`src/mito2/src/config.rs`	Changed `intermediate_path` in `InvertedIndexConfig`'s default implementation to use `join_dir(common_config::DEFAULT_DATA_HOME, "index_intermediate")`.
`config/config.md`	Updated `region_engine.mito.inverted_index.intermediate_path` to `/tmp/greptimedb/index_intermediate/`.
`config/datanode.example.toml`	Adjusted `intermediate_path` setting to `/tmp/greptimedb/index_intermediate/`.
`config/standalone.example.toml`	Modified `intermediate_path` setting to `/tmp/greptimedb/index_intermediate/`.
`tests-integration/tests/http.rs`	Updated `intermediate_path` configuration to `/tmp/greptimedb/index_intermediate/`.

Oh coding paths, now aligned, In /tmp/greptimedb they bind, With constants in place, Storage paths embrace, Order in configs defined.

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

codecov[bot] commented 1 week ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 84.58%. Comparing base (ef935a1) to head (ff46a5a).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #4212 +/- ## ========================================== - Coverage 84.86% 84.58% -0.29% ========================================== Files 1045 1045 Lines 184251 184250 -1 ========================================== - Hits 156373 155850 -523 - Misses 27878 28400 +522 ```

zyy17 commented 4 days ago

@evenyag @zhongzc PTAL

GreptimeTeam / greptimedb