FlowControlSettings

The configuration which controls the flow control-based CircuitBreakers (that is, those circuit breakers which are created via the CircuitBreakerRegistry#forFlowControl function).

failure: - the configuration for the failure component of the flow control CircuitBreaker. In addition to providing flow control, it also provides the same failure functionality as its failure-only variant.
sampleWindow: - the time-based window to be used to constrain the number of inbound program execution requests per second and program executions processed per second. The flow control circuit breaker maintains two separate collections (the inbound rate and the processing/completed rate) and both use this sample window configuration to constrain the sizes of these collections.
allowedOverProcessingRate: - the Percentage that the mean inbound rate is allowed to exceed the mean processing rate before this circuit breaker starts throttling inbound requests to lower it to an acceptable rate. Put another way, the acceptable rate is the processing rate + (processing rate * percentage / 100).
minimumReportableRateChange: - this is the percent that the calculated acceptable rate must be observed to have changed (either lower or higher) before a state change event is triggered. If it is 0, all state changes result in an event. This configuration item is meant to alleviate a flood of events when the request traffic pattern is very choppy (lots of spikes and valleys in a short time period).
perSecondRateMinimum: - this is the minimum observed inbound rate at which flow control throttling will kick in.
perSecondRateHardLimit: - this is the hard limit of the inbound requests per second above which requests will be throttled by the circuit breaker (failed fast without execution) for the remainder of the current second. It will be monitored and acted upon continuously.
enabled: - The flow control portion of the CircuitBreaker can be enabled or disabled with this parameter.

Source: CircuitBreakerSettings.scala

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new FlowControlSettings(failure: FailureSettings, sampleWindow: SampleWindow, allowedOverProcessingRate: Percentage, minimumReportableRateChange: Percentage, perSecondRateMinimum: Long, perSecondRateHardLimit: Long, enabled: Boolean = true)

failure
- the configuration for the failure component of the flow control CircuitBreaker. In addition to providing flow control, it also provides the same failure functionality as its failure-only variant.
sampleWindow
- the time-based window to be used to constrain the number of inbound program execution requests per second and program executions processed per second. The flow control circuit breaker maintains two separate collections (the inbound rate and the processing/completed rate) and both use this sample window configuration to constrain the sizes of these collections.
allowedOverProcessingRate
- the Percentage that the mean inbound rate is allowed to exceed the mean processing rate before this circuit breaker starts throttling inbound requests to lower it to an acceptable rate. Put another way, the acceptable rate is the processing rate + (processing rate * percentage / 100).
minimumReportableRateChange
- this is the percent that the calculated acceptable rate must be observed to have changed (either lower or higher) before a state change event is triggered. If it is 0, all state changes result in an event. This configuration item is meant to alleviate a flood of events when the request traffic pattern is very choppy (lots of spikes and valleys in a short time period).
perSecondRateMinimum
- this is the minimum observed inbound rate at which flow control throttling will kick in.
perSecondRateHardLimit
- this is the hard limit of the inbound requests per second above which requests will be throttled by the circuit breaker (failed fast without execution) for the remainder of the current second. It will be monitored and acted upon continuously.
enabled
- The flow control portion of the CircuitBreaker can be enabled or disabled with this parameter.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
def +(other: String): String

Implicit information
This member is added by an implicit conversion from FlowControlSettings to any2stringadd[FlowControlSettings] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (FlowControlSettings, B)

Implicit information
This member is added by an implicit conversion from FlowControlSettings to ArrowAssoc[FlowControlSettings] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val allowedOverProcessingRate: Percentage

- the Percentage that the mean inbound rate is allowed to exceed the mean processing rate before this circuit breaker starts throttling inbound requests to lower it to an acceptable rate.
- the Percentage that the mean inbound rate is allowed to exceed the mean processing rate before this circuit breaker starts throttling inbound requests to lower it to an acceptable rate. Put another way, the acceptable rate is the processing rate + (processing rate * percentage / 100).
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val enabled: Boolean

- The flow control portion of the CircuitBreaker can be enabled or disabled with this parameter.
def ensuring(cond: (FlowControlSettings) ⇒ Boolean, msg: ⇒ Any): FlowControlSettings

Implicit information
This member is added by an implicit conversion from FlowControlSettings to Ensuring[FlowControlSettings] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (FlowControlSettings) ⇒ Boolean): FlowControlSettings

