This is an automated email from the ASF dual-hosted git repository.
ocket8888 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficcontrol.git
The following commit(s) were added to refs/heads/master by this push:
new e3db195 Feature/tm heartbeat poll documentation (#6298)
e3db195 is described below
commit e3db19536a6c59d0948136942e0fa83ea60d49da
Author: Taylor Clayton Frey <[email protected]>
AuthorDate: Thu Oct 21 09:26:58 2021 -0600
Feature/tm heartbeat poll documentation (#6298)
* Ignore test configuration files
* Clarify and
* Update changelog to include addition to documentation
* Correctly use double backticks for 'code' markup in rst
Co-authored-by: Taylor Frey <[email protected]>
---
.gitignore | 1 +
CHANGELOG.md | 1 +
docs/source/api/v2/cdns_name_configs_monitoring.rst | 3 ++-
docs/source/api/v3/cdns_name_configs_monitoring.rst | 3 ++-
docs/source/api/v4/cdns_name_configs_monitoring.rst | 3 ++-
5 files changed, 8 insertions(+), 3 deletions(-)
diff --git a/.gitignore b/.gitignore
index 4c44026..c6e6f9f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -40,6 +40,7 @@ traffic_ops/**/*.log
traffic_stats/traffic_stats
traffic_router/*/*.log
traffic_router/*.log
+traffic_router/core/src/test/conf/*.properties
vendor/**/appveyor.yml
vendor/**/.gitattributes
vendor/**/.gitignore
diff --git a/CHANGELOG.md b/CHANGELOG.md
index c4b3e3b..095a769 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -11,6 +11,7 @@ The format is based on [Keep a
Changelog](http://keepachangelog.com/en/1.0.0/).
- Added a new Traffic Monitor configuration option --
`short_hostname_override` -- to traffic_monitor.cfg to allow overriding the
system hostname that Traffic Monitor uses.
- A new Traffic Portal server command-line option `-c` to specify a
configuration file, and the ability to set `log: null` to log to stdout
(consult documentation for details).
- SANs information to the SSL key endpoint and Traffic Portal page.
+- Added definition for `heartbeat.polling.interval` for CDN Traffic Monitor
config in API documentation.
### Fixed
- Fixed Traffic Router crs/stats to prevent overflow and to correctly record
the time used in averages.
diff --git a/docs/source/api/v2/cdns_name_configs_monitoring.rst
b/docs/source/api/v2/cdns_name_configs_monitoring.rst
index 322eab5..e4d6590 100644
--- a/docs/source/api/v2/cdns_name_configs_monitoring.rst
+++ b/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``.
:tm.polling.interval: The interval at which to poll for
configuration updates
:deliveryServices: An array of objects representing each :term:`Delivery
Service` provided by this CDN
diff --git a/docs/source/api/v3/cdns_name_configs_monitoring.rst
b/docs/source/api/v3/cdns_name_configs_monitoring.rst
index 9d394e2..e4b9a13 100644
--- a/docs/source/api/v3/cdns_name_configs_monitoring.rst
+++ b/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``.
:tm.polling.interval: The interval at which to poll for
configuration updates
:deliveryServices: An array of objects representing each :term:`Delivery
Service` provided by this CDN
diff --git a/docs/source/api/v4/cdns_name_configs_monitoring.rst
b/docs/source/api/v4/cdns_name_configs_monitoring.rst
index 6a45f05..34d0770 100644
--- a/docs/source/api/v4/cdns_name_configs_monitoring.rst
+++ b/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``.
:tm.polling.interval: The interval at which to poll for
configuration updates
:deliveryServices: An array of objects representing each :term:`Delivery
Service` provided by this CDN
