วิธีสร้างแอปพลิเคชันง่ายๆด้วย Akka Cluster

หากคุณอ่านเรื่องราวก่อนหน้าของฉันเกี่ยวกับ Scalachain คุณอาจสังเกตเห็นว่ามันยังห่างไกลจากการเป็นระบบกระจาย ไม่มีคุณสมบัติทั้งหมดที่จะทำงานร่วมกับโหนดอื่น ๆ ได้อย่างถูกต้อง เพิ่มเติมว่า blockchain ที่ประกอบด้วยโหนดเดียวนั้นไร้ประโยชน์ ด้วยเหตุนี้ฉันจึงตัดสินใจว่าถึงเวลาที่ต้องแก้ไขปัญหานี้

เนื่องจาก Scalachain ขับเคลื่อนโดย Akka ทำไมไม่ลองใช้โอกาสนี้ในการเล่นกับ Akka Cluster? ฉันสร้างโปรเจ็กต์ง่ายๆเพื่อคนจรจัดกับ Akka Cluster และในเรื่องนี้ฉันจะแบ่งปันสิ่งที่ฉันเรียนรู้ เรากำลังจะสร้างคลัสเตอร์ของสามโหนดโดยใช้ Cluster Aware Routers เพื่อปรับสมดุลของโหลดระหว่างกัน ทุกอย่างจะทำงานใน Docker container และเราจะใช้ docker-compose เพื่อให้ใช้งานได้ง่าย

โอเคเริ่มกันเลย! เหรอ?

ข้อมูลเบื้องต้นเกี่ยวกับ Akka Cluster

Akka Cluster ให้การสนับสนุนที่ดีเยี่ยมในการสร้างแอปพลิเคชันแบบกระจาย กรณีการใช้งานที่ดีที่สุดคือเมื่อคุณมีโหนดที่คุณต้องการจำลอง N ครั้งในสภาพแวดล้อมแบบกระจาย ซึ่งหมายความว่าโหนดทั้งหมดเป็นเพียร์ที่ใช้รหัสเดียวกัน Akka Cluster ช่วยให้คุณค้นพบสมาชิกในคลัสเตอร์เดียวกันได้ทันที การใช้เราเตอร์ Cluster Aware ทำให้สามารถปรับสมดุลของข้อความระหว่างนักแสดงในโหนดต่างๆ นอกจากนี้ยังเป็นไปได้ที่จะเลือกนโยบายการปรับสมดุลการทำเค้กให้สมดุล!

จริงๆแล้วคุณสามารถเลือกระหว่างเราเตอร์สองประเภท:

Group Router - ตัวแสดงที่จะส่งข้อความไปยัง - เรียกว่า Routes - ระบุโดยใช้เส้นทางนักแสดงของพวกเขา เราเตอร์แบ่งใช้เราเตอร์ที่สร้างขึ้นในคลัสเตอร์ เราจะใช้ Group Router ในตัวอย่างนี้

Pool Router - เราเตอร์สร้างและปรับใช้เราเตอร์ดังนั้นพวกเขาจึงเป็นลูกของมันในลำดับชั้นของนักแสดง จะไม่มีการแชร์เส้นทางระหว่างเราเตอร์ สิ่งนี้เหมาะอย่างยิ่งสำหรับสถานการณ์จำลองหลักโดยที่เราเตอร์แต่ละตัวเป็นตัวหลักและกำหนดเส้นทางของตัวจำลอง

นี่เป็นเพียงส่วนเล็ก ๆ ของภูเขาน้ำแข็งดังนั้นฉันขอเชิญคุณอ่านเอกสารอย่างเป็นทางการเพื่อรับข้อมูลเชิงลึกเพิ่มเติม

คลัสเตอร์สำหรับการคำนวณทางคณิตศาสตร์

ลองนึกภาพสถานการณ์การใช้งาน สมมติว่าออกแบบระบบเพื่อดำเนินการคำนวณทางคณิตศาสตร์ตามคำขอ ระบบถูกปรับใช้แบบออนไลน์ดังนั้นจึงต้องใช้ REST API เพื่อรับคำขอการคำนวณ โปรเซสเซอร์ภายในจะจัดการกับคำร้องขอเหล่านี้ดำเนินการคำนวณและส่งคืนผลลัพธ์

ตอนนี้โปรเซสเซอร์สามารถคำนวณได้เฉพาะหมายเลขฟีโบนักชี เราตัดสินใจใช้คลัสเตอร์ของโหนดเพื่อกระจายโหลดระหว่างโหนดและปรับปรุงประสิทธิภาพ Akka Cluster จะจัดการพลศาสตร์คลัสเตอร์และการทำโหลดบาลานซ์ระหว่างโหนด โอเคฟังดูดี!

ลำดับชั้นของนักแสดง

