blob: ec8788fc3add70cd7d096ee0a09df06c04e9e732 [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>Traffic Monitor APIs &mdash; Traffic Control 2.1-dev 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 2.1-dev documentation" href="../../index.html"/>
<link rel="up" title="Traffic Monitor" href="../traffic_monitor.html"/>
<link rel="next" title="Traffic Monitor Golang" href="../traffic_monitor_golang.html"/>
<link rel="prev" title="Traffic Monitor" href="../traffic_monitor.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_c_only.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/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</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_monitor_golang.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"><a class="reference internal" href="../building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><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 current"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="../traffic_monitor_golang.html">Traffic Monitor Golang</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 2.1-dev</a> &raquo;</li>
<li><a href="../index.html">Developer&#8217;s Guide</a> &raquo;</li>
<li><a href="../traffic_monitor.html">Traffic Monitor</a> &raquo;</li>
<li>Traffic Monitor APIs</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/development/traffic_monitor/traffic_monitor_api.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../traffic_monitor_golang.html" class="btn btn-neutral float-right" title="Traffic Monitor Golang">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../traffic_monitor.html" class="btn btn-neutral" title="Traffic Monitor"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<div role="main" class="document">
<div class="section" id="traffic-monitor-apis">
<span id="reference-tm-api"></span><h1>Traffic Monitor APIs<a class="headerlink" href="#traffic-monitor-apis" title="Permalink to this headline">ΒΆ</a></h1>
<p>The Traffic Monitor URLs below allow certain query parameters for use in controlling the data returned. The optional query parameters are the <em>tabbed</em> in values under each URL, if they exist.</p>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p><strong>/publish/EventLog</strong></p>
<p>Log of recent events.</p>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p><strong>/publish/CacheStats</strong></p>
<p>Statistics gathered for each cache.</p>
<p><strong>Query Parameters</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="20%" />
<col width="13%" />
<col width="68%" />
</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">hc</span></code></td>
<td>int</td>
<td>The history count, number of items to display.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">stats</span></code></td>
<td>string</td>
<td>A comma separated list of stats to display.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">wildcard</span></code></td>
<td>boolean</td>
<td>Controls whether specified stats should be
treated as partial strings.</td>
</tr>
</tbody>
</table>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p><strong>/publish/CacheStats/:cache</strong></p>
<p>Statistics gathered for only this cache.</p>
<p><strong>Query Parameters</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="20%" />
<col width="13%" />
<col width="68%" />
</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">hc</span></code></td>
<td>int</td>
<td>The history count, number of items to display.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">stats</span></code></td>
<td>string</td>
<td>A comma separated list of stats to display.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">wildcard</span></code></td>
<td>boolean</td>
<td>Controls whether specified stats should be
treated as partial strings.</td>
</tr>
</tbody>
</table>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p><strong>/publish/DsStats</strong></p>
<p>Statistics gathered for delivery services.</p>
<p><strong>Query Parameters</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="20%" />
<col width="13%" />
<col width="68%" />
</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">hc</span></code></td>
<td>int</td>
<td>The history count, number of items to display.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">stats</span></code></td>
<td>string</td>
<td>A comma separated list of stats to display.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">wildcard</span></code></td>
<td>boolean</td>
<td>Controls whether specified stats should be
treated as partial strings.</td>
</tr>
</tbody>
</table>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p><strong>/publish/DsStats/:deliveryService</strong></p>
<p>Statistics gathered for this delivery service only.</p>
<p><strong>Query Parameters</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="20%" />
<col width="13%" />
<col width="68%" />
</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">hc</span></code></td>
<td>int</td>
<td>The history count, number of items to display.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">stats</span></code></td>
<td>string</td>
<td>A comma separated list of stats to display.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">wildcard</span></code></td>
<td>boolean</td>
<td>Controls whether specified stats should be
treated as partial strings.</td>
</tr>
</tbody>
</table>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p><strong>/publish/CrStates</strong></p>
<p>The current state of this CDN per the health protocol.</p>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p><strong>raw</strong></p>
<p>The current state of this CDN per this Traffic Monitor only.</p>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p><strong>/publish/CrConfig</strong></p>
<p>The CrConfig served to and consumed by Traffic Router.</p>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p><strong>/publish/PeerStates</strong></p>
<p>The health state information from all peer Traffic Monitors.</p>
<p><strong>Query Parameters</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="20%" />
<col width="13%" />
<col width="68%" />
</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">hc</span></code></td>
<td>int</td>
<td>The history count, number of items to display.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">stats</span></code></td>
<td>string</td>
<td>A comma separated list of stats to display.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">wildcard</span></code></td>
<td>boolean</td>
<td>Controls whether specified stats should be
treated as partial strings.</td>
</tr>
</tbody>
</table>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p><strong>/publish/Stats</strong></p>
<p>The general statistics about Traffic Monitor.</p>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p><strong>/publish/StatSummary</strong></p>
<p>The summary of cache statistics.</p>
<p><strong>Query Parameters</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="18%" />
<col width="11%" />
<col width="71%" />
</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">startTime</span></code></td>
<td>number</td>
<td>Window start. The number of milliseconds since the epoch.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">endTime</span></code></td>
<td>number</td>
<td>Window end. The number of milliseconds since the epoch.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">hc</span></code></td>
<td>int</td>
<td>The history count, number of items to display.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">stats</span></code></td>
<td>string</td>
<td>A comma separated list of stats to display.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">wildcard</span></code></td>
<td>boolean</td>
<td>Controls whether specified stats should be
treated as partial strings.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cache</span></code></td>
<td>string</td>
<td>Summary statistics for just this cache.</td>
</tr>
</tbody>
</table>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p><strong>/publish/ConfigDoc</strong></p>
<p>The overview of configuration options.</p>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../traffic_monitor_golang.html" class="btn btn-neutral float-right" title="Traffic Monitor Golang">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../traffic_monitor.html" class="btn btn-neutral" title="Traffic Monitor"><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:'2.1-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: ''
};
</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>