case class DefaultOptimalSizeExploringResizer(lowerBound: PoolSize = 1, upperBound: PoolSize = 30, chanceOfScalingDownWhenFull: Double = 0.2, actionInterval: Duration = 5.seconds, numOfAdjacentSizesToConsiderDuringOptimization: Int = 16, exploreStepSize: Double = 0.1, downsizeRatio: Double = 0.8, downsizeAfterUnderutilizedFor: Duration = 72.hours, explorationProbability: Double = 0.4, weightOfLatestMetric: Double = 0.5) extends OptimalSizeExploringResizer with Product with Serializable
This resizer resizes the pool to an optimal size that provides the most message throughput.
This resizer works best when you expect the pool size to performance function to be a convex function.
For example, when you have a CPU bound tasks, the optimal size is bound to the number of CPU cores. When your task is IO bound, the optimal size is bound to optimal number of concurrent connections to that IO service - e.g. a 4 node elastic search cluster may handle 4-8 concurrent requests at optimal speed.
It achieves this by keeping track of message throughput at each pool size and performing the following three resizing operations (one at a time) periodically:
* Downsize if it hasn't seen all routees ever fully utilized for a period of time. * Explore to a random nearby pool size to try and collect throughput metrics. * Optimize to a nearby pool size with a better (than any other nearby sizes) throughput metrics.
When the pool is fully-utilized (i.e. all routees are busy), it randomly choose between exploring and optimizing. When the pool has not been fully-utilized for a period of time, it will downsize the pool to the last seen max utilization multiplied by a configurable ratio.
By constantly exploring and optimizing, the resizer will eventually walk to the optimal size and remain nearby. When the optimal size changes it will start walking towards the new one.
It keeps a performance log so it's stateful as well as having a larger memory footprint than the default Resizer. The memory usage is O(n) where n is the number of sizes you allow, i.e. upperBound - lowerBound.
For documentation about the parameters, see the reference.conf - akka.actor.deployment.default.optimal-size-exploring-resizer
- Annotations
- @SerialVersionUID()
- Source
- OptimalSizeExploringResizer.scala
- Alphabetic
- By Inheritance
- DefaultOptimalSizeExploringResizer
- Serializable
- Serializable
- Product
- Equals
- OptimalSizeExploringResizer
- Resizer
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- new DefaultOptimalSizeExploringResizer(lowerBound: PoolSize = 1, upperBound: PoolSize = 30, chanceOfScalingDownWhenFull: Double = 0.2, actionInterval: Duration = 5.seconds, numOfAdjacentSizesToConsiderDuringOptimization: Int = 16, exploreStepSize: Double = 0.1, downsizeRatio: Double = 0.8, downsizeAfterUnderutilizedFor: Duration = 72.hours, explorationProbability: Double = 0.4, weightOfLatestMetric: Double = 0.5)
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
def
+(other: String): String
- Implicit
- This member is added by an implicit conversion from DefaultOptimalSizeExploringResizer to any2stringadd[DefaultOptimalSizeExploringResizer] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (DefaultOptimalSizeExploringResizer, B)
- Implicit
- This member is added by an implicit conversion from DefaultOptimalSizeExploringResizer to ArrowAssoc[DefaultOptimalSizeExploringResizer] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val actionInterval: Duration
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- val chanceOfScalingDownWhenFull: Double
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate() @throws( ... )
- val downsizeAfterUnderutilizedFor: Duration
- val downsizeRatio: Double
-
def
ensuring(cond: (DefaultOptimalSizeExploringResizer) ⇒ Boolean, msg: ⇒ Any): DefaultOptimalSizeExploringResizer
- Implicit
- This member is added by an implicit conversion from DefaultOptimalSizeExploringResizer to Ensuring[DefaultOptimalSizeExploringResizer] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (DefaultOptimalSizeExploringResizer) ⇒ Boolean): DefaultOptimalSizeExploringResizer
- Implicit
- This member is added by an implicit conversion from DefaultOptimalSizeExploringResizer to Ensuring[DefaultOptimalSizeExploringResizer] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): DefaultOptimalSizeExploringResizer
- Implicit
- This member is added by an implicit conversion from DefaultOptimalSizeExploringResizer to Ensuring[DefaultOptimalSizeExploringResizer] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): DefaultOptimalSizeExploringResizer
- Implicit
- This member is added by an implicit conversion from DefaultOptimalSizeExploringResizer to Ensuring[DefaultOptimalSizeExploringResizer] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val explorationProbability: Double
- val exploreStepSize: Double
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from DefaultOptimalSizeExploringResizer to StringFormat[DefaultOptimalSizeExploringResizer] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isTimeForResize(messageCounter: Long): Boolean
Is it time for resizing.
Is it time for resizing. Typically implemented with modulo of nth message, but could be based on elapsed time or something else. The messageCounter starts with 0 for the initial resize and continues with 1 for the first message. Make sure to perform initial resize before first message (messageCounter == 0), because there is no guarantee that resize will be done when concurrent messages are in play.
CAUTION: this method is invoked from the thread which tries to send a message to the pool, i.e. the ActorRef.!() method, hence it may be called concurrently.
- Definition Classes
- DefaultOptimalSizeExploringResizer → Resizer
- val lowerBound: PoolSize
-
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()
- val numOfAdjacentSizesToConsiderDuringOptimization: Int
-
def
reportMessageCount(currentRoutees: IndexedSeq[Routee], messageCounter: Long): Unit
Report the messageCount as well as current routees so that the it can collect metrics.
Report the messageCount as well as current routees so that the it can collect metrics. Caution: this method is not thread safe.
- Definition Classes
- DefaultOptimalSizeExploringResizer → OptimalSizeExploringResizer
-
def
resize(currentRoutees: IndexedSeq[Routee]): Int
Decide if the capacity of the router need to be changed.
Decide if the capacity of the router need to be changed. Will be invoked when
isTimeForResizereturns true and no other resize is in progress.Return the number of routees to add or remove. Negative value will remove that number of routees. Positive value will add that number of routees. 0 will not change the routees.
This method is invoked only in the context of the Router actor.
- Definition Classes
- DefaultOptimalSizeExploringResizer → Resizer
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
- val upperBound: PoolSize
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
- val weightOfLatestMetric: Double
-
def
→[B](y: B): (DefaultOptimalSizeExploringResizer, B)
- Implicit
- This member is added by an implicit conversion from DefaultOptimalSizeExploringResizer to ArrowAssoc[DefaultOptimalSizeExploringResizer] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc