OptimizelyConfig for the Go SDK
Describes how to get access to project configuration data within the datafile using OptimizelyConfig for the Optimizely Feature Experimentation Go SDK.
Optimizely Feature Experimentation SDKs open a well-defined set of public APIs, hiding implementation details. However, you may need access to project configuration data within thedatafile. The following section extends the public APIs to define data models and access methods, which you can use to access project configuration data.
OptimizelyConfig API
A public configuration data model (OptimizelyConfig) is defined as a structured format of static Optimizely Project data.
GetOptimizelyConfig
OptimizelyConfigYou can accessOptimizelyConfig through theOptimizelyClient (top-level) using this public API call.
client, err := optimizelyFactory.Client()if err != nil {// handler error}var config = client.GetOptimizelyConfig()getOptimizelyConfig returns anOptimizelyConfig instance containing the following:
- Environment key
- SDK key
- Datafile revision number
- Experiments mapped by key values
- All attributes
- All audiences
- All events
- Feature flags mapped by key values
- Function to retrieve the project configuration (the datafile)
📘
NoteWhen the system updates the SDK datafile, you can add a notification listener for
ProjectConfigUpdateNotificationto get notified. After receiving the notification, call the method to get the updatedOptimizelyConfigdata. Refer to the following examples.
Get datafile
To share the same datafile between multiple SDK instances, such as in a client or server scenario, pass a JSON string representation of the config (the datafile) between instances. To get the datafile, use the OptimizelyConfig object's GetDatafile method. For more information, seeSharing the datafile with multiple SDK implementations.
Object model
The following shows the object model forOptimizelyConfig:
type OptimizelyConfig struct {EnvironmentKey stringSdkKey stringRevision string// This experimentsMap is for experiments of legacy projects only.// For flag projects, experiment keys are not guaranteed to be unique// across multiple flags, so this map may not include all experiments// when keys conflict.ExperimentsMap map[string]OptimizelyExperimentFeaturesMap map[string]OptimizelyFeatureAttributes []OptimizelyAttributeAudiences []OptimizelyAudienceEvents []OptimizelyEvent}type OptimizelyExperiment struct {ID stringKey stringAudiences stringVariationsMap map[string]OptimizelyVariation}type OptimizelyFeature struct {ID stringKey stringExperimentRules []OptimizelyExperimentDeliveryRules []OptimizelyExperimentVariablesMap map[string]OptimizelyVariable// Deprecated: Use experimentRules and deliveryRulesExperimentsMap map[string]OptimizelyExperiment}type OptimizelyVariation struct {ID stringKey stringFeatureEnabled boolVariablesMap map[string]OptimizelyVariable}type OptimizelyVariable struct {ID stringKey stringType stringValue string}type OptimizelyAttribute struct {ID stringKey string}type OptimizelyAudience struct {ID stringName stringConditions string}type OptimizelyEvent struct {ID stringKey stringExperimentIds []string}Examples
You can accessOptimizelyConfig from theOptimizelyClient (top-level) using the following code example:
optimizelyConfig := optimizelyClient.GetOptimizelyConfig()fmt.Println("[OptimizelyConfig] revision = " + optimizelyConfig.Revision)fmt.Println("[OptimizelyConfig] sdkKey = " + optimizelyConfig.SdkKey)fmt.Println("[OptimizelyConfig] environmentKey = " + optimizelyConfig.EnvironmentKey)fmt.Println("[OptimizelyConfig] attributes:")for _, attribute := range optimizelyConfig.Attributes {fmt.Println("[OptimizelyAttribute] -- (id, key) = " + attribute.ID + ", " + attribute.Key)}fmt.Println("[OptimizelyConfig] audiences:")for _, audience := range optimizelyConfig.Audiences {fmt.Println("[OptimizelyAudience] -- (id, name, conditions) = " + audience.ID + ", " + audience.Name + ", " + audience.Conditions)}fmt.Println("[OptimizelyConfig] events:")for _, event := range optimizelyConfig.Events {fmt.Println(fmt.Sprintf("[OptimizelyEvent] -- (id, key, experimentIds) = %s, %s, %v", event.ID, event.Key, event.ExperimentIds))}// all flagsflagKeys := []string{}for flagKey := range optimizelyConfig.FeaturesMap {flagKeys = append(flagKeys, flagKey)}for _, flagKey := range flagKeys {flag := optimizelyConfig.FeaturesMap[flagKey]experimentRules := flag.ExperimentRulesdeliveryRules := flag.DeliveryRules// use experiment rules and delivery rules and other flag data here...for _, experiment := range experimentRules {fmt.Println("[OptimizelyExperiment] - experiment rule-key = " + experiment.Key)fmt.Println("[OptimizelyExperiment] - experiment audiences = " + experiment.Audiences)variationKeys := []string{}variationsMap := experiment.VariationsMapfor variationKey, _ := range variationsMap {variationKeys = append(variationKeys, variationKey)}for _, varKey := range variationKeys {variation := variationsMap[varKey]fmt.Println(fmt.Sprintf("OptimizelyVariation] -- variation = { key: %s, id: %s, featureEnabled: %v }", varKey, variation.ID, variation.FeatureEnabled))variablesMap := variationsMap[varKey].VariablesMapvariableKeys := []string{}for variableKey := range variablesMap {variableKeys = append(variableKeys, variableKey)}for _, variableKey := range variableKeys {variable := variablesMap[variableKey]fmt.Println(fmt.Sprintf("[OptimizelyVariable] --- variable: %s, %v", variableKey, variable))}}}for _, delivery := range deliveryRules {fmt.Println("[OptimizelyExperiment] - delivery rule-key = " + delivery.Key)fmt.Println("[OptimizelyExperiment] - delivery audiences = " + delivery.Audiences)// use delivery rule data here...}}// listen to NotificationType.datafileChange to get updated datacallback := func(notification notification.ProjectConfigUpdateNotification) {var newOptConfig = optimizelyClient.GetOptimizelyConfig()fmt.Println("[OptimizelyConfig] revision = " + newOptConfig.Revision)}optimizelyClient.ConfigManager.OnProjectConfigUpdate(callback)Updated 17 days ago