<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html xmlns:fn="http://www.w3.org/2005/02/xpath-functions">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../../doc/otp_doc.css" type="text/css">
<title>Erlang -- etop</title>
</head>
<body bgcolor="white" text="#000000" link="#0000ff" vlink="#ff00ff" alink="#ff0000"><div id="container">
<script id="js" type="text/javascript" language="JavaScript" src="../../../../doc/js/flipmenu/flipmenu.js"></script><script id="js2" type="text/javascript" src="../../../../doc/js/erlresolvelinks.js"></script><script language="JavaScript" type="text/javascript">
<!--
function getWinHeight() {
var myHeight = 0;
if( typeof( window.innerHeight ) == 'number' ) {
//Non-IE
myHeight = window.innerHeight;
} else if( document.documentElement && ( document.documentElement.clientWidth ||
document.documentElement.clientHeight ) ) {
//IE 6+ in 'standards compliant mode'
myHeight = document.documentElement.clientHeight;
} else if( document.body && ( document.body.clientWidth || document.body.clientHeight ) ) {
//IE 4 compatible
myHeight = document.body.clientHeight;
}
return myHeight;
}
function setscrollpos() {
var objf=document.getElementById('loadscrollpos');
document.getElementById("leftnav").scrollTop = objf.offsetTop - getWinHeight()/2;
}
function addEvent(obj, evType, fn){
if (obj.addEventListener){
obj.addEventListener(evType, fn, true);
return true;
} else if (obj.attachEvent){
var r = obj.attachEvent("on"+evType, fn);
return r;
} else {
return false;
}
}
addEvent(window, 'load', setscrollpos);
//--></script><div id="leftnav"><div class="innertube">
<img alt="Erlang logo" src="../../../../doc/erlang-logo.png"><br><small><a href="users_guide.html">User's Guide</a><br><a href="index.html">Reference Manual</a><br><a href="release_notes.html">Release Notes</a><br><a href="../pdf/observer-1.2.pdf">PDF</a><br><a href="../../../../doc/index.html">Top</a></small><p><strong>Observer</strong><br><strong>Reference Manual</strong><br><small>Version 1.2</small></p>
<br><a href="javascript:openAllFlips()">Expand All</a><br><a href="javascript:closeAllFlips()">Contract All</a><p><small><strong>Table of Contents</strong></small></p>
<ul class="flipMenu">
<li title="observer (App)"><a href="observer_app.html">observer (App)
</a></li>
<li id="no" title="observer " expanded="false">observer<ul>
<li><a href="observer.html">
Top of manual page
</a></li>
<li title="start-0"><a href="observer.html#start-0">start/0</a></li>
</ul>
</li>
<li id="no" title="ttb " expanded="false">ttb<ul>
<li><a href="ttb.html">
Top of manual page
</a></li>
<li title="start_trace-4"><a href="ttb.html#start_trace-4">start_trace/4</a></li>
<li title="tracer-0"><a href="ttb.html#tracer-0">tracer/0</a></li>
<li title="tracer-1"><a href="ttb.html#tracer-1">tracer/1</a></li>
<li title="tracer-1"><a href="ttb.html#tracer-1">tracer/1</a></li>
<li title="tracer-2"><a href="ttb.html#tracer-2">tracer/2</a></li>
<li title="p-2"><a href="ttb.html#p-2">p/2</a></li>
<li title="-0"><a href="ttb.html#-0">/0</a></li>
<li title="list_history-0"><a href="ttb.html#list_history-0">list_history/0</a></li>
<li title="run_history-1"><a href="ttb.html#run_history-1">run_history/1</a></li>
<li title="write_config-2"><a href="ttb.html#write_config-2">write_config/2</a></li>
<li title="write_config-3"><a href="ttb.html#write_config-3">write_config/3</a></li>
<li title="run_config-1"><a href="ttb.html#run_config-1">run_config/1</a></li>
<li title="run_config-2"><a href="ttb.html#run_config-2">run_config/2</a></li>
<li title="list_config-1"><a href="ttb.html#list_config-1">list_config/1</a></li>
<li title="write_trace_info-2"><a href="ttb.html#write_trace_info-2">write_trace_info/2</a></li>
<li title="seq_trigger_ms-0"><a href="ttb.html#seq_trigger_ms-0">seq_trigger_ms/0</a></li>
<li title="seq_trigger_ms-1"><a href="ttb.html#seq_trigger_ms-1">seq_trigger_ms/1</a></li>
<li title="stop-0"><a href="ttb.html#stop-0">stop/0</a></li>
<li title="stop-1"><a href="ttb.html#stop-1">stop/1</a></li>
<li title="get_et_handler-0"><a href="ttb.html#get_et_handler-0">get_et_handler/0</a></li>
<li title="format-1"><a href="ttb.html#format-1">format/1</a></li>
<li title="format-2"><a href="ttb.html#format-2">format/2</a></li>
</ul>
</li>
<li id="loadscrollpos" title="etop " expanded="true">etop<ul>
<li><a href="etop.html">
Top of manual page
</a></li>
<li title="start-0"><a href="etop.html#start-0">start/0</a></li>
<li title="start-1"><a href="etop.html#start-1">start/1</a></li>
<li title="help-0"><a href="etop.html#help-0">help/0</a></li>
<li title="config-2"><a href="etop.html#config-2">config/2</a></li>
<li title="dump-1"><a href="etop.html#dump-1">dump/1</a></li>
<li title="stop-0"><a href="etop.html#stop-0">stop/0</a></li>
</ul>
</li>
<li id="no" title="crashdump_viewer " expanded="false">crashdump_viewer<ul>
<li><a href="crashdump_viewer.html">
Top of manual page
</a></li>
<li title="start-0"><a href="crashdump_viewer.html#start-0">start/0</a></li>
<li title="stop-0"><a href="crashdump_viewer.html#stop-0">stop/0</a></li>
</ul>
</li>
</ul>
</div></div>
<div id="content">
<div class="innertube">
<!-- refpage --><center><h1>etop</h1></center>
<h3>MODULE</h3>
<div class="REFBODY">etop</div>
<h3>MODULE SUMMARY</h3>
<div class="REFBODY">Erlang Top is a tool for presenting information about erlang processes similar to the information presented by "top" in UNIX.</div>
<h3>DESCRIPTION</h3>
<div class="REFBODY"><p>
<p><span class="code">etop</span> should be started with the provided scripts
<span class="code">etop</span> and <span class="code">getop</span> for text based and graphical
presentation respectively. This will start a hidden erlang node
which connects to the node to be measured. The measured node is
given with the <span class="code">-node</span> 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 <span class="code">-setcookie</span> option.</p>
<p>Under Windows the batch files <span class="code">etop.bat</span> and
<span class="code">getop.bat</span> can be used.</p>
<p>The following configuration parameters exist for the
<span class="code">etop</span> tool. When executing the <span class="code">etop</span> or <span class="code">getop</span>
scripts, these parameters can be given as command line options,
e.g. <span class="code">getop -node testnode@myhost -setcookie MyCookie</span>.</p>
<dl>
<dt><strong>node</strong></dt>
<dd>The measured node.
<br>
Value: atom()
<br>
Mandatory</dd>
<dt><strong>setcookie</strong></dt>
<dd>Cookie to use for the etop node - must be the same
as the cookie on the measured node.
<br>
Value: atom()</dd>
<dt><strong>lines</strong></dt>
<dd>Number of lines (processes) to display.
<br>
Value: integer()
<br>
Default: 10</dd>
<dt><strong>interval</strong></dt>
<dd>The time interval (in seconds) between each update of
the display.
<br>
Value: integer()
<br>
Default: 5</dd>
<dt><strong>accumulate</strong></dt>
<dd>If <span class="code">true</span> the execution time and reductions are
accumulated.
<br>
Value: boolean()
<br>
Default: <span class="code">false</span>
</dd>
<dt><strong>sort</strong></dt>
<dd>Identifies what information to sort by.
<br>
Value: <span class="code">runtime | reductions | memory | msg_q</span> <br>
Default: <span class="code">runtime</span> (<span class="code">reductions</span> if
<span class="code">tracing=off</span>)</dd>
<dt><strong>tracing</strong></dt>
<dd>
<span class="code">etop</span> uses the erlang trace facility, and thus no
other tracing is possible on the measured node while
<span class="code">etop</span> is running, unless this option is set to
<span class="code">off</span>. Also helpful if the <span class="code">etop</span> tracing causes too
high load on the measured node. With tracing off, runtime is
not measured.
<br>
Value: <span class="code">on | off</span> <br>
Default: <span class="code">on</span>
</dd>
</dl>
<p>All interaction with <span class="code">etop</span> when running the graphical
presentation should happen via the menus. For the text based
presentation the functions described below can be used.
</p>
<p>See the <span class="bold_code"><a href="etop_ug.html">user's guide</a></span> for
more information about the <span class="code">etop</span> tool.</p>
</p></div>
<h3>EXPORTS</h3>
<p><a name="start-0"><span class="bold_code">start() -> ok</span></a><br></p>
<div class="REFBODY"><p>
<p>This function starts <span class="code">etop</span>.
Note that etop is preferably started with the etop and getop scripts</p>
</p></div>
<p><a name="start-1"><span class="bold_code">start(Options) -> ok</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Options = [Option]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Option = {Key, Value}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Key = atom()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Value = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>This function starts <span class="code">etop</span>. Use
<span class="bold_code"><a href="#help-0">help/0</a></span> to see a
description of the possible options.</p>
</p></div>
<p><a name="help-0"><span class="bold_code">help() -> ok</span></a><br></p>
<div class="REFBODY"><p>
<p>This function prints the help of <span class="code">etop</span> and
its options.</p>
</p></div>
<p><a name="config-2"><span class="bold_code">config(Key,Value) -> Result</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Result = ok | {error,Reason}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Key = lines | interval | accumulate | sort</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Value = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>This function is used to change the tool's configuration
parameters during runtime. The table above indicates the
allowed values for each parameter.</p>
</p></div>
<p><a name="dump-1"><span class="bold_code">dump(File) -> Result</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Result = ok | {error,Reason}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">File = string()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>This function dumps the current display to a text file.</p>
</p></div>
<p><a name="stop-0"><span class="bold_code">stop() -> stop</span></a><br></p>
<div class="REFBODY"><p>
<p>This function terminates <span class="code">etop</span>.</p>
</p></div>
</div>
<div class="footer">
<hr>
<p>Copyright © 2002-2012 Ericsson AB. All Rights Reserved.</p>
</div>
</div>
</div></body>
</html>
distrib
>
Fedora
>
17
>
i386
>
media
>
updates
>
by-pkgid
>
675c8c8167236dfcf8d66da674f931e8
>
files
>
1029
