ZIO Akka Cluster

The ZIO Akka Cluster library is a ZIO wrapper on Akka Cluster. We can use clustering features of the Akka toolkit without the need to use the actor model.

Production Ready CI Badge Sonatype Releases Sonatype Snapshots javadoc ZIO Akka Cluster


This library provides us following features:

  • Akka Cluster — This feature contains two Akka Cluster Membership operations called join and leave and also it has some methods to retrieve Cluster State and Cluster Events.

  • Akka Distributed PubSub — Akka has a Distributed Publish Subscribe facility in the cluster. It helps us to send a message to all actors in the cluster that have registered and subscribed for a specific topic name without knowing their physical address or without knowing which node they are running on.

  • Akka Cluster Sharding — Cluster sharding is useful when we need to distribute actors across several nodes in the cluster and want to be able to interact with them using their logical identifier without having to care about their physical location in the cluster, which might also change over time. When we have many stateful entities in our application that together they consume more resources (e.g. memory) than fit on one machine, it is useful to use Akka Cluster Sharding to distribute our entities to multiple nodes.


In order to use this library, we need to add the following line in our build.sbt file:

libraryDependencies += "dev.zio" %% "zio-akka-cluster" % "0.3.0"


In the following example, we are using all these three features. We have a distributed counter application that lives in the Akka Cluster using Akka Cluster Sharding feature. So the location of LiveUsers and TotalRequests entities in the cluster is transparent for us. We send the result of each entity to the Distributed PubSub. So every node in the cluster can subscribe and listen to those results. Also, we have created a fiber that is subscribed to the cluster events. All the new events will be logged to the console:

import akka.actor.ActorSystem
import com.typesafe.config.{ Config, ConfigFactory }
import zio._
import zio.akka.cluster.Cluster
import zio.akka.cluster.sharding.{ Entity, Sharding }

sealed trait Counter extends Product with Serializable
case object Inc      extends Counter
case object Dec      extends Counter

case class CounterApp(port: String) {
  val config: Config =
                                 |akka {
                                 |  actor {
                                 |    provider = "cluster"
                                 |  }
                                 |  remote {
                                 |    netty.tcp {
                                 |      hostname = ""
                                 |      port = $port
                                 |    }
                                 |  }
                                 |  cluster {
                                 |    seed-nodes = ["akka.tcp://[email protected]:2551"]
                                 |  }

  val actorSystem: ZLayer[Any, Nothing, ActorSystem] =
      ZIO.acquireRelease(ZIO.succeed(ActorSystem("CounterApp", config)))(sys =>
        ZIO.fromFuture(_ => sys.terminate()).either

  val counterApp: ZIO[Scope, Throwable, Unit] =
    (for {
      queue              <- Cluster.clusterEvents(true)
      pubsub             <- zio.akka.cluster.pubsub.PubSub.createPubSub[Int]
      liveUsersLogger    <- pubsub
          _.take.tap(u => Console.printLine(s"Number of live users: $u")).forever
      totalRequestLogger <- pubsub
          _.take.tap(r => Console.printLine(s"Total request until now: $r")).forever

      clusterEvents      <- queue.take
        .tap(x => Console.printLine("New event in cluster: " + x.toString))

      counterEntityLogic  = (c: Counter) =>
        for {
          entity   <- ZIO.environment[Entity[Int]]
          newState <- c match {
            case Inc =>
              entity.get.state.updateAndGet(s => Some(s.getOrElse(0) + 1))
            case Dec =>
              entity.get.state.updateAndGet(s => Some(s.getOrElse(0) - 1))
          _        <- pubsub.publish(entity.get.id, newState.getOrElse(0)).orDie
        } yield ()
      cluster            <- Sharding.start("CounterEntity", counterEntityLogic)

      _ <- cluster.send("LiveUsers", Inc)
      _ <- cluster.send("TotalRequests", Inc)
      _ <- cluster.send("LiveUsers", Dec)
      _ <- cluster.send("LiveUsers", Inc)
      _ <- cluster.send("LiveUsers", Inc)
      _ <- cluster.send("TotalRequests", Inc)
      _ <- cluster.send("TotalRequests", Inc)

      _ <- clusterEvents.join zipPar liveUsersLogger.join zipPar totalRequestLogger.join
    } yield ()).provide(actorSystem)

Now, let's create a cluster comprising two nodes:

object CounterApp1 extends ZIOAppDefault {
  override def run = CounterApp("2551").counterApp

object CounterApp2 extends ZIOAppDefault {
  override def run = CounterApp("2552").counterApp


Learn more on the ZIO Akka Cluster homepage!


For the general guidelines, see ZIO contributor's guide.

Code of Conduct

See the Code of Conduct


Come chat with us on Badge-Discord.