9463: Polishing the last details to make the integration tests work ok

[arvados.git] / services / keep-balance / usage.go

diff --git a/services/keep-balance/usage.go b/services/keep-balance/usage.go
index c5363641cab6453289bfafc1553241fb8d8e3eca..b521c652cc6766f901c05513ade1197f527fca6d 100644 (file)
--- a/services/keep-balance/usage.go
+++ b/services/keep-balance/usage.go
@@ -17,7 +17,8 @@ var exampleConfigFile = []byte(`
            "disk"
        ],
        "RunPeriod": "600s",
-       "CollectionBatchSize": 100000
+       "CollectionBatchSize": 100000,
+       "CollectionBuffers": 1000
     }`)
 
 func usage() {
@@ -72,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