docs: note FlushPolicy.MaxFlushSizeFlushPolicy has a better option #3230
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
product-auto-label
bot
added
size: xs
BenWhitehead
force-pushed
the
nonblocking-appendable/13/config-cleanup-hasher
branch
from
40b6e0d to
57e2bd6
Compare
BenWhitehead
force-pushed
the
nonblocking-appendable/14/flush-docs-cleanup
branch
from
ae17be2 to
61d2625
Compare
BenWhitehead
force-pushed
the
nonblocking-appendable/13/config-cleanup-hasher
branch
from
57e2bd6 to
2cd6104
Compare
BenWhitehead
force-pushed
the
nonblocking-appendable/14/flush-docs-cleanup
branch
from
61d2625 to
d5722a3
Compare
BenWhitehead
force-pushed
the
nonblocking-appendable/13/config-cleanup-hasher
branch
from
2cd6104 to
3cf5a66
Compare
BenWhitehead
force-pushed
the
nonblocking-appendable/14/flush-docs-cleanup
branch
from
d5722a3 to
c15e110
Compare
BenWhitehead
force-pushed
the
nonblocking-appendable/13/config-cleanup-hasher
branch
from
3cf5a66 to
245dec7
Compare
BenWhitehead
force-pushed
the
nonblocking-appendable/14/flush-docs-cleanup
branch
from
c15e110 to
b229dbe
Compare
BenWhitehead
force-pushed
the
nonblocking-appendable/13/config-cleanup-hasher
branch
from
245dec7 to
dd946d1
Compare
Further testing is needed to determine if MaxFlushSizeFlushPolicy can/should be removed all together.
BenWhitehead
force-pushed
the
nonblocking-appendable/14/flush-docs-cleanup
branch
from
b229dbe to
0257fe0
Compare
BrandonY
approved these changes
Aug 12, 2025
BenWhitehead
added a commit
that referenced
this pull request
Aug 20, 2025
## Description feat: *breaking behavior* rewrite Storage.blobAppendableUpload to be non-blocking and have improved throughput (#3231) Rewrite internals of BlobAppendableUpload to provide non-blocking write calls, and it take advantage of grpc async message handling. When `AppendableUploadWriteableByteChannel#write(ByteBuffer)` is called, an attempt will be made to enqueue the bytes in the outbound queue to GCS. If there is only enough room to partially consume the bytes provided in the `ByteBuffer` the write call will return early specifying the number of bytes actually consumed. As acknowledgements come in from gcs, enqueued messages will be evicted freeing space in the outbound queue. Thereby allowing more bytes to be consumed and enqueued. Given appendable objects are still in private preview I can't quote any metrics here, however preliminary benchmarking of several million objects across a range of sizes show across the board throughput improvments. Because the channel's write call is now non-blocking, if you want to block your application until the full buffer is consumed some new helper methods have been added in StorageChannelUtils to provide blocking behavior. A new method `MinFlushSizeFlushPolicy#withMaxPendingBytes(long)` has been added to allow limiting the number of pending outbound bytes. The default values is 16MiB, but can be configured lower if necessary. ## Release Notes BEGIN_COMMIT_OVERRIDE BEGIN_NESTED_COMMIT feat: *breaking behavior* rewrite Storage.blobAppendableUpload to be non-blocking and have improved throughput (#3231) END_NESTED_COMMIT BEGIN_NESTED_COMMIT feat: add StorageChannelUtils to provide helper methods to perform blocking read/write to/from non-blocking channels (#3231) END_NESTED_COMMIT BEGIN_NESTED_COMMIT feat: add MinFlushSizeFlushPolicy#withMaxPendingBytes(long) (#3231) END_NESTED_COMMIT BEGIN_NESTED_COMMIT fix: update BlobAppendableUploadConfig and FlushPolicy.MinFlushSizeFlushPolicy to default to 4MiB minFlushSize and 16MiB maxPendingBytes (#3249) END_NESTED_COMMIT BEGIN_NESTED_COMMIT fix: make FlushPolicy${Min,Max}FlushSizeFlushPolicy constructors private (#3217) END_NESTED_COMMIT END_COMMIMT_OVERRIDE ## Sub PRs This PR is made of up the following PRs, in sequence 1. #3217 2. #3218 3. #3219 4. #3220 5. #3221 6. #3222 7. #3223 8. #3224 9. #3225 10. #3226 11. #3227 12. #3228 13. #3229 14. #3230 15. #3235 16. #3236 17. #3241 18. #3242 19. #3246 20. #3248 21. #3249 22. #3252
|
Merged in #3231 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Further testing is needed to determine if MaxFlushSizeFlushPolicy can/should be removed all together.