[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request #4627: Tm plugin docs

[GitBox <gi...@apache.org>]

zrhoffman commented on a change in pull request #4627:
URL: https://github.com/apache/trafficcontrol/pull/4627#discussion_r413922184



##########
File path: docs/source/admin/traffic_monitor.rst
##########
@@ -104,3 +81,21 @@ It is not recommended to set either flush interval to 0, regardless of the stat
 Troubleshooting and Log Files
 =============================
 Traffic Monitor log files are in :file:`/opt/traffic_monitor/var/log/`.
+
+.. _admin-tm-extensions:
+
+Extensions
+==========
+Traffic Monitor allows extensions to its parsers for the statistics returned by :term:`cache servers` and/or their plugins. The formats supported by Traffic Monitor by default are ``astats``, ``astats-dsnames`` (which is an odd variant of ``astats`` that probably shouldn't be used), and ``stats_over_http``. The format of a :term:`cache server`'s health and statistics reporting payloads must be declared on its :term:`Profile` as the :ref:`param-health-polling-format` :term:`Parameter`, or the default format (``astats``) will be assumed.

Review comment:
       Getting a warning about `param-health-polling-format` being undefined on this line
   
   ```
   WARNING: undefined label: param-health-polling-format (if the link has no caption the label must precede a section header)
   ```

##########
File path: docs/source/admin/traffic_monitor.rst
##########
@@ -104,3 +81,21 @@ It is not recommended to set either flush interval to 0, regardless of the stat
 Troubleshooting and Log Files
 =============================
 Traffic Monitor log files are in :file:`/opt/traffic_monitor/var/log/`.
+
+.. _admin-tm-extensions:
+
+Extensions
+==========
+Traffic Monitor allows extensions to its parsers for the statistics returned by :term:`cache servers` and/or their plugins. The formats supported by Traffic Monitor by default are ``astats``, ``astats-dsnames`` (which is an odd variant of ``astats`` that probably shouldn't be used), and ``stats_over_http``. The format of a :term:`cache server`'s health and statistics reporting payloads must be declared on its :term:`Profile` as the :ref:`param-health-polling-format` :term:`Parameter`, or the default format (``astats``) will be assumed.
+
+For instructions on how to develop a parsing extension, refer to the :atc-godoc:`traffic_monitor/cache` package's documentation.
+
+Importantly, though, a statistics provider *must* respond to HTTP GET requests over either plain HTTP or HTTPS (which is used will be controlled by the :ref:`param-health-polling-url` :term:`Parameter`), and it *must* provide the following statistics, or enough information to calculate them:

Review comment:
       Getting a warning about `param-health-polling-url` being undefined on this line
   
   ```
   WARNING: undefined label: param-health-polling-url (if the link has no caption the label must precede a section header)
   ```




----------------------------------------------------------------
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:
users@infra.apache.org