สิ่งแรกอันดับแรกเราต้องกำหนดลำดับชั้นนักแสดงของเรา ระบบสามารถแบ่งออกเป็นสามส่วนการทำงาน: ตรรกะทางธุรกิจการจัดการคลัสเตอร์และโหนดเอง นอกจากนี้ยังมีเซิร์ฟเวอร์แต่ไม่ใช่นักแสดงและเราจะดำเนินการในภายหลัง

ตรรกะทางธุรกิจ

แอปพลิเคชันควรทำการคำนวณทางคณิตศาสตร์ เราสามารถกำหนดProcessorนักแสดงที่เรียบง่ายเพื่อจัดการงานด้านการคำนวณทั้งหมด การคำนวณทุกอย่างที่เราสนับสนุนสามารถนำไปใช้กับนักแสดงที่เฉพาะเจาะจงซึ่งจะเป็นลูกของProcessorคน ๆ ด้วยวิธีนี้แอปพลิเคชันเป็นแบบแยกส่วนและง่ายต่อการขยายและบำรุงรักษา ตอนนี้ลูกคนเดียวของProcessorจะเป็นProcessorFibonacciนักแสดง ฉันคิดว่าคุณคงเดาได้ว่างานของมันคืออะไร นี่น่าจะเพียงพอสำหรับการเริ่มต้น

การจัดการคลัสเตอร์

ในการจัดการคลัสเตอร์เราจำเป็นต้องมีClusterManager. ฟังดูง่ายใช่มั้ย? นักแสดงคนนี้จัดการทุกอย่างที่เกี่ยวข้องกับคลัสเตอร์เช่นส่งคืนสมาชิกเมื่อถูกถาม การบันทึกสิ่งที่เกิดขึ้นภายในคลัสเตอร์จะเป็นประโยชน์ดังนั้นเราจึงกำหนดClusterListenerนักแสดง นี่เป็นลูกของClusterManagerและสมัครรับเหตุการณ์คลัสเตอร์ที่บันทึกไว้

โหนด

Nodeนักแสดงที่เป็นรากของลำดับชั้นของเรา เป็นจุดเริ่มต้นของระบบของเราที่สื่อสารกับ API ProcessorและClusterManagerเป็นลูกของตนพร้อมกับProcessorRouterนักแสดง นี่คือตัวจัดสรรภาระงานของระบบโดยกระจายภาระระหว่างProcessors เราจะกำหนดค่าเป็น Cluster Aware Router เพื่อให้ทุกคนProcessorRouterสามารถส่งข้อความถึงProcessors ได้ทุกโหนด

การดำเนินการของนักแสดง

ได้เวลาปรับใช้นักแสดงของเราแล้ว! กำปั้นเราใช้ตัวแสดงที่เกี่ยวข้องกับตรรกะทางธุรกิจของระบบ จากนั้นเราจะย้ายนักแสดงสำหรับการจัดการคลัสเตอร์และตัวแสดงรูท ( Node) ในตอนท้าย

โปรเซสเซอร์ Fibonacci

นักแสดงคนนี้ดำเนินการคำนวณหมายเลขฟีโบนักชี ได้รับComputeข้อความที่มีหมายเลขที่ต้องคำนวณและข้อมูลอ้างอิงของนักแสดงที่จะตอบกลับ การอ้างอิงมีความสำคัญเนื่องจากอาจมีผู้ร้องขอที่แตกต่างกัน โปรดจำไว้ว่าเรากำลังทำงานในสภาพแวดล้อมแบบกระจาย!

เมื่อComputeได้รับข้อความfibonacciฟังก์ชันจะคำนวณผลลัพธ์ เราห่อไว้ในProcessorResponseวัตถุเพื่อให้ข้อมูลเกี่ยวกับโหนดที่ดำเนินการคำนวณ ซึ่งจะเป็นประโยชน์ในภายหลังเพื่อดูนโยบาย Round-Robin ที่กำลังดำเนินการอยู่

จากนั้นผลลัพธ์จะถูกส่งไปยังนักแสดงที่เราควรตอบกลับ ง่าย peasy

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นักแสดงจัดการย่อยโปรเซสเซอร์ที่เฉพาะเจาะจงเช่น Fibonacci หนึ่ง ควรสร้างอินสแตนซ์โปรเซสเซอร์ย่อยและส่งต่อคำขอไปยังโปรเซสเซอร์เหล่านี้ ตอนนี้เรามีเพียงหนึ่งย่อยหน่วยประมวลผลเพื่อให้ได้รับหนึ่งในชนิดของข้อความ: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 } } }

โปรเซสเซอร์

The load-balancing among processors is handled by the ProcessorRouter. It is created by the Node actor, but this time all the required information are provided in the configuration of the system.

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

Let’s analyse the relevant part in the application.conf file.

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

The first thing is to specify the path to the router actor, that is /node/processorRouter. Inside that property we can configure the behaviour of the router:

  • router: this is the policy for the load balancing of messages. I chose the round-robin-group, but there are many others.
  • 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! ?