git.m6w6.name Git - m6w6/libmemcached/blob - libmemcached/memcached_stats.html

   1
   2
   3 <!DOCTYPE html>
   4 <html class="writer-html5" lang="en" >
   5 <head>
   6   <meta charset="utf-8">
   7
   8   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   9
  10   <title>Working with statistical information from a server &mdash; libmemcached 1.0.99 documentation</title>
  11
  12
  13
  14   <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  15   <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  16
  17
  18
  19
  20
  21
  22
  23   <!--[if lt IE 9]>
  24     <script src="../_static/js/html5shiv.min.js"></script>
  25   <![endif]-->
  26
  27
  28       <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
  29         <script src="../_static/jquery.js"></script>
  30         <script src="../_static/underscore.js"></script>
  31         <script src="../_static/doctools.js"></script>
  32         <script src="../_static/language_data.js"></script>
  33
  34     <script type="text/javascript" src="../_static/js/theme.js"></script>
  35
  36
  37     <link rel="index" title="Index" href="../genindex.html" />
  38     <link rel="search" title="Search" href="../search.html" />
  39     <link rel="copyright" title="Copyright" href="../copyright.html" />
  40     <link rel="next" title="Deprecated Functionality" href="index_deprecated.html" />
  41     <link rel="prev" title="Analyzing servers" href="memcached_analyze.html" />
  42 </head>
  43
  44 <body class="wy-body-for-nav">
  45
  46
  47   <div class="wy-grid-for-nav">
  48
  49     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  50       <div class="wy-side-scroll">
  51         <div class="wy-side-nav-search" >
  52
  53
  54
  55             <a href="../index.html" class="icon icon-home" alt="Documentation Home"> libmemcached
  56
  57
  58
  59           </a>
  60
  61
  62
  63
  64               <div class="version">
  65                 1.0
  66               </div>
  67
  68
  69
  70
  71 <div role="search">
  72   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
  73     <input type="text" name="q" placeholder="Search docs" />
  74     <input type="hidden" name="check_keywords" value="yes" />
  75     <input type="hidden" name="area" value="default" />
  76   </form>
  77 </div>
  78
  79
  80         </div>
  81
  82
  83         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  84
  85
  86
  87
  88
  89
  90               <p class="caption"><span class="caption-text">libmemcached</span></p>
  91 <ul class="current">
  92 <li class="toctree-l1"><a class="reference internal" href="../libmemcached.html">Introduction</a></li>
  93 <li class="toctree-l1 current"><a class="reference internal" href="index.html">libmemcached API</a><ul class="current">
  94 <li class="toctree-l2"><a class="reference internal" href="index_basics.html">Basics</a></li>
  95 <li class="toctree-l2"><a class="reference internal" href="index_data.html">Working with Data</a></li>
  96 <li class="toctree-l2"><a class="reference internal" href="index_errors.html">Messages and Errors</a></li>
  97 <li class="toctree-l2 current"><a class="reference internal" href="index_advanced.html">Advanced Topics</a><ul class="current">
  98 <li class="toctree-l3"><a class="reference internal" href="index_advanced_internals.html">Internal Behavior</a></li>
  99 <li class="toctree-l3"><a class="reference internal" href="index_advanced_aeh.html">Authentication, Encryption &amp; Hashing</a></li>
 100 <li class="toctree-l3"><a class="reference internal" href="index_advanced_servers.html">Servers and Server Lists</a></li>
 101 <li class="toctree-l3"><a class="reference internal" href="index_advanced_daemon.html">Affecting the memcached Daemon</a></li>
 102 <li class="toctree-l3 current"><a class="reference internal" href="index_advanced_stats.html">Statistics</a><ul class="current">
 103 <li class="toctree-l4"><a class="reference internal" href="memcached_analyze.html">Analyzing servers</a></li>
 104 <li class="toctree-l4 current"><a class="current reference internal" href="#">Working with statistical information from a server</a></li>
 105 </ul>
 106 </li>
 107 </ul>
 108 </li>
 109 <li class="toctree-l2"><a class="reference internal" href="index_deprecated.html">Deprecated Functionality</a></li>
 110 </ul>
 111 </li>
 112 <li class="toctree-l1"><a class="reference internal" href="index_misc.html">Misc</a></li>
 113 </ul>
 114 <p class="caption"><span class="caption-text">libmemcachedutil</span></p>
 115 <ul>
 116 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil.html">Introduction</a></li>
 117 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a></li>
 118 </ul>
 119 <p class="caption"><span class="caption-text">libhashkit</span></p>
 120 <ul>
 121 <li class="toctree-l1"><a class="reference internal" href="../libhashkit.html">Introduction</a></li>
 122 <li class="toctree-l1"><a class="reference internal" href="../libhashkit/index.html">libhashkit API</a></li>
 123 </ul>
 124 <p class="caption"><span class="caption-text">Client Applications</span></p>
 125 <ul>
 126 <li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a></li>
 127 </ul>
 128 <p class="caption"><span class="caption-text">Copyright</span></p>
 129 <ul>
 130 <li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
 131 </ul>
 132
 133
 134
 135         </div>
 136
 137       </div>
 138     </nav>
 139
 140     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 141
 142
 143       <nav class="wy-nav-top" aria-label="top navigation">
 144
 145           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 146           <a href="../index.html">libmemcached</a>
 147
 148       </nav>
 149
 150
 151       <div class="wy-nav-content">
 152
 153         <div class="rst-content">
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168
 169
 170
 171 <div role="navigation" aria-label="breadcrumbs navigation">
 172
 173   <ul class="wy-breadcrumbs">
 174
 175       <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
 176
 177           <li><a href="index.html">libmemcached API</a> &raquo;</li>
 178
 179           <li><a href="index_advanced.html">Advanced Topics</a> &raquo;</li>
 180
 181           <li><a href="index_advanced_stats.html">Statistics</a> &raquo;</li>
 182
 183       <li>Working with statistical information from a server</li>
 184
 185
 186       <li class="wy-breadcrumbs-aside">
 187
 188
 189
 190       </li>
 191
 192   </ul>
 193
 194
 195   <hr/>
 196 </div>
 197           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 198            <div itemprop="articleBody">
 199
 200   <div class="section" id="working-with-statistical-information-from-a-server">
 201 <h1>Working with statistical information from a server<a class="headerlink" href="#working-with-statistical-information-from-a-server" title="Permalink to this headline">¶</a></h1>
 202 <p>Get memcached statistics</p>
 203 <div class="section" id="synopsis">
 204 <span id="index-0"></span><h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
 205 <p>#include &lt;libmemcached/memcached.h&gt;</p>
 206 <dl class="cpp type">
 207 <dt id="_CPPv417memcached_stat_st">
 208 <span id="_CPPv317memcached_stat_st"></span><span id="_CPPv217memcached_stat_st"></span><span id="memcached_stat_st"></span><em class="property">type </em><code class="sig-name descname">memcached_stat_st</code><a class="headerlink" href="#_CPPv417memcached_stat_st" title="Permalink to this definition">¶</a><br /></dt>
 209 <dd></dd></dl>
 210
 211 <dl class="cpp type">
 212 <dt id="_CPPv417memcached_stat_fn">
 213 <span id="_CPPv317memcached_stat_fn"></span><span id="_CPPv217memcached_stat_fn"></span><span id="memcached_stat_fn"></span><em class="property">typedef </em><a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> (*<code class="sig-name descname">memcached_stat_fn</code>)<span class="sig-paren">(</span><em class="property">const</em> memcached_instance_st *server, <em class="property">const</em> char *key, size_t key_length, <em class="property">const</em> char *value, size_t value_length, void *context<span class="sig-paren">)</span><a class="headerlink" href="#_CPPv417memcached_stat_fn" title="Permalink to this definition">¶</a><br /></dt>
 214 <dd></dd></dl>
 215
 216 <dl class="cpp function">
 217 <dt id="_CPPv414memcached_statP12memcached_stPcP18memcached_return_t">
 218 <span id="_CPPv314memcached_statP12memcached_stPcP18memcached_return_t"></span><span id="_CPPv214memcached_statP12memcached_stPcP18memcached_return_t"></span><span id="memcached_stat__memcached_stP.cP.memcached_return_tP"></span><a class="reference internal" href="#_CPPv417memcached_stat_st" title="memcached_stat_st">memcached_stat_st</a> *<code class="sig-name descname">memcached_stat</code><span class="sig-paren">(</span><a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *<em>ptr</em>, char *<em>args</em>, <a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> *<em>error</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv414memcached_statP12memcached_stPcP18memcached_return_t" title="Permalink to this definition">¶</a><br /></dt>
 219 <dd></dd></dl>
 220
 221 <dl class="cpp function">
 222 <dt id="_CPPv425memcached_stat_servernameP17memcached_stat_stPcPKc9in_port_t">
 223 <span id="_CPPv325memcached_stat_servernameP17memcached_stat_stPcPKc9in_port_t"></span><span id="_CPPv225memcached_stat_servernameP17memcached_stat_stPcPKc9in_port_t"></span><span id="memcached_stat_servername__memcached_stat_stP.cP.cCP.in_port_t"></span><a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> <code class="sig-name descname">memcached_stat_servername</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv417memcached_stat_st" title="memcached_stat_st">memcached_stat_st</a> *<em>stat</em>, char *<em>args</em>, <em class="property">const</em> char *<em>hostname</em>, in_port_t <em>port</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv425memcached_stat_servernameP17memcached_stat_stPcPKc9in_port_t" title="Permalink to this definition">¶</a><br /></dt>
 224 <dd></dd></dl>
 225
 226 <dl class="cpp function">
 227 <dt id="_CPPv424memcached_stat_get_valueP12memcached_stP17memcached_stat_stPKcP18memcached_return_t">
 228 <span id="_CPPv324memcached_stat_get_valueP12memcached_stP17memcached_stat_stPKcP18memcached_return_t"></span><span id="_CPPv224memcached_stat_get_valueP12memcached_stP17memcached_stat_stPKcP18memcached_return_t"></span><span id="memcached_stat_get_value__memcached_stP.memcached_stat_stP.cCP.memcached_return_tP"></span>char *<code class="sig-name descname">memcached_stat_get_value</code><span class="sig-paren">(</span><a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *<em>ptr</em>, <a class="reference internal" href="#_CPPv417memcached_stat_st" title="memcached_stat_st">memcached_stat_st</a> *<em>stat</em>, <em class="property">const</em> char *<em>key</em>, <a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> *<em>error</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv424memcached_stat_get_valueP12memcached_stP17memcached_stat_stPKcP18memcached_return_t" title="Permalink to this definition">¶</a><br /></dt>
 229 <dd></dd></dl>
 230
 231 <dl class="cpp function">
 232 <dt id="_CPPv423memcached_stat_get_keysP12memcached_stP17memcached_stat_stP18memcached_return_t">
 233 <span id="_CPPv323memcached_stat_get_keysP12memcached_stP17memcached_stat_stP18memcached_return_t"></span><span id="_CPPv223memcached_stat_get_keysP12memcached_stP17memcached_stat_stP18memcached_return_t"></span><span id="memcached_stat_get_keys__memcached_stP.memcached_stat_stP.memcached_return_tP"></span>char **<code class="sig-name descname">memcached_stat_get_keys</code><span class="sig-paren">(</span><a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *<em>ptr</em>, <a class="reference internal" href="#_CPPv417memcached_stat_st" title="memcached_stat_st">memcached_stat_st</a> *<em>stat</em>, <a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> *<em>error</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv423memcached_stat_get_keysP12memcached_stP17memcached_stat_stP18memcached_return_t" title="Permalink to this definition">¶</a><br /></dt>
 234 <dd></dd></dl>
 235
 236 <dl class="cpp function">
 237 <dt id="_CPPv422memcached_stat_executeP12memcached_stPKc17memcached_stat_fnPv">
 238 <span id="_CPPv322memcached_stat_executeP12memcached_stPKc17memcached_stat_fnPv"></span><span id="_CPPv222memcached_stat_executeP12memcached_stPKc17memcached_stat_fnPv"></span><span id="memcached_stat_execute__memcached_stP.cCP.memcached_stat_fn.voidP"></span><a class="reference internal" href="memcached_return_t.html#_CPPv418memcached_return_t" title="memcached_return_t">memcached_return_t</a> <code class="sig-name descname">memcached_stat_execute</code><span class="sig-paren">(</span><a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st">memcached_st</a> *<em>memc</em>, <em class="property">const</em> char *<em>args</em>, <a class="reference internal" href="#_CPPv417memcached_stat_fn" title="memcached_stat_fn">memcached_stat_fn</a> <em>func</em>, void *<em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv422memcached_stat_executeP12memcached_stPKc17memcached_stat_fnPv" title="Permalink to this definition">¶</a><br /></dt>
 239 <dd></dd></dl>
 240
 241 <p>Compile and link with -lmemcached</p>
 242 </div>
 243 <div class="section" id="description">
 244 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
 245 <p>libmemcached(3) has the ability to query a memcached server (or collection
 246 of servers) for their current state. Queries to find state return a
 247 <a class="reference internal" href="#_CPPv417memcached_stat_st" title="memcached_stat_st"><code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">memcached_stat_st</span></code></a> structure. You are responsible for freeing this structure. While it is possible to access the structure directly it is not advisable. <a class="reference internal" href="#_CPPv424memcached_stat_get_valueP12memcached_stP17memcached_stat_stPKcP18memcached_return_t" title="memcached_stat_get_value"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_stat_get_value()</span></code></a> has been provided to query the structure.</p>
 248 <p><a class="reference internal" href="#_CPPv422memcached_stat_executeP12memcached_stPKc17memcached_stat_fnPv" title="memcached_stat_execute"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_stat_execute()</span></code></a> uses the servers found in <a class="reference internal" href="#_CPPv417memcached_stat_st" title="memcached_stat_st"><code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">memcached_stat_st</span></code></a> and executes a &quot;stat&quot; command on each server. args is an optional argument that can be passed in to modify the behavior of &quot;stats&quot;. You will need to supply a callback function that will be supplied each pair of values returned by
 249 the memcached server.</p>
 250 <p><a class="reference internal" href="#_CPPv414memcached_statP12memcached_stPcP18memcached_return_t" title="memcached_stat"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_stat()</span></code></a> fetches an array of <a class="reference internal" href="#_CPPv417memcached_stat_st" title="memcached_stat_st"><code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">memcached_stat_st</span></code></a> structures containing the state of all available memcached servers. The return value must be freed by the calling application. If called with the <a class="reference internal" href="memcached_behavior.html#_CPPv4N20memcached_behavior_t26MEMCACHED_BEHAVIOR_USE_UDPE" title="MEMCACHED_BEHAVIOR_USE_UDP"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_BEHAVIOR_USE_UDP</span></code></a> behavior set, a NULL value is returned and the error parameter is set to <a class="reference internal" href="memcached_return_t.html#_CPPv4N18memcached_return_t23MEMCACHED_NOT_SUPPORTEDE" title="MEMCACHED_NOT_SUPPORTED"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">MEMCACHED_NOT_SUPPORTED</span></code></a>.</p>
 251 <p><a class="reference internal" href="#_CPPv425memcached_stat_servernameP17memcached_stat_stPcPKc9in_port_t" title="memcached_stat_servername"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_stat_servername()</span></code></a> can be used standalone without a <a class="reference internal" href="memcached_create.html#_CPPv412memcached_st" title="memcached_st"><code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">memcached_st</span></code></a> to obtain the state of a particular server.  &quot;args&quot; is used to define a particular state object (a list of these are not provided for by either
 252 the <a class="reference internal" href="#_CPPv423memcached_stat_get_keysP12memcached_stP17memcached_stat_stP18memcached_return_t" title="memcached_stat_get_keys"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_stat_get_keys()</span></code></a> call nor are they defined in the memcached protocol). You must specify the hostname and port of the server you want to
 253 obtain information on.</p>
 254 <p><a class="reference internal" href="#_CPPv424memcached_stat_get_valueP12memcached_stP17memcached_stat_stPKcP18memcached_return_t" title="memcached_stat_get_value"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_stat_get_value()</span></code></a> returns the value of a particular state key. You specify the key you wish to obtain.  The key must be null terminated.</p>
 255 <p><a class="reference internal" href="#_CPPv423memcached_stat_get_keysP12memcached_stP17memcached_stat_stP18memcached_return_t" title="memcached_stat_get_keys"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">memcached_stat_get_keys()</span></code></a> returns a list of keys that the server has state objects on. You are responsible for freeing this list.</p>
 256 <p>A command line tool, memstat(1), is provided so that you do not have to write
 257 an application to do this.</p>
 258 </div>
 259 <div class="section" id="return-value">
 260 <h2>RETURN VALUE<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
 261 <p>Varies, see particular functions.</p>
 262 <p>Any method returning a <a class="reference internal" href="#_CPPv417memcached_stat_st" title="memcached_stat_st"><code class="xref cpp cpp-type docutils literal notranslate"><span class="pre">memcached_stat_st</span></code></a> expects you to free the
 263 memory allocated for it.</p>
 264 </div>
 265 <div class="section" id="see-also">
 266 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
 267 </div>
 268 </div>
 269
 270
 271            </div>
 272
 273           </div>
 274           <footer>
 275
 276     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 277
 278         <a href="index_deprecated.html" class="btn btn-neutral float-right" title="Deprecated Functionality" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 279
 280
 281         <a href="memcached_analyze.html" class="btn btn-neutral float-left" title="Analyzing servers" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 282
 283     </div>
 284
 285
 286   <hr/>
 287
 288   <div role="contentinfo">
 289     <p>
 290
 291
 292         &copy; <a href="../copyright.html">Copyright</a>
 293
 294     </p>
 295   </div>
 296
 297
 298
 299     Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
 300
 301     <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
 302
 303     provided by <a href="https://readthedocs.org">Read the Docs</a>.
 304
 305 </footer>
 306
 307         </div>
 308       </div>
 309
 310     </section>
 311
 312   </div>
 313
 314
 315   <script type="text/javascript">
 316       jQuery(function () {
 317           SphinxRtdTheme.Navigation.enable(true);
 318       });
 319   </script>
 320
 321
 322
 323
 324
 325
 326 </body>
 327 </html>