| |
| |
| <!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 — Traffic Control 1.2.1 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.2.1 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_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_portal.html">Traffic Portal</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’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_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’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_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> |
| |
| </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.2.1</a> »</li> |
| |
| <li><a href="../../index.html">Developer’s Guide</a> »</li> |
| |
| <li><a href="../../traffic_ops.html">Traffic Ops</a> »</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><strong>Query Parameters</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="14%" /> |
| <col width="86%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Query Parameter</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>The name that was configured in the Parameters database table as ‘CDN_name’</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">metricType</span></code></td> |
| <td>The metric type (valid metric types: ‘ats.proxy.process.http.current_client_connections’, ‘bandwidth’, ‘maxKbps’)</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">startDate</span></code></td> |
| <td>The begin date (Formatted as ISO8601 (Formatted as ISO8601, for example: ‘2015-08-11T12:30:00-06:00’)</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">endDate</span></code></td> |
| <td>The end date (Formatted as ISO8601 (Formatted as ISO8601, for example: ‘2015-08-13T12:30:00-06:00’)</td> |
| </tr> |
| </tbody> |
| </table> |
| <dl class="docutils"> |
| <dt>Required Query Parameters:</dt> |
| <dd>cdnName, metricType, startDate, endDate</dd> |
| </dl> |
| </div></blockquote> |
| <p><strong>GET /api/1.2/cache_stats.json</strong></p> |
| <blockquote> |
| <div><p>Example Query: <a class="reference external" href="http://localhost:3000/api/1.2/cache_stats.json?cdnName=yourcdn&metricType=bandwidth&startDate=2015-08-11T12:30:00Z&endDate=2015-08-11T13:30:00Z&interval=60s">http://localhost:3000/api/1.2/cache_stats.json?cdnName=yourcdn&metricType=bandwidth&startDate=2015-08-11T12:30:00Z&endDate=2015-08-11T13:30:00Z&interval=60s</a></p> |
| <p><strong>Summary Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="55%" /> |
| <col width="13%" /> |
| <col width="32%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">DeliveryService Stats Summary</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">average</span></code></td> |
| <td>float</td> |
| <td>You complete me!</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">count</span></code></td> |
| <td>float</td> |
| <td>You complete me!</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">max</span></code></td> |
| <td>float</td> |
| <td>You complete me!</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">min</span></code></td> |
| <td>float</td> |
| <td>You complete me!</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">ninetyEighthPercentile</span></code></td> |
| <td>float</td> |
| <td>You complete me!</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">ninetyFifthPercentile</span></code></td> |
| <td>float</td> |
| <td>You complete me!</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">total</span></code></td> |
| <td>float</td> |
| <td>You complete me!</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">totalBytes</span></code></td> |
| <td>float</td> |
| <td>You complete me!</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">totalTransactions</span></code></td> |
| <td>float</td> |
| <td>You complete me!</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Example</strong></p> |
| <div class="highlight-python"><div class="highlight"><pre>{ |
| "response": { |
| "query": { |
| "language": { |
| "influxdbDatabaseName": "cache_stats", |
| "influxdbSeriesQuery": "SELECT sum(value)*1000/6 FROM \"bandwidth\" WHERE |
| time > '2015-08-10T16:40:00-06:00' |
| AND time < '2015-08-10T17:10:00-06:00' |
| AND cdn = 'yourcdn' GROUP BY time(60s), cdn ORDER BY asc", |
| "influxdbSummaryQuery": "SELECT mean(value), |
| percentile(value, 5), |
| percentile(value, 95), |
| percentile(value, 98), |
| min(value), |
| max(value), |
| sum(value), |
| count(value) FROM \"bandwidth\" |
| WHERE cdn = 'over-the-top' |
| AND time > '2015-08-10T16:40:00-06:00' |
| AND time < '2015-08-10T17:10:00-06:00' GROUP BY time(60s), cdn" |
| }, |
| "parameters": { |
| "cdnName": "over-the-top", |
| "endDate": "2015-08-10T17:10:00-06:00", |
| "interval": "60s", |
| "limit": null, |
| "metricType": "bandwidth", |
| "offset": null, |
| "orderby": null, |
| "startDate": "2015-08-10T16:40:00-06:00" |
| } |
| }, |
| "series": { |
| "columns": [ |
| "time", |
| "" |
| ], |
| "count": 29, |
| "name": "bandwidth", |
| "tags": { |
| "cdn": "over-the-top" |
| }, |
| "values": [ |
| [ |
| "2015-08-10T22:40:00Z", |
| 229340299720 |
| ], |
| [ |
| "2015-08-10T22:41:00Z", |
| 224309221713.334 |
| ], |
| [ |
| "2015-08-10T22:42:00Z", |
| 229551834168.334 |
| ], |
| [ |
| "2015-08-10T22:43:00Z", |
| 225179658876.667 |
| ], |
| [ |
| "2015-08-10T22:44:00Z", |
| 230443968275 |
| ] |
| ] |
| }, |
| "summary": { |
| "average": 970410.295, |
| "count": 1376041798, |
| "fifthPercentile": 202.03, |
| "max": 3875441.02, |
| "min": 0, |
| "ninetyEighthPercentile": 2957940.93, |
| "ninetyFifthPercentile": 2366728.63 |
| } |
| } |
| } |
| </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.2.1', |
| 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> |