Setup the SDK
1
2
Initialize the SDK
After installation, you will need to initialize the SDK using a Server Secret Key from the Statsig console.There is also an optional parameter named You can also provide custom options:For shared instance usage:
Server Secret Keys should always be kept private. If you expose one, you can disable and recreate it in the Statsig console.
options
that allows you to pass in a StatsigOptions to customize the SDK.initialize
will perform a network request. After initialize
completes, virtually all SDK operations will be synchronous (See Evaluating Feature Gates in the Statsig SDK). The SDK will fetch updates from Statsig in the background, independently of your API calls.Working with the SDK
Checking a Feature Flag/Gate
Now that your SDK is initialized, let’s fetch a Feature Gate. Feature Gates can be used to create logic branches in code that can be rolled out to different users from the Statsig Console. Gates are always CLOSED or OFF (thinkreturn false;
) by default. From this point on, all APIs will require you to specify the user (see Statsig user) associated with the request. For example, check a gate for a certain user like this: Reading a Dynamic Config
Feature Gates can be very useful for simple on/off switches, with optional but advanced user targeting. However, if you want to be send a different set of values (strings, numbers, and etc.) to your clients based on specific user attributes, e.g. country, Dynamic Configs can help you with that. The API is very similar to Feature Gates, but you get an entire json object you can configure on the server and you can fetch typed parameters from it. For example:Getting a Layer/Experiment
Then we have Layers/Experiments, which you can use to run A/B/n experiments. We offer two APIs, but often recommend the use of layers, which make parameters reusable and let you run mutually exclusive experiments.EvaluationOptions
. Logging an Event
Now that you have a Feature Gate or an Experiment set up, you may want to track some custom events and see how your new features or different experiment groups affect these events. This is super easy with Statsig—simply call the Log Event API and specify the user and event name to log; you additionally provide some value and/or an object of metadata to be logged together with the event:LogEvent
method supports multiple overloads: LogEvent(user, eventName)
LogEvent(user, eventName, stringValue, metadata)
LogEvent(user, eventName, intValue, metadata)
LogEvent(user, eventName, doubleValue, metadata)
Retrieving Feature Gate Metadata
In certain scenarios, you may need more information about a gate evaluation than just a boolean value. For additional metadata about the evaluation, use the Get Feature Gate API, which returns a FeatureGate object:Using Shared Instance
In some applications, you may want to create a single Statsig instance that can be accessed globally throughout your codebase. The shared instance functionality provides a singleton pattern for this purpose:- Singleton pattern usage across your application
- Dependency injection scenarios
- Avoiding multiple SDK instances
Manual Exposures
By default, the SDK will automatically log an exposure event when you check a gate, get a config, get an experiment, or get a layer. However, there are times when you may want to log an exposure event manually. For example, if you’re using a gate to control access to a feature, but you don’t want to log an exposure until the user actually uses the feature, you can use manual exposures. All of the main SDK functions (CheckGate
, GetDynamicConfig
, GetExperiment
, GetLayer
) accept an optional EvaluationOptions
parameter. When disableExposureLogging
is set to true
, the SDK will not automatically log an exposure event. You can then manually log the exposure at a later time using the corresponding manual exposure logging method: - Feature Gates
- Dynamic Configs
- Experiments
- Layers
Statsig User
TheStatsigUser
object represents a user in Statsig. You must provide a userID
or at least one of the customIDs
to identify the user. When calling APIs that require a user, you should pass as much information as possible in order to take advantage of advanced gate and config conditions (like country or OS/browser level checks), and correctly measure impact of your experiments on your metrics/events. At least one ID (userID or customID) is required because it’s needed to provide a consistent experience for a given user (click here) Besides userID, we also have email, ip, userAgent, country, locale and appVersion as top-level fields on StatsigUser. In addition, you can pass any key-value pairs in an object/dictionary to the custom field and be able to create targeting based on them. Private Attributes
Private attributes are user attributes that are used for evaluation but are not forwarded to any integrations. They are useful for PII or sensitive data that you don’t want to send to third-party services.StatsigUser
represents the user context for feature flag evaluation. Use StatsigUserBuilder
to create user instances: Builder Methods
Builder Methods
Builder Methods
- SetUserID(string): Set the primary user ID
- SetEmail(string): Set user email
- SetIP(string): Set user IP address
- SetUserAgent(string): Set browser user agent
- SetCountry(string): Set user country
- SetLocale(string): Set user locale
- SetAppVersion(string): Set app version
- SetCustomIDs(Dictionary<string, string>): Set all custom IDs
- AddCustomID(string, string): Add a single custom ID
- SetCustomProperties(Dictionary<string, object>): Set all custom properties
- AddCustomProperty(string, object): Add a single custom property
- SetPrivateAttributes(Dictionary<string, object>): Set all private attributes
- AddPrivateAttribute(string, object): Add a single private attribute
- Build(): Create the StatsigUser instance
Statsig Options
You can pass in an optional parameteroptions
in addition to sdkKey
during initialization to customize the Statsig client. Here are the available options that you can configure. StatsigOptions
StatsigOptions
StatsigOptions
can be configured using the StatsigOptionsBuilder
pattern:Available Options
- SetSpecsURL(string): Override the default specs download endpoint
- SetLogEventURL(string): Override the default event logging endpoint
- SetEnvironment(string): Set the environment tier (e.g., “production”, “staging”)
- SetSpecsSyncIntervalMs(int): How often to sync configuration specs (default: 10000ms)
- SetEventLoggingMaxQueueSize(int): Maximum events to queue before flushing
- SetWaitForCountryLookupInit(bool): Wait for country lookup initialization
- SetWaitForUserAgentInit(bool): Wait for user agent parsing initialization
- SetDisableCountryLookup(bool): Disable automatic country detection
- SetDisableUserAgentParsing(bool): Disable user agent parsing
- SetDisableAllLogging(bool): Disable all event logging
- SetInitTimeoutMs(int): Maximum time in milliseconds to wait for SDK initialization (default: 3000ms)
- SetFallbackToStatsigApi(bool): Fallback to Statsig API when custom adapters fail (default: false)
- SetEnableIDLists(bool): Enable ID list targeting
- SetIDListsURL(string): Override the default ID lists endpoint
- SetIDListsSyncIntervalMs(int): How often to sync ID lists (default: 60000ms)
- SetGlobalCustomFields(Dictionary<string, object>): Global custom fields for all events
EvaluationOptions
EvaluationOptions
EvaluationOptions
allows you to customize the behavior of feature flag evaluations:Options
- DisableExposureLogging: When
true
, prevents automatic exposure event logging for this evaluation. Useful when you want to evaluate a feature flag without affecting analytics or experiment results.
Use Cases
- Internal Tools: Check flag values for debugging without affecting user metrics
- Conditional Logic: Evaluate flags as part of complex logic where exposure should be logged manually later
Shutting Statsig Down
Because we batch and periodically flush events, some events may not have been sent when your app/server shuts down. To make sure all logged events are properly flushed, you should callshutdown()
before your app/server shuts down: Methods
- FlushEvents(): Immediately flush any pending events to Statsig servers
- Shutdown(): Gracefully shutdown the SDK, flushing events and cleaning up resources
- Dispose(): Release native resources (implements IDisposable)
FlushEvents()
before Shutdown()
to ensure all events are sent, and always call Dispose()
or use using
statements to properly clean up resources. Client SDK Bootstrapping | SSR
If you are using the Statsig client SDK in a browser or mobile app, you can bootstrap the client SDK with the values from the server SDK to avoid a network request on the client. This is useful for server-side rendering (SSR) or when you want to reduce the number of network requests on the client.GetClientInitializeResponse
method returns a JSON string containing the initialization data needed by client-side SDKs. This enables server-side rendering and reduces client initialization time. ClientInitResponseOptions
- HashAlgorithm: Hash algorithm for response integrity (default: “djb2”)
- ClientSDKKey: Client SDK key to include in response
- IncludeLocalOverrides: Whether to include local overrides in the response (default: false)
Working with IP or UserAgent Values
The server SDK will not automatically use theip
, or userAgent
for gate evaluation as Statsig servers would, since we don’t have access to the request headers. If you’d like to use the attributes we derive from these properties, like Browser Name/Version, OS Name/Version & Country, you must manually set the ip
and userAgent
fields on the user object when calling GetClientInitializeResponse
. Working with IDs
To ensure that the server SDK evaluates each config accurately, they need access to all user attributes that the client SDK leverages. We recommend passing all of these attributes to the server SDK - using tools like Cookies if needed to ensure they’re attached on first requests. If the user objects on the client and server aren’t identical, modern SDKs will throw an InvalidBootstrap warning. Client SDKs also auto-generate a StableID, and its important to manage the lifecycle of this ID to be sure that it is consistent on client and server side. Managing this with a cookie is often easiest, see Keeping StableID Consistent. If StableID differs between Client and Server, you’ll see a BootstrapStableIDMismatch warning, and checks with this warning won’t contribute to your experiment analyses.getClientInitializeResponse and the legacy JS SDK
If you are migrating from the legacy JS Client, you will need to make some updates to how your server SDK generates values. The default hashing algorithm was changed fromsha256
to djb2
for performance and size reasons. Local Overrides
Local Overrides are a way to override the values of gates, configs, experiments, and layers for testing purposes. This is useful for local development or testing scenarios where you want to force a specific value without having to change the configuration in the Statsig console.- Testing specific configurations during development
- QA testing with known values
- Debugging feature flag behavior
- Integration testing with predictable results
Performance Benefits
The .NET Core SDK leverages Statsig’s high-performance Rust evaluation engine through FFI bindings, details:- Native Rust evaluation engine handles all rule processing
- .NET wrapper provides familiar C# APIs and type safety
- Automatic memory management between .NET and Rust boundaries
- Thread-safe operations across the FFI boundary