9395: Explain CollectionBatchSize and CollectionBuffers in -help message.
authorTom Clegg <tom@curoverse.com>
Wed, 15 Jun 2016 14:53:01 +0000 (10:53 -0400)
committerTom Clegg <tom@curoverse.com>
Wed, 15 Jun 2016 14:53:01 +0000 (10:53 -0400)
services/keep-balance/usage.go

index 2273f3a57fef08ec716320bcce660470e24ecb3a..b521c652cc6766f901c05513ade1197f527fca6d 100644 (file)
@@ -73,6 +73,19 @@ Committing:
     Use the -commit-pull and -commit-trash flags to implement the
     computed changes.
 
+Tuning resource usage:
+
+    CollectionBatchSize limits the number of collections retrieved per
+    API transaction. If this is zero or omitted, page size is
+    determined by the API server's own page size limits (see
+    max_items_per_response and max_index_database_read configs).
+
+    CollectionBuffers sets the size of an internal queue of
+    collections. Higher values use more memory, and improve throughput
+    by allowing keep-balance to fetch the next page of collections
+    while the current page is still being processed. If this is zero
+    or omitted, pages are processed serially.
+
 Limitations:
 
     keep-balance does not attempt to discover whether committed pull