Class/Object

com.ccadllc.cedi.circuitbreaker

FailureSettings

Related Docs: object FailureSettings | package circuitbreaker

Permalink

case class FailureSettings(sampleWindow: SampleWindow, degradationThreshold: Percentage, test: Test, enabled: Boolean = true) extends Product with Serializable

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

sampleWindow

- the time-based window to be used to constrain the number of program execution success/failure indicators to store in order to determine the percentage of failures over this time period. An example would be SampleWindow(2.minutes) which means maintain the last two minutes of program execution success/failure indicators for a program protected by a given CircuitBreaker.

degradationThreshold

- the Percentage of items within the sample window which indicate program failure. For instance, if the percentage were Percentage(40.0) and there were 50 sample items in the 2 minute window, with 25 indicating program failure, then since 50% is greater than 40%, the circuit breaker would open.

test

- the testing configuration is used when the circuit breaker is open in order to determine how often a program should be executed rather than failed fast and then how many consecutively successful test executions need to occur in order to close the circuit breaker and allow normal operation of the protected program.

enabled

- The CircuitBreaker can be enabled or disabled with this parameter.

Source
CircuitBreakerSettings.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FailureSettings
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FailureSettings(sampleWindow: SampleWindow, degradationThreshold: Percentage, test: Test, enabled: Boolean = true)

    Permalink

    sampleWindow

    - the time-based window to be used to constrain the number of program execution success/failure indicators to store in order to determine the percentage of failures over this time period. An example would be SampleWindow(2.minutes) which means maintain the last two minutes of program execution success/failure indicators for a program protected by a given CircuitBreaker.

    degradationThreshold

    - the Percentage of items within the sample window which indicate program failure. For instance, if the percentage were Percentage(40.0) and there were 50 sample items in the 2 minute window, with 25 indicating program failure, then since 50% is greater than 40%, the circuit breaker would open.

    test

    - the testing configuration is used when the circuit breaker is open in order to determine how often a program should be executed rather than failed fast and then how many consecutively successful test executions need to occur in order to close the circuit breaker and allow normal operation of the protected program.

    enabled

    - The CircuitBreaker can be enabled or disabled with this parameter.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

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

  4. def ->[B](y: B): (FailureSettings, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from FailureSettings to ArrowAssoc[FailureSettings] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. val degradationThreshold: Percentage

    Permalink

    - the Percentage of items within the sample window which indicate program failure.

    - the Percentage of items within the sample window which indicate program failure. For instance, if the percentage were Percentage(40.0) and there were 50 sample items in the 2 minute window, with 25 indicating program failure, then since 50% is greater than 40%, the circuit breaker would open.

  9. val enabled: Boolean

    Permalink

    - The CircuitBreaker can be enabled or disabled with this parameter.

  10. def ensuring(cond: (FailureSettings) ⇒ Boolean, msg: ⇒ Any): FailureSettings

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

  11. def ensuring(cond: (FailureSettings) ⇒ Boolean): FailureSettings

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

  12. def ensuring(cond: Boolean, msg: ⇒ Any): FailureSettings

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

  13. def ensuring(cond: Boolean): FailureSettings

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

  14. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  15. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  16. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from FailureSettings to StringFormat[FailureSettings] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  17. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  19. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  22. val sampleWindow: SampleWindow

    Permalink

    - the time-based window to be used to constrain the number of program execution success/failure indicators to store in order to determine the percentage of failures over this time period.

    - the time-based window to be used to constrain the number of program execution success/failure indicators to store in order to determine the percentage of failures over this time period. An example would be SampleWindow(2.minutes) which means maintain the last two minutes of program execution success/failure indicators for a program protected by a given CircuitBreaker.

  23. def show: String

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  25. val test: Test

    Permalink

    - the testing configuration is used when the circuit breaker is open in order to determine how often a program should be executed rather than failed fast and then how many consecutively successful test executions need to occur in order to close the circuit breaker and allow normal operation of the protected program.

  26. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  28. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  29. def →[B](y: B): (FailureSettings, B)

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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped