Source of: /manual/en/function.memcache-getstats.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.memcache.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.memcache-getstats.php',
1 => 'Memcache::getStats',
),
'up' =>
array (
0 => 'ref.memcache.php',
1 => 'Memcache Functions',
),
'prev' =>
array (
0 => 'function.memcache-getserverstatus.php',
1 => 'Memcache::getServerStatus',
),
'next' =>
array (
0 => 'function.memcache-getversion.php',
1 => 'Memcache::getVersion',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.memcache-getstats" class="refentry">
<div class="refnamediv">
<h1 class="refname">Memcache::getStats</h1>
<p class="verinfo">(PECL memcache >= 0.2.0)</p><p class="refpurpose"><span class="refname">Memcache::getStats</span> — <span class="dc-title">Get statistics of the server</span></p>
</div>
<a name="function.memcache-getstats.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><b>Memcache::getStats</b></span>
([ <span class="methodparam"><span class="type">string</span> <tt class="parameter">$type</tt></span>
[, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$slabid</tt></span>
[, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$limit</tt></span>
]]] )</div>
<p class="para rdfs-comment">
<b>Memcache::getStats()</b> returns an associative array
with server's statistics. Array keys correspond to stats parameters and
values to parameter's values.
Also you can use <b>memcache_get_stats()</b> function.
</p>
</div>
<a name="function.memcache-getstats.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">type</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The type of statistics to fetch. Valid values are {reset,
malloc, maps, cachedump, slabs, items, sizes}. According to
the memcached protocol spec these additional arguments "are
subject to change for the convenience of memcache developers".
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">slabid</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Used in conjunction with <i><tt class="parameter">type</tt></i>
set to
cachedump to identify the slab to dump from. The cachedump
command ties up the server and is strictly to be used for
debugging purposes.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">limit</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Used in conjunction with <i><tt class="parameter">type</tt></i>
set to
cachedump to limit the number of entries to dump. Default value
is 100.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.memcache-getstats.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an associative array of server statistics or <b><tt class="constant">FALSE</tt></b> on failure.
</p>
</div>
<a name="function.memcache-getstats.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.memcache-getversion.php" class="function" rel="rdfs-seeAlso">Memcache::getVersion()</a> - Return version of the server</li>
<li class="member"><a href="function.memcache-getextendedstats.php" class="function" rel="rdfs-seeAlso">Memcache::getExtendedStats()</a> - Get statistics from all servers in pool</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
