FIXUP

evolution-gaming · Nov 29, 2024 · f55d41b · f55d41b
1 parent 1f7671d
commit f55d41b
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/journal/src/main/scala/com/evolutiongaming/kafka/journal/Journal.scala b/journal/src/main/scala/com/evolutiongaming/kafka/journal/Journal.scala
@@ -329,7 +329,9 @@ object Journal {
    * Configuration for the dynamic pool of Kafka consumers used on recovery in case the data is not yet replicated to
    * Cassandra
    *
-   * @param multiplier max pool size = multiplier x number of cores, capped at 1 below
+   * @param multiplier defines max pool size = multiplier x number of cores,
+   *                   if a calculated max pool size is below 1, the size of 1 is used to avoid starting with
+   *                   an unusable consumer pool configuration
    * @param idleTimeout if idle for this time, Kafka consumers are closed
    */
   final case class ConsumerPoolConfig(

diff --git a/persistence/src/main/resources/reference.conf b/persistence/src/main/resources/reference.conf
@@ -57,8 +57,10 @@ evolutiongaming.kafka-journal.persistence {
     # Configuration for the dynamic pool of Kafka consumers used on recovery in case the data is not yet replicated to
     # Cassandra
     consumer-pool {
-      # max pool size = multiplier x number of cores, capped at 1 below
-      # multiplier value could be fractional
+      # Defines max pool size = multiplier x number of cores.
+      # If a calculated max pool size is below 1, the size of 1 is used to avoid starting with an unusable consumer pool
+      # configuration.
+      # Multiplier value could be fractional.
       multiplier = 10
 
       # if idle for this time, Kafka consumers are closed