Make actor start / stop telemetry descriptors overrideable (#7434)

Designed to support petabridge/phobos-issues#82
akkadotnet · Dec 23, 2024 · 0a01453 · 0a01453
1 parent 61bdebf
commit 0a01453
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 2 deletions.
diff --git a/src/core/Akka.API.Tests/verify/CoreAPISpec.ApproveCore.DotNet.verified.txt b/src/core/Akka.API.Tests/verify/CoreAPISpec.ApproveCore.DotNet.verified.txt
@@ -94,6 +94,8 @@ namespace Akka.Actor
         public void CheckReceiveTimeout(bool reschedule = True) { }
         protected void ClearActor(Akka.Actor.ActorBase actor) { }
         protected void ClearActorCell() { }
+        protected virtual Akka.Actor.ActorStarted CreateActorStartedEvent() { }
+        protected virtual Akka.Actor.ActorStopped CreateActorStoppedEvent() { }
         protected virtual Akka.Actor.ActorBase CreateNewActorInstance() { }
         [System.ObsoleteAttribute("Use TryGetChildStatsByName [0.7.1]", true)]
         public Akka.Actor.IInternalActorRef GetChildByName(string name) { }

diff --git a/src/core/Akka.API.Tests/verify/CoreAPISpec.ApproveCore.Net.verified.txt b/src/core/Akka.API.Tests/verify/CoreAPISpec.ApproveCore.Net.verified.txt
@@ -94,6 +94,8 @@ namespace Akka.Actor
         public void CheckReceiveTimeout(bool reschedule = True) { }
         protected void ClearActor(Akka.Actor.ActorBase actor) { }
         protected void ClearActorCell() { }
+        protected virtual Akka.Actor.ActorStarted CreateActorStartedEvent() { }
+        protected virtual Akka.Actor.ActorStopped CreateActorStoppedEvent() { }
         protected virtual Akka.Actor.ActorBase CreateNewActorInstance() { }
         [System.ObsoleteAttribute("Use TryGetChildStatsByName [0.7.1]", true)]
         public Akka.Actor.IInternalActorRef GetChildByName(string name) { }

diff --git a/src/core/Akka/Actor/ActorCell.DefaultMessages.cs b/src/core/Akka/Actor/ActorCell.DefaultMessages.cs
@@ -429,6 +429,22 @@ public void Restart(Exception cause)
             SendSystemMessage(new Recreate(cause));
         }
 
+        /// <summary>
+        /// Overrideable in order to support issues such as https://github.com/petabridge/phobos-issues/issues/82
+        /// </summary>
+        protected virtual ActorStarted CreateActorStartedEvent()
+        {
+            return new ActorStarted(Self, Props.Type);
+        }
+
+        /// <summary>
+        /// Overrideable in order to support issues such as https://github.com/petabridge/phobos-issues/issues/82
+        /// </summary>
+        protected virtual ActorStopped CreateActorStoppedEvent()
+        {
+            return new ActorStopped(Self, Props.Type);
+        }
+
         private void Create(Exception failure)
         {
             if (failure != null)
@@ -442,7 +458,7 @@ private void Create(Exception failure)
                 if (System.Settings.DebugLifecycle)
                     Publish(new Debug(Self.Path.ToString(), created.GetType(), "Started (" + created + ")"));
                 if(System.Settings.EmitActorTelemetry)
-                    System.EventStream.Publish(new ActorStarted(Self, Props.Type));
+                    System.EventStream.Publish(CreateActorStartedEvent());
             }
             catch (Exception e)
             {

diff --git a/src/core/Akka/Actor/ActorCell.FaultHandling.cs b/src/core/Akka/Actor/ActorCell.FaultHandling.cs
@@ -290,7 +290,7 @@ private void FinishTerminate()
                 }
 
                 if(System.Settings.EmitActorTelemetry)
-                    System.EventStream.Publish(new ActorStopped(Self, Props.Type));
+                    System.EventStream.Publish(CreateActorStoppedEvent());
             }
             catch (Exception x)
             {