You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@trafficcontrol.apache.org by GitBox <gi...@apache.org> on 2021/10/19 14:36:49 UTC

[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request #6298: Feature/tm heartbeat poll documentation

ocket8888 commented on a change in pull request #6298:
URL: https://github.com/apache/trafficcontrol/pull/6298#discussion_r731937086



##########
File path: docs/source/api/v3/cdns_name_configs_monitoring.rst
##########
@@ -52,7 +52,8 @@ Response Structure
 
 :config: A collection of parameters used to configure the monitoring behaviour of Traffic Monitor
 
-	:health.polling.interval:     An interval in milliseconds on which to poll for health statistics
+	:health.polling.interval:     An interval in milliseconds on which to poll for cache statistics
+	:heartbeat.polling.interval:  An interval in milliseconds on which to poll for health statistics. If missing, defaults to `health.polling.interval`.

Review comment:
       same as above

##########
File path: docs/source/api/v2/cdns_name_configs_monitoring.rst
##########
@@ -52,7 +52,8 @@ Response Structure
 
 :config: A collection of parameters used to configure the monitoring behaviour of Traffic Monitor
 
-	:health.polling.interval:     An interval in milliseconds on which to poll for health statistics
+	:health.polling.interval:     An interval in milliseconds on which to poll for cache statistics
+	:heartbeat.polling.interval:  An interval in milliseconds on which to poll for health statistics. If missing, defaults to `health.polling.interval`.

Review comment:
       Single grave accents (or "backticks": <kbd>\`</kbd>) place the contained text within the `any` role, which renders as emphasized text in our configuration - not like Markdown, where that would be monospace "code" markup.
   
   To make text inline monospaced, use _double_ grave accents like:
   ```rst
   If missing, defaults to ``health.polling.interval``.
   ```

##########
File path: docs/source/api/v4/cdns_name_configs_monitoring.rst
##########
@@ -53,7 +53,8 @@ Response Structure
 
 :config: A collection of parameters used to configure the monitoring behaviour of Traffic Monitor
 
-	:health.polling.interval:     An interval in milliseconds on which to poll for health statistics
+	:health.polling.interval:     An interval in milliseconds on which to poll for cache statistics
+	:heartbeat.polling.interval:  An interval in milliseconds on which to poll for health statistics. If missing, defaults to `health.polling.interval`.

Review comment:
       same as above




-- 
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.

To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org