rob05c commented on a change in pull request #3605: Fix TM polling urls with
ports
URL: https://github.com/apache/trafficcontrol/pull/3605#discussion_r288662250
##########
File path: docs/source/admin/traffic_monitor.rst
##########
@@ -52,6 +52,27 @@ Configuration Overview
----------------------
Traffic Monitor is configured via two JSON configuration files,
:file:`traffic_ops.cfg` and :file:`traffic_monitor.cfg`, by default located in
the ``conf`` directory in the install location. :file:`traffic_ops.cfg`
contains Traffic Ops connection information. Specify the URL, username, and
password for the instance of Traffic Ops of which this Traffic Monitor is a
member. :file:`traffic_monitor.cfg` contains log file locations, as well as
detailed application configuration variables such as processing flush times and
initial poll intervals. Once started with the correct configuration, Traffic
Monitor downloads its configuration from Traffic Ops and begins polling
:term:`cache server` s. Once every :term:`cache server` has been polled,
:ref:`health-proto` state is available via RESTful JSON endpoints and a web
browser UI.
+
+Cache Polling URL
+-----------------------------------
+
+Caches are polled at the URL specified in the ``health.polling.url``
Parameter, on the cache's Server Profile.
+
+This Parameter must have the config file ``rascal.properties``.
+
+The value is a template with the text ``${hostname}`` being replaced with the
cache server's Network IP (IPv4), and ``${interface_name}`` being replaced with
the server's network Interface Name. For example,
``http://${hostname}/_astats?application=&inf.name=${interface_name}``.
+
+If the template contains a port, that port will be used, and the cache
server's HTTPS and TCP Ports will not be added.
+
+If the template does not contain a port, then if the template starts with
``https`` the cache server's HTTPS Port will be added, and if the template
doesn't start with ``https`` the cache server's TCP Port will be added.
+
+Examples:
+
+Template
``http://${hostname}/_astats?application=&inf.name=${interface_name}`` Server
IP ``192.0.2.42`` Server TCP Port ``8080`` HTTPS Port ``8443`` becomes
``http://192.0.2.42:8080/_astats?application=&inf.name=${interface_name}``.
+Template
``https://${hostname}/_astats?application=&inf.name=${interface_name}`` Server
IP ``192.0.2.42`` Server TCP Port ``8080`` HTTPS Port ``8443`` becomes
``https://192.0.2.42:8443/_astats?application=&inf.name=${interface_name}``.
+Template
``http://${hostname}:1234/_astats?application=&inf.name=${interface_name}``
Server IP ``192.0.2.42`` Server TCP Port ``8080`` HTTPS Port ``8443`` becomes
``http://192.0.2.42:1234/_astats?application=&inf.name=${interface_name}``.
+Template
``https://${hostname}:1234/_astats?application=&inf.name=${interface_name}``
Server IP ``192.0.2.42`` Server TCP Port ``8080`` HTTPS Port ``8443`` becomes
``https://192.0.2.42:1234/_astats?application=&inf.name=${interface_name}``.
+
Review comment:
Done
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
