<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Get statistics from all servers in pool</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="memcache.get.html">Memcache::get</a></div>
<div class="next" style="text-align: right; float: right;"><a href="memcache.getserverstatus.html">Memcache::getServerStatus</a></div>
<div class="up"><a href="class.memcache.html">Memcache</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="memcache.getextendedstats" class="refentry">
<div class="refnamediv">
<h1 class="refname">Memcache::getExtendedStats</h1>
<p class="verinfo">(PECL memcache >= 2.0.0)</p><p class="refpurpose"><span class="refname">Memcache::getExtendedStats</span> — <span class="dc-title">Get statistics from all servers in pool</span></p>
</div>
<div class="refsect1 description" id="refsect1-memcache.getextendedstats-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>Memcache::getExtendedStats</strong></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$type</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$slabid</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$limit</code><span class="initializer"> = 100</span></span>
]]] )</div>
<p class="para rdfs-comment">
<span class="function"><strong>Memcache::getExtendedStats()</strong></span> returns a two-dimensional
associative array with server statistics. Array keys correspond to
host:port of server and values contain the individual server statistics.
A failed server will have its corresponding entry set to <strong><code>FALSE</code></strong>.
You can also use the <span class="function"><strong>memcache_get_extended_stats()</strong></span> function.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
This function has been added to Memcache version 2.0.0.
</p>
</p></blockquote>
</div>
<div class="refsect1 parameters" id="refsect1-memcache.getextendedstats-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">type</code></em></span>
<dd>
<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>
<dt>
<span class="term"><em><code class="parameter">slabid</code></em></span>
<dd>
<p class="para">
Used in conjunction with <em><code class="parameter">type</code></em> 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>
<dt>
<span class="term"><em><code class="parameter">limit</code></em></span>
<dd>
<p class="para">
Used in conjunction with <em><code class="parameter">type</code></em> set to
cachedump to limit the number of entries to dump.
</p>
</dd>
</dt>
</dl>
<div class="warning"><strong class="warning">Warning</strong>
<p class="simpara">
The cachedump stat type has been removed from the memcached daemon
due to security reasons.
</p>
</div>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-memcache.getextendedstats-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a two-dimensional associative array of server statistics or <strong><code>FALSE</code></strong>
on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-memcache.getextendedstats-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4416">
<p><strong>Example #1 <span class="function"><strong>Memcache::getExtendedStats()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /> $memcache_obj </span><span style="color: #007700">= new </span><span style="color: #0000BB">Memcache</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">$memcache_obj</span><span style="color: #007700">-></span><span style="color: #0000BB">addServer</span><span style="color: #007700">(</span><span style="color: #DD0000">'memcache_host'</span><span style="color: #007700">, </span><span style="color: #0000BB">11211</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$memcache_obj</span><span style="color: #007700">-></span><span style="color: #0000BB">addServer</span><span style="color: #007700">(</span><span style="color: #DD0000">'failed_host'</span><span style="color: #007700">, </span><span style="color: #0000BB">11211</span><span style="color: #007700">);<br /> <br /> </span><span style="color: #0000BB">$stats </span><span style="color: #007700">= </span><span style="color: #0000BB">$memcache_obj</span><span style="color: #007700">-></span><span style="color: #0000BB">getExtendedStats</span><span style="color: #007700">();<br /> </span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$stats</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
Array
(
[memcache_host:11211] => Array
(
[pid] => 3756
[uptime] => 603011
[time] => 1133810435
[version] => 1.1.12
[rusage_user] => 0.451931
[rusage_system] => 0.634903
[curr_items] => 2483
[total_items] => 3079
[bytes] => 2718136
[curr_connections] => 2
[total_connections] => 807
[connection_structures] => 13
[cmd_get] => 9748
[cmd_set] => 3096
[get_hits] => 5976
[get_misses] => 3772
[bytes_read] => 3448968
[bytes_written] => 2318883
[limit_maxbytes] => 33554432
)
[failed_host:11211] => false
)
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-memcache.getextendedstats-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="memcache.getversion.html" class="function" rel="rdfs-seeAlso">Memcache::getVersion()</a> - Return version of the server</span></li>
<li class="member"> <span class="function"><a href="memcache.getstats.html" class="function" rel="rdfs-seeAlso">Memcache::getStats()</a> - Get statistics of the server</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="memcache.get.html">Memcache::get</a></div>
<div class="next" style="text-align: right; float: right;"><a href="memcache.getserverstatus.html">Memcache::getServerStatus</a></div>
<div class="up"><a href="class.memcache.html">Memcache</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
