Как создать простое приложение с помощью Akka Cluster

Если вы читали мой предыдущий рассказ о Scalachain, вы, вероятно, заметили, что это далеко не распределенная система. В нем отсутствуют все функции для правильной работы с другими узлами. Добавьте к этому, что блокчейн, состоящий из одного узла, бесполезен. По этой причине я решил, что пора заняться этим вопросом.

Поскольку Scalachain работает на Akka, почему бы не поиграть с Akka Cluster? Я создал простой проект, чтобы немного поработать с Akka Cluster, и в этой истории я собираюсь поделиться своими знаниями. Мы собираемся создать кластер из трех узлов, используя кластерные маршрутизаторы для балансировки нагрузки между ними. Все будет работать в контейнере Docker, и мы будем использовать docker-compose для упрощения развертывания.

Хорошо, поехали! ?

Краткое введение в Akka Cluster

Akka Cluster обеспечивает отличную поддержку для создания распределенных приложений. Наилучший вариант использования - это когда у вас есть узел, который вы хотите реплицировать N раз в распределенной среде. Это означает, что все N узлов являются одноранговыми узлами, выполняющими один и тот же код. Akka Cluster дает вам готовое решение для обнаружения членов в одном кластере. Используя кластерные маршрутизаторы, можно сбалансировать сообщения между участниками в разных узлах. Также можно выбрать политику балансировки, что делает балансировку нагрузки легкой задачей!

На самом деле вы можете выбирать между двумя типами маршрутизаторов:

Групповой маршрутизатор - субъекты, которым следует отправлять сообщения, называемые маршрутами, указываются с использованием их пути к субъекту. Маршрутизаторы совместно используют маршруты, созданные в кластере. В этом примере мы будем использовать групповой маршрутизатор.

Маршрутизатор пула - маршруты создаются и развертываются маршрутизатором, поэтому они являются его дочерними элементами в иерархии субъектов. Маршрутизаторы не используются совместно маршрутизаторами. Это идеально подходит для сценария первичной реплики, где каждый маршрутизатор является первичным и маршрутизирует реплики.

Это только верхушка айсберга, поэтому я предлагаю вам прочитать официальную документацию для получения дополнительных сведений.

Кластер для математических вычислений

Представим себе сценарий варианта использования. Предположим, разработать систему для выполнения математических вычислений по запросу. Система развернута в сети, поэтому для получения запросов вычислений ей необходим REST API. Внутренний процессор обрабатывает эти запросы, выполняя вычисления и возвращая результат.

Прямо сейчас процессор может вычислять только число Фибоначчи. Мы решили использовать кластер узлов для распределения нагрузки между узлами и повышения производительности. Akka Cluster будет обрабатывать динамику кластера и балансировку нагрузки между узлами. Окей, звучит хорошо!

Актерская иерархия

Перво-наперво: нам нужно определить нашу иерархию акторов. Систему можно разделить на три функциональные части: бизнес-логику , управление кластером и сам узел . Также есть сервер, но он не актер, и мы будем работать над ним позже.

Бизнес-логика

Приложение должно выполнять математические вычисления. Мы можем определить простой Processorсубъект для управления всеми вычислительными задачами. Каждое вычисление, которое мы поддерживаем, может быть реализовано в конкретном актере, который будет его потомком Processor. Таким образом, приложение является модульным, и его легче расширять и поддерживать. Сейчас единственным ребенком Processorбудет ProcessorFibonacciактер. Полагаю, вы догадались, в чем его задача. Этого должно хватить для начала.

Управление кластером

Для управления кластером нам понадобится ClusterManager. Звучит просто, правда? Этот субъект обрабатывает все, что связано с кластером, например, возвращает его участников по запросу. Было бы полезно регистрировать то, что происходит внутри кластера, поэтому мы определяем ClusterListenerактера. Это дочерний элемент ClusterManager, и он подписывается на события кластера, регистрируя их.

Узел

NodeАктер является корнем нашей иерархии. Это точка входа в нашу систему, которая взаимодействует с API. The Processorи the ClusterManagerявляются его детьми вместе с ProcessorRouterактером. Это балансировщик нагрузки системы, распределяющий нагрузку между Processors. Мы настроим его как кластерный маршрутизатор, чтобы каждый ProcessorRouterмог отправлять сообщения Processors на каждом узле.

Актер Реализация

Пора реализовывать наших актеров! Сначала мы реализуем акторов, связанных с бизнес-логикой системы. Затем мы переходим к акторам для управления кластером и, Nodeв конце концов, к корневому актору ( ).

ПроцессорFibonacci

Этот актер выполняет вычисление числа Фибоначчи. Он получает Computeсообщение, содержащее номер для вычисления и ссылку на актера, которому нужно ответить. Ссылка важна, так как могут быть разные запрашивающие субъекты. Помните, что мы работаем в распределенной среде!

Как только Computeсообщение получено, fibonacciфункция вычисляет результат. Мы оборачиваем его в ProcessorResponseобъект, чтобы предоставить информацию об узле, выполнившем вычисление. Это будет полезно позже, чтобы увидеть в действии циклическую политику.

Затем результат отправляется актеру, которому мы должны ответить. Очень просто.

object ProcessorFibonacci { sealed trait ProcessorFibonacciMessage case class Compute(n: Int, replyTo: ActorRef) extends ProcessorFibonacciMessage def props(nodeId: String) = Props(new ProcessorFibonacci(nodeId)) def fibonacci(x: Int): BigInt = { @tailrec def fibHelper(x: Int, prev: BigInt = 0, next: BigInt = 1): BigInt = x match { case 0 => prev case 1 => next case _ => fibHelper(x - 1, next, next + prev) } fibHelper(x) } } class ProcessorFibonacci(nodeId: String) extends Actor { import ProcessorFibonacci._ override def receive: Receive = { case Compute(value, replyTo) => { replyTo ! ProcessorResponse(nodeId, fibonacci(value)) } } }

Процессор

ProcessorАктер управляет конкретным суб-процессоры, как один Фибоначчи. Он должен создавать экземпляры подпроцессоров и пересылать им запросы. Сейчас у нас есть только один вспомогательный процессор, поэтому Processorполучает один вид сообщения: ComputeFibonacci. Это сообщение содержит число Фибоначчи для вычисления. После получения число для вычисления отправляется в a FibonacciProcessorвместе со ссылкой на sender().

object Processor { sealed trait ProcessorMessage case class ComputeFibonacci(n: Int) extends ProcessorMessage def props(nodeId: String) = Props(new Processor(nodeId)) } class Processor(nodeId: String) extends Actor { import Processor._ val fibonacciProcessor: ActorRef = context.actorOf(ProcessorFibonacci.props(nodeId), "fibonacci") override def receive: Receive = { case ComputeFibonacci(value) => { val replyTo = sender() fibonacciProcessor ! Compute(value, replyTo) } } }

ClusterListener

Мы хотели бы регистрировать полезную информацию о том, что происходит в кластере. Это может помочь нам отладить систему, если нам понадобится. В этом цель ClusterListenerактера. Перед запуском он подписывается на сообщения о событиях кластера. Актер реагирует на сообщения , как MemberUp, UnreachableMemberили MemberRemoved, войдя в соответствующее событие. Когда ClusterListenerон остановлен, он отписывается от событий кластера.

object ClusterListener { def props(nodeId: String, cluster: Cluster) = Props(new ClusterListener(nodeId, cluster)) } class ClusterListener(nodeId: String, cluster: Cluster) extends Actor with ActorLogging { override def preStart(): Unit = { cluster.subscribe(self, initialStateMode = InitialStateAsEvents, classOf[MemberEvent], classOf[UnreachableMember]) } override def postStop(): Unit = cluster.unsubscribe(self) def receive = { case MemberUp(member) => log.info("Node {} - Member is Up: {}", nodeId, member.address) case UnreachableMember(member) => log.info(s"Node {} - Member detected as unreachable: {}", nodeId, member) case MemberRemoved(member, previousStatus) => log.info(s"Node {} - Member is Removed: {} after {}", nodeId, member.address, previousStatus) case _: MemberEvent => // ignore } }

ClusterManager

Актером, ответственным за управление кластером, является ClusterManager. Он создает ClusterListenerсубъект и по запросу предоставляет список членов кластера. Его можно расширить, добавив больше функций, но сейчас этого достаточно.

object ClusterManager { sealed trait ClusterMessage case object GetMembers extends ClusterMessage def props(nodeId: String) = Props(new ClusterManager(nodeId)) } class ClusterManager(nodeId: String) extends Actor with ActorLogging { val cluster: Cluster = Cluster(context.system) val listener: ActorRef = context.actorOf(ClusterListener.props(nodeId, cluster), "clusterListener") override def receive: Receive = { case GetMembers => { sender() ! cluster.state.members.filter(_.status == MemberStatus.up) .map(_.address.toString) .toList } } }

Процессор Маршрутизатор

Балансировка нагрузки между процессорами осуществляется платформой ProcessorRouter. Он создается Nodeактером, но на этот раз вся необходимая информация предоставляется в конфигурации системы.

class Node(nodeId: String) extends Actor { //... val processorRouter: ActorRef = context.actorOf(FromConfig.props(Props.empty), "processorRouter") //... }

Давайте проанализируем соответствующую часть application.confфайла.

akka { actor { ... deployment { /node/processorRouter { router = round-robin-group routees.paths = ["/user/node/processor"] cluster { enabled = on allow-local-routees = on } } } } ... }

Первым делом нужно указать путь к субъекту маршрутизатора, то есть /node/processorRouter. Внутри этого свойства мы можем настроить поведение маршрутизатора:

  • router: это политика балансировки нагрузки сообщений. Я выбрал свое round-robin-group, но есть и другие.
  • routees.paths: these are the paths to the actors that will receive the messages handled by the router. We are saying: “When you receive a message, look for the actors corresponding to these paths. Choose one according to the policy and forward the message to it.” Since we are using Cluster Aware Routers, the routees can be on any node of the cluster.
  • cluster.enabled: are we operating in a cluster? The answer is on, of course!
  • cluster.allow-local-routees: here we are allowing the router to choose a routee in its node.

Using this configuration we can create a router to load balance the work among our processors.

Node

The root of our actor hierarchy is the Node. It creates the children actors — ClusterManager, Processor, and ProcessorRouter — and forwards the messages to the right one. Nothing complex here.

object Node { sealed trait NodeMessage case class GetFibonacci(n: Int) case object GetClusterMembers def props(nodeId: String) = Props(new Node(nodeId)) } class Node(nodeId: String) extends Actor { val processor: ActorRef = context.actorOf(Processor.props(nodeId), "processor") val processorRouter: ActorRef = context.actorOf(FromConfig.props(Props.empty), "processorRouter") val clusterManager: ActorRef = context.actorOf(ClusterManager.props(nodeId), "clusterManager") override def receive: Receive = { case GetClusterMembers => clusterManager forward GetMembers case GetFibonacci(value) => processorRouter forward ComputeFibonacci(value) } }

Server and API

Every node of our cluster runs a server able to receive requests. The Server creates our actor system and is configured through the application.conf file.

object Server extends App with NodeRoutes { implicit val system: ActorSystem = ActorSystem("cluster-playground") implicit val materializer: ActorMaterializer = ActorMaterializer() val config: Config = ConfigFactory.load() val address = config.getString("http.ip") val port = config.getInt("http.port") val nodeId = config.getString("clustering.ip") val node: ActorRef = system.actorOf(Node.props(nodeId), "node") lazy val routes: Route = healthRoute ~ statusRoutes ~ processRoutes Http().bindAndHandle(routes, address, port) println(s"Node $nodeId is listening at //$address:$port") Await.result(system.whenTerminated, Duration.Inf) }

Akka HTTP powers the server itself and the REST API, exposing three simple endpoints. These endpoints are defined in the NodeRoutes trait.

The first one is /health, to check the health of a node. It responds with a 200 OK if the node is up and running

lazy val healthRoute: Route = pathPrefix("health") { concat( pathEnd { concat( get { complete(StatusCodes.OK) } ) } ) }

The /status/members endpoint responds with the current active members of the cluster.

lazy val statusRoutes: Route = pathPrefix("status") { concat( pathPrefix("members") { concat( pathEnd { concat( get { val membersFuture: Future[List[String]] = (node ? GetClusterMembers).mapTo[List[String]] onSuccess(membersFuture) { members => complete(StatusCodes.OK, members) } } ) } ) } ) }

The last (but not the least) is the /process/fibonacci/n endpoint, used to request the Fibonacci number of n.

lazy val processRoutes: Route = pathPrefix("process") { concat( pathPrefix("fibonacci") { concat( path(IntNumber) { n => pathEnd { concat( get { val processFuture: Future[ProcessorResponse] = (node ? GetFibonacci(n)).mapTo[ProcessorResponse] onSuccess(processFuture) { response => complete(StatusCodes.OK, response) } } ) } } ) } ) }

It responds with a ProcessorResponse containing the result, along with the id of the node where the computation took place.

Cluster Configuration

Once we have all our actors, we need to configure the system to run as a cluster! The application.conf file is where the magic takes place. I’m going to split it in pieces to present it better, but you can find the complete file here.

Let’s start defining some useful variables.

clustering { ip = "127.0.0.1" ip = ${?CLUSTER_IP} port = 2552 port = ${?CLUSTER_PORT} seed-ip = "127.0.0.1" seed-ip = ${?CLUSTER_SEED_IP} seed-port = 2552 seed-port = ${?CLUSTER_SEED_PORT} cluster.name = "cluster-playground" }

Here we are simply defining the ip and port of the nodes and the seed, as well as the cluster name. We set a default value, then we override it if a new one is specified. The configuration of the cluster is the following.

akka { actor { provider = "cluster" ... /* router configuration */ ... } remote { log-remote-lifecycle-events = on netty.tcp { hostname = ${clustering.ip} port = ${clustering.port} } } cluster { seed-nodes = [ "akka.tcp://"${clustering.cluster.name}"@"${clustering.seed-ip}":"${clustering.seed-port} ] auto-down-unreachable-after = 10s } } ... /* server vars */ ... /* cluster vars */ }

Akka Cluster is build on top of Akka Remoting, so we need to configure it properly. First of all, we specify that we are going to use Akka Cluster saying that provider = "cluster". Then we bind cluster.ip and cluster.port to the hostname and port of the netty web framework.

The cluster requires some seed nodes as its entry points. We set them in the seed-nodes array, in the format akka.tcp://"{clustering.cluster.name}"@"{clustering.seed-ip}":”${clustering.seed-port}”. Right now we have one seed node, but we may add more later.

The auto-down-unreachable-after property sets a member as down after it is unreachable for a period of time. This should be used only during development, as explained in the official documentation.

Ok, the cluster is configured, we can move to the next step: Dockerization and deployment!

Dockerization and deployment

To create the Docker container of our node we can use sbt-native-packager. Its installation is easy: add addSbtPlugin("com.typesafe.sbt" % "sbt-native-packager" % "1.3.15") to the plugin.sbt file in the project/ folder. This amazing tool has a plugin for the creation of Docker containers. it allows us to configure the properties of our Dockerfile in the build.sbt file.

// other build.sbt properties enablePlugins(JavaAppPackaging) enablePlugins(DockerPlugin) enablePlugins(AshScriptPlugin) mainClass in Compile := Some("com.elleflorio.cluster.playground.Server") dockerBaseImage := "java:8-jre-alpine" version in Docker := "latest" dockerExposedPorts := Seq(8000) dockerRepository := Some("elleflorio")

Once we have setup the plugin, we can create the docker image running the command sbt docker:publishLocal. Run the command and taste the magic… ?

We have the Docker image of our node, now we need to deploy it and check that everything works fine. The easiest way is to create a docker-compose file that will spawn a seed and a couple of other nodes.

version: '3.5' networks: cluster-network: services: seed: networks: - cluster-network image: elleflorio/akka-cluster-playground ports: - '2552:2552' - '8000:8000' environment: SERVER_IP: 0.0.0.0 CLUSTER_IP: seed CLUSTER_SEED_IP: seed node1: networks: - cluster-network image: elleflorio/akka-cluster-playground ports: - '8001:8000' environment: SERVER_IP: 0.0.0.0 CLUSTER_IP: node1 CLUSTER_PORT: 1600 CLUSTER_SEED_IP: seed CLUSTER_SEED_PORT: 2552 node2: networks: - cluster-network image: elleflorio/akka-cluster-playground ports: - '8002:8000' environment: SERVER_IP: 0.0.0.0 CLUSTER_IP: node2 CLUSTER_PORT: 1600 CLUSTER_SEED_IP: seed CLUSTER_SEED_PORT: 2552

I won’t spend time going through it, since it is quite simple.

Let’s run it!

Time to test our work! Once we run the docker-compose up command, we will have a cluster of three nodes up and running. The seed will respond to requests at port :8000, while node1 and node2 at port :8001 and :8002. Play a bit with the various endpoints. You will see that the requests for a Fibonacci number will be computed by a different node each time, following a round-robin policy. That’s good, we are proud of our work and can get out for a beer to celebrate! ?

Conclusion

We are done here! We learned a lot of things in these ten minutes:

  • What Akka Cluster is and what can do for us.
  • How to create a distributed application with it.
  • How to configure a Group Router for load-balancing in the cluster.
  • How to Dockerize everything and deploy it using docker-compose.

You can find the complete application in my GitHub repo. Feel free to contribute or play with it as you like! ?

See you! ?