Akka.Remote Commands

The Akka.Remote commands supported by Petabridge.Cmd.Host can be added to your Petabridge.Cmd.Host installation by installing the Petabridge.Cmd.Remote NuGet package:

PM> Install-Package Petabridge.Cmd.Remote 

And then inside your Akka.NET application, you can simply register the remotecommands command palette with your ActorSystem using the following syntax:

var cmd = PetabridgeCmd.Get(aNode);
cmd.RegisterCommandPalette(RemoteCommands.Instance);
cmd.Start();

Working with Petabridge.Cmd.Remote

To get the best use of the remote commands you will need to setup the host on the node you would like to monitor. To be able to use these commands your node will need to be connected to other nodes using Akka.Remote or Akka.Cluster. You can run this on multiple nodes if you would like to monitor the connection for each node separately.

Available Commands

Command Name	Description
remote stats	Lists the number of Associated and Disassociated events seen by the node.
remote connections	List all of the active connections to this particular node.
remote tail	Similar to the log tail command, remote tail writes all of the connection and disconnection events out to the console until stopped via Control + C.
remote history	Shows the connection events witnessed by the node. Can show up to 1,000 events.

remote stats

remote stats can help get an understanding of the status of the system. Running this command will provide the number of associations and disassociation events seen by the host node.

remote stats doesn't take any command line arguments.

Examples

pbm remote stats

remote connections

remote connections can be used to see all of the current connections to the host node. Running this command will show all of the active host connections in a list form.

remote connections doesn't take any command line arguments.

Examples

pbm remote connections

remote tail

remote tail will print out all of the connection events with the remote host out to the console. You can limit the scope to a single node if you would only like to follow one nodes connection. The event stream can be terminated through Control + C.

remote tail takes the following optional argument:

Argument Name	Switches	Mandatory?	Allow Multiple?	Is Flag?	Description
remote host	-h or -H	no	no	no	The remote host node that needs to be tracked.

 

Examples

Tracks the connection information for a specific remote host.

pbm remote tail -h 127.0.0.1

Track all of the remote host connections

pbm remote tail

remote history

remote history can be used to list the history of connection events for all nodes connected to the host node or the history for a specific remote host. remote history can save up to 1,000 events, if more than 1,000 events are seen only the newest 1,000 events will be saved. You can limit your history search by selecting a remote host you would like to see the history for or providing a time frame you would like to look back.

remote history takes the following arguments:

Argument Name	Switches	Mandatory?	Allow Multiple?	Is Flag?	Description
remote address	-h or -H	no	no	no	The remote host of the node that we want to see a history for.
time	-t or -T	no	no	no	The time frame we want to gather connection information for. Can be specified with the following units: seconds(s), minutes(m) or hours(h).

 

Examples

To list all of the connection history for all of the remote nodes.

pbm remote history

To list the past 5 minutes of connection history for all of the remote nodes.

pbm remote history -t 5m

To list the past hour of connection history for the specified host.

pbm remote history -t 1h -h 127.0.0.1