chinnurtb / entop

A top-like tool for monitoring an Erlang node

entop

A top-like Erlang node monitoring tool

Introduction

Entop is a tool which shows information about a remote Erlang node in a way which is similar to unix 'top'.

For entop to run it needs cecho 0.3.0 or higher for pre-R15 or cecho 0.4.0 or higher for R15 and above (http://www.github.com/mazenharake/cecho).

Compile

To clean/compile run

./rebar clean
./rebar compile

NOTE: If you have problems with dependencies to cecho then create a symlink to cecho in deps/ (if you already have cecho somewhere) or run ./rebar get-deps to download the latest version. Don't forget to recompile if you get the dependencies through rebar.

Usage

To run entop make sure you have Erlang installed and that the cecho library (http://www.github.com/mazenharake/cecho) is available in your Erlang code path. The start script assumes that you run it inside the entop application root directory, if you don't want that then change the paths in the scripts accordingly or just make sure you have the ebin/ directory for entop in your Erlang code path. Look at the start script for more details.

Usage: ./entop <TARGETNODE> [-name <NAME>|-sname <SNAME>] [-setcookie <COOKIE>]

An example of how you run entop:

> ./entop [email protected] -name [email protected] -setcookie secret

User Interface:

entop's interface can be customized so this section only applies for the "built-in" interface.

Headers

First row shows information about the node which is more or less static such as the node name the operating system, erl flags and erlang version it is running.
The second row shows information on what the local time is (according to the node), how long it has been up for (Days:Hours:Minutes:Seconds) and how much latency there is to the node I.e. how long a net_adm:ping() takes.
Third row shows information about the processes of the system; the total number of processes, the run queue (number of processes scheduled to run by the scheduler(s)), the reductions per interval (RpI) which shows how many reductions the system has made since it last called the node and how much memory the processes are using.
Fourth row shows how much system memory, atom memory (currently used/total allocated), binary memory, code memory and ets memory.
Fifth row is left blank and is reserved for now.
Sixth row shows information about the rows in the list such as the interval in which the information is fetched, what the list is sorted on and how long it took to retrieve the information.

Commands when running entop:

[1-N]: Sort on column number 1 through N. Starts with first column (1) and up to N where N is the last column.

r: Toggles the sorting order from ascending to descending and vice versa.

q: Quits entop and return to the shell.

Ctrl-C: Same as 'q'.

'<' and '>': Moves the sorting column to the left or right respectively (these are the lower/greater-than-tags; not arrow keys).

Contribute

Should you find yourself using entop and have issues, comments or feedback please [create an issue!] 1