http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/8582b168/docs/1.1.2/basics/http_11.html ---------------------------------------------------------------------- diff --git a/docs/1.1.2/basics/http_11.html b/docs/1.1.2/basics/http_11.html new file mode 100644 index 0000000..ae4682a --- /dev/null +++ b/docs/1.1.2/basics/http_11.html @@ -0,0 +1,285 @@ + + +<!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>HTTP 1.1 — Traffic Control 1.1.2 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.1.2 documentation" href="../index.html"/> + <link rel="up" title="CDN Basics" href="index.html"/> + <link rel="next" title="Caching Proxies" href="caching_proxies.html"/> + <link rel="prev" title="Content Delivery Networks" href="content_delivery_networks.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 class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="index.html">CDN Basics</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="content_delivery_networks.html">Content Delivery Networks</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="">HTTP 1.1</a></li> +<li class="toctree-l2"><a class="reference internal" href="caching_proxies.html">Caching Proxies</a></li> +<li class="toctree-l2"><a class="reference internal" href="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> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../development/traffic_ops.html">Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../development/traffic_router.html">Traffic Router</a></li> +<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor</a></li> +<li class="toctree-l2"><a class="reference internal" href="../development/traffic_stats.html">Traffic Stats</a></li> +<li class="toctree-l2"><a class="reference internal" href="../development/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.1.2</a> »</li> + + <li><a href="index.html">CDN Basics</a> »</li> + + <li>HTTP 1.1</li> + <li class="wy-breadcrumbs-aside"> + + <a href="../_sources/basics/http_11.txt" rel="nofollow"> View page source</a> + + </li> + </ul> + <hr/> +</div> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="caching_proxies.html" class="btn btn-neutral float-right" title="Caching Proxies">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="content_delivery_networks.html" class="btn btn-neutral" title="Content Delivery Networks"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + <div role="main" class="document"> + + <div class="section" id="http-1-1"> +<span id="index-0"></span><h1>HTTP 1.1<a class="headerlink" href="#http-1-1" title="Permalink to this headline">¶</a></h1> +<p>For a comprehensive look at Traffic Control, it is important to understand basic HTTP 1.1 protocol operations and how caches function. The example below illustrates the fulfillment of an HTTP 1.1 request in a situation without CDN or proxy, followed by viewing the changes after inserting different types of (caching) proxies. Several of the examples below are simplified for clarification of the essentials.</p> +<p>For complete details on HTTP 1.1 see <a class="reference external" href="https://www.ietf.org/rfc/rfc2616.txt";>RFC 2616 - Hypertext Transfer Protocol – HTTP/1.1</a>.</p> +<p>Below are the steps of a client retrieving the URL <code class="docutils literal"><span class="pre">http://www.origin.com/foo/bar/fun.html</span></code> using HTTP/1.1 without proxies:</p> +<ol class="arabic simple"> +<li>The client sends a request to the Local DNS (LDNS) server to resolve the name <code class="docutils literal"><span class="pre">www.origin.com</span></code> to an IPv4 address.</li> +<li>If the LDNS does not have this name (IPv4 mapping cached), it sends DNS requests to the ., .com, and .origin.com authoritative servers until it receives a response with the address for <code class="docutils literal"><span class="pre">www.origin.com</span></code>. Per the DNS SPEC, this response has a Time To Live (TTL), which indicates how long this mapping can be cached at the LDNS server. In the example, the IP address found by the LDNS server for www.origin.com is 44.33.22.11.</li> +</ol> +<blockquote> +<div><div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">While longer DNS TTLs of a day (86400 seconds) or more are quite common in other use cases, in CDN use cases DNS TTLs are often below a minute.</p> +</div> +</div></blockquote> +<ol class="arabic" start="3"> +<li><p class="first">The client opens a TCP connection from a random port locally to port 80 (the HTTP default) on 44.33.22.11, and sends this (showing the minimum HTTP 1.1 request, typically there are additional headers):</p> +<div class="highlight-python"><div class="highlight"><pre>GET /foo/bar/fun.html HTTP/1.1 +Host: www.origin.com +</pre></div> +</div> +</li> +<li><p class="first">The server at <code class="docutils literal"><span class="pre">www.origin.com</span></code> looks up the Host: header to match that to a configuration section, usually referred to as a virtual host section. If the Host: header and configuration section match, the search continues for the content of the path <code class="docutils literal"><span class="pre">/foo/bar/fun.html</span></code>, in the example, this is a file that contains <code class="docutils literal"><span class="pre"><html><body>This</span> <span class="pre">is</span> <span class="pre">a</span> <span class="pre">fun</span> <span class="pre">file</body></html></span></code>, so the server responds with the following:</p> +<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 200 OK +Content-Type: text/html; charset=UTF-8 +Content-Length: 45 + +<html><body>This is a fun file</body></html> +</pre></div> +</div> +</li> +</ol> +<blockquote> +<div>At this point, HTTP transaction is complete.</div></blockquote> +</div> + + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="caching_proxies.html" class="btn btn-neutral float-right" title="Caching Proxies">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="content_delivery_networks.html" class="btn btn-neutral" title="Content Delivery Networks"><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.1.2', + 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> \ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/8582b168/docs/1.1.2/basics/index.html ---------------------------------------------------------------------- diff --git a/docs/1.1.2/basics/index.html b/docs/1.1.2/basics/index.html new file mode 100644 index 0000000..1cd878f --- /dev/null +++ b/docs/1.1.2/basics/index.html @@ -0,0 +1,264 @@ + + +<!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>CDN Basics — Traffic Control 1.1.2 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.1.2 documentation" href="../index.html"/> + <link rel="next" title="Content Delivery Networks" href="content_delivery_networks.html"/> + <link rel="prev" title="Traffic Control" href="../index.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 class="current"> +<li class="toctree-l1 current"><a class="current reference internal" href="">CDN Basics</a><ul> +<li class="toctree-l2"><a class="reference internal" href="content_delivery_networks.html">Content Delivery Networks</a></li> +<li class="toctree-l2"><a class="reference internal" href="http_11.html">HTTP 1.1</a></li> +<li class="toctree-l2"><a class="reference internal" href="caching_proxies.html">Caching Proxies</a></li> +<li class="toctree-l2"><a class="reference internal" href="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> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../development/traffic_ops.html">Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../development/traffic_router.html">Traffic Router</a></li> +<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor</a></li> +<li class="toctree-l2"><a class="reference internal" href="../development/traffic_stats.html">Traffic Stats</a></li> +<li class="toctree-l2"><a class="reference internal" href="../development/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.1.2</a> »</li> + + <li>CDN Basics</li> + <li class="wy-breadcrumbs-aside"> + + <a href="../_sources/basics/index.txt" rel="nofollow"> View page source</a> + + </li> + </ul> + <hr/> +</div> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="content_delivery_networks.html" class="btn btn-neutral float-right" title="Content Delivery Networks">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="../index.html" class="btn btn-neutral" title="Traffic Control"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + <div role="main" class="document"> + + <div class="section" id="cdn-basics"> +<h1>CDN Basics<a class="headerlink" href="#cdn-basics" title="Permalink to this headline">¶</a></h1> +<p>Traffic Control is a CDN control plane, see the topics below to familiarize yourself with the basic concepts of a CDN.</p> +<div class="toctree-wrapper compound"> +<ul> +<li class="toctree-l1"><a class="reference internal" href="content_delivery_networks.html">Content Delivery Networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="http_11.html">HTTP 1.1</a></li> +<li class="toctree-l1"><a class="reference internal" href="caching_proxies.html">Caching Proxies</a><ul> +<li class="toctree-l2"><a class="reference internal" href="caching_proxies.html#arrow-reverse-proxy"> Reverse Proxy</a></li> +<li class="toctree-l2"><a class="reference internal" href="caching_proxies.html#arrow-forward-proxy"> Forward Proxy</a></li> +<li class="toctree-l2"><a class="reference internal" href="caching_proxies.html#arrow-transparent-proxy"> Transparent Proxy</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="cache_revalidation.html">Cache Control Headers and Revalidation</a></li> +</ul> +</div> +</div> + + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="content_delivery_networks.html" class="btn btn-neutral float-right" title="Content Delivery Networks">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="../index.html" class="btn btn-neutral" title="Traffic Control"><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.1.2', + 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> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/8582b168/docs/1.1.2/development/index.html ---------------------------------------------------------------------- diff --git a/docs/1.1.2/development/index.html b/docs/1.1.2/development/index.html new file mode 100644 index 0000000..a8fd406 --- /dev/null +++ b/docs/1.1.2/development/index.html @@ -0,0 +1,297 @@ + + +<!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>Developerâs Guide — Traffic Control 1.1.2 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.1.2 documentation" href="../index.html"/> + <link rel="next" title="Traffic Ops" href="traffic_ops.html"/> + <link rel="prev" title="Traffic Vault Administration" href="../admin/traffic_vault.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> +</ul> +</li> +</ul> +<ul class="current"> +<li class="toctree-l1 current"><a class="current reference internal" href="">Developer’s Guide</a><ul> +<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_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.1.2</a> »</li> + + <li>Developer’s Guide</li> + <li class="wy-breadcrumbs-aside"> + + <a href="../_sources/development/index.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_ops.html" class="btn btn-neutral float-right" title="Traffic Ops">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="../admin/traffic_vault.html" class="btn btn-neutral" title="Traffic Vault Administration"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + <div role="main" class="document"> + + <div class="section" id="developer-s-guide"> +<h1>Developer’s Guide<a class="headerlink" href="#developer-s-guide" title="Permalink to this headline">¶</a></h1> +<p>Use this guide to start developing applications that consume the Traffic Control APIs, to create extensions to Traffic Ops, or work on Traffic Control itself.</p> +<div class="toctree-wrapper compound"> +<ul> +<li class="toctree-l1"><a class="reference internal" href="traffic_ops.html">Traffic Ops</a><ul> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops.html#introduction">Introduction</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops.html#software-requirements">Software Requirements</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops.html#traffic-ops-project-tree-overview">Traffic Ops Project Tree Overview</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops.html#perl-formatting-conventions">Perl Formatting Conventions</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops.html#database-management">Database Management</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops.html#installing-the-developer-environment">Installing The Developer Environment</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops.html#test-cases">Test Cases</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops.html#extensions">Extensions</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops.html#api">API</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="traffic_router.html">Traffic Router</a><ul> +<li class="toctree-l2"><a class="reference internal" href="traffic_router.html#introduction">Introduction</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_router.html#software-requirements">Software Requirements</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_router.html#traffic-router-project-tree-overview">Traffic Router Project Tree Overview</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_router.html#java-formatting-conventions">Java Formatting Conventions</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_router.html#installing-the-developer-environment">Installing The Developer Environment</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_router.html#test-cases">Test Cases</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_router.html#api">API</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor</a><ul> +<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html#introduction">Introduction</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html#software-requirements">Software Requirements</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html#traffic-monitor-project-tree-overview">Traffic Monitor Project Tree Overview</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html#java-formatting-conventions">Java Formatting Conventions</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html#installing-the-developer-environment">Installing The Developer Environment</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html#test-cases">Test Cases</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html#api">API</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="traffic_stats.html">Traffic Stats</a><ul> +<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html#introduction">Introduction</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html#software-requirements">Software Requirements</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html#traffic-stats-project-tree-overview">Traffic Stats Project Tree Overview</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html#go-formatting-conventions">Go Formatting Conventions</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html#installing-the-developer-environment">Installing The Developer Environment</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html#test-cases">Test Cases</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="traffic_server.html">Traffic Server</a></li> +</ul> +</div> +</div> + + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="traffic_ops.html" class="btn btn-neutral float-right" title="Traffic Ops">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="../admin/traffic_vault.html" class="btn btn-neutral" title="Traffic Vault Administration"><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.1.2', + 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> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/8582b168/docs/1.1.2/development/traffic_monitor.html ---------------------------------------------------------------------- diff --git a/docs/1.1.2/development/traffic_monitor.html b/docs/1.1.2/development/traffic_monitor.html new file mode 100644 index 0000000..d1658c5 --- /dev/null +++ b/docs/1.1.2/development/traffic_monitor.html @@ -0,0 +1,389 @@ + + +<!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 — Traffic Control 1.1.2 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.1.2 documentation" href="../index.html"/> + <link rel="up" title="Developerâs Guide" href="index.html"/> + <link rel="next" title="Traffic Monitor APIs" href="traffic_monitor/traffic_monitor_api.html"/> + <link rel="prev" title="Traffic Router API" href="traffic_router/traffic_router_api.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> +</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"><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 current"><a class="current reference internal" href="">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.1.2</a> »</li> + + <li><a href="index.html">Developer’s Guide</a> »</li> + + <li>Traffic Monitor</li> + <li class="wy-breadcrumbs-aside"> + + <a href="../_sources/development/traffic_monitor.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/traffic_monitor_api.html" class="btn btn-neutral float-right" title="Traffic Monitor APIs">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="traffic_router/traffic_router_api.html" class="btn btn-neutral" title="Traffic Router API"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + <div role="main" class="document"> + + <div class="section" id="traffic-monitor"> +<h1>Traffic Monitor<a class="headerlink" href="#traffic-monitor" title="Permalink to this headline">¶</a></h1> +<div class="section" id="introduction"> +<h2>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2> +<p>Traffic Monitor is a Java Tomcat application that monitors caches, provides health state information to Traffic Router, and collects statistics for use in tools such as Traffic Ops and Traffic Stats. The health state provided by Traffic Monitor is used by Traffic Router to control which caches are available on the CDN.</p> +</div> +<div class="section" id="software-requirements"> +<h2>Software Requirements<a class="headerlink" href="#software-requirements" title="Permalink to this headline">¶</a></h2> +<p>To work on Traffic Monitor you need a *nix (MacOS and Linux are most commonly used) environment that has the following installed:</p> +<ul class="simple"> +<li>Eclipse >= Kepler SR2 (or another Java IDE)</li> +<li>Maven >= 3.3.1</li> +<li>JDK >= 6.0</li> +</ul> +</div> +<div class="section" id="traffic-monitor-project-tree-overview"> +<h2>Traffic Monitor Project Tree Overview<a class="headerlink" href="#traffic-monitor-project-tree-overview" title="Permalink to this headline">¶</a></h2> +<ul> +<li><p class="first"><code class="docutils literal"><span class="pre">traffic_control/traffic_monitor/</span></code> - base directory for Traffic Monitor</p> +<blockquote> +<div><ul> +<li><p class="first"><code class="docutils literal"><span class="pre">etc/</span></code> - Miscellaneous simulator utilities</p> +</li> +<li><p class="first"><code class="docutils literal"><span class="pre">src/main</span></code> - Main source directory for the Traffic Monitor</p> +<blockquote> +<div><ul class="simple"> +<li><code class="docutils literal"><span class="pre">bin/</span></code> - Configuration tools</li> +<li><code class="docutils literal"><span class="pre">conf/</span></code> - Configuration files</li> +<li><code class="docutils literal"><span class="pre">java/</span></code> - Java source code for Traffic Monitor</li> +<li><code class="docutils literal"><span class="pre">opt/tomcat/conf</span></code> - Contains Tomcat configuration file(s) pulled in during an RPM build</li> +<li><code class="docutils literal"><span class="pre">resources/</span></code> - Resources pulled in during an RPM build</li> +<li><code class="docutils literal"><span class="pre">scripts/</span></code> - Scripts used by the RPM build process</li> +<li><code class="docutils literal"><span class="pre">webapp/</span></code> - Java webapp resources</li> +</ul> +</div></blockquote> +</li> +<li><p class="first"><code class="docutils literal"><span class="pre">src/test</span></code> - Test source directory for Traffic Monitor</p> +<blockquote> +<div><ul class="simple"> +<li><code class="docutils literal"><span class="pre">java/</span></code> - JUnit based unit tests for Traffic Monitor</li> +<li><code class="docutils literal"><span class="pre">resources/conf</span></code> - Configuration files used by unit tests</li> +<li><code class="docutils literal"><span class="pre">resources/db</span></code> - Files downloaded by unit tests</li> +<li><code class="docutils literal"><span class="pre">resources/var</span></code> - Files generated by unit tests</li> +</ul> +</div></blockquote> +</li> +</ul> +</div></blockquote> +</li> +</ul> +</div> +<div class="section" id="java-formatting-conventions"> +<h2>Java Formatting Conventions<a class="headerlink" href="#java-formatting-conventions" title="Permalink to this headline">¶</a></h2> +<p>None at this time. The codebase will eventually be formatted per Java standards.</p> +</div> +<div class="section" id="installing-the-developer-environment"> +<h2>Installing The Developer Environment<a class="headerlink" href="#installing-the-developer-environment" title="Permalink to this headline">¶</a></h2> +<p>To install the Traffic Monitor Developer environment:</p> +<ol class="arabic simple"> +<li>Clone the traffic_control repository using Git.</li> +<li>Change directories into <code class="docutils literal"><span class="pre">traffic_control/traffic_monitor</span></code>.</li> +<li>Edit the following parameters in src/test/resources/conf/traffic_monitor_config.js:</li> +</ol> +<table border="1" class="docutils"> +<colgroup> +<col width="22%" /> +<col width="78%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Value</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">tm.hostname</span></code></td> +<td>FQDN of the Traffic Ops instance (do not include <a class="reference external" href="http://";>http://</a>).</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">tm.username</span></code></td> +<td>Admin username for Traffic Ops</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">tm.password</span></code></td> +<td>Password for admin user</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdnName</span></code></td> +<td>Name of the CDN this Traffic Monitor will monitor</td> +</tr> +</tbody> +</table> +<ol class="arabic" start="4"> +<li><p class="first">Import the existing git repo into Eclipse:</p> +<blockquote> +<div><ol class="loweralpha simple"> +<li>File -> Import -> Git -> Projects from Git; Next</li> +<li>Existing local repository; Next</li> +<li>Add -> browse to find <code class="docutils literal"><span class="pre">traffic_control</span></code>; Add</li> +<li>Select <code class="docutils literal"><span class="pre">traffic_control</span></code>; Next</li> +<li>Ensure “Import existing projects” is selected, expand <code class="docutils literal"><span class="pre">traffic_control</span></code>, select <code class="docutils literal"><span class="pre">traffic_monitor</span></code>; Next</li> +<li>Ensure <code class="docutils literal"><span class="pre">traffic_monitor</span></code> is checked; Finish</li> +<li>Ensure <code class="docutils literal"><span class="pre">traffic_monitor</span></code> has been opened by Eclipse after importing</li> +</ol> +</div></blockquote> +</li> +<li><p class="first">Run <code class="docutils literal"><span class="pre">mvn</span> <span class="pre">clean</span> <span class="pre">verify</span></code> from the <code class="docutils literal"><span class="pre">traffic_monitor</span></code> directory</p> +</li> +<li><p class="first">Start the embedded Jetty instance from within Eclipse</p> +<blockquote> +<div><ol class="loweralpha"> +<li><p class="first">In the package explorer, expand <code class="docutils literal"><span class="pre">traffic_monitor</span></code></p> +</li> +<li><p class="first">Expand <code class="docutils literal"><span class="pre">src/test/java</span></code></p> +</li> +<li><p class="first">Expand the package <code class="docutils literal"><span class="pre">com.comcast.cdn.traffic_control.traffic_monitor</span></code></p> +</li> +<li><p class="first">Open and run <code class="docutils literal"><span class="pre">Start.java</span></code></p> +<blockquote> +<div><div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">If an error is displayed in the Console, run <code class="docutils literal"><span class="pre">mvn</span> <span class="pre">clean</span> <span class="pre">verify</span></code> from the <code class="docutils literal"><span class="pre">traffic_monitor</span></code> directory</p> +</div> +</div></blockquote> +</li> +<li><p class="first">With a web browser, navigate to <a class="reference external" href="http://localhost:8080";>http://localhost:8080</a></p> +</li> +</ol> +</div></blockquote> +</li> +</ol> +</div> +<div class="section" id="test-cases"> +<h2>Test Cases<a class="headerlink" href="#test-cases" title="Permalink to this headline">¶</a></h2> +<p>Unit tests can be executed using Maven by running <code class="docutils literal"><span class="pre">mvn</span> <span class="pre">test</span></code> at the root of the <code class="docutils literal"><span class="pre">traffic_monitor</span></code> project.</p> +</div> +<div class="section" id="api"> +<h2>API<a class="headerlink" href="#api" title="Permalink to this headline">¶</a></h2> +<p><a class="reference internal" href="traffic_monitor/traffic_monitor_api.html#reference-tm-api"><span>Traffic Monitor APIs</span></a></p> +<div class="toctree-wrapper compound"> +</div> +</div> +</div> + + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="traffic_monitor/traffic_monitor_api.html" class="btn btn-neutral float-right" title="Traffic Monitor APIs">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="traffic_router/traffic_router_api.html" class="btn btn-neutral" title="Traffic Router API"><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.1.2', + 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> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/8582b168/docs/1.1.2/development/traffic_monitor/traffic_monitor_api.html ---------------------------------------------------------------------- diff --git a/docs/1.1.2/development/traffic_monitor/traffic_monitor_api.html b/docs/1.1.2/development/traffic_monitor/traffic_monitor_api.html new file mode 100644 index 0000000..a93cb49 --- /dev/null +++ b/docs/1.1.2/development/traffic_monitor/traffic_monitor_api.html @@ -0,0 +1,502 @@ + + +<!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 — Traffic Control 1.1.2 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.1.2 documentation" href="../../index.html"/> + <link rel="up" title="Traffic Monitor" href="../traffic_monitor.html"/> + <link rel="next" title="Traffic Stats" href="../traffic_stats.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.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> +</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"><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 current"><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.1.2</a> »</li> + + <li><a href="../index.html">Developer’s Guide</a> »</li> + + <li><a href="../traffic_monitor.html">Traffic Monitor</a> »</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_stats.html" class="btn btn-neutral float-right" title="Traffic Stats">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_stats.html" class="btn btn-neutral float-right" title="Traffic Stats">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:'1.1.2', + 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> \ No newline at end of file
