Introduce CLI option for input buffer size (digital-asset#6211)

* Introduce CLI option for input buffer size Also improves CLI help text for other back-pressure related options. changelog_begin [Sandbox] Allow to configure --input-buffer-size, which allows to tune the number of commands waiting to be submitted before the Sandbox applies back-pressure, run daml sandbox --help for more info. changelog_end * Update ledger/sandbox/src/main/scala/com/digitalasset/platform/sandbox/cli/Cli.scala Co-authored-by: Samir Talwar <samir.talwar@digitalasset.com> Co-authored-by: Samir Talwar <samir.talwar@digitalasset.com>
kgeonw · Jun 4, 2020 · 003549e · 003549e
1 parent b993339
commit 003549e
Showing 1 changed file with 8 additions and 3 deletions.
diff --git a/ledger/sandbox/src/main/scala/com/digitalasset/platform/sandbox/cli/Cli.scala b/ledger/sandbox/src/main/scala/com/digitalasset/platform/sandbox/cli/Cli.scala
@@ -266,14 +266,19 @@ object Cli {
         .optional()
         .action((value, config) =>
           config.copy(commandConfig = config.commandConfig.copy(maxCommandsInFlight = value)))
-        .text("The maximum number of unconfirmed commands in flight in CommandService.")
+        .text("Maximum number of submitted commands waiting for completion for each party (only applied when using the CommandService). Overflowing this threshold will cause back-pressure, signaled by a RESOURCE_EXHAUSTED error code. Default is 256.")
 
       opt[Int]("max-parallel-submissions")
         .optional()
         .action((value, config) =>
           config.copy(commandConfig = config.commandConfig.copy(maxParallelSubmissions = value)))
-        .text(
-          "The maximum number of parallel command submissions. Only applicable to sandbox-classic.")
+        .text("Maximum number of successfully interpreted commands waiting to be sequenced (applied only when running sandbox-classic). The threshold is shared across all parties. Overflowing it will cause back-pressure, signaled by a RESOURCE_EXHAUSTED error code. Default is 512.")
+
+      opt[Int]("input-buffer-size")
+        .optional()
+        .action((value, config) =>
+          config.copy(commandConfig = config.commandConfig.copy(inputBufferSize = value)))
+        .text("The maximum number of commands waiting to be submitted for each party. Overflowing this threshold will cause back-pressure, signaled by a RESOURCE_EXHAUSTED error code. Default is 512.")
 
       opt[Long]("max-lf-value-translation-cache-entries")
         .optional()