org.apache.pekko.pattern.CircuitBreakersRegistry.scala Maven / Gradle / Ivy

Go to download
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * license agreements; and to You under the Apache License, version 2.0:
 *
 *   https://www.apache.org/licenses/LICENSE-2.0
 *
 * This file is part of the Apache Pekko project, which was derived from Akka.
 */

/*
 * Copyright (C) 2022 Lightbend Inc. 
 */

package org.apache.pekko.pattern

import java.util.concurrent.ConcurrentHashMap
import scala.concurrent.duration.{ DurationLong, MILLISECONDS }
import org.apache.pekko
import pekko.actor.{
  ActorSystem,
  ClassicActorSystemProvider,
  ExtendedActorSystem,
  Extension,
  ExtensionId,
  ExtensionIdProvider
}
import pekko.pattern.internal.CircuitBreakerTelemetryProvider
import pekko.util.ccompat.JavaConverters._

/**
 * Companion object providing factory methods for Circuit Breaker which runs callbacks in caller's thread
 */
object CircuitBreakersRegistry extends ExtensionId[CircuitBreakersRegistry] with ExtensionIdProvider {

  /**
   * Is used by Pekko to instantiate the Extension identified by this ExtensionId,
   * internal use only.
   */
  override def createExtension(system: ExtendedActorSystem): CircuitBreakersRegistry =
    new CircuitBreakersRegistry(system)

  /**
   * Returns the canonical ExtensionId for this Extension
   */
  override def lookup: ExtensionId[_ <: Extension] = CircuitBreakersRegistry

  /**
   * Returns an instance of the extension identified by this ExtensionId instance.
   * Java API
   */
  override def get(system: ActorSystem): CircuitBreakersRegistry = super.get(system)

  /**
   * Returns an instance of the extension identified by this ExtensionId instance.
   * Java API
   */
  override def get(system: ClassicActorSystemProvider): CircuitBreakersRegistry = super.get(system)
}

/**
 * A CircuitBreakersPanel is a central point collecting all circuit breakers in Akka.
 */
final class CircuitBreakersRegistry(system: ExtendedActorSystem) extends Extension {

  private val breakers = new ConcurrentHashMap[String, CircuitBreaker]

  private val config = system.settings.config.getConfig("pekko.circuit-breaker")
  private val defaultBreakerConfig = config.getConfig("default")

  private def createCircuitBreaker(id: String): CircuitBreaker = {
    val breakerConfig =
      if (config.hasPath(id)) config.getConfig(id).withFallback(defaultBreakerConfig)
      else defaultBreakerConfig

    val maxFailures = breakerConfig.getInt("max-failures")
    val callTimeout = breakerConfig.getDuration("call-timeout", MILLISECONDS).millis
    val resetTimeout = breakerConfig.getDuration("reset-timeout", MILLISECONDS).millis
    val maxResetTimeout = breakerConfig.getDuration("max-reset-timeout", MILLISECONDS).millis
    val exponentialBackoffFactor = breakerConfig.getDouble("exponential-backoff")
    val randomFactor = breakerConfig.getDouble("random-factor")

    val allowExceptions: Set[String] = breakerConfig.getStringList("exception-allowlist").asScala.toSet

    val telemetry = CircuitBreakerTelemetryProvider.start(id, system)
    new CircuitBreaker(
      system.scheduler,
      maxFailures,
      callTimeout,
      resetTimeout,
      maxResetTimeout,
      exponentialBackoffFactor,
      randomFactor,
      allowExceptions,
      telemetry)(system.dispatcher)
  }

  private[pekko] def get(id: String): CircuitBreaker =
    breakers.computeIfAbsent(id, createCircuitBreaker)
}