SentryBuilder

Instance Constructors

new SentryBuilder(owner: Class[_], resourceName: String, sentryRegistry: SentriesRegistry)

Abstract Value Members

abstract def withSentry(andThenSentry: ChainableSentry): ChainableSentry with SentryBuilder

Append a custom sentry to the current sentry.
Append a custom sentry to the current sentry.
andThenSentry
the sentry to add
returns
a new sentry that applies the given sentry after the current sentry behavior

Concrete Value Members

final def !=(arg0: Any): Boolean

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

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

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def hashCode(): Int

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

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def registered(sentry: ChainableSentry): ChainableSentry

Returns the registered instance of the sentry (when applicable).
Returns the registered instance of the sentry (when applicable).

Attributes
protected
val resourceName: String
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

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

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
def withAdaptiveThroughput(targetSuccessRatio: Double = 0.95D, evaluationDelay: Duration = Duration(1, TimeUnit.SECONDS), minimumInvocationCountThreshold: Int = 0, successIncreaseFactor: Double = 1.2D): ChainableSentry with SentryBuilder

Append an adaptive throughput sentry to the current sentry.
Append an adaptive throughput sentry to the current sentry. See nl.grons.sentries.core.AdaptiveThroughputSentry for more information.
targetSuccessRatio
target success ratio, 0 < targetSuccessRatio < 1, defaults to 0.95
evaluationDelay
the time between calculations of the current throughput, defaults to 1 second
minimumInvocationCountThreshold
the minimum number of invocations that must be observed per evaluationDelay before invocations are throttled, defaults to 0 (>=0)
successIncreaseFactor
factor to apply to current throughput ratio, successIncreaseFactor > 1, defaults to 1.2D
returns
a new sentry that adaptively changes allowed throughput after the current sentry behavior
def withConcurrencyLimit(concurrencyLimit: Int): ChainableSentry with SentryBuilder

Append a concurrency limit sentry to the current sentry.
Append a concurrency limit sentry to the current sentry.
concurrencyLimit
number of concurrently allowed invocations
returns
a new sentry that applies a concurrency limit after the current sentry behavior
def withDurationLimit(durationLimit: Duration): ChainableSentry with SentryBuilder

Append a invocation duration limit sentry to the current sentry.
Append a invocation duration limit sentry to the current sentry.
WARNING: do NOT use this sentry when you invoke it from a Future or an Actor. For such circumstances you are MUCH better of with a timeout on the enclosing future or a timeout message within the actor. Reason: this sentry blocks the current thread while waiting on a future that executes the task. Blocking the current thread is an anti-pattern for futures and actors.
durationLimit
the maximum duration of a call
returns
a new sentry that applies a duration limit after the current sentry behavior
def withFailLimit(failLimit: Int, retryDelay: Duration = Duration(1, TimeUnit.SECONDS)): ChainableSentry with SentryBuilder

Append a circuit breaker sentry to the current sentry.
Append a circuit breaker sentry to the current sentry. See nl.grons.sentries.core.CircuitBreakerSentry for more information.
failLimit
number of failure after which the flow will be broken
retryDelay
timeout for trying again, defaults to 1 second
returns
a new sentry that applies a circuit breaker after the current sentry behavior
def withFailLimitAndAdaptiveThroughput(failLimit: Int, retryDelay: Duration = Duration(1, TimeUnit.SECONDS), targetSuccessRatio: Double = 0.95D): ChainableSentry with SentryBuilder

Append a circuit breaker AND an adaptive throughput sentry to the current sentry.
Append a circuit breaker AND an adaptive throughput sentry to the current sentry. See nl.grons.sentries.core.CircuitBreakerSentry and nl.grons.sentries.core.AdaptiveThroughputSentry for more information.
failLimit
number of failure after which the flow will be broken by circuit breaker, AND the minimum number of invocations before throttling takes place in the adaptive throughput
retryDelay
timeout for trying again (> 5 milliseconds), defaults to 1 second
targetSuccessRatio
target success ratio for adaptive throughput, 0 < targetSuccessRatio < 1, defaults to 0.95
returns
a new sentry that applies adaptive throughput after a circuit breaker after the current sentry behavior
def withMetrics: ChainableSentry with SentryBuilder

Append a metric sentry to the current sentry.
Append a metric sentry to the current sentry.
One timer and 2 meter metrics are registered: "all", "fail" and "notAvailable". The "all" timer times and counts all invocations, the "fail" meter counts invocations that threw an exception, and the "notAvailable" meter counts invocations that were blocked by a sentry that is later in the chain (detected by catching nl.grons.sentries.support.NotAvailableExceptions).
When only a timer is needed, use .withTimer instead.
To count the 'not available' invocations, this must be the first sentry in the chain.
For more information see nl.grons.sentries.core.MetricSentry.
returns
a new sentry that collects metrics after the current sentry behavior
def withRateLimit(rate: Int, per: Duration): ChainableSentry with SentryBuilder

Append a rate limit sentry to the current sentry.
Append a rate limit sentry to the current sentry.
rate
number of invocations per time unit
per
the time unit
returns
a new sentry that applies a concurrency limit after the current sentry behavior
def withTimer: ChainableSentry with SentryBuilder

Append a timer sentry to the current sentry.
Append a timer sentry to the current sentry.
One timer is registered: "all". It is updated for each invocation. For more extensive measuring, use .withMetrics instead.
For more information see nl.grons.sentries.core.TimerSentry.
returns
a new sentry that collects metrics after the current sentry behavior

abstract class SentryBuilder extends AnyRef

Instance Constructors

new SentryBuilder(owner: Class[_], resourceName: String, sentryRegistry: SentriesRegistry)

Abstract Value Members

abstract def withSentry(andThenSentry: ChainableSentry): ChainableSentry with SentryBuilder

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def registered(sentry: ChainableSentry): ChainableSentry

val resourceName: String

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def withAdaptiveThroughput(targetSuccessRatio: Double = 0.95D, evaluationDelay: Duration = Duration(1, TimeUnit.SECONDS), minimumInvocationCountThreshold: Int = 0, successIncreaseFactor: Double = 1.2D): ChainableSentry with SentryBuilder

def withConcurrencyLimit(concurrencyLimit: Int): ChainableSentry with SentryBuilder

def withDurationLimit(durationLimit: Duration): ChainableSentry with SentryBuilder

def withFailLimit(failLimit: Int, retryDelay: Duration = Duration(1, TimeUnit.SECONDS)): ChainableSentry with SentryBuilder

def withFailLimitAndAdaptiveThroughput(failLimit: Int, retryDelay: Duration = Duration(1, TimeUnit.SECONDS), targetSuccessRatio: Double = 0.95D): ChainableSentry with SentryBuilder

def withMetrics: ChainableSentry with SentryBuilder

def withRateLimit(rate: Int, per: Duration): ChainableSentry with SentryBuilder

def withTimer: ChainableSentry with SentryBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped