Tyk Pump v1.9 Release Notes

Open Source (Mozilla Public License)

This page contains all release notes for version 1.9.X displayed in a reverse chronological order

Support Lifetime

Our minor releases are supported until our next minor comes out. This would be v1.9.1 scheduled in Q2 if this goes ahead as planned.

1.9 Release Notes

Release Date 5 Apr 2024

Breaking Changes

Attention: Please read this section carefully

MongoDB v4.4 will reach its end of life support at the end of February 2024. In order to support newer versions of MongoDB and align with newer versions of Tyk, we have changed the default MongoDB driver from mgo to mongo-go. The mongo-go driver supports MongoDB versions greater or equal to v4. If you are using a version of MongoDB less than v4, please follow this guide to update the driver type to mgo.

Users are strongly advised to follow the recommended upgrade instructions provided by Tyk before applying any updates.

Dependencies

3rd Party Dependencies & Tools

Given the time difference between your upgrade and the release of this version, we recommend customers verify the ongoing support of third-party dependencies they install, as their status may have changed since the release.

Deprecations

There are no deprecations in this release.

Upgrade instructions

For users currently on v1.8.X, we strongly recommend promptly upgrading to the latest release. If you are working with an older version, it is advisable to bypass version 1.8 and proceed directly to this latest release.

Release Highlights

Redis 7 and storage library

Tyk Pump now supports Redis v7, utilizing our storage library v1.2.0.

MongoDB Driver

As of v1.9, the default MongoDB driver has been changed from mgo to mongo-go.

AWS Simple Queue Service Support

Thanks to a community contribution by masoudhaghbin, Tyk Pump can now pump logs to an AWS SQS instance.

Tyk Graph Pump

There has been a significant enhancement in Tyk Graph Pump with the removal of the dependency on the enable_detailed_recording setting. This change is designed to streamline operations, reduce storage requirements and enhance overall performance in production environments. By decoupling detailed recording from specific configuration options, Tyk Graph Pump now provides greater flexibility and control over data storage.

Downloads

• «Docker Image v1.9.0»

• docker pull tykio/tyk-pump-docker-pub:v1.9.0
  

• Source code tarball for OSS - GH Tyk Pump Repo

Changelog

Added

• Redis 7 Support

  Tyk Pump now support Redis v7 utilizing our storage library v1.2.0.

• Added AWS Simple Queue Service pump support

  Pump can now send logs to an Amazon SQS instance. This was a community contribution co-authored by masoudhaghbin. Please follow this guide to set up an SQS pump.

Changed

• Updated Go version to v1.21

  Tyk Pump now uses Go v1.21

• Resurface Pump Updated

  The Resurface Pump has been updated with the following improvements.

  • Upgrade logger-go dependency to version 3.3.1, which includes improvements in goroutine management, as well as a new Stop method for graceful shutdown.
  • Add support for async data writing, by adding a bounded channel to buffer data records and process them concurrently in the background.
  • Add Shutdown method for graceful shutdown of ResurfacePump backend.

  Thanks to community member Ramón Márquez for updating this pump.

Fixed

• Added backoff retry mechanism for Splunk Pump

  Tyk Pump now has an expontential backoff retry mechanism for sending logs to Splunk. This mechanism mitigates the chance of losing logs if Pump should fail to send logs to Splunk. This fixes a bug where Splunk responses were not being checked correctly and fixes a bug where Pump was not closing connections after receiving responses.

• Added a field so that GraphQL aggregated analytics will display correctly for SQL databases

  For SQL databases, the GraphQL aggregated analytics record will now have a new api_value field so that analytics will be shown in the Dashboard correctly.

• Environment variables TYK_PMP_PUMPS_AGGREGATE_* now correctly correspond to definitions in pump.conf

  Fixed a bug where any TYK_PMP_PUMPS_AGGREGATE_* environment variables didn’t correctly correspond to definitions in the pump.conf file.

• Added an api_id field so that GraphQL aggregated analytics will display correctly

  For SQL databases, the GraphQL aggregated analytics record will now have a new api_id field so that analytics will be shown in the Dashboard correctly.

• Fixed a bug where Tyk Pump could not connect to Redis Sentinel when TLS is enabled

  Fixed a bug causing Tyk Pump not to connect when Redis Sentinel was deployed using TLS.

Security Fixes

• Fixed the following CVEs

  • CVE-2022-39325
  • CVE-2022-3978

Community Contributions

Special thanks to the following members of the Tyk community for their contributions to this release:

• Added Simple Queue Service pump support

  Pump can now send logs to an Amazon SQS instance. Thanks to masoudhaghbin for creating this pump. Please follow this guide to set up an SQS pump.

• Resurface Pump Updated

  The Resurface Pump has been updated with the following improvements.

  • Upgrade logger-go dependency to version 3.3.1, which includes improvements in goroutine management, as well as a new Stop method for graceful shutdown.
  • Add support for async data writing, by adding a bounded channel to buffer data records and process them concurrently in the background.
  • Add Shutdown method for graceful shutdown of ResurfacePump backend.

  Thanks to community member Ramón Márquez for updating this pump.

Further Information

Upgrading Tyk

Please refer to the upgrading Tyk page for further guidance on the upgrade strategy.

FAQ

Please visit our Developer Support page for further information relating to reporting bugs, upgrading Tyk, technical support and how to contribute.