88 lines
4.3 KiB
HTML
88 lines
4.3 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<title>Module mrdb_stats</title>
|
|
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
|
|
</head>
|
|
<body bgcolor="white">
|
|
<div class="navbar"><a name="#navbar_top"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
|
|
<hr>
|
|
|
|
<h1>Module mrdb_stats</h1>
|
|
<ul class="index"><li><a href="#description">Description</a></li><li><a href="#types">Data Types</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>Statistics API for the mnesia_rocksdb plugin.
|
|
|
|
|
|
<h2><a name="description">Description</a></h2><p>Statistics API for the mnesia_rocksdb plugin</p>
|
|
|
|
Some counters are maintained for each active alias. Currently, the following
|
|
counters are supported:
|
|
* inner_retries
|
|
* outer_retries
|
|
|
|
<h2><a name="types">Data Types</a></h2>
|
|
|
|
<h3 class="typedecl"><a name="type-alias">alias()</a></h3>
|
|
<p><tt>alias() = <a href="/home/uwiger/ae/mnesia_rocksdb/doc/mnesia_rocksdb.html#type-alias">mnesia_rocksdb:alias()</a></tt></p>
|
|
|
|
|
|
<h3 class="typedecl"><a name="type-counter">counter()</a></h3>
|
|
<p><tt>counter() = atom()</tt></p>
|
|
|
|
|
|
<h3 class="typedecl"><a name="type-counters">counters()</a></h3>
|
|
<p><tt>counters() = #{<a href="#type-counter">counter()</a> := integer()}</tt></p>
|
|
|
|
|
|
<h3 class="typedecl"><a name="type-db_ref">db_ref()</a></h3>
|
|
<p><tt>db_ref() = <a href="/home/uwiger/ae/mnesia_rocksdb/doc/mrdb.html#type-db_ref">mrdb:db_ref()</a></tt></p>
|
|
|
|
|
|
<h3 class="typedecl"><a name="type-increment">increment()</a></h3>
|
|
<p><tt>increment() = integer()</tt></p>
|
|
|
|
|
|
<h2><a name="index">Function Index</a></h2>
|
|
<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#get-1">get/1</a></td><td>Fetches all known counters for <code>Alias</code>, in the form of a map,
|
|
<code>#{Counter => Value}</code>.</td></tr>
|
|
<tr><td valign="top"><a href="#get-2">get/2</a></td><td>Fetches the integer value of the known counter <code>Ctr</code> for <code>Alias</code>.</td></tr>
|
|
<tr><td valign="top"><a href="#incr-3">incr/3</a></td><td>Increment <code>Ctr</code> counter for <code>Alias` with increment `N</code>.</td></tr>
|
|
<tr><td valign="top"><a href="#new-0">new/0</a></td><td></td></tr>
|
|
</table>
|
|
|
|
<h2><a name="functions">Function Details</a></h2>
|
|
|
|
<h3 class="function"><a name="get-1">get/1</a></h3>
|
|
<div class="spec">
|
|
<p><tt>get(Alias::<a href="#type-alias">alias()</a> | <a href="#type-db_ref">db_ref()</a>) -> <a href="#type-counters">counters()</a></tt><br></p>
|
|
<p> </p>
|
|
</div><p>Fetches all known counters for <code>Alias</code>, in the form of a map,
|
|
<code>#{Counter => Value}</code>.</p>
|
|
|
|
<h3 class="function"><a name="get-2">get/2</a></h3>
|
|
<div class="spec">
|
|
<p><tt>get(Alias::<a href="#type-alias">alias()</a> | <a href="#type-db_ref">db_ref()</a>, Ctr::<a href="#type-counter">counter()</a>) -> integer()</tt><br></p>
|
|
<p> </p>
|
|
</div><p>Fetches the integer value of the known counter <code>Ctr</code> for <code>Alias</code>.</p>
|
|
|
|
<h3 class="function"><a name="incr-3">incr/3</a></h3>
|
|
<div class="spec">
|
|
<p><tt>incr(Alias::<a href="#type-alias">alias()</a> | <a href="#type-db_ref">db_ref()</a>, Ctr::<a href="#type-counter">counter()</a>, N::<a href="#type-increment">increment()</a>) -> ok</tt><br></p>
|
|
<p> </p>
|
|
</div><p><p>Increment <code>Ctr</code> counter for <code>Alias` with increment `N</code>.</p>
|
|
|
|
Note that the first argument may also be a <code>db_ref()</code> map,
|
|
corresponding to <code>mrdb:get_ref({admin, Alias})</code>.</p>
|
|
|
|
<h3 class="function"><a name="new-0">new/0</a></h3>
|
|
<div class="spec">
|
|
<p><tt>new() -> any()</tt></p>
|
|
<p> </p>
|
|
</div>
|
|
<hr>
|
|
|
|
<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
|
|
<p><i>Generated by EDoc</i></p>
|
|
</body>
|
|
</html>
|