Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make actor start / stop telemetry descriptors overrideable #7434

Merged
merged 1 commit into from
Dec 23, 2024
Merged

Make actor start / stop telemetry descriptors overrideable #7434

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/core/Akka.API.Tests/verify/CoreAPISpec.ApproveCore.DotNet.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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() { }
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Part of the public API but only gets access by components that use custom ActorCells, which are rare

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) { }
Expand Down
2 changes: 2 additions & 0 deletions src/core/Akka.API.Tests/verify/CoreAPISpec.ApproveCore.Net.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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) { }
Expand Down
18 changes: 17 additions & 1 deletion src/core/Akka/Actor/ActorCell.DefaultMessages.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Going to customize these events mostly to support F# users, since Akkling actors all use the same base type, this should make them easier to distinguish in Phobos traces and metrics in the future.

{
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)
Expand All @@ -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)
{
Expand Down
2 changes: 1 addition & 1 deletion src/core/Akka/Actor/ActorCell.FaultHandling.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
{
Expand Down
Loading