statsig

README

Statsig Go Server SDK

The Statsig Go SDK for multi-user, server side environments. If you need a SDK for another language or single user client environment, check out our other SDKs.

Statsig helps you move faster with Feature Gates (Feature Flags) and Dynamic Configs. It also allows you to run A/B tests to validate your new features and understand their impact on your KPIs. If you're new to Statsig, create an account at statsig.com.

Getting Started

Check out our SDK docs to get started.

Testing

Each server SDK is tested at multiple levels - from unit to integration and e2e tests. Our internal e2e test harness runs daily against each server SDK, while unit and integration tests can be seen in the respective github repos of each SDK. The statsig_test.go runs a validation test on local rule/condition evaluation for this SDK against the results in the statsig backend.

Guidelines

• Pull requests are welcome!
• If you encounter bugs, feel free to file an issue.
• For integration questions/help, join our slack community.

Documentation

Overview

Package statsig implements feature gating and a/b testing

Index

• Constants
• func CheckGate(user User, gate string) bool
• func Initialize(sdkKey string)
• func InitializeWithOptions(sdkKey string, options *Options)
• func LogEvent(event Event)
• func LogImmediate(events []Event) (*http.Response, error)
• func OverrideConfig(config string, val map[string]interface{})
• func OverrideGate(gate string, val bool)
• func Shutdown()
• type Client
  • func NewClient(sdkKey string) *Client
  • func NewClientWithOptions(sdkKey string, options *Options) *Client
  • func (c *Client) CheckGate(user User, gate string) bool
  • func (c *Client) GetConfig(user User, config string) DynamicConfig
  • func (c *Client) GetExperiment(user User, experiment string) DynamicConfig
  • func (c *Client) GetLayer(user User, layer string) Layer
  • func (c *Client) LogEvent(event Event)
  • func (c *Client) LogImmediate(events []Event) (*http.Response, error)
  • func (c *Client) OverrideConfig(config string, val map[string]interface{})
  • func (c *Client) OverrideGate(gate string, val bool)
  • func (c *Client) Shutdown()
• type DynamicConfig
  • func GetConfig(user User, config string) DynamicConfig
  • func GetExperiment(user User, experiment string) DynamicConfig
  • func NewConfig(name string, value map[string]interface{}, ruleID string) *DynamicConfig
  • func (d *DynamicConfig) GetBool(key string, fallback bool) bool
  • func (d *DynamicConfig) GetMap(key string, fallback map[string]interface{}) map[string]interface{}
  • func (d *DynamicConfig) GetNumber(key string, fallback float64) float64
  • func (d *DynamicConfig) GetSlice(key string, fallback []interface{}) []interface{}
  • func (d *DynamicConfig) GetString(key string, fallback string) string
• type Environment
• type Event
• type Layer
  • func GetLayer(user User, layer string) Layer
  • func NewLayer(name string, value map[string]interface{}, ruleID string, ...) *Layer
  • func (d *Layer) GetBool(key string, fallback bool) bool
  • func (d *Layer) GetMap(key string, fallback map[string]interface{}) map[string]interface{}
  • func (d *Layer) GetNumber(key string, fallback float64) float64
  • func (d *Layer) GetSlice(key string, fallback []interface{}) []interface{}
  • func (d *Layer) GetString(key string, fallback string) string
• type Options
• type User

Constants

const DefaultEndpoint = "https://statsigapi.net/v1"

Functions

func CheckGate

func CheckGate(user User, gate string) bool

Checks the value of a Feature Gate for the given user

func Initialize

func Initialize(sdkKey string)

Initializes the global Statsig instance with the given sdkKey

func InitializeWithOptions

func InitializeWithOptions(sdkKey string, options *Options)

Initializes the global Statsig instance with the given sdkKey and options

func LogEvent

func LogEvent(event Event)

Logs an event to the Statsig console

func LogImmediate

func LogImmediate(events []Event) (*http.Response, error)

Logs a slice of events to Statsig server immediately

func OverrideConfig

func OverrideConfig(config string, val map[string]interface{})

Override the DynamicConfig value for the given user

func OverrideGate

func OverrideGate(gate string, val bool)

Override the value of a Feature Gate for the given user

func Shutdown

func Shutdown()

Cleans up Statsig, persisting any Event Logs and cleanup processes Using any method is undefined after Shutdown() has been called

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

An instance of a StatsigClient for interfacing with Statsig Feature Gates, Dynamic Configs, Experiments, and Event Logging

func NewClient

func NewClient(sdkKey string) *Client

Initializes a Statsig Client with the given sdkKey

func NewClientWithOptions

func NewClientWithOptions(sdkKey string, options *Options) *Client

Initializes a Statsig Client with the given sdkKey and options

func (*Client) CheckGate

func (c *Client) CheckGate(user User, gate string) bool

Checks the value of a Feature Gate for the given user

func (*Client) GetConfig

func (c *Client) GetConfig(user User, config string) DynamicConfig

Gets the DynamicConfig value for the given user

func (*Client) GetExperiment

func (c *Client) GetExperiment(user User, experiment string) DynamicConfig

Gets the DynamicConfig value of an Experiment for the given user

func (*Client) GetLayer

func (c *Client) GetLayer(user User, layer string) Layer

