Class

com.twitter.finagle.param

SessionQualificationParams

Related Doc: package param

Permalink

class SessionQualificationParams[A <: Parameterized[A]] extends AnyRef

A collection of methods for configuring modules which help Finagle determine the health of a session. Some of these act as circuit breakers, instructing the load balancer to choose alternate paths. Effectively these enable your client to maintain higher success rates.

A

a Stack.Parameterized client to configure

See also

https://twitter.github.io/finagle/guide/Clients.html#circuit-breaking

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SessionQualificationParams
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SessionQualificationParams(self: Parameterized[A])

    Permalink

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. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

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

  6. def consecutiveFailuresFailureAccrual(nFailures: Int): A

    Permalink

    Sets a FailureAccrualPolicy that triggers after nFailures consecutive failures.

    Sets a FailureAccrualPolicy that triggers after nFailures consecutive failures.

    nFailures

    The number of failures to trigger on

    See also

    https://twitter.github.io/finagle/guide/Clients.html#failure-accrual https://twitter.github.io/finagle/guide/Clients.html#circuit-breaking FailureAccrualFactory

  7. def consecutiveFailuresFailureAccrual(nFailures: Int, backoff: Stream[Duration]): A

    Permalink

    Sets a FailureAccrualPolicy that triggers after nFailures consecutive failures.

    Sets a FailureAccrualPolicy that triggers after nFailures consecutive failures.

    nFailures

    The number of failures to trigger on

    backoff

    The backoff that should be applied to revival attempts

    See also

    https://twitter.github.io/finagle/guide/Clients.html#failure-accrual https://twitter.github.io/finagle/guide/Clients.html#circuit-breaking FailureAccrualFactory

  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. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  15. def noFailFast: A

    Permalink

    Disables the Fail Fast module on this client (default: enabled).

    Disables the Fail Fast module on this client (default: enabled).

    The Fail Fast module is a Finagle per-session circuit breaker. It marks a host unavailable upon connection failure. The host remains dead until we successfully connect.

    Note

    Usually, it's a good idea to disable Fail Fast for server sets with only one host in the load balancer's replica set.

    See also

    https://twitter.github.io/finagle/guide/Clients.html#fail-fast https://twitter.github.io/finagle/guide/Clients.html#circuit-breaking FailFastFactory

  16. def noFailureAccrual: A

    Permalink

    Disables the Failure Accrual module on this client (default: enabled).

    Disables the Failure Accrual module on this client (default: enabled).

    The Failure Accrual module is a Finagle per-request circuit breaker. It marks a host unavailable depending on the used policy. The default setup for the Failure Accrual module is to use a policy based on the number of consecutive failures (default is 5) accompanied by equal jittered backoff producing durations for which a host is marked unavailable.

    See also

    https://twitter.github.io/finagle/guide/Clients.html#failure-accrual https://twitter.github.io/finagle/guide/Clients.html#circuit-breaking FailureAccrualFactory

  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  19. def successRateFailureAccrual(successRate: Double, window: Duration, backoff: Stream[Duration]): A

    Permalink

    Sets a failure accrual policy that triggers when success rate drops under a given value by looking at a moving average over a time window.

    Sets a failure accrual policy that triggers when success rate drops under a given value by looking at a moving average over a time window.

    The current default policy is success rate based with a cutoff of 80% and a window of 30 seconds.

    successRate

    The success rate to trigger on

    window

    The time window of the moving average

    backoff

    The backoff that should be applied to revival attempts

    See also

    https://twitter.github.io/finagle/guide/Clients.html#failure-accrual

  20. def successRateFailureAccrual(successRate: Double, window: Duration): A

    Permalink

    Sets a failure accrual policy that triggers when success rate drops under a given value by looking at a moving average over a time window.

    Sets a failure accrual policy that triggers when success rate drops under a given value by looking at a moving average over a time window.

    The current default policy is success rate based with a cutoff of 80% and a window of 30 seconds.

    successRate

    The success rate to trigger on

    window

    The time window of the moving average

    See also

    https://twitter.github.io/finagle/guide/Clients.html#failure-accrual

  21. def successRateFailureAccrual(successRate: Double, window: Duration, backoff: Stream[Duration], minRequestThreshold: Int): A

    Permalink

    Sets a failure accrual policy that triggers when success rate drops under a given value by looking at a moving average over a time window.

    Sets a failure accrual policy that triggers when success rate drops under a given value by looking at a moving average over a time window.

    The current default policy is success rate based with a cutoff of 80% and a window of 30 seconds.

    successRate

    The success rate to trigger on

    window

    The time window of the moving average

    backoff

    The backoff that should be applied to revival attempts

    minRequestThreshold

    The minimum number of requests in a window required for failure accrual to trigger

    See also

    https://twitter.github.io/finagle/guide/Clients.html#failure-accrual

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

    Permalink
    Definition Classes
    AnyRef

  23. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  24. final def wait(): Unit

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

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

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped