Packages

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.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RateLimitingConfig
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. 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

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def calculateCollectionUsageThreshold(maxPoolBytes: Long): Long
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  10. val maxApiServicesIndexDbQueueSize: Int
  11. val maxApiServicesQueueSize: Int
  12. val maxStreams: Int
  13. val maxUsedHeapSpacePercentage: Int
  14. val minFreeHeapSpaceBytes: Long
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  18. def productElementNames: Iterator[String]
    Definition Classes
    Product
  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped