| |
| |
| <!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 Administration — Traffic Control 1.1.5-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 1.1.5-dev documentation" href="../index.html"/> |
| <link rel="up" title="Administrator’s Guide" href="index.html"/> |
| <link rel="next" title="Traffic Router Administration" href="traffic_router.html"/> |
| <link rel="prev" title="Managing Traffic Ops Extensions" href="traffic_ops_extensions.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 class="current"> |
| <li class="toctree-l1 current"><a class="reference internal" href="index.html">Administrator’s Guide</a><ul class="current"> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_ops_install.html">Installing Traffic Ops</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_ops_config.html">Configuring Traffic Ops</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_ops_using.html">Using Traffic Ops</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li> |
| <li class="toctree-l2 current"><a class="current reference internal" href="">Traffic Monitor Administration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router Administration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats Administration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server Administration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="traffic_vault.html">Traffic Vault Administration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="quick_howto/index.html">Quick How To Guides</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.5-dev</a> »</li> |
| |
| <li><a href="index.html">Administrator’s Guide</a> »</li> |
| |
| <li>Traffic Monitor Administration</li> |
| <li class="wy-breadcrumbs-aside"> |
| |
| <a href="../_sources/admin/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_router.html" class="btn btn-neutral float-right" title="Traffic Router Administration">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="traffic_ops_extensions.html" class="btn btn-neutral" title="Managing Traffic Ops Extensions"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
| |
| </div> |
| |
| <div role="main" class="document"> |
| |
| <div class="section" id="traffic-monitor-administration"> |
| <h1>Traffic Monitor Administration<a class="headerlink" href="#traffic-monitor-administration" title="Permalink to this headline">¶</a></h1> |
| <div class="section" id="installing-traffic-monitor"> |
| <h2>Installing Traffic Monitor<a class="headerlink" href="#installing-traffic-monitor" title="Permalink to this headline">¶</a></h2> |
| <p>The following are requirements to ensure an accurate set up:</p> |
| <ul class="simple"> |
| <li>CentOS 6</li> |
| <li>4 vCPUs</li> |
| <li>8GB RAM</li> |
| <li>Successful install of Traffic Ops</li> |
| <li>Tomcat</li> |
| <li>Administrative access to the Traffic Ops</li> |
| <li>Physical address of the site</li> |
| <li>perl-JSON</li> |
| <li>perl-WWW-Curl</li> |
| </ul> |
| <ol class="arabic"> |
| <li><p class="first">Enter the Traffic Monitor server into Traffic Ops</p> |
| </li> |
| <li><p class="first">Make sure the FQDN of the Traffic Monitor is resolvable in DNS.</p> |
| </li> |
| <li><p class="first">Install Traffic Monitor and perl mods: <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">yum</span> <span class="pre">-y</span> <span class="pre">install</span> <span class="pre">traffic_monitor</span> <span class="pre">perl-JSON</span> <span class="pre">perl-WWW-Curl</span></code></p> |
| </li> |
| <li><p class="first">Take the config from Traffic Ops - run : <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">/opt/traffic_monitor/bin/traffic_monitor_config.pl</span></code></p> |
| <blockquote> |
| <div><p>Sample output:</p> |
| <div class="highlight-python"><div class="highlight"><pre>traffic_mon # /opt/traffic_monitor/bin/traffic_monitor_config.pl https://traffic-ops.cdn.kabletown.net admin:password prompt |
| DEBUG: traffic_ops selected: https://traffic-ops.cdn.kabletown.net |
| DEBUG: traffic_ops login: admin:kl0tevax |
| DEBUG: Config write mode: prompt |
| DEBUG: Found profile from traffic_ops: RASCAL_CDN |
| DEBUG: Found CDN name from traffic_ops: kabletown_cdn |
| DEBUG: Found location for rascal-config.txt from traffic_ops: /opt/traffic_monitor/conf |
| WARN: Param not in traffic_ops: allow.config.edit description: Allow the running configuration to be edited through the UI Using default value of: false |
| WARN: Param not in traffic_ops: default.accessControlAllowOrigin description: The value for the header: Access-Control-Allow-Origin for published jsons... should be narrowed down to TMs Using default value of: * |
| WARN: Param not in traffic_ops: default.connection.timeout description: Default connection time for all queries (cache, peers, TM) Using default value of: 2000 |
| WARN: Param not in traffic_ops: hack.forceSystemExit description: Call System.exit on shutdown Using default value of: false |
| WARN: Param not in traffic_ops: hack.peerOptimistic description: The assumption of a caches availability when unknown by peers Using default value of: true |
| WARN: Param not in traffic_ops: hack.publishDsStates description: If true, the delivery service states will be included in the CrStates.json Using default value of: true |
| WARN: Param not in traffic_ops: health.ds.interval description: The polling frequency for calculating the deliveryService states Using default value of: 1000 |
| WARN: Param not in traffic_ops: health.ds.leniency description: The amount of time before the deliveryService disregards the last update from a non-responsive cache Using default value of: 30000 |
| WARN: Param not in traffic_ops: health.event-count description: The number of historical events that will be kept Using default value of: 200 |
| WARN: Param not in traffic_ops: health.polling.interval description: The polling frequency for getting the states from caches Using default value of: 5000 |
| WARN: Param not in traffic_ops: health.startupMinCycles description: The number of query cycles that must be completed before this Traffic Monitor will start reporting Using default value of: 2 |
| WARN: Param not in traffic_ops: health.timepad description: A delay between each separate cache query Using default value of: 10 |
| WARN: Param not in traffic_ops: peers.polling.interval description: Polling frequency for getting states from peer monitors Using default value of: 5000 |
| WARN: Param not in traffic_ops: peers.polling.url description: The url for current, unfiltered states from peer monitors Using default value of: http://${hostname}/publish/CrStates?raw |
| WARN: Param not in traffic_ops: peers.threadPool description: The number of threads given to the pool for querying peers Using default value of: 1 |
| WARN: Param not in traffic_ops: tm.auth.url description: The url for the authentication form Using default value of: https://${tmHostname}/login |
| WARN: Param not in traffic_ops: tm.crConfig.json.polling.url description: Url for the cr-config (json) Using default value of: https://${tmHostname}/CRConfig-Snapshots/${cdnName}/CRConfig.json |
| WARN: Param not in traffic_ops: tm.healthParams.polling.url description: The url for the heath params (json) Using default value of: https://${tmHostname}/health/${cdnName} |
| WARN: Param not in traffic_ops: tm.polling.interval description: The polling frequency for getting updates from TM Using default value of: 10000 |
| DEBUG: allow.config.edit needed in config, but does not exist in config on disk. |
| DEBUG: cdnName value on disk () does not match value needed in config (kabletown_cdn). |
| DEBUG: default.accessControlAllowOrigin needed in config, but does not exist in config on disk. |
| DEBUG: default.connection.timeout needed in config, but does not exist in config on disk. |
| DEBUG: hack.forceSystemExit needed in config, but does not exist in config on disk. |
| DEBUG: hack.peerOptimistic needed in config, but does not exist in config on disk. |
| DEBUG: hack.publishDsStates needed in config, but does not exist in config on disk. |
| DEBUG: health.ds.interval needed in config, but does not exist in config on disk. |
| DEBUG: health.ds.leniency needed in config, but does not exist in config on disk. |
| DEBUG: health.startupMinCycles needed in config, but does not exist in config on disk. |
| DEBUG: health.timepad value on disk (20) does not match value needed in config (10). |
| DEBUG: peers.polling.interval needed in config, but does not exist in config on disk. |
| DEBUG: peers.threadPool needed in config, but does not exist in config on disk. |
| DEBUG: tm.auth.password value on disk () does not match value needed in config (kl0tevax). |
| DEBUG: tm.auth.username value on disk () does not match value needed in config (admin). |
| DEBUG: tm.hostname value on disk () does not match value needed in config (traffic-ops.cdn.kabletown.net). |
| DEBUG: Proposed traffic_monitor_config: |
| { |
| "traffic_monitor_config":{ |
| "default.accessControlAllowOrigin":"*", |
| "health.startupMinCycles":"2", |
| "tm.auth.password":"kl0tevax", |
| "tm.auth.url":"https://${tmHostname}/login", |
| "tm.healthParams.polling.url":"https://${tmHostname}/health/${cdnName}", |
| "allow.config.edit":"false", |
| "tm.crConfig.json.polling.url":"https://${tmHostname}/CRConfig-Snapshots/${cdnName}/CRConfig.json", |
| "tm.auth.username":"admin", |
| "peers.polling.url":"http://${hostname}/publish/CrStates?raw", |
| "health.timepad":"10", |
| "hack.publishDsStates":"true", |
| "default.connection.timeout":"2000", |
| "health.ds.interval":"1000", |
| "peers.polling.interval":"5000", |
| "hack.forceSystemExit":"false", |
| "health.ds.leniency":"30000", |
| "cdnName":"kabletown_cdn", |
| "peers.threadPool":"1", |
| "tm.polling.interval":"10000", |
| "health.polling.interval":"5000", |
| "health.event-count":"200", |
| "hack.peerOptimistic":"true", |
| "tm.hostname":"traffic-ops.cdn.kabletown.net" |
| } |
| } |
| ---------------------------------------------- |
| ----OK to write this config to disk? (Y/n) [n]y |
| ---------------------------------------------- |
| ---------------------------------------------- |
| ----OK to write this config to disk? (Y/n) [n]Y |
| ---------------------------------------------- |
| DEBUG: Writing /opt/traffic_monitor/conf/traffic_monitor_config.js |
| traffic_mon # |
| </pre></div> |
| </div> |
| </div></blockquote> |
| </li> |
| <li><p class="first">Start Tomcat: <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">service</span> <span class="pre">tomcat</span> <span class="pre">start</span></code></p> |
| <div class="highlight-python"><div class="highlight"><pre>Using CATALINA_BASE: /opt/tomcat |
| Using CATALINA_HOME: /opt/tomcat |
| Using CATALINA_TMPDIR: /opt/tomcat/temp |
| Using JRE_HOME: /usr |
| Using CLASSPATH:/opt/tomcat/bin/bootstrap.jar |
| Using CATALINA_PID:/var/run/tomcat/tomcat.pid |
| Starting tomcat [ OK ] |
| </pre></div> |
| </div> |
| </li> |
| <li><p class="first">Verify Traffic Monitor is running by pointing your browser to port 80 on the Traffic Monitor host.</p> |
| </li> |
| </ol> |
| </div> |
| <div class="section" id="configuring-traffic-monitor"> |
| <h2>Configuring Traffic Monitor<a class="headerlink" href="#configuring-traffic-monitor" title="Permalink to this headline">¶</a></h2> |
| <div class="section" id="configuration-overview"> |
| <h3>Configuration Overview<a class="headerlink" href="#configuration-overview" title="Permalink to this headline">¶</a></h3> |
| <p>Traffic Monitor is configured using its JSON configuration file, <code class="docutils literal"><span class="pre">traffic_monitor_config.js</span></code>. Specify the URL, username, password, and CDN name for the instance of Traffic Ops for which this Traffic Monitor is a member, and start the software. Once started with the correct configuration, Traffic Monitor downloads its configuration from Traffic Ops and begins polling caches. Once a configurable number of polling cycles completes, health protocol state is available via RESTful JSON endpoints.</p> |
| </div> |
| </div> |
| <div class="section" id="troubleshooting-and-log-files"> |
| <h2>Troubleshooting and log files<a class="headerlink" href="#troubleshooting-and-log-files" title="Permalink to this headline">¶</a></h2> |
| <p>Traffic Monitor log files are in <code class="docutils literal"><span class="pre">/opt/traffic_monitor/var/log/</span></code>, and tomcat log files are in <code class="docutils literal"><span class="pre">/opt/tomcat/logs/</span></code>.</p> |
| </div> |
| </div> |
| |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="traffic_router.html" class="btn btn-neutral float-right" title="Traffic Router Administration">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="traffic_ops_extensions.html" class="btn btn-neutral" title="Managing Traffic Ops Extensions"><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.5-dev', |
| 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> |