Object/Class

com.ccadllc.cedi.circuitbreaker.statistics

FailureStatistics

Related Docs: class FailureStatistics | package statistics

Permalink

object FailureStatistics extends Serializable

The companion object to the FailureStatistics instances, providing various data types and constructor functions used by and for those instances.

Source
Statistics.scala
Linear Supertypes
Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FailureStatistics
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. sealed abstract class Change extends Product with Serializable

    Permalink

    An Algebraic Data Type (ADT) which represents the latest state change for a FailureStatistics instance.

    An Algebraic Data Type (ADT) which represents the latest state change for a FailureStatistics instance. If the changed property of the FailureStatististics instance is set to Some(Opened), it indicates the associated CircuitBreaker has just transitioned to open, if set to Some(Closed), it indicates it has just transitioned to closed, and if set to None, it indicates that the CircuitBreaker was already opened or closed prior to the latest statistics update.

  2. case class SlidingAggregateMetrics(vector: SlidingVector[Boolean]) extends Product with Serializable

    Permalink

    The sliding statistics, which maintains a pass/failure boolean indicator for results of the execution of programs protected by the associated CircuitBreaker.

    The sliding statistics, which maintains a pass/failure boolean indicator for results of the execution of programs protected by the associated CircuitBreaker. Each pass/failure indicator is associated with a java.time.Instant timestamp in the SlidingVector contained here and the sliding vector keeps only the items with associated time-stamps in the configured range of the statistics window (specified when the SlidingVector[Boolean] is created).

    vector

    - the SlidingVector[Boolean] containing the pass/fail indicators for the latest protected program executions which fall within the configured time range of the statistics window (e.g., a 30s configuration would keep all items with a timestamp that falls within 30 seconds of the current time).

  3. case class Testing(config: Test, timestamp: Instant = Instant.EPOCH, successes: Int = 0) extends Product with Serializable

    Permalink

    This data type is used for testing the protected program by periodically letting the program execute when the associated CircuitBreaker is open, so that we can determine when it is appropriate to close the CB after a configured minimum number of consecutive execution successes.

    This data type is used for testing the protected program by periodically letting the program execute when the associated CircuitBreaker is open, so that we can determine when it is appropriate to close the CB after a configured minimum number of consecutive execution successes.

    config

    - the FailureSettings#Test configuration for testing an open CircuitBreaker, including the minimum number of consecutive tests to close an open CB and the minimum time interval between tests (between which program executions are failed fast without executing).

    timestamp

    - the java.time.Instant timestamp indicating the time the last test was executed.FailureSettings#Test configuration for testing an open CircuitBreaker.

    successes

    - the current number of consecutive test execution successes.

Value Members

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. object Change extends Serializable

    Permalink
  5. object SlidingAggregateMetrics extends Serializable

    Permalink

    The companion object for instances of SlidingAggregateMetrics instances provides a smart constructor for an initial instance (all other instances are created via instance methods).

  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. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  13. def initial(id: Identifier, config: FailureSettings): FailureStatistics

    Permalink

    Creates an initial instance of the FailureStatistics with the passed-in identifier and configuration.

    Creates an initial instance of the FailureStatistics with the passed-in identifier and configuration. All other instances are created by instance methods when the state needs updating.

    id

    - the CircuitBreaker#Identifier of the associated CircuitBreaker instance, binding the two together.

    config

    - the FailureSettings of the associated CircuitBreaker, used to configure the statistics as appropriate.

    returns

    initialFailureSettings - the initial instance for this data type.

  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  18. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  19. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  20. final def wait(): Unit

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

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

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

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped