2002 2013 Ericsson AB, All Rights Reserved The contents of this file are subject to the Erlang Public License, Version 1.1, (the "License"); you may not use this file except in compliance with the License. You should have received a copy of the Erlang Public License along with this software. If not, it can be retrieved online at http://www.erlang.org/. Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License. The Initial Developer of the Original Code is Ericsson AB. etop Siri hansen
etop Erlang Top is a tool for presenting information about erlang processes similar to the information presented by "top" in UNIX.

etop should be started with the provided scripts etop. This will start a hidden erlang node which connects to the node to be measured. The measured node is given with the -node option. If the measured node has a different cookie than the default cookie for the user who invokes the script, the cookie must be explicitly given witht the -setcookie option.

Under Windows the batch file etop.bat can be used.

The following configuration parameters exist for the etop tool. When executing the etop script, these parameters can be given as command line options, e.g. etop -node testnode@myhost -setcookie MyCookie.

node The measured node.

Value: atom()

Mandatory setcookie Cookie to use for the etop node - must be the same as the cookie on the measured node.

Value: atom() lines Number of lines (processes) to display.

Value: integer()

Default: 10 interval The time interval (in seconds) between each update of the display.

Value: integer()

Default: 5 accumulate If true the execution time and reductions are accumulated.

Value: boolean()

Default: false sort Identifies what information to sort by.

Value: runtime | reductions | memory | msg_q

Default: runtime (reductions if tracing=off) tracing etop uses the erlang trace facility, and thus no other tracing is possible on the measured node while etop is running, unless this option is set to off. Also helpful if the etop tracing causes too high load on the measured node. With tracing off, runtime is not measured.

Value: on | off

Default: on

See the user's guide for more information about the etop tool.

 start() -> ok Start etop

This function starts etop. Note that etop is preferably started with the etop script.

 start(Options) -> ok Start etop Options = [Option] Option = {Key, Value} Key = atom() Value = term()

This function starts etop. Use help/0 to see a description of the possible options.

 help() -> ok Print etop's help

This function prints the help of etop and its options.

 config(Key,Value) -> Result Change tool's configuration Result = ok | {error,Reason} Key = lines | interval | accumulate | sort Value = term()

This function is used to change the tool's configuration parameters during runtime. The table above indicates the allowed values for each parameter.

 dump(File) -> Result Dump the current display to a file. Result = ok | {error,Reason} File = string()

This function dumps the current display to a text file.

 stop() -> stop Terminate etop

This function terminates etop.