Merge branch 'RC-v1.32.0' into 'master'

Telemetry Streaming 1.32.0 Release

See merge request automation-toolchain/f5-telemetry!632

.gitignore

@@ -16,6 +16,7 @@ test/functional/logs/
 test/functional/*_harness_file.json
 test/artifacts/
 # misc
+.misc/
 .vscode/
 **/.DS_Store
 # generated schema & docs

.gitlab-ci.yml

@@ -18,7 +18,7 @@ include:
 # adds atg_shared_checks_result job to test stage
   - project: automation-toolchain/atg-shared-templates
     file: security/base.gitlab-ci.yml
-    ref: v1.1.3
+    ref: v1.1.7
 
 
 ##############################################################

CHANGELOG.md

@@ -1,6 +1,14 @@
 # Changelog
 Changes to this project are documented in this file. More detail and links can be found in the Telemetry Streaming [Document Revision History](https://clouddocs.f5.com/products/extensions/f5-telemetry-streaming/latest/revision-history.html).
 
+## 1.32.0
+### Added
+### Fixed
+### Changed
+- TS-691: DataDog: forward metric data additionally to the logs endpoint
+- TS-699: Removed Beacon from documentation
+### Removed
+
 ## 1.31.0
 ### Added
 - TS-676: Add gRPC exporter to OpenTelemetry_Exporter (experimental feature)

README.md

@@ -6,30 +6,30 @@
 
 ## Introduction
 
-Telemetry Streaming (TS) is an iControl LX Extension delivered as a TMOS-independent RPM file. Installing the TS Extension on BIG-IP enables you to declaratively aggregate, normalize, and forward statistics and events from the BIG-IP to a consumer application by POSTing a single TS JSON declaration to TS’s declarative REST API endpoint.
+F5 BIG-IP Telemetry Streaming (BIG-IP TS) is an iControl LX Extension delivered as a TMOS-independent RPM file. Installing the BIG-IP TS Extension on BIG-IP enables you to declaratively aggregate, normalize, and forward statistics and events from the BIG-IP to a consumer application by POSTing a single BIG-IP TS JSON declaration to BIG-IP TS’s declarative REST API endpoint.
 
-**IMPORTANT** Beginning with TS 1.7.0, the RPM and checksum files will no longer be located in the **/dist** directory in this repository.  These files can be found on the [Release page](https://github.com/F5Networks/f5-telemetry-streaming/releases), as **Assets**.  You can find historical files on GitHub by using the **Branch** drop-down, clicking the **Tags** tab, and then selecting the appropriate release.
+**IMPORTANT** Beginning with BIG-IP TS 1.7.0, the RPM and checksum files will no longer be located in the **/dist** directory in this repository.  These files can be found on the [Release page](https://github.com/F5Networks/f5-telemetry-streaming/releases), as **Assets**.  You can find historical files on GitHub by using the **Branch** drop-down, clicking the **Tags** tab, and then selecting the appropriate release.
 
 ## Documentation
 
-For the documentation on Telemetry Streaming, including download, installation, and usage instructions, see the Telemetry Streaming User guide at [http://clouddocs.f5.com/products/extensions/f5-telemetry-streaming/latest/](http://clouddocs.f5.com/products/extensions/f5-telemetry-streaming/latest/).
+For the documentation on BIG-IP Telemetry Streaming, including download, installation, and usage instructions, see the BIG-IP Telemetry Streaming User guide at [http://clouddocs.f5.com/products/extensions/f5-telemetry-streaming/latest/](http://clouddocs.f5.com/products/extensions/f5-telemetry-streaming/latest/).
 
 ### Example Telemetry Streaming declarations
 
-The Telemetry Streaming documentation contains a variety of example declarations you can use directly or modify to suit your needs. See the [Consumers](https://clouddocs.f5.com/products/extensions/f5-telemetry-streaming/latest/setting-up-consumer.html) and [Example Declarations](https://clouddocs.f5.com/products/extensions/f5-telemetry-streaming/latest/declarations.html) pages.
+The BIG-IP Telemetry Streaming documentation contains a variety of example declarations you can use directly or modify to suit your needs. See the [Consumers](https://clouddocs.f5.com/products/extensions/f5-telemetry-streaming/latest/setting-up-consumer.html) and [Example Declarations](https://clouddocs.f5.com/products/extensions/f5-telemetry-streaming/latest/declarations.html) pages.
 
 ## Filing Issues and Getting Help
 
-If you come across a bug or other issue when using Telemetry Streaming, use [GitHub Issues](https://github.com/f5networks/f5-telemetry-streaming/issues) to submit an issue for our team.  You can also see the current known issues on that page, which are tagged with a purple Known Issue label.  
+If you come across a bug or other issue when using BIG-IP Telemetry Streaming, use [GitHub Issues](https://github.com/f5networks/f5-telemetry-streaming/issues) to submit an issue for our team.  You can also see the current known issues on that page, which are tagged with a purple Known Issue label.  
 
 **Important**: Github Issues are consistently monitored by F5 staff, but should be considered as best effort only and you should not expect to receive the same level of response as provided by F5 Support. Please open a case as described below with F5 if this is a critical issue.
 
-Because Telemetry Streaming has been created and fully tested by F5 Networks, it is fully supported by F5. This means you can get assistance if necessary from [F5 Technical Support](https://support.f5.com/csp/article/K25327565).
+Because BIG-IP Telemetry Streaming has been created and fully tested by F5 Networks, it is fully supported by F5. This means you can get assistance if necessary from [F5 Technical Support](https://support.f5.com/csp/article/K25327565).
 
-Be sure to see the [Support page](SUPPORT.md) in this repo for more details and supported versions of Telemetry Streaming.
+Be sure to see the [Support page](SUPPORT.md) in this repo for more details and supported versions of BIG-IP Telemetry Streaming.
 
 ### Community Help
-We encourage you to use our [Slack channel](https://f5cloudsolutions.herokuapp.com) for discussion and assistance on Telemetry Streaming (click the **telemetry-streaming** channel). There are F5 employees who are members of this community who typically monitor the channel Monday-Friday 9-5 PST and will offer best-effort assistance. See the [Slack Channel Statement](slack-channel-statement.md) for guidelines on using this channel.
+We encourage you to use our [Slack channel](https://f5cloudsolutions.herokuapp.com) for discussion and assistance on BIG-IP Telemetry Streaming (click the **telemetry-streaming** channel). There are F5 employees who are members of this community who typically monitor the channel Monday-Friday 9-5 PST and will offer best-effort assistance. See the [Slack Channel Statement](slack-channel-statement.md) for guidelines on using this channel.
 
 ## Copyright
 

SUPPORT.md

@@ -18,9 +18,9 @@ Currently supported versions:
 | Software Version | Release Type  | First Customer Ship | End of Support  |
 |------------------|---------------|---------------------|-----------------|
 | TS 1.27.1        | LTS           |  19-Apr-2022        | 19-Apr-2023     |
-| TS 1.29.0        | Feature       |  31-May-2022        | 31-Aug-2022     |
 | TS 1.30.0        | Feature       |  15-Jul-2022        | 15-Oct-2022     |
 | TS 1.31.0        | Feature       |  23-Aug-2022        | 23-Nov-2022     |
+| TS 1.32.0        | Feature       |  04-Oct-2022        | 04-Jan-2023     |
 
 Versions no longer supported:
 
@@ -55,5 +55,6 @@ Versions no longer supported:
 | TS 1.26.0        | Feature       |  25-Jan-2022        | 25-Apr-2022     |
 | TS 1.27.0        | Feature       |  08-Mar-2022        | 08-Jun-2022     |
 | TS 1.28.0        | Feature       |  19-Apr-2022        | 19-Jul-2022     |
+| TS 1.29.0        | Feature       |  31-May-2022        | 31-Aug-2022     |
 
 See the [Release notes](https://github.com/F5Networks/f5-telemetry-streaming/releases) and [Telemetry Streaming documentation](https://clouddocs.f5.com/products/extensions/f5-telemetry-streaming/latest/revision-history.html) for new features and issues resolved for each release.

contributing/README.md

@@ -108,7 +108,7 @@ How does the project handle a typical `POST` request?
             "trace": false,
             "format": "default"
         },
-        "schemaVersion": "1.31.0"
+        "schemaVersion": "1.32.0"
     }
 }
 ```

contributing/process_release.md

@@ -67,6 +67,7 @@
     * 1.29.0 - 17.8 MB
     * 1.30.0 - 16.0 MB
     * 1.31.0 - 20.5 MB (NOTE: inclusion of OpenTelemetry and grpc-js libraries)
+    * 1.32.0 - 20.5 MB
   * Install build to BIG-IP, navigate to folder `/var/config/rest/iapps/f5-telemetry/` and check following:
     * Run `du -sh` and check that folder's size (shouldn't be much greater than previous versions):
       * 1.4.0 - 65 MB
@@ -97,6 +98,7 @@
       * 1.29.0 - 129 MB
       * 1.30.0 - 116 MB
       * 1.31.0 - 153 MB (NOTE: inclusion of OpenTelemetry and grpc-js libraries)
+      * 1.31.0 - 154 MB
     * Check `node_modules` folder - if you see `eslint`, `mocha` or something else from [package.json](package.json) `devDependencies` section - something wrong with build process. Probably some `npm` flags are work as not expected and it MUST BE FIXED before publishing.
 * Ensure that all tests (unit tests and functional tests passed)
 * Optional: Ensure that your local tags match remote. If not, remove all and re-fetch:

docs/advanced-options.rst

@@ -1,7 +1,7 @@
 Advanced Options
 ----------------
 
-This section describes additional options that you may want to configure once you comfortable to using Telemetry Streaming.
+This section describes additional options you may want to use for configuring, once you are comfortable using F5 BIG-IP Telemetry Streaming.
 
 
 +-----------------------------+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

docs/avr.rst

@@ -2,25 +2,25 @@
 
 Exporting data from AVR
 =======================
-This section shows how you can export data from the Application Visibility and Reporting (AVR) module to Telemetry Streaming.  To see more information on AVR, see the |analytics|.
+This section shows how you can export data from the Application Visibility and Reporting (AVR) module to BIG-IP Telemetry Streaming.  To see more information on AVR, see the |analytics|.
 
-.. NOTE:: The configuration on this page was modified to use an existing Telemetry Streaming *Log Publisher* as opposed to a static IP address. There is also a new, optional section for TS and AVR in a fanout configuration. This documentation change was made in Telemetry Streaming 1.16, but the configuration can be used with any TS version.
+.. NOTE:: The configuration on this page was modified to use an existing BIG-IP Telemetry Streaming *Log Publisher* as opposed to a static IP address. There is also a new, optional section for BIG-IP TS and AVR in a fanout configuration. This documentation change was made in BIG-IP Telemetry Streaming 1.16, but the configuration can be used with any BIG-IP TS version.
 
-The prerequisites for using TS with AVR include:
+The prerequisites for using BIG-IP TS with AVR include:
 
 - The AVR module must be provisioned 
 - You must have an Event Listener, including an existing Log Publisher (see :ref:`eventlistener-ref` for instructions)
 - The Analytics profile for HTTP or TCP should be configured and assigned to the virtual server
 
 .. _avr-note:
 
-.. IMPORTANT:: It is currently not possible to configure AVR to publish data to both Telemetry Streaming and BIG-IQ concurrently. Additionally, if a BIG-IP is managed by a BIG-IQ, and has Statistics Collection enabled, the entire AVR configuration of the BIG-IP will be overwritten to publish only to the BIG-IQ.
+.. IMPORTANT:: It is currently not possible to configure AVR to publish data to both BIG-IP Telemetry Streaming and BIG-IQ concurrently. Additionally, if a BIG-IP is managed by a BIG-IQ, and has Statistics Collection enabled, the entire AVR configuration of the BIG-IP will be overwritten to publish only to the BIG-IQ.
 
 |
 
 Modifying AVR configuration to use the Log Publisher
 ----------------------------------------------------
-To use AVR with Telemetry Streaming, you must modify the AVR logging configuration to point to the existing Log Publisher. If you do not have an existing log publisher, see :ref:`logsrc-ref` for guidance on creating one.
+To use AVR with BIG-IP Telemetry Streaming, you must modify the AVR logging configuration to point to the existing Log Publisher. If you do not have an existing log publisher, see :ref:`logsrc-ref` for guidance on creating one.
 
 Use the following TMSH command, but be sure to change **telemetry_publisher** to the name of your Log Publisher if your publisher has a different name.
 
@@ -40,11 +40,11 @@ Example output of AVR basic data:
 
 | 
 
-Optional: Configuring AVR and Telemetry Streaming in a fanout scenario
-``````````````````````````````````````````````````````````````````````
-If you want to configure AVR and Telemetry Streaming in a fanout configuration (where AVR can send to multiple destinations using the TS Log Publisher), you can add new Log Destinations to the existing Log Publisher.  For more information, see |hsldocs| in the AVR documentation. This includes configuration instructions using the BIG-IP Configuration utility. Note the Log Destination type must be **Remote High-Speed Log**.  The TS :ref:`Event Listener page<eventlistener-ref>` shows how to configure Log Destinations with AS3 and TMSH.
+Optional: Configuring AVR and BIG-IP Telemetry Streaming in a fanout scenario
+`````````````````````````````````````````````````````````````````````````````
+If you want to configure AVR and BIG-IP Telemetry Streaming in a fanout configuration (where AVR can send to multiple destinations using the BIG-IP TS Log Publisher), you can add new Log Destinations to the existing Log Publisher.  For more information, see |hsldocs| in the AVR documentation. This includes configuration instructions using the BIG-IP Configuration utility. Note the Log Destination type must be **Remote High-Speed Log**.  The BIG-IP TS :ref:`Event Listener page<eventlistener-ref>` shows how to configure Log Destinations with BIG-IP AS3 and TMSH.
 
-If you need to add a Log Destination to an existing AS3 declaration (see :ref:`as3logging-ref`), you can simply add the new destination to the existing Log Publisher's **Destination** array (named **telemetry_publisher** in our example), and the AS3 declaration.
+If you need to add a Log Destination to an existing BIG-IP AS3 declaration (see :ref:`as3logging-ref`), you can simply add the new destination to the existing Log Publisher's **Destination** array (named **telemetry_publisher** in our example), and the BIG-IP AS3 declaration.
 
 |
 

docs/conf.py

@@ -68,7 +68,7 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'Telemetry Streaming'
+project = u'F5 BIG-IP Telemetry Streaming'
 copyright = u'2022 F5 Networks Inc'
 author = u'F5 Networks'
 
@@ -79,7 +79,7 @@
 # The short X.Y version.
 version = u''
 # The full version, including alpha/beta/rc tags.
-release = u'1.31.0'
+release = u'1.32.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/custom-endpoints.rst

@@ -1,6 +1,6 @@
 Configuring Custom Endpoints
 ----------------------------
-Telemetry Streaming v1.10 and later allows you to define a list of Custom Endpoints that reference iControlRequest paths in a new **Telemetry_Endpoints** class.
+F5 BIG-IP Telemetry Streaming v1.10 and later allows you to define a list of Custom Endpoints that reference iControlRequest paths in a new **Telemetry_Endpoints** class.
 The Custom Endpoints defined within a Telemetry Streaming declaration must then be attached to a Telemetry Streaming System Poller, where the System Poller will query the defined endpoints.
 
 .. NOTE:: Custom Endpoints *replace* the endpoints that a Telemetry Streaming System Poller queries by default - once a System Poller references a collection of Custom Endpoints, that System Poller will *only* query the Custom Endpoints.
@@ -152,7 +152,7 @@ The following snippet demonstrates how Custom Endpoint(s) can be attached to Sys
 
 Example declaration for using custom Endpoints with specific pollers
 --------------------------------------------------------------------
-The following example contains an example declaration for Telemetry Streaming, which includes the snippets in the examples above.
+The following example contains an example declaration for F5 BIG-IP Telemetry Streaming, which includes the snippets in the examples above.
 **Note:** The example below does not define a Telemetry Consumer, and a consumer of your choice must be added to the example declaration in order to receive the Telemetry Streaming data.
 
 .. literalinclude:: ../examples/declarations/system_custom_endpoints.json

docs/customizing-data.rst

@@ -1,11 +1,11 @@
 .. _customize-data:
 
-Customizing the Telemetry Streaming payload
--------------------------------------------
+Customizing the F5 BIG-IP Telemetry Streaming payload
+-----------------------------------------------------
 
-Telemetry Streaming 1.20 introduced a feature that allows you to restructure the data coming out of the Telemetry Streaming Generic HTTP consumer so it fits the format of 3rd party systems.  This is useful when you want the Telemetry Streaming payload in the format of a system that does not have a specific Telemetry Streaming consumer.  It also helps when trying to get log data into any kind of HTTP API.
+F5 BIG-IP Telemetry Streaming 1.20 introduced a feature that allows you to restructure the data coming out of the Telemetry Streaming Generic HTTP consumer so it fits the format of 3rd party systems.  This is useful when you want the Telemetry Streaming payload in the format of a system that does not have a specific Telemetry Streaming consumer.  It also helps when trying to get log data into any kind of HTTP API.
 
-This feature is enabled as a JMESPath expression (using a JMESPath library) in the Telemetry Consumer class as an **action** for the Generic HTTP consumer. TS takes the JMESPath expression with the string that you provide, and applies the expression to the data received by the consumer.
+This feature is enabled as a JMESPath expression (using a JMESPath library) in the Telemetry Consumer class as an **action** for the Generic HTTP consumer. BIG-IP TS takes the JMESPath expression with the string that you provide, and applies the expression to the data received by the consumer.
 
 For information on JMESPath, including the JMESPath specification, additional examples, and an interactive query tool, see https://jmespath.org/.