com.digitalasset.canton.platform.apiserver.configuration
RateLimitingConfig
Companion object RateLimitingConfig
final case class RateLimitingConfig(maxApiServicesQueueSize: Int = 10000, maxApiServicesIndexDbQueueSize: Int = 1000, maxUsedHeapSpacePercentage: Int = 100, minFreeHeapSpaceBytes: Long = 0, maxStreams: Int = 1000) extends Product with Serializable
The memory based rate limiting parameters (maxUsedHeapSpacePercentage and minFreeHeapSpaceBytes are highly sensitive to the operating environment and should only be configured where memory profiling has highlighted spikes in memory usage that need to be flattened.
- maxApiServicesQueueSize
The maximum number of non-running items in the ApiServices execution service
- maxApiServicesIndexDbQueueSize
The maximum number of non-running items in the IndexDb execution service
- maxUsedHeapSpacePercentage
If, following a garbage collection of the 'tenured' memory pool, the percentage of used pool memory is above this percentage the system will be rate limited until additional space is freed up.
- minFreeHeapSpaceBytes
If, following a garbage collection of the 'tenured' memory pool, the amount of free space is below this value the system will be rate limited until additional space is freed up.
- Alphabetic
- By Inheritance
- RateLimitingConfig
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new RateLimitingConfig(maxApiServicesQueueSize: Int = 10000, maxApiServicesIndexDbQueueSize: Int = 1000, maxUsedHeapSpacePercentage: Int = 100, minFreeHeapSpaceBytes: Long = 0, maxStreams: Int = 1000)
- maxApiServicesQueueSize
The maximum number of non-running items in the ApiServices execution service
- maxApiServicesIndexDbQueueSize
The maximum number of non-running items in the IndexDb execution service
- maxUsedHeapSpacePercentage
If, following a garbage collection of the 'tenured' memory pool, the percentage of used pool memory is above this percentage the system will be rate limited until additional space is freed up.
- minFreeHeapSpaceBytes
If, following a garbage collection of the 'tenured' memory pool, the amount of free space is below this value the system will be rate limited until additional space is freed up.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def calculateCollectionUsageThreshold(maxPoolBytes: Long): Long
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val maxApiServicesIndexDbQueueSize: Int
- val maxApiServicesQueueSize: Int
- val maxStreams: Int
- val maxUsedHeapSpacePercentage: Int
- val minFreeHeapSpaceBytes: Long
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])