Skip to content

v1.9.0
Compare
Choose a tag to compare
@mativm02 mativm02 released this 07 May 13:55
· 42 commits to master since this release
v1.9.0
ee0fce0
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.

1.9.0 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. To support newer versions of MongoDB and align with newer versions of Tyk, the default MongoDB driver has changed from mgo to mongo-go. The mongo-go driver supports MongoDB v4 or later. If you're using a version of MongoDB below v4, please follow this guide to update the driver type to mgo.

Users should follow Tyk's recommended upgrade instructions before applying any updates.

Dependencies

3rd Party Dependencies & Tools

Third Party Dependency Tested Versions Compatible Versions Comments
GoLang 1.19, 1.20, 1.21 1.19, 1.20, 1.21 All our binaries
MongoDB 5.x, 6.x, and 7.0 4.4.x, 5.x, 6.x, and 7.0 Used by Tyk Dashboard
PostgreSQL 11.x - 15.x LTS 11.x - 15.x Used by Tyk Dashboard
Redis 6.x - 7.0 6.x - 7.x Used by all Tyk components

Given the time between your upgrade and this release, customers should verify the ongoing support of their third-party dependencies, as their status may have changed since this version's release.

Deprecations

There are no deprecations in this release.

Upgrade Instructions

For users currently on v1.8.X, upgrading promptly to the latest release is strongly recommended. If you're working with an older version, bypass version 1.8 and proceed directly to the latest release.

Release Highlights

Redis 7 and Storage Library

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

MongoDB Driver

As of v1.9, the default MongoDB driver has 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

Significant enhancements have been made to Tyk Graph Pump, including removing the dependency on the enable_detailed_recording setting. This change reduces storage requirements, streamlines operations, and enhances performance. By decoupling detailed recording from configuration, Tyk Graph Pump now provides better flexibility and control over data storage.

Downloads

Changelog {#Changelog-v1.9.0}

Added

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 and 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 a Shutdown method for graceful shutdown of the 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 exponential backoff retry mechanism for sending logs to Splunk, reducing the risk of losing logs. It fixes a bug with response handling and proper connection closure.

  • Added a Field for GraphQL Aggregated Analytics (SQL Databases)
    SQL databases now have a new api_value field for GraphQL aggregated analytics records to ensure correct display on the Dashboard.

  • Environment Variables TYK_PMP_PUMPS_AGGREGATE_*
    Fixed a bug where TYK_PMP_PUMPS_AGGREGATE_* environment variables didn't correspond correctly to pump.conf.

  • Added an api_id Field
    SQL databases now have a new api_id field for GraphQL aggregated analytics records to ensure proper display on the Dashboard.

  • Redis Sentinel TLS Fix
    Fixed a bug preventing Tyk Pump from connecting to Redis Sentinel when TLS was enabled.

Security Fixes

Community Contributions

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

  • Added Simple Queue Service Pump Support
    Tyk 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 and 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 a Shutdown method for graceful shutdown of the 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

Visit our Developer Support page for information about bug reporting, upgrading Tyk, technical support, and how to contribute.

Assets 2
Loading