Release 4.0.0

[4.0.0] - January 22, 2023

New Features

The 4.0.0 release introduces a new primary feature, Advanced Audience Targeting enabled through integration with Optimizely Data Platform (ODP) (#356, #364, #365, #366).

You can use ODP, a high-performance Customer Data Platform (CDP), to easily create complex real-time segments (RTS) using first-party and 50+ third-party data sources out of the box. You can create custom schemas that support the user attributes important for your business, and stitch together user behavior done on different devices to better understand and target your customers for personalized user experiences. ODP can be used as a single source of truth for these segments in any Optimizely or 3rd party tool.

With ODP accounts integrated into Optimizely projects, you can build audiences using segments pre-defined in ODP. The SDK will fetch the segments for given users and make decisions using the segments. For access to ODP audience targeting in your Feature Experimentation account, please contact your Optimizely Customer Success Manager.

This version includes the following changes:

• FetchQualifiedSegments() API has been added to the /decide endpoint. This API will retrieve user segments from the ODP server. The fetched segments will be used for audience evaluation. Fetched data will be stored in the local cache to avoid repeated network delays.

• SendOdpEvent() API has been added with the /send-opd-event endpoint. Customers can build/send arbitrary ODP events that will bind user identifiers and data to user profiles in ODP.

For details, refer to our documentation pages:

• Advanced Audience Targeting

• Server SDK Support

• Use Optimizely Agent

• Configure Optimizely Agent

This release also introduces a fundamental enhancement to the agent with the addition of a datafile syncer. This feature is designed to facilitate seamless synchronization of datafiles across agent nodes, ensuring consistency and accuracy in the operation of the webhook API.
The datafile syncer uses a PubSub system (Default: Redis) to send updated datafile webhook notification to Agent nodes (in HA system) so that nodes can immediately fetch the latest datafile. (#405)

Breaking Changes

• ODPManager in the SDK is enabled by default. Unless an ODP account is integrated into the Optimizely projects, most ODPManager functions will be ignored. If needed, ODPManager can be disabled when OptimizelyClient is instantiated. From Agent, it can be switched off from config.yaml or env variables.
• Updated go-sdk version to v2.0.0 with module path github.com/optimizely/go-sdk/v2

Functionality Enhancement

• Updated openapi schema to 3.1.0. (#392)
• Added support for prometheus metrics. (#348)
• Github Issue template is udpated. (#396)
• Updated go version to 1.21. (#398)
• Added OpenTelemetry Tracing Support. (#400)
• Added traceID & spanID to logs. (#407)

Bug fixes

In previous versions, there was an issue where the Notification API would miss notification events when the Agent was operating in HA mode. It only got notification events from one Agent node. The bug has been addressed in this release with the implementation of a comprehensive solution. A PubSub system (Default: Redis) is used to ensure consistent retrieval of notification events across all nodes in an HA setup. (#399)

Release 3.2.0

[3.2.0] - December 13, 2023

New Features

• Added support for including traceId and spanId into the logs. (#407)

Release 3.1.0

[3.1.0] - November 3, 2023

• Added support for Prometheus-based metrics alongside expvar metrics. This can be configured from the config.yaml file. (#348)

• Added support for OpenTelemetry tracing. Distributed tracing is also supported according to W3C TraceContext. (#400, #401, #402)

Release 4.0.0-beta

[4.0.0-beta] - May 11, 2023

New Features

The 4.0.0-beta release introduces a new primary feature, Advanced Audience Targeting enabled through integration with Optimizely Data Platform (ODP) (#356, #364, #365, #366).

You can use ODP, a high-performance Customer Data Platform (CDP), to easily create complex real-time segments (RTS) using first-party and 50+ third-party data sources out of the box. You can create custom schemas that support the user attributes important for your business, and stitch together user behavior done on different devices to better understand and target your customers for personalized user experiences. ODP can be used as a single source of truth for these segments in any Optimizely or 3rd party tool.

With ODP accounts integrated into Optimizely projects, you can build audiences using segments pre-defined in ODP. The SDK will fetch the segments for given users and make decisions using the segments. For access to ODP audience targeting in your Feature Experimentation account, please contact your Optimizely Customer Success Manager.

This version includes the following changes:

• FetchQualifiedSegments() API has been added to the /decide endpoint. This API will retrieve user segments from the ODP server. The fetched segments will be used for audience evaluation. Fetched data will be stored in the local cache to avoid repeated network delays.

• SendOdpEvent() API has been added with the /send-opd-event endpoint. Customers can build/send arbitrary ODP events that will bind user identifiers and data to user profiles in ODP.

For details, refer to our documentation pages:

• Advanced Audience Targeting

• Server SDK Support

• Use Optimizely Agent

• Configure Optimizely Agent

Breaking Changes

• ODPManager in the SDK is enabled by default. Unless an ODP account is integrated into the Optimizely projects, most ODPManager functions will be ignored. If needed, ODPManager can be disabled when OptimizelyClient is instantiated. From Agent, it can be switched off from config.yaml or env variables.

Release 3.0.1

[3.0.1] - March 16, 2023

• Update README.md and other non-functional code to reflect that this SDK supports both Optimizely Feature Experimentation and Optimizely Full Stack. (#369).

Release 3.0.0

[3.0.0] - February 28, 2023

• Upgrade golang version to 1.20 (#357).
• Fix an issue with oauth/token API denying client access (#346).

Breaking Changes

• Minimum required golang version for agent has been upgraded to 1.20 to fix vulnerabilities.

Release 2.7.1

[2.7.1] - December 20, 2022

• Add support for asynchronous Save using rest UPS by setting async boolean value inside config.yaml (#350).

Release 2.7.0

[2.7.0] - April 6, 2022

• Add UserProfileService support. Out of the box implementations include in-memory, rest and redis. In-memory service supports both fifo and lifo orders. For details refer to our documentation page: UserProfileService (#326, #331).
• Add more detail in documentation for sdk key. (#332)
• Add support to remove sdkKey from logs (#329).
• Update JWT library to https://github.com/golang-jwt/jwt to fix security warnings since the previous library was no longer maintained
  (#334).

Release 2.6.0

[2.6.0] - Jan 13, 2022

• Introduce Forced Decisions property into the decide API for overriding and managing user-level flag, experiment and delivery rule decisions. Forced decisions can be used for QA and automated testing purposes (#324, #325).

  • For details, refer to our API documentation page: https://library.optimizely.com/docs/api/agent/v1/index.html#operation/decide.
  • Upgrade to use Go SDK v1.8.0. This adds support for Forced Decisions.

Release 2.5.0

[2.5.0] - Sep 24, 2021

• Add new fields (sdkKey, environmentKey, attributes, audiences, events, experimentRules, deliveryRules) to /config endpoint (PR #322)