| |
| |
| |
| |
| <!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 Stats — Traffic Control 2.2-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="index" title="Index" |
| href="../genindex.html"/> |
| <link rel="search" title="Search" href="../search.html"/> |
| <link rel="top" title="Traffic Control 2.2-dev documentation" href="../index.html"/> |
| <link rel="up" title="Developer’s Guide" href="index.html"/> |
| <link rel="next" title="APIs" href="../api/index.html"/> |
| <link rel="prev" title="Traffic Monitor APIs" href="traffic_monitor/traffic_monitor_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_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_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/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/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</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/installation.html">Traffic Portal Administration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</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’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"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor Golang</a></li> |
| <li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Stats</a></li> |
| </ul> |
| </li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../api/index.html">APIs</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="../api/traffic_ops_api.html">API Overview</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../api/routes.html">API Routes</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../api/v11/index.html">API 1.1 Reference</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../api/v12/index.html">API 1.2 Reference</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../api/v13/index.html">API 1.3 Reference</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 2.2-dev</a> »</li> |
| |
| <li><a href="index.html">Developer’s Guide</a> »</li> |
| |
| <li>Traffic Stats</li> |
| <li class="wy-breadcrumbs-aside"> |
| |
| <a href="../_sources/development/traffic_stats.rst.txt" rel="nofollow"> View page source</a> |
| |
| </li> |
| </ul> |
| <hr/> |
| </div> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="../api/index.html" class="btn btn-neutral float-right" title="APIs">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="traffic_monitor/traffic_monitor_api.html" class="btn btn-neutral" title="Traffic Monitor APIs"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
| |
| </div> |
| |
| <div role="main" class="document"> |
| |
| <div class="section" id="traffic-stats"> |
| <h1>Traffic Stats<a class="headerlink" href="#traffic-stats" 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 Stats is a utility written in <a class="reference external" href="http.golang.org">Go</a> that is used to acquire and store statistics about CDNs controlled by Traffic Control. Traffic Stats mines metrics from Traffic Monitor’s JSON APIs and stores the data in <a class="reference external" href="http://influxdb.com">InfluxDb</a>. Data is typically stored in InfluxDb on a short-term basis (30 days or less) and is used to drive graphs created by <a class="reference external" href="http://grafana.org">Grafana</a> which are linked from Traffic Ops. Traffic Stats also calculates daily statistics from InfluxDb and stores them in the Traffic Ops database.</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 Stats you need a *nix (MacOS and Linux are most commonly used) environment that has the following installed:</p> |
| <blockquote> |
| <div><ul class="simple"> |
| <li><a class="reference external" href="https://golang.org/doc/install">Go 1.7.x or above</a></li> |
| <li>Access to a working instance of Traffic Ops</li> |
| <li>Access to a working instance of Traffic Monitor</li> |
| <li><a class="reference external" href="https://influxdb.com/download/index.html">InfluxDb version 1.0.0 or greater</a></li> |
| </ul> |
| </div></blockquote> |
| </div> |
| <div class="section" id="traffic-stats-project-tree-overview"> |
| <h2>Traffic Stats Project Tree Overview<a class="headerlink" href="#traffic-stats-project-tree-overview" title="Permalink to this headline">¶</a></h2> |
| <blockquote> |
| <div><ul class="simple"> |
| <li><strong>traffic_control/traffic_stats</strong> - contains Go source files and Files used to create the Traffic Stats rpm.</li> |
| <li><strong>traffic_control/traffic_stats/grafana/</strong> - contains a javascript file which is installed on the grafana server. This allows Traffic Ops to create custom dashboards for Delivery Services, Caches, etc.</li> |
| <li><strong>traffic_control/traffic_stats/influxdb_tools/</strong> - contains one tool to create the databases and retention policies needed by Traffic Stats as well as continuous queries to downsample data; contains another tool to sync downsampled data between influxdb instances. This is is helpful if you have multiple instances and they get out of sync with data.</li> |
| </ul> |
| </div></blockquote> |
| </div> |
| <div class="section" id="go-formatting-conventions"> |
| <h2>Go Formatting Conventions<a class="headerlink" href="#go-formatting-conventions" title="Permalink to this headline">¶</a></h2> |
| <p>In general <a class="reference external" href="https://golang.org/cmd/gofmt/">Go fmt</a> is the standard for formatting go code. It is also recommended to use <a class="reference external" href="https://github.com/golang/lint">Go lint</a>.</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 Ops Developer environment:</p> |
| <blockquote> |
| <div><ul class="simple"> |
| <li>Clone the traffic_control repository using Git into a location accessible by your $GOPATH</li> |
| <li>Navigate to the traffic_ops/client directory of your cloned repository. (This is the directory containing Traffic Ops client code used by Traffic Stats)</li> |
| <li>From the traffic_ops/client directory run <code class="docutils literal notranslate"><span class="pre">go</span> <span class="pre">test</span></code> to test the client code. This will run all unit tests for the client and return the results. If there are missing dependencies you will need to run <code class="docutils literal notranslate"><span class="pre">go</span> <span class="pre">get</span> <span class="pre"><dependency</span> <span class="pre">name></span></code> to get the dependency</li> |
| <li>Once the tests pass, run <code class="docutils literal notranslate"><span class="pre">go</span> <span class="pre">install</span></code> to build and install the Traffic Ops client package. This makes it accessible to Traffic Stats.</li> |
| <li>Navigate to your cloned repo under Traffic Stats</li> |
| <li>Run <code class="docutils literal notranslate"><span class="pre">go</span> <span class="pre">build</span> <span class="pre">traffic_stats.go</span></code> to build traffic_stats. You will need to run <code class="docutils literal notranslate"><span class="pre">go</span> <span class="pre">get</span></code> for any missing dependencies.</li> |
| </ul> |
| </div></blockquote> |
| </div> |
| <div class="section" id="test-cases"> |
| <h2>Test Cases<a class="headerlink" href="#test-cases" title="Permalink to this headline">¶</a></h2> |
| <blockquote> |
| <div>Currently there are no automated tests for Traffic Stats :( but pull requests are always welcome to fix this problem!</div></blockquote> |
| </div> |
| </div> |
| |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="../api/index.html" class="btn btn-neutral float-right" title="APIs">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="traffic_monitor/traffic_monitor_api.html" class="btn btn-neutral" title="Traffic Monitor APIs"><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> |
| |
| |
| |
| <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions"> |
| <span class="rst-current-version" data-toggle="rst-current-version"> |
| <span class="fa fa-book">Apache Traffic Control (Incubating)</span> |
| v: |
| <span class="fa fa-caret-down"></span> |
| </span> |
| <div class="rst-other-versions"> |
| <dl> |
| <dt>Versions</dt> |
| <dd><a href="/docs/master/">latest</a></dd> |
| <dd><a href="/docs/2.0/">2.0</a></dd> |
| <dd><a href="/docs/1.8.1/">1.8</a></dd> |
| <dd><a href="/docs/1.7.0/">1.7</a></dd> |
| </dl> |
| <hr/> |
| Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>. |
| |
| </div> |
| </div> |
| |
| |
| |
| <script type="text/javascript"> |
| var DOCUMENTATION_OPTIONS = { |
| URL_ROOT:'../', |
| VERSION:'2.2-dev', |
| COLLAPSE_INDEX:false, |
| FILE_SUFFIX:'.html', |
| HAS_SOURCE: true, |
| SOURCELINK_SUFFIX: '.txt' |
| }; |
| </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> |