Gets the Layer object for the given user

func (*Client) LogEvent

func (c *Client) LogEvent(event Event)

Logs an event to Statsig for analysis in the Statsig Console

func (*Client) LogImmediate

func (c *Client) LogImmediate(events []Event) (*http.Response, error)

func (*Client) OverrideConfig

func (c *Client) OverrideConfig(config string, val map[string]interface{})

Override the DynamicConfig value for the given user

func (*Client) OverrideGate

func (c *Client) OverrideGate(gate string, val bool)

Override the value of a Feature Gate for the given user

func (*Client) Shutdown

func (c *Client) Shutdown()

Cleans up Statsig, persisting any Event Logs and cleanup processes Using any method is undefined after Shutdown() has been called

type DynamicConfig

type DynamicConfig struct {
	// contains filtered or unexported fields
}

A json blob configured in the Statsig Console

func GetConfig

func GetConfig(user User, config string) DynamicConfig

Gets the DynamicConfig value for the given user

func GetExperiment

func GetExperiment(user User, experiment string) DynamicConfig

Gets the DynamicConfig value of an Experiment for the given user

func NewConfig

func NewConfig(name string, value map[string]interface{}, ruleID string) *DynamicConfig

func (*DynamicConfig) GetBool

func (d *DynamicConfig) GetBool(key string, fallback bool) bool

Gets the boolean value at the given key in the DynamicConfig Returns the fallback boolean if the item at the given key is not found or not of type boolean

func (*DynamicConfig) GetMap

func (d *DynamicConfig) GetMap(key string, fallback map[string]interface{}) map[string]interface{}

func (*DynamicConfig) GetNumber

func (d *DynamicConfig) GetNumber(key string, fallback float64) float64

Gets the float64 value at the given key in the DynamicConfig Returns the fallback float64 if the item at the given key is not found or not of type float64

func (*DynamicConfig) GetSlice

func (d *DynamicConfig) GetSlice(key string, fallback []interface{}) []interface{}

Gets the slice value at the given key in the DynamicConfig Returns the fallback slice if the item at the given key is not found or not of type slice

func (*DynamicConfig) GetString

func (d *DynamicConfig) GetString(key string, fallback string) string

Gets the string value at the given key in the DynamicConfig Returns the fallback string if the item at the given key is not found or not of type string

type Environment

type Environment struct {
	Tier   string            `json:"tier"`
	Params map[string]string `json:"params"`
}

See https://docs.statsig.com/guides/usingEnvironments

type Event

type Event struct {
	EventName string            `json:"eventName"`
	User      User              `json:"user"`
	Value     string            `json:"value"`
	Metadata  map[string]string `json:"metadata"`
	Time      int64             `json:"time"`
}

an event to be sent to Statsig for logging and analysis

type Layer

type Layer struct {
	// contains filtered or unexported fields
}

func GetLayer

func GetLayer(user User, layer string) Layer

Gets the Layer object for the given user

func NewLayer

func NewLayer(name string, value map[string]interface{}, ruleID string, logExposure *func(configBase, string)) *Layer

func (*Layer) GetBool

func (d *Layer) GetBool(key string, fallback bool) bool

Gets the boolean value at the given key in the DynamicConfig Returns the fallback boolean if the item at the given key is not found or not of type boolean

func (*Layer) GetMap

func (d *Layer) GetMap(key string, fallback map[string]interface{}) map[string]interface{}

func (*Layer) GetNumber

func (d *Layer) GetNumber(key string, fallback float64) float64

Gets the float64 value at the given key in the DynamicConfig Returns the fallback float64 if the item at the given key is not found or not of type float64

func (*Layer) GetSlice

func (d *Layer) GetSlice(key string, fallback []interface{}) []interface{}

Gets the slice value at the given key in the DynamicConfig Returns the fallback slice if the item at the given key is not found or not of type slice

func (*Layer) GetString

func (d *Layer) GetString(key string, fallback string) string

Gets the string value at the given key in the DynamicConfig Returns the fallback string if the item at the given key is not found or not of type string

type Options

type Options struct {
	API                string      `json:"api"`
	Environment        Environment `json:"environment"`
	LocalMode          bool        `json:"localMode"`
	ConfigSyncInterval time.Duration
	IDListSyncInterval time.Duration
}

Advanced options for configuring the Statsig SDK

type User

type User struct {
	UserID             string                 `json:"userID"`
	Email              string                 `json:"email"`
	IpAddress          string                 `json:"ip"`
	UserAgent          string                 `json:"userAgent"`
	Country            string                 `json:"country"`
	Locale             string                 `json:"locale"`
	AppVersion         string                 `json:"appVersion"`
	Custom             map[string]interface{} `json:"custom"`
	PrivateAttributes  map[string]interface{} `json:"privateAttributes"`
	StatsigEnvironment map[string]string      `json:"statsigEnvironment"`
	CustomIDs          map[string]string      `json:"customIDs"`
}

User specific attributes for evaluating Feature Gates, Experiments, and DyanmicConfigs

NOTE: UserID is **required** - see https://docs.statsig.com/messages/serverRequiredUserID\ PrivateAttributes are only used for user targeting/grouping in feature gates, dynamic configs, experiments and etc; they are omitted in logs.