blob: b518f911204ee04a2eabf7c7c1c259598b24770d [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Cache Statistics &mdash; Traffic Control 1.8.0 documentation </title>
<link rel="shortcut icon" href="../../../_static/favicon.ico"/>
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/theme_overrides.css" type="text/css" />
<link rel="top" title="Traffic Control 1.8.0 documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="CDN" href="cdn.html"/>
<link rel="prev" title="Cache Group" href="cachegroup.html"/>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-nav-search">
<a href="/" class="icon icon-home"> Traffic Control
<img src="../../../_static/tc_logo.png" class="logo" />
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../basics/index.html">CDN Basics</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../basics/http_11.html">HTTP 1.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../basics/caching_proxies.html">Caching Proxies</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../overview/index.html">Traffic Control Overview</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../../overview/introduction.html">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_stats.html">Traffic Stats</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator&#8217;s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_install.html">Installing Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_config.html">Configuring Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_using.html">Using Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_portal.html">Traffic Portal Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_monitor.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_server.html">Traffic Server Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../admin/quick_howto/index.html">Quick How To Guides</a></li>
</ul>
</li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../../index.html">Developer&#8217;s Guide</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="../../traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../traffic_stats.html">Traffic Stats</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../traffic_server.html">Traffic Server</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../faq/index.html">FAQ</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../../faq/general.html">General</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../faq/development.html">Development</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../faq/administration.html">Running a Traffic Control CDN</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../glossary.html">Glossary</a></li>
</ul>
</div>
&nbsp;
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../index.html">Traffic Control</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../index.html">Traffic Control 1.8.0</a> &raquo;</li>
<li><a href="../../index.html">Developer&#8217;s Guide</a> &raquo;</li>
<li><a href="../../traffic_ops.html">Traffic Ops</a> &raquo;</li>
<li>Cache Statistics</li>
<li class="wy-breadcrumbs-aside">
<a href="../../../_sources/development/traffic_ops_api/v12/cache_stats.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cdn.html" class="btn btn-neutral float-right" title="CDN">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="cachegroup.html" class="btn btn-neutral" title="Cache Group"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<div role="main" class="document">
<div class="section" id="cache-statistics">
<span id="to-api-v12-cache-stats"></span><h1>Cache Statistics<a class="headerlink" href="#cache-statistics" title="Permalink to this headline"></a></h1>
<div class="section" id="api-1-2-cache-stats">
<span id="to-api-v12-cache-stats-route"></span><h2>/api/1.2/cache_stats<a class="headerlink" href="#api-1-2-cache-stats" title="Permalink to this headline"></a></h2>
<p><strong>GET /api/1.2/cache_stats.json</strong></p>
<blockquote>
<div><p>Retrieves statistics about the CDN.</p>
<p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
<p><strong>Request Query Parameters</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="15%" />
<col width="6%" />
<col width="80%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Name</th>
<th class="head">Required</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><code class="docutils literal"><span class="pre">cdnName</span></code></td>
<td>yes</td>
<td>The CDN name to return cache stats for</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">metricType</span></code></td>
<td>yes</td>
<td>The metric type (valid metric types: &#8216;ats.proxy.process.http.current_client_connections&#8217;, &#8216;bandwidth&#8217;, &#8216;maxKbps&#8217;)</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">startDate</span></code></td>
<td>yes</td>
<td>The begin date (Formatted as ISO8601, for example: &#8216;2015-08-11T12:30:00-06:00&#8217;)</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">endDate</span></code></td>
<td>yes</td>
<td>The end date (Formatted as ISO8601, for example: &#8216;2015-08-12T12:30:00-06:00&#8217;)</td>
</tr>
</tbody>
</table>
<p><strong>Response Properties</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="21%" />
<col width="11%" />
<col width="67%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
<th class="head">Type</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><code class="docutils literal"><span class="pre">summary</span></code></td>
<td>hash</td>
<td>Summary data</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">&gt;count</span></code></td>
<td>int</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">&gt;min</span></code></td>
<td>float</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">&gt;max</span></code></td>
<td>float</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">&gt;fifthPercentile</span></code></td>
<td>float</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">&gt;ninetyEighthPercentile</span></code></td>
<td>float</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">&gt;ninetyFifthPercentile</span></code></td>
<td>float</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">&gt;average</span></code></td>
<td>float</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">series</span></code></td>
<td>hash</td>
<td>Series data</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">&gt;count</span></code></td>
<td>int</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">&gt;columns</span></code></td>
<td>array</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">&gt;name</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">&gt;values</span></code></td>
<td>array</td>
<td>&nbsp;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">&gt;&gt;time</span></code></td>
<td>string</td>
<td>&nbsp;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">&gt;&gt;value</span></code></td>
<td>float</td>
<td>&nbsp;</td>
</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
<span class="s">&quot;response&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;series&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;columns&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="s">&quot;time&quot;</span><span class="p">,</span>
<span class="s">&quot;&quot;</span>
<span class="p">],</span>
<span class="s">&quot;count&quot;</span><span class="p">:</span> <span class="mi">29</span><span class="p">,</span>
<span class="s">&quot;name&quot;</span><span class="p">:</span> <span class="s">&quot;bandwidth&quot;</span><span class="p">,</span>
<span class="s">&quot;tags&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;cdn&quot;</span><span class="p">:</span> <span class="s">&quot;over-the-top&quot;</span>
<span class="p">},</span>
<span class="s">&quot;values&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="p">[</span>
<span class="s">&quot;2015-08-10T22:40:00Z&quot;</span><span class="p">,</span>
<span class="mi">229340299720</span>
<span class="p">],</span>
<span class="p">[</span>
<span class="s">&quot;2015-08-10T22:41:00Z&quot;</span><span class="p">,</span>
<span class="mf">224309221713.334</span>
<span class="p">],</span>
<span class="p">[</span>
<span class="s">&quot;2015-08-10T22:42:00Z&quot;</span><span class="p">,</span>
<span class="mf">229551834168.334</span>
<span class="p">],</span>
<span class="p">[</span>
<span class="s">&quot;2015-08-10T22:43:00Z&quot;</span><span class="p">,</span>
<span class="mf">225179658876.667</span>
<span class="p">],</span>
<span class="p">[</span>
<span class="s">&quot;2015-08-10T22:44:00Z&quot;</span><span class="p">,</span>
<span class="mi">230443968275</span>
<span class="p">]</span>
<span class="p">]</span>
<span class="p">},</span>
<span class="s">&quot;summary&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;average&quot;</span><span class="p">:</span> <span class="mf">970410.295</span><span class="p">,</span>
<span class="s">&quot;count&quot;</span><span class="p">:</span> <span class="mi">1376041798</span><span class="p">,</span>
<span class="s">&quot;fifthPercentile&quot;</span><span class="p">:</span> <span class="mf">202.03</span><span class="p">,</span>
<span class="s">&quot;max&quot;</span><span class="p">:</span> <span class="mf">3875441.02</span><span class="p">,</span>
<span class="s">&quot;min&quot;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
<span class="s">&quot;ninetyEighthPercentile&quot;</span><span class="p">:</span> <span class="mf">2957940.93</span><span class="p">,</span>
<span class="s">&quot;ninetyFifthPercentile&quot;</span><span class="p">:</span> <span class="mf">2366728.63</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
<div class="line-block">
<div class="line"><br /></div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="cdn.html" class="btn btn-neutral float-right" title="CDN">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="cachegroup.html" class="btn btn-neutral" title="Cache Group"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</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/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>