1etop(3)                    Erlang Module Definition                    etop(3)
2
3
4

NAME

6       etop - Erlang Top is a tool for presenting information about Erlang
7         processes similar to the information presented by "top" in UNIX.
8

DESCRIPTION

10       Start  Erlang  Top with the provided scripts etop. This starts a hidden
11       Erlang node that connects to the node to be measured. The measured node
12       is  specified  with  option -node. If the measured node has a different
13       cookie than the default cookie for the user who invokes the script, the
14       cookie must be explicitly specified with option -setcookie.
15
16       Under Windows, batch file etop.bat can be used.
17
18       When  executing the etop script, configuration parameters can be speci‐
19       fied as command-line options, for example, etop  -node  testnode@myhost
20       -setcookie  MyCookie.  The following configuration parameters exist for
21       the tool:
22
23         node:
24           The measured node.
25
26           Value: atom()
27
28           Mandatory
29
30         setcookie:
31           Cookie to use for the etop node. Must be same as the cookie on  the
32           measured node.
33
34           Value: atom()
35
36         lines:
37           Number of lines (processes) to display.
38
39           Value: integer()
40
41           Default: 10
42
43         interval:
44           Time interval (in seconds) between each update of the display.
45
46           Value: integer()
47
48           Default: 5
49
50         accumulate:
51           If true, the execution time and reductions are accumulated.
52
53           Value: boolean()
54
55           Default: false
56
57         sort:
58           Identifies what information to sort by.
59
60           Value: runtime | reductions | memory | msg_q
61
62           Default: runtime (reductions if tracing=off)
63
64         tracing:
65           etop  uses  the Erlang trace facility, and thus no other tracing is
66           possible on the measured node while etop is  running,  unless  this
67           option  is  set to off. Also helpful if the etop tracing causes too
68           high load on the measured node. With tracing off,  runtime  is  not
69           measured.
70
71           Value: on | off
72
73           Default: on
74
75       For details about Erlang Top, see the User's Guide.
76

EXPORTS

78       start() -> ok
79
80              Starts  etop.  Notice  that  etop is preferably started with the
81              etop script.
82
83       start(Options) -> ok
84
85              Types:
86
87                 Options = [Option]
88                 Option = {Key, Value}
89                 Key = atom()
90                 Value = term()
91
92              Starts etop. To view the possible options, use help/0.
93
94       help() -> ok
95
96              Displays the help of etop and its options.
97
98       config(Key,Value) -> Result
99
100              Types:
101
102                 Result = ok | {error,Reason}
103                 Key = lines | interval | accumulate | sort
104                 Value = term()
105
106              Changes the configuration parameters of the tool during runtime.
107              Allowed parameters are lines, interval, accumulate, and sort.
108
109       dump(File) -> Result
110
111              Types:
112
113                 Result = ok | {error,Reason}
114                 File = string()
115
116              Dumps the current display to a text file.
117
118       stop() -> stop
119
120              Terminates etop.
121
122
123
124Ericsson AB                     observer 2.15.1                        etop(3)