2.1.0 docs

ctrldrift · Mar 4, 2014 · 3aecdac · 3aecdac
1 parent 26d4687
commit 3aecdac
Show file tree

Hide file tree

Showing 6 changed files with 362 additions and 13 deletions.
diff --git a/index.html b/index.html
@@ -13,13 +13,13 @@
         <h1>Recon</h1>
         <nav>
           <ul>
-<li><a href="index.html">index</a><li><a href="recon.html">recon</a><li><a href="recon_alloc.html">recon_alloc</a><li><a href="recon_lib.html">recon_lib</a>
+<li><a href="index.html">index</a><li><a href="recon.html">recon</a><li><a href="recon_alloc.html">recon_alloc</a><li><a href="recon_lib.html">recon_lib</a><li><a href="recon_trace.html">recon_trace</a>
           </ul>
         </nav>
     </header>
     <article>
     <h2>Recon Application</h2>
-<p>Copyright © 2012-2013 Fred Hebert (BSD 3-Clause License)
+<p>Copyright © 2012-2014 Fred Hebert (BSD 3-Clause License)
 </p>
 <p><strong>Authors:</strong> Fred Hebert (<a href="mailto:[email protected]"><code>[email protected]</code></a>) [<em>web site:</em> <code><a href="http://ferd.ca/" target="_top">http://ferd.ca/</a></code>].</p>
 <p>Recon is a library to be dropped into any other Erlang project,
@@ -41,18 +41,24 @@ <h2>Recon Application</h2>
         calls with distributed Erlang nodes.
     </dd>
 
+    <dt><a href="recon_alloc.html"><code>recon_alloc</code></a></dt>
+    <dd>
+        Regroups functions to deal with Erlang's memory allocators, or
+        particularly, to try to present the allocator data in a way that
+        makes it simpler to discover the presence of possible problems.
+    </dd>
+
     <dt><a href="recon_lib.html"><code>recon_lib</code></a></dt>
     <dd>
         Regroups useful functionality used by <a href="recon.html"><code>recon</code></a> when dealing
         with data from the node. Would be an interesting place to look
         if you were looking to extend Recon's functionality
     </dd>
 
-    <dt><a href="recon_alloc.html"><code>recon_alloc</code></a></dt>
+    <dt><a href="recon_trace.html"><code>recon_trace</code></a></dt>
     <dd>
-        Regroups functions to deal with Erlang's memory allocators, or
-        particularly, to try to present the allocator data in a way that
-        makes it simpler to discover the presence of possible problems.
+        Provides production-safe tracing facilities, to dig into the
+        execution of programs and function calls as they are running.
     </dd>
 </dl>
 
@@ -79,6 +85,16 @@ <h2>Recon Application</h2>
         information that can be useful in determining the most common causes
         of node failure.
     </dd>
+
+    <dt><code>queue_fun.awk</code></dt>
+    <dd>
+        Awk script to tun on an Erlang Crash dump as
+        <code>awk -v threshold=&lt;queue size&gt; -f queue_fun.awk &lt;crashdump&gt;</code> and will
+        show what function processes with queue sizes larger or equal to
+        <code>&lt;queue size&gt;</code> were operating at the time of the crash dump. May help
+        find out if most processes were stuck blocking on a given function
+        call while accumulating messages forever.
+    </dd>
 </dl>
 
     </article>

diff --git a/recon.html b/recon.html
@@ -13,7 +13,7 @@
         <h1>Recon</h1>
         <nav>
           <ul>
-<li><a href="index.html">index</a><li><a href="recon.html">recon</a><li><a href="recon_alloc.html">recon_alloc</a><li><a href="recon_lib.html">recon_lib</a>
+<li><a href="index.html">index</a><li><a href="recon.html">recon</a><li><a href="recon_alloc.html">recon_alloc</a><li><a href="recon_lib.html">recon_lib</a><li><a href="recon_trace.html">recon_trace</a>
           </ul>
         </nav>
     </header>
@@ -221,7 +221,8 @@ <h3><a name="index">Function Index</a></h3>
   the biggest <code>Num</code> consumers.</td></tr>
 <tr><td valign="top"><a href="#proc_window-3">proc_window/3</a></td><td>Fetches a given attribute from all processes and returns  
 the biggest entries, over a sliding time window.</td></tr>
-<tr><td valign="top"><a href="#remote_load-1">remote_load/1</a></td><td>Equivalent to <code>remote_load(nodes(), Mod)</code>.</td></tr>
+<tr><td valign="top"><a href="#remote_load-1">remote_load/1</a></td><td>Equivalent to <a href="#remote_load-2"><code>remote_load(nodes(), Mod)</code></a>.
+</td></tr>
 <tr><td valign="top"><a href="#remote_load-2">remote_load/2</a></td><td>Loads one or more modules remotely, in a diskless manner.</td></tr>
 <tr><td valign="top"><a href="#rpc-1">rpc/1</a></td><td>Shorthand for <code>rpc([node()|nodes()], Fun)</code>.</td></tr>
 <tr><td valign="top"><a href="#rpc-2">rpc/2</a></td><td>Shorthand for <code>rpc(Nodes, Fun, infinity)</code>.</td></tr>
@@ -475,7 +476,8 @@ <h4 class="function"><a name="proc_window-3">proc_window/3</a></h4>
 <h4 class="function"><a name="remote_load-1">remote_load/1</a></h4>
 <div class="spec">
 <p><code>remote_load(Mod::module()) -&gt; term()</code><br></p>
-</div><p>Equivalent to <code>remote_load(nodes(), Mod)</code>.</p>
+</div><p>Equivalent to <a href="#remote_load-2"><code>remote_load(nodes(), Mod)</code></a>.</p>
+
 
 <h4 class="function"><a name="remote_load-2">remote_load/2</a></h4>
 <div class="spec">

diff --git a/recon_alloc.html b/recon_alloc.html
@@ -13,7 +13,7 @@
         <h1>Recon</h1>
         <nav>
           <ul>
-<li><a href="index.html">index</a><li><a href="recon.html">recon</a><li><a href="recon_alloc.html">recon_alloc</a><li><a href="recon_lib.html">recon_lib</a>
+<li><a href="index.html">index</a><li><a href="recon.html">recon</a><li><a href="recon_alloc.html">recon_alloc</a><li><a href="recon_lib.html">recon_lib</a><li><a href="recon_trace.html">recon_trace</a>
           </ul>
         </nav>
     </header>
@@ -369,7 +369,7 @@ <h4 class="function"><a name="snapshot_load-1">snapshot_load/1</a></h4>
 </div><p><p>load a snapshot from a given file. The format of the data in the
   file can be either the same as output by <a href="#type-snapshot_save"><code>snapshot_save()</code></a>,
   or the output obtained by calling
-   <code>{erlang:memory(),[{A,erlang:system_info({allocator,A})} || A &lt;- element(3,erlang:system_info(allocator))]}.</code>
+   <code>{erlang:memory(),[{A,erlang:system_info({allocator,A})} || A &lt;- erlang:system_info(alloc_util_allocators)++[sys_alloc,mseg_alloc]]}.</code>
   and storing it in a file.
   If the latter option is taken, please remember to add a full stop at the end
   of the resulting Erlang term, as this function uses <code>file:consult/1</code> to load  

diff --git a/recon_lib.html b/recon_lib.html
@@ -13,7 +13,7 @@
         <h1>Recon</h1>
         <nav>
           <ul>
-<li><a href="index.html">index</a><li><a href="recon.html">recon</a><li><a href="recon_alloc.html">recon_alloc</a><li><a href="recon_lib.html">recon_lib</a>
+<li><a href="index.html">index</a><li><a href="recon.html">recon</a><li><a href="recon_alloc.html">recon_alloc</a><li><a href="recon_lib.html">recon_lib</a><li><a href="recon_trace.html">recon_trace</a>
           </ul>
         </nav>
     </header>