Implicit information
This member is added by an implicit conversion from FlowControlSettings to Ensuring[FlowControlSettings] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): FlowControlSettings

Implicit information
This member is added by an implicit conversion from FlowControlSettings to Ensuring[FlowControlSettings] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): FlowControlSettings

Implicit information
This member is added by an implicit conversion from FlowControlSettings to Ensuring[FlowControlSettings] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val failure: FailureSettings

- the configuration for the failure component of the flow control CircuitBreaker.
- the configuration for the failure component of the flow control CircuitBreaker. In addition to providing flow control, it also provides the same failure functionality as its failure-only variant.
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def formatted(fmtstr: String): String

Implicit information
This member is added by an implicit conversion from FlowControlSettings to StringFormat[FlowControlSettings] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val minimumReportableRateChange: Percentage

- this is the percent that the calculated acceptable rate must be observed to have changed (either lower or higher) before a state change event is triggered.
- this is the percent that the calculated acceptable rate must be observed to have changed (either lower or higher) before a state change event is triggered. If it is 0, all state changes result in an event. This configuration item is meant to alleviate a flood of events when the request traffic pattern is very choppy (lots of spikes and valleys in a short time period).
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val perSecondRateHardLimit: Long

- this is the hard limit of the inbound requests per second above which requests will be throttled by the circuit breaker (failed fast without execution) for the remainder of the current second.
- this is the hard limit of the inbound requests per second above which requests will be throttled by the circuit breaker (failed fast without execution) for the remainder of the current second. It will be monitored and acted upon continuously.
val perSecondRateMinimum: Long

- this is the minimum observed inbound rate at which flow control throttling will kick in.
val sampleWindow: SampleWindow

- the time-based window to be used to constrain the number of inbound program execution requests per second and program executions processed per second.
- the time-based window to be used to constrain the number of inbound program execution requests per second and program executions processed per second. The flow control circuit breaker maintains two separate collections (the inbound rate and the processing/completed rate) and both use this sample window configuration to constrain the sizes of these collections.
def show: String
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def →[B](y: B): (FlowControlSettings, B)

Implicit information
This member is added by an implicit conversion from FlowControlSettings to ArrowAssoc[FlowControlSettings] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Related Docs: object FlowControlSettings | package circuitbreaker

case class FlowControlSettings(failure: FailureSettings, sampleWindow: SampleWindow, allowedOverProcessingRate: Percentage, minimumReportableRateChange: Percentage, perSecondRateMinimum: Long, perSecondRateHardLimit: Long, enabled: Boolean = true) extends Product with Serializable

Instance Constructors

new FlowControlSettings(failure: FailureSettings, sampleWindow: SampleWindow, allowedOverProcessingRate: Percentage, minimumReportableRateChange: Percentage, perSecondRateMinimum: Long, perSecondRateHardLimit: Long, enabled: Boolean = true)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (FlowControlSettings, B)

final def ==(arg0: Any): Boolean

val allowedOverProcessingRate: Percentage

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val enabled: Boolean

def ensuring(cond: (FlowControlSettings) ⇒ Boolean, msg: ⇒ Any): FlowControlSettings

def ensuring(cond: (FlowControlSettings) ⇒ Boolean): FlowControlSettings

def ensuring(cond: Boolean, msg: ⇒ Any): FlowControlSettings

def ensuring(cond: Boolean): FlowControlSettings

final def eq(arg0: AnyRef): Boolean

val failure: FailureSettings

def finalize(): Unit

def formatted(fmtstr: String): String

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

val minimumReportableRateChange: Percentage

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val perSecondRateHardLimit: Long

val perSecondRateMinimum: Long

val sampleWindow: SampleWindow

def show: String

final def synchronized[T0](arg0: ⇒ T0): T0

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def →[B](y: B): (FlowControlSettings, B)

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from FlowControlSettings to any2stringadd[FlowControlSettings]

Inherited by implicit conversion StringFormat from FlowControlSettings to StringFormat[FlowControlSettings]

Inherited by implicit conversion Ensuring from FlowControlSettings to Ensuring[FlowControlSettings]

Inherited by implicit conversion ArrowAssoc from FlowControlSettings to ArrowAssoc[FlowControlSettings]

Ungrouped