Document Revision History¶
PLEASE NOTE: F5 BIG-IP Telemetry Streaming is no longer in active development. We are moving this technology into maintenance mode.
A product in maintenance mode continues to receive support and ensures its stability with regular critical fixes and security updates. This maintenance approach helps maintain the longevity and reliability of the product for the long term. Enhancement requests for this product will be evaluated on an individual basis, taking into consideration their overall impact and alignment with our business objectives. Only those with a strong case for improvement will be considered for implementation There is no plan to deprecate this product.
| Doc Rev | Description | Date |
|---|---|---|
| 1.35.0 | Updated the documentation for Telemetry Streaming v1.35.0. This release contains the following changes: * Added “memoryMonitor” (see Memory Mamangement). Changed: * Event Listener performance improvements |
02-23-24 |
| 1.34.0 | Updated the documentation for Telemetry Streaming v1.34.0. This release contains the following changes: * Added “verbose” option for “logLevel”. * Event Listener bugfixes, performance and memory usage improvements. * Updated description for “default” consumers. * More troubleshooting entries. Changed: * Update npm packages |
01-19-24 |
| 1.33.0 | Updated the documentation for Telemetry Streaming v1.33.0. This release contains the following changes: * Added allowing user provided endpoints for the Azure consumers Changed: * Update npm packages |
03-17-23 |
| 1.32.0 | Updated the documentation for Telemetry Streaming v1.32.0. This release contains the following changes: * DataDog: forward metric data additionally to the logs endpoint * Removed Beacon from documentation |
10-04-22 |
| 1.31.0 | Updated the documentation for Telemetry Streaming v1.31.0. This release contains the following changes: * Added gRPC exporter to OpenTelemetry_Exporter (experimental feature) * Added new performance stats - system.connectionsPerformance. * Generic_HTTP consumer should allow to tune transport options (experimental feature) * Added compressionType option to Generic_HTTP consumer. * DataDog consumer should support proxy configuration. * DataDog consumer should split huge payload into smaller chunks according to API docs. * DataDog consumer should allow to tune transport options (experimental feature). * Added OpenTelemetry_Exporter raw JSON output. * Added secure connection settings to OpenTelemetry_Exporter (experimental feature). Issues Resolved: * DataDog consumer should send correct timestamp value. * OpenTelemetry_Exporter should set correct timestamp. Changed: * system.throughputPerformance in System Poller’s default output should match output example in “examples” directory. * DataDog consumer should use API v2 for to send data. |
8-23-22 |
| 1.30.0 | Updated the documentation for Telemetry Streaming v1.30.0. This release contains the following resolved issues: * Add support for numerical enums, enhance SNMP metrics processing GitHub #207 * Created separate Azure Logs tables for pool members and removed that data from the pool tables. |
7-15-22 |
| 1.29.0 | Updated the documentation for Telemetry Streaming v1.29.0. This release contains the following changes: * Added support for querying SNMP using a custom endpoint (see SNMP example) * Added outputMode parameter to Generic HTTP consumer to support raw data output (see Generic HTTP) Issues Resolved: * Metric Consumers should not fail when ‘null’ found in data * Prometheus consumer should ignore NaN values |
5-31-22 |
| 1.28.0 | Updated the documentation for Telemetry Streaming v1.28.0. This release contains the following changes: * Increased number of messages in a single PutLogEvents command for AWS Logs consumer and added retry logic for InvalidSequenceTokenException, GitHub #191 * Updated the path to stored declarations, and noted that qkview now has access to the Declaration History file (see Stored Declarations) |
4-19-22 |
| 1.27.1 | Released Telemetry Streaming v1.27.1 as a LTS (Long Term Support) version. See the Telemetry Streaming Support information on GitHub for information about the Telemetry Streaming support policy. | 4-19-22 |
| 1.27.0 | Updated the documentation for Telemetry Streaming v1.27.0. This release contains the following changes: * Telemetry Streaming now stores up to 30 of the most recent declarations (see Stored Declarations) * Verified support for ElasticSearch 8 (see ElasticSearch) * Removed the experimental label from the OpenTelemetry Exporter consumer (see OpenTelemetry) * Updated the DataDog consumer to use the v2 logs API * TS now closes the tracer by timeout when inactive Issues Resolved: * Added additional sanitation to StatsD metric and tag naming, GitHub #184 * RegEx catastrophic backtracking on attempt to mask secrets in JSON data * Added info about installed ASM attack signatures to output (see System Information, GitHub #174) |
3-8-22 |
| 1.26.0 | Updated the documentation for Telemetry Streaming v1.26.0. This release contains the following changes: * Added the fqdn property to the output for pool members that use FQDNs (see System Information) * Added two new sections to Troubleshooting for logging and tracing |
1-25-22 |
| 1.25.0 | Updated the documentation for Telemetry Streaming v1.25.0. This release contains the following changes: * Added support for IAM roles for Google Cloud Platform (see Google Cloud Monitoring and Cloud Logging), GitHub #154 * Added the metricPrefix (GitHub #152) and customTags (GitHub #160) properties to the DataDog consumer (see DataDog) * Added the convertBooleansToMetrics property to the DataDog, StatsD, and OpenTelemetry consumers (see DataDog, StatsD, and OpenTelemetry) * Added the endpointUrl property to AWS S3 and CloudWatch consumers (see AWS S3 and AWS CloudWatch), GitHub #173 * Added poolName to pool member output (see System Information), GitHub #170 * Removed the experimental label from the autoTag property for StatsD (see StatsD addTags) * Removed the experimental label from Splunk multi-metric format (see Splunk multi-metric) |
12-14-21 |
| 1.24.0 | Updated the documentation for Telemetry Streaming v1.24.0. This release contains the following changes: * Added the region and service properties for the DataDog consumer (see DataDog) * Removed the Experimental label from the DataDog consumer (see DataDog) * Added support for the format property for Azure Log Analytics (see Azure Log Analytics) * Added support for ElasticSearch 7 (see ElasticSearch) Issues Resolved: * Fixed an issue where Telemetry Streaming would not collect System Poller data if bash was disabled on the BIG-IP device. Properties that require the bash endpoint are now skipped if bash is not available on the target BIG-IP (see System information). |
11-2-21 |
| 1.23.0 | Updated the documentation for Telemetry Streaming v1.23.0. This release contains the following changes: * Added a new EXPERIMENTAL Push consumer for OpenTelemetry Exporter (see OpenTelemetry Exporter) * Added isAvailable and isEnabled to virtual server output (see System information output), GitHub #152 * Added throughputPerformance to System output (see System information output), GitHub #129 * Added the compressionType property to the experimental DataDog consumer (see DataDog), GitHub #157 * Added functionality to handle responses from iControlREST that contain duplicate JSON keys * Added support for TS Namespaces (was experimental), see F5 BIG-IP Telemetry Streaming Namespaces * Added support for specifying fallback hosts for Generic HTTP consumers (was experimental) Fallback hosts Issues Resolved: * Fixed issue where Prometheus consumer did not return the correct Content-Type HTTP Header, GitHub #148 * Fixed issue where asmState could report incorrect state value. asmState and lastAsmChange properties are now retrieved from iControlREST, GitHub #151 |
9-21-21 |
| 1.22.0 | Updated the documentation for Telemetry Streaming v1.22.0. This release contains the following changes: * Added clientside.slowKilled and clientside.evictedConns to virtual server output (see System information output) * Added a new Push consumer for Google Cloud Logging (see Google Cloud Logging) * Added a new EXPERIMENTAL Push consumer for DataDog (see DataDog) * Added the reportInstanceMetadata property for Google Cloud Monitoring to enable or disable metadata reporting (see Google Cloud Monitoring) * Added the eventSchemaVersion property to the F5 Cloud consumer (see F5 Cloud consumer) Issues Resolved: * Fixed issue where Prometheus consumer encounters an error when a metric name is registered more than once, GitHub #134 * Fixed issue where the Kafka Consumer would create a new Kafka connection on each Telemetry Streaming payload * Google Cloud Monitoring Consumer now uses instance_id and zone as time-series resource labels for BIG-IPs that run in Google Cloud (change in behavior) * The default namespace (f5telemetry_default) is now stated explicitly in traceName and paths of the to the trace files (change in behavior) |
8-9-21 |
| 1.20.1 | Released Telemetry Streaming v1.20.1 as a LTS (Long Term Support) version. See the Telemetry Streaming Support information on GitHub for information about the Telemetry Streaming support policy. | 6-30-21 |
| 1.21.0 | Updated the documentation for Telemetry Streaming v1.21.0. This release contains the following changes: * An experimental property for the StatsD consumer (see StatsD addTags) * A number of minor bug fixes, stability enhancements, and foundational elements for some upcoming features. |
6-28-21 |
| 1.20.0 | Updated the documentation for Telemetry Streaming v1.20.0. This release contains the following changes: * Added support for customizing the Telemetry Streaming payload (see Customizing the F5 BIG-IP Telemetry Streaming payload and the related example) * Added a new troubleshooting entry for writing an Event Listener’s incoming raw data to a trace file (see Troubleshooting), also added a new note to the description of Event Listener class about tracing. * Added data tracing and ‘success’ message to Google Cloud Monitoring consumer * Added system.configSyncSucceeded to default output and f5_system_configSyncSucceeded to Prometheus output, GitHub #74 * Added Capacity_Float to system.diskStorage, GitHub #119 Issues Resolved: * Fixed issue where ‘long’ fields in ASM events were causing ASM events to become malformed. Individual event fields are now permitted to be <= MAX_BUFFER_SIZE (16k), GitHub #127 * AWS S3 date path was incorrect * Should not create multiple Tracer instances that point to the same file |
5-18-21 |
| 1.19.0 | Updated the documentation for Telemetry Streaming v1.19.0. This release contains the following changes: * Added a new troubleshooting entry providing memory threshold information (see Memory Threshold) * Added new Event Listener endpoints for sending debug messages to an Event Listener (see Event Listener endpoints) * Updated the Splunk Consumer documentation with the new compressionType property, and added a related troubleshooting entry (see Troubleshooting) * totNativeConns and totCompatConns are now exposed on SSL profile stats * Added the swap metric to the system group (System Poller output), see System Information) * Trace full payload now sent to StatsD Consumer * System Poller recurring scheduling changed so that System Poller executions do not overlap * Added a note to iHealth Poller stating it must be attached to a System * Added a bullet item to About Pull Consumer stating if a poller was attached to two systems, the response contains data from both * Added a note to the Important list for Namespaces about naming objects Issues Resolved: * Fixed Route Domain ID handling for Virtual Server and Pool stats * Splunk debug output does not log HTTP Response payload, GitHub #109 * Update example output for maxConns, pktsIn, pktsOut, and totConns * Tracer unable to access destination directory * Tracer(s) from other namespaces should not stop when namespace-only declaration posted * Removed excessive data formatting from tracer |
4-6-21 |
| Unreleased | This documentation only update contains the following change: * Updated the note in Splunk multi-metric format to add that custom endpoints are not supported with multi-metric format (added the same note to Configuring Custom Endpoints). |
3-1-21 |
| 1.18.0 | Updated the documentation for Telemetry Streaming v1.18.0. This release contains the following changes: * Added new endpoints for individual namespaces (see Namespace endpoints) * Added support for TLS client authentication for the Generic HTTP consumer (see the TLS Client example and the Generic HTTP consumer page) * Added response logging to Event Listener page (see LTM Request Log profile and the updated AS3 Logging example) * Added a note to the Splunk consumer and a new section in Custom Endpoints for Including hostname information (GitHub #107) * Added a note to AWS CloudWatch and AWS S3 about root certificates for AWS services being embedded within Telemetry Streaming Issues Resolved: * Fix Event Listener startup errors that might cause restnoded to crash * Splunk multiEvent format should ignore ‘References’ |
2-23-21 |
| 1.17.0 | Updated the documentation for Telemetry Streaming v1.17.0. This release contains the following changes: * Added support for configuring proxy settings on Generic HTTP consumers, GitHub #92 (see Specifying proxy settings for Generic HTTP consumers) * Added support for configuring proxy settings on Splunk consumers, GitHub #85 (see Specifying proxy settings for Splunk consumers) * Added a timestamp for APM Request Log output, GitHub #91 (see APM Request Log) * Added support for TLS client authentication to the Kafka consumer, GitHub #90 (see Kafka) * Added an F5 Internal Only push consumer for F5 Cloud (see F5 Cloud) * Added the ability to use the Splunk multi-metric format, currently EXPERIMENTAL (see Splunk multi-metric format) * Added a new reference for the Telemetry Streaming Default Output (see Default Output Appendix) * Tracefile now stores up to 10 items * Added a note to the System Information output page stating there is new pool and virtual server information collected (see System Information) * Deprecated TS support for the Splunk Legacy Format * Posting a declaration while a previous declaration is still processing now returns an HTTP 503 status code Issues Resolved: * Fixed error where unavailable Custom Endpoint would return HTTP 500 |
1-12-20 |
| 1.16.0 | Updated the documentation for Telemetry Streaming v1.16.0. This release contains the following changes: * Added support for the Telemetry_Namespace class in declarations posted to the /declare endpoint (see F5 BIG-IP Telemetry Streaming Namespaces) * Added new Namespace PullConsumer endpoint (see F5 BIG-IP Telemetry Streaming Namespaces) * Added support for Custom Endpoints. Moved the Custom Endpoint page from an Appendix to Using Telemetry Streaming (see Configuring Custom Endpoints) * TS now includes _ResourceId if available for Azure Log Analytics consumer, and metadata calls are now only happening upon consumer(s) load * Issues Resolved: * Fixed issue when TS incorrectly processing iRule stats with multiple events |
11-20-20 |
| 1.15.0 | Updated the documentation for Telemetry Streaming v1.15.0. This release contains the following changes: * Updated the default hostname for the StatsD consumer (see the Important note in StatsD) * Added a note to the Prometheus Pull Consumer consumer on how to access the consumer endpoint with a user other than admin * Added a new FAQ entry on why you may see a decrease in some pool statistics (see Pool Statistics) Issues Resolved: * Fixed syslog event hostname parsing for VCMP hosts * Resolve memory leak in ElasticSearch consumer, by replacing ‘elasticsearch’ library with ‘request’ library |
10-13-20 |
| 1.14.0 | Updated the documentation for Telemetry Streaming v1.14.0. This release contains the following changes: * Added support for AWS CloudWatch Metrics (see AWS CloudWatch Metrics) * Added an EXPERIMENTAL feature to specify fallback hosts for generic HTTP consumers (see Specifying fallback hosts for Generic HTTP consumers) * Added cipherUses stats for Client and Server SSL profiles (see the cipherUses lines in System Information) * Added a troubleshooting entry for a restjavad issue (see Why is my BIG-IP experiencing occasional high CPU usage and slower performance?) * Added a note to the Exporting data from AVR page about AVR caveats with TS and BIG-IQ (see the AVR note) * Updated the introduction for the experimental Configuring Custom Endpoints * Added support for BIG-IP 16.0 Issues Resolved: * Fixed Event Listener parsing when receiving multiple events |
09-01-20 |
| 1.13.0 | Updated the documentation for Telemetry Streaming v1.13.0. This release contains the following changes: * Added statusReason and monitorStatus fields to System Poller output for BIG-IQ Analytics (see System Information) * Added comprehensive troubleshooting entry for why data may not be showing up in a consumer (see Troubleshooting) * Updated the Event Listener page (see Event Listener class) Issues Resolved: * Fixed inconsistency in GSLB output: return empty object instead of ‘undefined’ * Fixed Azure consumer memory leak when calling metadata service on an instance where it is unavailable * Updated Azure Log Analytics dashboard example (GitHub #39) * Fixed lodash Prototype Pollution vulnerability * Fixed Splunk legacy format missing poolMemberStat data |
07-21-20 |
| 1.12.0 | Updated the documentation for Telemetry Streaming v1.12.0. This release contains the following changes: * Added a new consumer for Prometheus (see Prometheus Pull Consumer) * Updated the Pull Consumer page and added an example for using push and pull consumers in the same declaration (see Pull Consumers) * Added support for IAM Roles with AWS_S3 Consumer (see AWS S3) * Added TCP support to the StatsD consumer (see StatsD) * Added a note to Splunk Legacy format (Deprecated) stating if the legacy format is used, it ignores events from the Event Listener Issues Resolved: * Added a timeout to Azure metadata service HTTP requests to fix an issue where the Azure Consumer was slow when running in a non-Azure environment * Fixed renameKeys for networkInterfaces with multiple digits (GitHub #18) |
06-02-20 |
| Unreleased | Documentation only update. This update contains the following change: * Added an important note to the ElasticSearch consumer section stating TS currently does not support sending data to ElasticSearch 7 (see ElasticSearch). |
04-24-20 |
| 1.11.0 | Updated the documentation for Telemetry Streaming v1.11.0. This release contains the following changes: * Added a new consumer for Azure Application Insights (see Microsoft Azure Application Insights) * Added support for Azure Managed Identities for Azure Log Analytics and Azure Application Insights * Added support for AzureGov for Azure consumers using an optional region property (see Additions to the Application Insights consumer) * Added a new page for the Pull consumer (see Pull Consumers) and renamed the original Consumer page to Push consumer * Added a new page detailing how to delete the configuration produced by TS (see Deleting the F5 BIG-IP Telemetry Streaming configuration) * Renamed Google StackDriver to Google Cloud Monitoring Issues Resolved: * Fixed Regular Expression Denial of Service vulnerability and improved start up time on node v4.x and v6.x * Fixed error when Splunk consumer (configured with ‘legacy’ format) tries to forward event from Event Listener (GitHub #30) * Fixed crash in Kafka consumer on attempt to close idle connections to brokers (GitHub #17) |
04-21-20 |
| 1.10.0 | Updated the documentation for Telemetry Streaming v1.10.0. This release contains the following changes: * Added a feature (currently EXPERIMENTAL) for configuring custom endpoints (see Configuring Custom Endpoints) * Added ifAnyMatch functionality to the existing value-based matching logic (see Value-based matching) * Added support for F5 devices with multiple hosts (see the FAQ) Issues Resolved: * Event Listener unable to classify AFM DoS event * Splunk legacy tmstats - include last_cycle_count * Splunk legacy tmstats - add tenant and application data * Declarations with large secrets may timeout * Passphrases should be obfuscated in consumer trace files * Add ‘profiles’ data (profiles attached to Virtual Server) to ‘virtualServers’ * Use baseMac instead of hostname to fetch CM device (GitHub Issue 26) * cipherText validation when protected by SecureVault * Caching data about the host device to speed up declaration processing |
03-10-20 |
| 1.9.0 | Updated the documentation for Telemetry Streaming v1.9.0. This release contains the following changes: * Added support for gathering configuration information and statistics for GSLB Wide IP and Pools (see System Information example output) * Username and passphrase are now optional on the AWS CloudWatch consumer (see the important note in AWS CloudWatch) * Added detailed information about character encoding and Telemetry Streaming (see Character Encoding information) * Added a FAQ entry to define the F5 Automation Toolchain API contract (see What is the Automation Toolchain API Contract?) Issues Resolved: * Basic auth does not work with ElasticSearch consumer * Some Splunk legacy tmstats datamodels have a period in property name instead of underscore |
01-28-20 |
| 1.8.0 | Updated the documentation for Telemetry Streaming v1.8.0. This release contains the following changes: * Added support for Google StackDriver as a consumer (see Google Cloud Operations Suite’s Cloud Monitoring) * Added a new page for Data Modification, which includes support for Action Chains, and includeData and excludeData filtering (see Action Chains for information on these items). * Added machineId to System Poller output * Added reference to pools in virtual server data Issues Resolved: * Improved error handling to preserve stack traces |
12-3-19 |
| 1.7.0 | Updated the documentation for Telemetry Streaming v1.7.0. This release contains the following changes: * Added a new Consumer for Fluentd (see Fluentd) * Added a note to Splunk Legacy format (Deprecated) stating TS 1.7.0 and later gathers additional data from tmstats tables to improve compatibility with Splunk Legacy consumers * Added a troubleshooting entry and other notes about the /dist directory going away on GitHub, and the TS RPM being available as a release Asset (see Troubleshooting) * Added an FAQ entry about TS collecting non-identifiable usage data (see Usage data) * Updated the maximum number of concurrent established TCP sockets per consumer to 5 Issues Resolved: * Splunk Tmstat table data is being overwritten when forwarded to Splunk * Broken promise chain when loading config file. |
10-22-19 |
| 1.6.0 | Updated the documentation for Telemetry Streaming v1.6.0. This release contains the following changes: * In version 1.6.0 and later, tagging is now an array inside of which you can add tagging objects (see Tag Property). * Added the facility parameter for the Splunk Legacy format (see Splunk Legacy format (Deprecated)) * Added a Schema Reference appendix |
09-10-19 |
| 1.5.0 | Updated the documentation for Telemetry Streaming v1.5.0. This release contains the following changes: * Added support for Carrier Grade NAT (CGNAT) event logs (see Configuring CGNAT logging) * Telemetry Streaming now collects mask and ipProtocol for virtual servers (see the virtualServers lines of System Information Output for example output. * Telemetry Streaming now collects the system status information: devicegroup, asm_state, last_asm_change, apm_state, afm_state, last_afm_deploy, ltm_config_time, and gtm_config_time (see the System Information Output for example output) * Added iRules support to system poller stats (see the iRules lines of System Information Output for example output) * Added a Troubleshooting entry about a self-signed certificate error. Also added a related allowSelfSignedCert row to the Advanced Options table. Issues Resolved: * Elastic Search Unable to parse and index some messages with previously used keys * Elastic Search event data objects containing consecutive periods will be replaced with a single period * Splunk Host property is null for TS events |
07-30-19 |
| 1.4.0 | Updated the documentation for Telemetry Streaming v1.4.0. This release contains the following changes: * Added a new troubleshooting entry for an error that can occur with the ElasticSearch consumer (see Troubleshooting). * Added the schema files from previous releases to the GitHub repository * Updated Validating a declaration to clarify the schema URL to use * Updated the documentation theme and indexes. Issues Resolved: * System Poller throws unhandled exception “socket hang up” on attempt to fetch stats. |
06-18-19 |
| 1.3.0 | Updated the documentation for Telemetry Streaming v1.3.0. This release contains the following changes: * TS now exports AVR data. See the Exporting data from AVR section for configuration notes. * Added documentation for the tag property. * Added support for Kafka SASL-PLAIN authentication. |
04-30-19 |
| 1.2.0 | Updated the documentation for Telemetry Streaming v1.2.0. This release contains the following changes: * Changed the System Poller class to the Telemetry System class. * Added support for iHealth polling. * Added support for IPsec Tunnel statistics. * Added Event Listener log profile configuration example using a single AS3 declaration. * Updated the Event Listener log profile configuration examples to use non-mgmt-IP-based endpoints. * Updated example output. |
04-02-19 |
| 1.1.0 | Updated the documentation for Telemetry Streaming v1.1.0. This release contains the following changes: * Added reference links for importing the example Azure dashboard to the Push Consumers section. * Added a section for Validating a declaration. * Updated the Kafka example declaration to include binaryTcp as an alternate protocol option. * Added UDP as a protocol for the event listener. * Added StatsD and generic HTTP as consumers. See the Push Consumers section for declaration examples. * Added System Log to the Event Listener class section. * Updated GitHub links. |
03-05-19 |
| 1.0.0 | Initial release of Telemetry Streaming documentation. | 02-05-19 |
| 0.9.0 | Initial internal release of Telemetry Streaming documentation. | 12-27-18 |