Class/Object

com.ccadllc.cedi.circuitbreaker.statistics.FlowControlStatistics

AggregateFlowRate

Related Docs: object AggregateFlowRate | package FlowControlStatistics

Permalink

case class AggregateFlowRate(perSecond: SlidingAggregateMetrics, currentSample: FlowRateSample) extends Product with Serializable

Maintains the sliding window per second request rates as well as the current second's request count.

perSecond

- a SlidingAggregateMetrics instance which contains a sliding window of the aggregate rate statistics.

currentSample

- a FlowRateSample instance which contains the current per-second request count and a timestamp indicating the start time of this count (when a second has past, the value is added to the sliding window of values and cleared to begin the next count).

Source
Statistics.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AggregateFlowRate
  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 AggregateFlowRate(perSecond: SlidingAggregateMetrics, currentSample: FlowRateSample)

    Permalink

    perSecond

    - a SlidingAggregateMetrics instance which contains a sliding window of the aggregate rate statistics.

    currentSample

    - a FlowRateSample instance which contains the current per-second request count and a timestamp indicating the start time of this count (when a second has past, the value is added to the sliding window of values and cleared to begin the next count).

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

    Permalink
    Implicit information
    This member is added by an implicit conversion from AggregateFlowRate to ArrowAssoc[AggregateFlowRate] 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 addToSample: AggregateFlowRate

    Permalink

    Increments the per-second request rate count.

    Increments the per-second request rate count.

    returns

    newAggregateFlowRate - A new instance of this data type with the per-second count incremented by 1.

  7. def ageSample(time: Instant): AggregateFlowRate

    Permalink

    Possibly age the current per-second sample, if more than one second has passed since the current per-second sample count started, by copying the count into the aggregate sliding window and resetting the current sample count to 0 and its start time to the passed-in time parameter.

    Possibly age the current per-second sample, if more than one second has passed since the current per-second sample count started, by copying the count into the aggregate sliding window and resetting the current sample count to 0 and its start time to the passed-in time parameter. The aggregate sliding window of stats is first filled with zero count samples for the number of seconds over 2 which have occurred since the last time this function was invoked.

    time

    - the java.time.Instant timestamp representing the current time, usually (or at least the relative current time; not necessarily the current wall clock time).

    returns

    newAggregateFlowRate - updated with the state updated if sufficient time has passed or else it returns itself.

  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. val currentSample: FlowRateSample

    Permalink

    - a FlowRateSample instance which contains the current per-second request count and a timestamp indicating the start time of this count (when a second has past, the value is added to the sliding window of values and cleared to begin the next count).

  11. def ensuring(cond: (AggregateFlowRate) ⇒ Boolean, msg: ⇒ Any): AggregateFlowRate

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

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

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

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

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

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

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

    Permalink

    Indicates whether we've collected enough per-second request rate samples to completely fill the sliding window of values, indicating we have enough data to derive meaningful statistics.

    Indicates whether we've collected enough per-second request rate samples to completely fill the sliding window of values, indicating we have enough data to derive meaningful statistics. For instance, if the sample window for the sliding vector is 30 seconds, this will return true if we've collected over 30 samples.

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

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

    Permalink
    Definition Classes
    Any
  21. def mean: Double

    Permalink

    The mean/average of the per-second rate values in the contained SlidingAggregateMetrics.

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

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

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

    Permalink
    Definition Classes
    AnyRef
  25. val perSecond: SlidingAggregateMetrics

    Permalink

    - a SlidingAggregateMetrics instance which contains a sliding window of the aggregate rate statistics.

  26. def show: String

    Permalink

    Renders the aggregate flow rate as a human-readable string value.

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

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

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

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

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

    Permalink
    Implicit information
    This member is added by an implicit conversion from AggregateFlowRate to ArrowAssoc[AggregateFlowRate] 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 AggregateFlowRate to any2stringadd[AggregateFlowRate]

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

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

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

Ungrouped