Class/Object

com.ccadllc.cedi.circuitbreaker.statistics

FailureStatistics

Related Docs: object FailureStatistics | package statistics

Permalink

case class FailureStatistics extends Statistics with Product with Serializable

This represents the statistics that CircuitBreaker instances use to track the success and failure rates of their protected programs, for use in determining when to trip ("open") the breaker and, when open, to maintain the periodic testing state for use in determining when the breaker can be closed and normal traffic let flow to the program.

Source
Statistics.scala
Linear Supertypes
Statistics, Serializable, Serializable, Product, Equals, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FailureStatistics
  2. Statistics
  3. Serializable
  4. Serializable
  5. Product
  6. Equals
  7. AnyRef
  8. 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

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 FailureStatistics to any2stringadd[FailureStatistics] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (FailureStatistics, B)

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

    Permalink
    Definition Classes
    AnyRef → Any
  6. def afterExecution(timestamp: Instant, success: Boolean): FailureStatistics

    Permalink

    Lifecycle function invoked by the CircuitBreaker after the program execution has completed.

    Lifecycle function invoked by the CircuitBreaker after the program execution has completed. If goes down two separate paths depending on whether the circuit breaker is open and therefore the execution is a test or if it is a normal execution. In either case, the statistics are updated appropriately and a new value is returned.

    timestamp

    - the timestamp of the execution completion.

    success

    - the indicator as to whether the request was successful or a failure.

    returns

    newStatistics - The metrics are updated based on the evaluation of the statistics.

  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def beforeExecution(timestamp: Instant): FailureStatistics

    Permalink

    Lifecycle function invoked by the CircuitBreaker after it performed circuit breaker open checked and determined the program execution request should go forth (either for testing if the circuit breaker is open or for normal execution).

    Lifecycle function invoked by the CircuitBreaker after it performed circuit breaker open checked and determined the program execution request should go forth (either for testing if the circuit breaker is open or for normal execution).

    returns

    newStatistics - The metrics are updated with the last activity timestamp updated.

  9. val change: Option[Change]

    Permalink

    - if the statistics have undergone any state change, the last change will be present here.

  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. val config: FailureSettings

    Permalink

    - the configuration of the associated CircuitBreaker, also used to configure this statistics instance.

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  17. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  20. val id: Identifier

    Permalink

    - the unique identifier of the CircuitBreaker which "owns" this statistics instance.

  21. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  22. val lastActivity: Instant

    Permalink

    - the timestamp of the last state change for these statistics.

  23. val lastChangeClosed: Boolean

    Permalink
  24. val lastChangeOpened: Boolean

    Permalink
  25. val metrics: SlidingAggregateMetrics

    Permalink

    - the sliding time-based metrics for the success/failure indicators of the protected program execution.

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

    Permalink
    Definition Classes
    AnyRef
  27. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  28. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  29. val open: Boolean

    Permalink
  30. def openButUntestable(current: Instant): Boolean

    Permalink
  31. def show: String

    Permalink

    Render this statistics object in human readable form.

    Render this statistics object in human readable form.

    Definition Classes
    FailureStatisticsStatistics
  32. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  33. val testing: Option[Testing]

    Permalink

    - if the associated CircuitBreaker is open, there will be a value here that maintains statistics on program execution tests (periodically allowing a program to execute and keeping track of the consecutive successes or, if a test failure, resetting these stats).

  34. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. def [B](y: B): (FailureStatistics, B)

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

Inherited from Statistics

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped