Update documentation in configuration.md file #1606
Conversation
Summary of ChangesHello @shrutisinghania, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on enhancing the clarity and accuracy of the Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
|
/gcbrun |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request significantly improves the configuration documentation by clarifying the effectiveness of various settings for HTTP_API_CLIENT, STORAGE_CLIENT, and Bidi mode. The changes are clear and valuable. I've provided a few suggestions to further enhance readability, consistency, and completeness in some of the descriptions. Overall, this is a great update.
|
|
||
| Whether to perform copy operation using Rewrite requests which allows copy | ||
| files between different locations and storage classes. | ||
| files between different locations and storage classes. Is effective only if `fs.gs.client.type` is set to `HTTP_API_CLIENT`. For `STORAGE_CLIENT` (gRPC), rewrite is always enabled. |
There was a problem hiding this comment.
For better readability, consider rephrasing this sentence. Starting with 'This setting is...' can make the purpose clearer. I've noticed this pattern in a few other places in this file (lines 305, 323, 347, 370, 374). It would be great to apply this change consistently for a more natural flow.
| files between different locations and storage classes. Is effective only if `fs.gs.client.type` is set to `HTTP_API_CLIENT`. For `STORAGE_CLIENT` (gRPC), rewrite is always enabled. | |
| files between different locations and storage classes. This setting is effective only if `fs.gs.client.type` is set to `HTTP_API_CLIENT`. For `STORAGE_CLIENT` (gRPC), rewrite is always enabled. |
|
|
||
| Maximum size of object chunk that will be rewritten in a single rewrite | ||
| request when `fs.gs.copy.with.rewrite.enable` is set to `true`. | ||
| request. For `HTTP_API_CLIENT`, this is effective only when `fs.gs.copy.with.rewrite.enable` is `true`. For `STORAGE_CLIENT` (gRPC), rewrite is always enabled, so this configuration is always effective. |
There was a problem hiding this comment.
To improve clarity and reduce redundancy, you could rephrase this sentence. The phrase 'so this configuration is always effective' is redundant given the preceding context.
| request. For `HTTP_API_CLIENT`, this is effective only when `fs.gs.copy.with.rewrite.enable` is `true`. For `STORAGE_CLIENT` (gRPC), rewrite is always enabled, so this configuration is always effective. | |
| request. For `HTTP_API_CLIENT`, this is effective only when `fs.gs.copy.with.rewrite.enable` is `true`. For `STORAGE_CLIENT` (gRPC), this configuration is always effective as rewrite is always enabled. |
|
|
||
| These threads are used to execute the Class A, Class B and Free Cloud Storage | ||
| operations as copy, list, delete, etc. These operations are part of typical | ||
| `hdfs` CLI commands such as `hdfs mv`, `hdfs cp`, etc. Depending on the number of requests the connector evenly distributes the number of requests across batch threads. |
There was a problem hiding this comment.
The sentence 'Depending on the number of requests the connector evenly distributes the number of requests across batch threads.' seems to be specific to the HTTP_API_CLIENT's batching behavior. For STORAGE_CLIENT, this property just controls the thread pool size for parallel operations. To improve clarity, consider moving this sentence to be part of the HTTP_API_CLIENT description on lines 122-123.
| [`MediaHttUploader` class](https://cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.media.MediaHttpUploader). | ||
| This is used only for JSON API and for best performance should be a multiple | ||
| of 8 MiB. | ||
| Not supported by `STORAGE_CLIENT` (gRPC) when `fs.gs.bidi.enable` is `true` and for best performance should be a multiple of 8 MiB. |
There was a problem hiding this comment.
The updated description is more accurate but could be more comprehensive. It clarifies when the setting is not supported but doesn't explain when it is supported for STORAGE_CLIENT. Consider clarifying that this setting is used for HTTP_API_CLIENT and for STORAGE_CLIENT when using CHUNK_UPLOAD, but not with Bidi enabled.
| Not supported by `STORAGE_CLIENT` (gRPC) when `fs.gs.bidi.enable` is `true` and for best performance should be a multiple of 8 MiB. | |
| This setting is used for `HTTP_API_CLIENT` resumable uploads and for `STORAGE_CLIENT` (gRPC) with `CHUNK_UPLOAD`. It is not supported by `STORAGE_CLIENT` when `fs.gs.bidi.enable` is `true`. For best performance, this should be a multiple of 8 MiB. |
| It controls the parallel processing of range request. These threads will be | ||
| shared across all readVectored invocation. If the task queue of range request | ||
| is overloaded do consider increasing this value. | ||
| Supported by `HTTP_API_CLIENT`, `STORAGE_CLIENT` (gRPC) only when `fs.gs.bidi.enable` is `false`. If `fs.gs.bidi.enable` is `true`, `fs.gs.bidi.thread.count` is used instead. |
There was a problem hiding this comment.
The comma after HTTP_API_CLIENT could create ambiguity. To improve clarity, consider rephrasing to make it clear that the condition only when fs.gs.bidi.enable is false applies to STORAGE_CLIENT.
| Supported by `HTTP_API_CLIENT`, `STORAGE_CLIENT` (gRPC) only when `fs.gs.bidi.enable` is `false`. If `fs.gs.bidi.enable` is `true`, `fs.gs.bidi.thread.count` is used instead. | |
| Supported by `HTTP_API_CLIENT` and by `STORAGE_CLIENT` (gRPC) only when `fs.gs.bidi.enable` is `false`. If `fs.gs.bidi.enable` is `true`, `fs.gs.bidi.thread.count` is used instead. |
|
/gcbrun |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1606 +/- ##
============================================
- Coverage 81.90% 81.88% -0.02%
+ Complexity 2425 2424 -1
============================================
Files 128 128
Lines 10819 10819
Branches 1302 1302
============================================
- Hits 8861 8859 -2
- Misses 1415 1417 +2
Partials 543 543
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
2 participants
Update configuration effectiveness for HTTP_API_CLIENT, STORAGE_CLIENT and BIDI mode.