<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>memstat - Gather statistics from a server — libmemcached 1.0.99 documentation</title>
+ <title>memstat — libmemcached 1.0.99 documentation</title>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
- <script src="../_static/jquery.js"></script>
- <script src="../_static/underscore.js"></script>
- <script src="../_static/doctools.js"></script>
- <script src="../_static/language_data.js"></script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+ <script type="text/javascript" src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="copyright" title="Copyright" href="../copyright.html" />
- <link rel="next" title="memexist - Check for the existence of a key" href="memexist.html" />
- <link rel="prev" title="memaslap - Load testing and benchmarking a server" href="memaslap.html" />
+ <link rel="next" title="memerror" href="memerror.html" />
+ <link rel="prev" title="memping" href="memping.html" />
</head>
<body class="wy-body-for-nav">
- <p class="caption"><span class="caption-text">libmemcached</span></p>
-<ul>
+ <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../libmemcached.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../libmemcached/index.html">libmemcached API</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../libmemcached/index_misc.html">Misc</a></li>
-</ul>
-<p class="caption"><span class="caption-text">libmemcachedutil</span></p>
-<ul>
-<li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a></li>
-</ul>
-<p class="caption"><span class="caption-text">libhashkit</span></p>
-<ul>
-<li class="toctree-l1"><a class="reference internal" href="../libhashkit.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../libhashkit/index.html">libhashkit API</a></li>
-</ul>
-<p class="caption"><span class="caption-text">Client Applications</span></p>
-<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Client Applications</a><ul class="current">
-<li class="toctree-l2"><a class="reference internal" href="memcapable.html">memcapable - Checking a Memcached server capabilities and compatibility</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcat.html">memcat - “cat” data from a server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memcp.html">memcp - Copy data to a server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memdump.html">memdump - Dumping your server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memerror.html">memerror - translate an error code to a string</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memflush.html">memflush - flush all data from a server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memrm.html">memrm - Remove data from a server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memslap.html">memslap - Load testing and benchmarking a server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memaslap.html">memaslap - Load testing and benchmarking a server</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="#">memstat - Gather statistics from a server</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l3"><a class="reference internal" href="#description">DESCRIPTION</a></li>
-<li class="toctree-l3"><a class="reference internal" href="#options">OPTIONS</a></li>
-<li class="toctree-l3"><a class="reference internal" href="#see-also">SEE ALSO</a></li>
-</ul>
-</li>
-<li class="toctree-l2"><a class="reference internal" href="memexist.html">memexist - Check for the existence of a key</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memparse.html">memparse - Parse an option string</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memping.html">memping - Test to see if a server is available.</a></li>
-<li class="toctree-l2"><a class="reference internal" href="memtouch.html">memtouch - Touches a key.</a></li>
+<li class="toctree-l2"><a class="reference internal" href="memexist.html">memexist — Check for the existence of a key</a></li>
+<li class="toctree-l2"><a class="reference internal" href="memcat.html">memcat — "cat" data from a server</a></li>
+<li class="toctree-l2"><a class="reference internal" href="memcp.html">memcp — "cp" files to a server</a></li>
+<li class="toctree-l2"><a class="reference internal" href="memtouch.html">memtouch — "touch" a key</a></li>
+<li class="toctree-l2"><a class="reference internal" href="memrm.html">memrm – "rm" a key</a></li>
+<li class="toctree-l2"><a class="reference internal" href="memaslap.html">memaslap - Load testing and benchmarking a server</a></li>
+<li class="toctree-l2"><a class="reference internal" href="memslap.html">memslap - Load testing and benchmarking a server</a></li>
+<li class="toctree-l2"><a class="reference internal" href="memping.html">memping – Ping a server</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">memstat – Gather statistics from a server</a></li>
+<li class="toctree-l2"><a class="reference internal" href="memerror.html">memerror — Translate libmemcached error codes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="memparse.html">memparse — Parse and validate an option string</a></li>
+<li class="toctree-l2"><a class="reference internal" href="memcapable.html">memcapable — Check a server's capabilities and compatibility</a></li>
+<li class="toctree-l2"><a class="reference internal" href="memdump.html">memdump — Dump a server's data</a></li>
+<li class="toctree-l2"><a class="reference internal" href="memflush.html">memflush — Flush a server (erase all cached data)</a></li>
</ul>
</li>
+<li class="toctree-l1"><a class="reference internal" href="../libmemcached/index_misc.html">Miscellaneous</a></li>
</ul>
-<p class="caption"><span class="caption-text">Copyright</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../changelogs.html">Change Logs</a></li>
<li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
</ul>
<li><a href="index.html">Client Applications</a> »</li>
- <li>memstat - Gather statistics from a server</li>
+ <li>memstat</li>
<li class="wy-breadcrumbs-aside">
+
+ <a href="https://github.com/m6w6/libmemcached/blob/v1.x/docs/source/bin/memstat.rst" class="fa fa-github"> Edit on GitHub</a>
+
+
</li>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
- <div class="section" id="memstat-gather-statistics-from-a-server">
-<h1>memstat - Gather statistics from a server<a class="headerlink" href="#memstat-gather-statistics-from-a-server" title="Permalink to this headline">¶</a></h1>
-<p>memstat - Display the operating status of a single or group of memcached servers</p>
+ <div class="section" id="memstat">
+<h1>memstat<a class="headerlink" href="#memstat" title="Permalink to this headline">¶</a></h1>
<div class="section" id="synopsis">
<h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
<p>memstat [options]</p>
+<p>Gather statistics from a server</p>
</div>
<div class="section" id="description">
<h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
-<p><strong class="program">memstat</strong> dumps the state of memcached(1) servers.
-It displays all data to stdout.</p>
+<p><strong class="program">memstat</strong> dumps the state of <em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/1/memcached">memcached(1)</a></em> servers.
+It prints all data to stdout.</p>
</div>
<div class="section" id="options">
<h2>OPTIONS<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>
-<p>You can specify servers via the option:</p>
+<dl class="option">
+<dt id="cmdoption-memstat-help">
+<code class="descname">--help</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-memstat-help" title="Permalink to this definition">¶</a></dt>
+<dd><p>Display help.</p>
+</dd></dl>
+
+<dl class="option">
+<dt id="cmdoption-memstat-version">
+<code class="descname">--version</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-memstat-version" title="Permalink to this definition">¶</a></dt>
+<dd><p>Display version.</p>
+</dd></dl>
+
+<dl class="option">
+<dt id="cmdoption-memstat-quiet">
+<code class="descname">--quiet</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-memstat-quiet" title="Permalink to this definition">¶</a></dt>
+<dd><p>Operate quietly.</p>
+</dd></dl>
+
+<dl class="option">
+<dt id="cmdoption-memstat-verbose">
+<code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-memstat-verbose" title="Permalink to this definition">¶</a></dt>
+<dd><p>Operate more verbosely.</p>
+</dd></dl>
+
+<dl class="option">
+<dt id="cmdoption-memstat-debug">
+<code class="descname">--debug</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-memstat-debug" title="Permalink to this definition">¶</a></dt>
+<dd><p>See <a class="reference internal" href="#cmdoption-memstat-verbose"><code class="xref std std-option docutils literal notranslate"><span class="pre">--verbose</span></code></a>.</p>
+</dd></dl>
+
<dl class="option">
<dt id="cmdoption-memstat-servers">
-<code class="sig-name descname">--servers</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-memstat-servers" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
+<code class="descname">--servers</code><code class="descclassname"> <list of servers></code><a class="headerlink" href="#cmdoption-memstat-servers" title="Permalink to this definition">¶</a></dt>
+<dd><p>Specify the list of servers as <em>hostname[:port][,hostname[:port]...]</em>.</p>
+</dd></dl>
-<p>or via the environment variable:</p>
-<dl class="envvar">
-<dt id="envvar-'MEMCACHED_SERVERS,--args'">
-<code class="sig-name descname">'MEMCACHED_SERVERS, --args'</code><a class="headerlink" href="#envvar-'MEMCACHED_SERVERS,--args'" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
+<dl class="option">
+<dt id="cmdoption-memstat-binary">
+<code class="descname">--binary</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-memstat-binary" title="Permalink to this definition">¶</a></dt>
+<dd><p>Enable binary protocol.</p>
+</dd></dl>
-<p>which can be used to specify the “argument” sent to the stats command (ie slab, size, items, etc..).</p>
-<p>For a full list of operations run the tool with:</p>
<dl class="option">
-<dt id="cmdoption-memstat-help">
-<code class="sig-name descname">--help</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-memstat-help" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
+<dt id="cmdoption-memstat-username">
+<code class="descname">--username</code><code class="descclassname"> <username></code><a class="headerlink" href="#cmdoption-memstat-username" title="Permalink to this definition">¶</a></dt>
+<dd><p>Use <em>username</em> for SASL authentication.</p>
+</dd></dl>
+
+<dl class="option">
+<dt id="cmdoption-memstat-password">
+<code class="descname">--password</code><code class="descclassname"> <password></code><a class="headerlink" href="#cmdoption-memstat-password" title="Permalink to this definition">¶</a></dt>
+<dd><p>Use <em>password</em> for SASL authentication.</p>
+</dd></dl>
<dl class="option">
<dt id="cmdoption-memstat-analyze">
-<code class="sig-name descname">--analyze</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-memstat-analyze" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
+<code class="descname">--analyze</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-memstat-analyze" title="Permalink to this definition">¶</a></dt>
+<dd><p>Analyze and print differences of a server cluster. A memory and uptime comparison is performed by default.</p>
+<p>Available additional modes:</p>
+<table class="docutils option-list" frame="void" rules="none">
+<col class="option" />
+<col class="description" />
+<tbody valign="top">
+<tr><td class="option-group" colspan="2">
+<kbd><span class="option">--analyze=<var>latency</var></span></kbd></td>
+</tr>
+<tr><td> </td><td>Network latency comparison</td></tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="option">
+<dt id="cmdoption-memstat-server-version">
+<code class="descname">--server-version</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-memstat-server-version" title="Permalink to this definition">¶</a></dt>
+<dd><p>Obtain and print server version(s) only.</p>
+</dd></dl>
+
+</div>
+<div class="section" id="environment">
+<h2>ENVIRONMENT<a class="headerlink" href="#environment" title="Permalink to this headline">¶</a></h2>
+<dl class="envvar">
+<dt id="envvar-MEMCACHED_SERVERS">
+<code class="descname">MEMCACHED_SERVERS</code><a class="headerlink" href="#envvar-MEMCACHED_SERVERS" title="Permalink to this definition">¶</a></dt>
+<dd><p>Specify the list of servers.</p>
+</dd></dl>
</div>
<div class="section" id="see-also">
<h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
+<ul class="simple">
+<li><a class="reference internal" href="../libmemcached.html"><span class="doc">C/C++ Client Library for memcached</span></a></li>
+<li><a class="reference internal" href="../libmemcached/memcached_stats.html"><span class="doc">Working with statistical information from a server</span></a></li>
+</ul>
</div>
</div>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="memexist.html" class="btn btn-neutral float-right" title="memexist - Check for the existence of a key" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="memerror.html" class="btn btn-neutral float-right" title="memerror" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="memaslap.html" class="btn btn-neutral float-left" title="memaslap - Load testing and benchmarking a server" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="memping.html" class="btn btn-neutral float-left" title="memping" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
projects / m6w6 / libmemcached / blobdiff