Optimizely Go SDK

Installation

Install from github:

go get github.com/optimizely/go-sdk

Install from source:

go get github.com/optimizely/go-sdk
cd $GOPATH/src/github.com/optimizely/go-sdk
go install

NOTE: We practice trunk-based development, and as such our default branch, master might not always be the most stable. We do tag releases on Github and you can pin your installation to those particular release versions. One way to do this is to use Go Modules for managing external dependencies:

Install using go.mod:

module mymodule

go 1.13

require (
	github.com/optimizely/go-sdk v1.8.3
)

If you are already using go.mod in your application you can run the following:

go mod edit -require github.com/optimizely/go-sdk@v1.8.3

NOTE:

go get github.com/optimizely/go-sdk/...

go get github.com/optimizely/go-sdk/pkg

will install it as a package to pkg directory, rather than src directory. It could be useful for future development and vendoring.

Usage

Instantiation

To start using the SDK, create an instance using our factory method:

import optly "github.com/optimizely/go-sdk"
import "github.com/optimizely/go-sdk/client"

// Simple one-line initialization with the SDK key
client, err := optly.Client("SDK_KEY")

// You can also instantiate with a hard-coded datafile using our client factory method
optimizelyFactory := &client.OptimizelyFactory{
	Datafile: []byte("datafile_string"),
}

client, err = optimizelyFactory.Client()

Feature Rollouts

import (
  optly "github.com/optimizely/go-sdk"
)

// instantiate a client
client, err := optly.Client("SDK_KEY")

// User attributes are optional and used for targeting and results segmentation
atributes := map[string]interface{}{
     "state":      "California",
     "likes_donuts": true,
}, 
user := optly.UserContext("optimizely end user", attributes)
enabled, _ := client.IsFeatureEnabled("binary_feature", user)

Credits

This software is distributed with code from the following open source projects:

andersjanmyr/go-sdk