t

akka.pattern.internal

CircuitBreakerTelemetry

trait CircuitBreakerTelemetry extends AnyRef

Service Provider Interface (SPI) for collecting metrics from Circuit Breaker.

Implementations must include a single constructor with two arguments: Circuit Breaker id and ExtendedActorSystem. To setup your implementation, add a setting in your application.conf:

akka.circuit-breaker.telemetry.implementations += com.example.MyMetrics
Annotations
@InternalStableApi()
Source
CircuitBreakerTelemetry.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CircuitBreakerTelemetry
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def onCallBreakerOpenFailure(): Unit

    Invoked for each call when the future is completed with akka.pattern.CircuitBreakerOpenException

  2. abstract def onCallFailure(elapsedNanos: Long): Unit

    Invoked for each call when the future is completed with exception, except for and akka.pattern.CircuitBreakerOpenException that are handled by separate methods.

    Invoked for each call when the future is completed with exception, except for and akka.pattern.CircuitBreakerOpenException that are handled by separate methods.

    elapsedNanos

    the elapsed duration of the call in nanoseconds

  3. abstract def onCallSuccess(elapsedNanos: Long): Unit

    Invoked for each successful call.

    Invoked for each successful call.

    elapsedNanos

    the elapsed duration of the call in nanoseconds

  4. abstract def onCallTimeoutFailure(elapsedNanos: Long): Unit

    Invoked for each call when the future is completed with java.util.concurrent.TimeoutException

    Invoked for each call when the future is completed with java.util.concurrent.TimeoutException

    elapsedNanos

    the elapsed duration of the call in nanoseconds

  5. abstract def onClose(): Unit

    Invoked when the circuit breaker transitions to the close state.

  6. abstract def onHalfOpen(): Unit

    Invoked when the circuit breaker transitions to the half-open state after reset timeout.

  7. abstract def onOpen(): Unit

    Invoked when the circuit breaker transitions to the open state.

  8. abstract def stopped(): Unit

    Called when the circuit breaker is removed, e.g.

    Called when the circuit breaker is removed, e.g. expired due to inactivity. It is also called if the circuit breaker is re-configured, before calling CircuitBreakerTelemetryProvider#start.