api naming

Author: sebastian-alfers

akka-cluster-sharding/src/main/scala/akka/cluster/sharding/ShardCoordinator.scala

@@ -648,7 +648,7 @@ object ShardCoordinator {
     private val instrumentation = ClusterShardingInstrumentationProvider.get(context.system).instrumentation
     private val cluster = Cluster(context.system)
 
-    instrumentation.beginShardHandoff(cluster.selfAddress, self, typeName, shard)
+    instrumentation.onBeginShardHandoff(cluster.selfAddress, self, typeName, shard)
 
     regions.foreach { region =>
       region ! BeginHandOff(shard)
@@ -713,7 +713,7 @@ object ShardCoordinator {
     }
 
     def done(ok: Boolean): Unit = {
-      instrumentation.finishedShardHandoff(cluster.selfAddress, self, typeName, shard, ok)
+      instrumentation.onFinishedShardHandoff(cluster.selfAddress, self, typeName, shard, ok)
       context.parent ! RebalanceDone(shard, ok)
       context.stop(self)
     }

akka-cluster-sharding/src/main/scala/akka/cluster/sharding/internal/ClusterShardingInstrumentation.scala

@@ -94,20 +94,20 @@ class ClusterShardingTelemetryEnsemble(val instrumentations: Seq[ClusterSharding
       typeName: String): Unit =
     instrumentations.foreach(_.incrementShardRegionBufferSize(selfAddress, shardRegionActor, typeName))
 
-  override def beginShardHandoff(
+  override def onBeginShardHandoff(
       selfAddress: Address,
       shardCoordinatorActor: ActorRef,
       typeName: String,
       shard: String): Unit =
-    instrumentations.foreach(_.beginShardHandoff(selfAddress, shardCoordinatorActor, typeName, shard))
+    instrumentations.foreach(_.onBeginShardHandoff(selfAddress, shardCoordinatorActor, typeName, shard))
 
-  override def finishedShardHandoff(
+  override def onFinishedShardHandoff(
       selfAddress: Address,
       shardCoordinatorActor: ActorRef,
       typeName: String,
       shard: String,
       ok: Boolean): Unit =
-    instrumentations.foreach(_.finishedShardHandoff(selfAddress, shardCoordinatorActor, typeName, shard, ok))
+    instrumentations.foreach(_.onFinishedShardHandoff(selfAddress, shardCoordinatorActor, typeName, shard, ok))
 
   override def dependencies: immutable.Seq[String] =
     instrumentations.flatMap(_.dependencies)
@@ -136,13 +136,13 @@ class EmptyClusterShardingInstrumentation extends ClusterShardingInstrumentation
       shardRegionActor: ActorRef,
       typeName: String): Unit = ()
 
-  override def beginShardHandoff(
+  override def onBeginShardHandoff(
       selfAddress: Address,
       shardRegionActor: ActorRef,
       typeName: String,
       shard: String): Unit = ()
 
-  override def finishedShardHandoff(
+  override def onFinishedShardHandoff(
       selfAddress: Address,
       self: ActorRef,
       typeName: String,
@@ -168,9 +168,26 @@ trait ClusterShardingInstrumentation {
    */
   def incrementShardRegionBufferSize(selfAddress: Address, shardRegionActor: ActorRef, typeName: String): Unit
 
-  def beginShardHandoff(selfAddress: Address, shardCoordinatorActor: ActorRef, typeName: String, shard: String): Unit
+  /**
+   * Triggered when a shard handoff is initiated.
+   *
+   * @param selfAddress
+   * @param shardCoordinatorActor
+   * @param typeName
+   * @param shard
+   */
+  def onBeginShardHandoff(selfAddress: Address, shardCoordinatorActor: ActorRef, typeName: String, shard: String): Unit
 
-  def finishedShardHandoff(
+  /**
+   * Triggered when a shard handoff is finished.
+   *
+   * @param selfAddress
+   * @param shardCoordinatorActor
+   * @param typeName
+   * @param shard
+   * @param ok
+   */
+  def onFinishedShardHandoff(
       selfAddress: Address,
       shardCoordinatorActor: ActorRef,
       typeName: String,

akka-cluster-sharding/src/multi-jvm/scala/akka/cluster/sharding/ClusterShardingInstrumentationSpecTelemetry.scala

@@ -35,13 +35,13 @@ class ClusterShardingInstrumentationSpecTelemetry(@nowarn("msg=never used") syst
     shardRegionBufferSizeCounter.incrementAndGet()
   }
 
-  override def beginShardHandoff(
+  override def onBeginShardHandoff(
       selfAddress: Address,
       shardCoordinatorActor: ActorRef,
       typeName: String,
       shard: String): Unit = beginShardHandoffDurationCounter.incrementAndGet()
 
-  override def finishedShardHandoff(
+  override def onFinishedShardHandoff(
       selfAddress: Address,
       shardCoordinatorActor: ActorRef,
       typeName: String,

akka-cluster-sharding/src/multi-jvm/scala/akka/cluster/sharding/RollingUpdateShardAllocationSpec.scala

@@ -30,7 +30,7 @@ object RollingUpdateShardAllocationSpecConfig
         akka.coordinated-shutdown.terminate-actor-system = off
         # use the new LeastShardAllocationStrategy
         akka.cluster.sharding.least-shard-allocation-strategy.rebalance-absolute-limit = 1
-        # to test shard handoff latency telemetry
+        # to test shard handoff instrumentation
         telemetry.instrumentations += akka.cluster.sharding.ClusterShardingInstrumentationSpecTelemetry
       }
      """) {
@@ -235,7 +235,7 @@ abstract class RollingUpdateShardAllocationSpec
 
         beginShardHandoffDurationCounter.get() shouldBe finishShardHandoffDurationCounter.get()
       }
-      enterBarrier("shard-handoff-latency")
+      enterBarrier("shard-handoff-telemetry")
     }
   }
 }