Statsig

https://docs.statsig.com
Admin
Statsig is a unified platform for product experimentation and feature management, enabling teams to...
Tokens:1,125,221
Snippets:10,282
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install the SDK with go get

Source: https://docs.statsig.com/en/server/go

Use the go get command to install the Statsig Go SDK. This is the recommended installation method.

```bash
go get github.com/statsig-io/go-sdk

```

--------------------------------

### Install the legacy Go SDK with go get

Source: https://docs.statsig.com/server/go

Installs the legacy Statsig Go SDK using the go get command. Use this to add the SDK to your Go module.

```bash
go get github.com/statsig-io/go-sdk
```

--------------------------------

### Install statsig-python-core

Source: https://docs.statsig.com/autotune/contextual/getting-started

Install the Statsig Python SDK before running the contextual autotune example.

```bash
pip install statsig-python-core
```

--------------------------------

### Node Core SDK Complete Example

Source: https://docs.statsig.com/en/server-core/migration-guides/node

Complete example using the @statsig/statsig-node-core SDK. It initializes the SDK, creates a user, checks a gate, gets a dynamic config, experiment, and layer, logs an event, and shuts down gracefully.

```typescript
import {
  Statsig,
  StatsigUser,
  StatsigOptions,
} from "@statsig/statsig-node-core";

async function main() {
  // 1. Configure options
  const options: StatsigOptions = {
    environment: "development",
    specsSyncIntervalMs: 60000,
    eventLoggingFlushIntervalMs: 10000,
  };

  // 2. Create SDK instance (instance-based approach)
  const statsig = new Statsig("secret-your-server-key", options);

  // 3. Initialize the SDK
  await statsig.initialize();

  // 4. Create a user (must use class constructor)
  const user = new StatsigUser({
    userID: "user_123",
    email: "user@example.com",
    custom: {
      subscription_tier: "premium",
      signup_date: "2024-01-15",
    },
  });

  // 5. Check a feature gate
  const showNewFeature = statsig.checkGate(user, "new_feature_gate");
  console.log("Show new feature:", showNewFeature);

  // 6. Get a dynamic config (note: getDynamicConfig, not getConfig)
  const config = statsig.getDynamicConfig(user, "app_config");
  const welcomeMessage = config.get("welcome_message", "Hello!");
  const maxItems = config.get("max_items", 10);
  console.log("Welcome message:", welcomeMessage);
  console.log("Max items:", maxItems);

  // 7. Get an experiment
  const experiment = statsig.getExperiment(user, "checkout_flow_test");
  const variant = experiment.get("variant", "control");
  const buttonColor = experiment.get("button_color", "#007bff");
  console.log("Experiment variant:", variant);
  console.log("Button color:", buttonColor);

  // 8. Get a layer
  const layer = statsig.getLayer(user, "homepage_layer");
  const heroText = layer.get("hero_text", "Welcome to our app");
  console.log("Hero text:", heroText);

  // 9. Log a custom event
  statsig.logEvent(user, "purchase_completed", 49.99, {
    item_id: "SKU_12345",
    currency: "USD",
  });

  // 10. Shutdown gracefully
  await statsig.shutdown();
  console.log("Statsig shutdown complete");
}

main().catch(console.error);
```

--------------------------------

### Install PHP Core SDK and configure composer.json

Source: https://docs.statsig.com/en/server-core/migration-guides/php

Install the PHP Core SDK and configure composer.json to run the provided post-install.php file. This setup is required for the PHP Core SDK.

```json
composer require statsig/statsig-php-core

// composer.json
{
  "name": "awesome-php-project",
  ...
  "scripts": {
    ...
    "post-install-cmd": [
      "cd vendor/statsig/statsig-php-core && php post-install.php"
    ],
    "post-update-cmd": [
      "cd vendor/statsig/statsig-php-core && php post-install.php"
    ]
  }
}

```

--------------------------------

### AI-powered setup prompt for integrating Statsig SDK

Source: https://docs.statsig.com/en/client/React

A text prompt to copy into your IDE for AI-assisted setup. It instructs the AI to install required packages, initialize the SDK with a client key, and wrap the app in StatsigProvider with loading component.

```text
You are a frontend engineer integrating the Statsig SDK into a React app. Follow these instructions carefully:
1. Install the required Statsig packages:
     npm install @statsig/react-bindings @statsig/session-replay @statsig/web-analytics

2. In the main component file (`App.jsx` or `App.tsx`):
   - Import `StatsigProvider` and `useClientAsyncInit` from `@statsig/react-bindings`
   - Import `StatsigAutoCapturePlugin` from `@statsig/web-analytics` and `StatsigSessionReplayPlugin` from `@statsig/session-replay`
   - Initialize the SDK using your client key: 'YOUR-CLIENT-API-KEY'
   - Use `userID` from an existing variable if it's already declared in the file; otherwise, default to `'a-user'`
   - Wrap the existing app content inside `<StatsigProvider>`, using `<div>Loading...</div>` as the `loadingComponent`

3. DO NOT remove any existing JSX content from the component. Just wrap it.

4. Here is what the final file structure should look like:

    import { StatsigProvider, useClientAsyncInit } from '@statsig/react-bindings';
    import { StatsigAutoCapturePlugin } from '@statsig/web-analytics';
    import { StatsigSessionReplayPlugin } from '@statsig/session-replay';
    import YourApp from './YourApp';

    function App() {
      const id = typeof userID !== 'undefined' ? userID : 'a-user';
      const { client } = useClientAsyncInit(
        'YOUR-CLIENT-API-KEY',
        { userID: id },
        { plugins: [new StatsigAutoCapturePlugin(), new StatsigSessionReplayPlugin()] }
      );

      return (
        <StatsigProvider client={client} loadingComponent={<div>Loading...</div>}>
          <YourApp />
        </StatsigProvider>
      );
    }

5. Ask the user to provide their CLIENT-API-KEY and insert it where prompted above.

```

--------------------------------

### Implement custom SpecsAdapterBase with Redis

Source: https://docs.statsig.com/en/server-core/php-core

Extend SpecsAdapterBase to fetch Statsig configurations from a custom source like Redis. Implement setup() to store the listener, start() to fetch initial specs, and use didReceiveSpecsUpdate() to notify the SDK. The example includes error handling and a timestamp in milliseconds.

```php
<?php

use Statsig\SpecsAdapterBase;
use Statsig\SpecsUpdateListener;

class RedisSpecsAdapter extends SpecsAdapterBase
{
    private $redis;
    private $listener;

    public function __construct($redis)
    {
        parent::__construct();
        $this->redis = $redis;
    }

    public function setup(SpecsUpdateListener $listener): void
    {
        $this->listener = $listener;
    }

    public function start(): void
    {
        // Fetch initial specs when SDK starts
        $this->refreshSpecsFromRedis();
        
        // Optionally, trigger a background job or set up a timer
        $this->refreshSpecsFromRedis();
    }

    private function fetchSpecsFromRedis()
    {
        try {
            $specs = $this->redis->get('statsig_config_specs');
            return $specs ?: null;
        } catch (Exception $e) {
            error_log("Failed to fetch specs from Redis: " . $e->getMessage());
            return null;
        }
    }

    private function refreshSpecsFromRedis()
    {
        $specs = $this->fetchSpecsFromRedis();
        if ($specs && $this->listener) {
            $timestamp = intval(microtime(true) * 1000);
            $this->listener->didReceiveSpecsUpdate($specs, "Redis", $timestamp);
        }
    }
}

```

--------------------------------

### Install OpenAI and Statsig packages

Source: https://docs.statsig.com/en/integrations/openai

Install the OpenAI and Statsig Python packages before starting the integration.

```bash
pip3 install openai, statsig

```

--------------------------------

### Start Recording via SessionReplay Client Instance

Source: https://docs.statsig.com/en/session-replay/configure

Manually starts a recording when you have access to the Session Replay client instance. The startRecording method respects the Global Targeting Gate and Global Sampling Rate.

```plaintext
const sessionReplayClient = new SessionReplay(client);
…

if (someCondition) {
  sessionReplayClient.startRecording();
}
```

--------------------------------

### Get a Layer or Experiment with useLayer and useExperiment

Source: https://docs.statsig.com/client/Next

Gets a layer or experiment using useLayer and useExperiment hooks. The example shows both APIs, with layers recommended for quicker iterations. Requires the 'use client' directive in App Router apps.

```tsx
'use client';

import { useExperiment, useLayer} from "@statsig/react-bindings";

export default function Home() {
  const layer = useLayer("my_experiment_layer");
  // or
  const experiment = useExperiment("my_experiment");

  return (
    <div>
      Title: {layer.get('title', 'Fallback Title')}
      {/* or */}
      Title: {experiment.get('title', 'Fallback Title')}
    </div>
  );
}

```

--------------------------------

### Initialize the SDK with a client key and user

Source: https://docs.statsig.com/client/DotNet

Initialize the SDK with a client SDK key and a StatsigUser object. The key is safe to embed in client applications. The StatsigOptions with StatsigEnvironment is optional for customizing behaviors.

```csharp
using Statsig;
using Statsig.Client;

await StatsigClient.Initialize(
    "client-sdk-key",
    new StatsigUser { UserID = "some_user_id", Email = "user@email.com" },
    new StatsigOptions(new StatsigEnvironment(EnvironmentTier.Development)) // optional, use when needed to customize certain behaviors
);

```

--------------------------------

### Install all skills from the repository

Source: https://docs.statsig.com/integrations/agent-skills

Installs every skill in the statsig-io/agent-skills repository.

```bash
npx skills add statsig-io/agent-skills --all

```

--------------------------------

### DummyPersistentStorageAdapter implementation

Source: https://docs.statsig.com/en/server/ruby

Example implementation of IUserPersistentStorage using an in-memory hash store. Useful for testing or as a starting point for a custom adapter.

```ruby
class DummyPersistentStorageAdapter < Statsig::Interfaces::IUserPersistentStorage
  attr_accessor :store

  def initialize
    @store = {}
  end

  def load(key)
    return nil unless @store&.key?(key)

    @store[key]
  end

  def save(key, data)
    @store[key] = data
  end
end

```

--------------------------------

### Set up application logs with pino and OpenTelemetry

Source: https://docs.statsig.com/infra-analytics/getting-started

Install the pino instrumentation and configure the NodeSDK to export logs to Statsig's OTLP logs endpoint. The example shows adding a BatchLogRecordProcessor with an OTLPLogExporter and enabling PinoInstrumentation, then using pino in application code.

```bash
npm i pino @opentelemetry/instrumentation-pino
```

```js
// instrumentation.js (continued)
const { BatchLogRecordProcessor } = require('@opentelemetry/sdk-logs');

const statsigKey = process.env.STATSIG_SERVER_SDK_SECRET;
const headers = { 'statsig-api-key': statsigKey ?? '' };

const sdk = new NodeSDK({
  // ... other config ...
  logRecordProcessors: [
    new BatchLogRecordProcessor(
      new OTLPLogExporter({
        url: 'https://api.statsig.com/otlp/v1/logs',
        // or
        // url: <your-collector-endpoint>/v1/logs
        headers
      })
    ),
  ],
  instrumentations: [getNodeAutoInstrumentations(), new PinoInstrumentation()],
});


// in your application code, e.g., app.js
const pino = require('pino');

const logger = pino();

logger.info('OTel logs initialized');
```

--------------------------------

### Get Layer with Statsig.getLayerSync

Source: https://docs.statsig.com/en/server-core/migration-guides/java

Retrieves a layer synchronously and reads string and double parameters with defaults. The example uses the layer name 'user_promo_experiments'.

```java
Layer layer = Statsig.getLayerSync(user, "user_promo_experiments");

String promoTitle = layer.getString("title", "Welcome to Statsig!");
Double discount = layer.getDouble("discount", 0.1);

```

--------------------------------

### Initialize PHP SDK with Local File Adapters

Source: https://docs.statsig.com/en/server/php

Initializes the Statsig server with a server secret key and local file storage adapters for config and logging. The options parameter requires a storage adapter; local file is for initial setup, not production.

```php
require_once __DIR__ . '/vendor/autoload.php'; // path to installation folder

use Statsig\StatsigServer;
use Statsig\StatsigOptions;
use Statsig\Adapters\LocalFileDataAdapter;
use Statsig\Adapters\LocalFileLoggingAdapter;

$config_adapter = new LocalFileDataAdapter();
$logging_adapter = new LocalFileLoggingAdapter();
$options = new StatsigOptions($config_adapter, $logging_adapter);
$this->statsig = new StatsigServer("server-sdk-key", $options);

```

--------------------------------

### Get Experiment with Statsig.getExperimentSync

Source: https://docs.statsig.com/en/server-core/migration-guides/java

Retrieves an experiment synchronously and reads string and double parameters with defaults. The example uses the experiment name 'new_user_promo_title'.

```java
DynamicConfig experiment = Statsig.getExperimentSync(user, "new_user_promo_title");

String promoTitle = experiment.getString("title", "Welcome to Statsig!");
Double discount = experiment.getDouble("discount", 0.1);

```

--------------------------------

### Get an experiment with StatsigService.getExperiment

Source: https://docs.statsig.com/client/Angular

Retrieves an experiment value using getExperiment. Experiments support A/B/n testing; the example fetches a value with a default.

```TypeScript
// experiment.component.ts
import { Component, OnInit } from '@angular/core';
import { CommonModule } from '@angular/common';
import { StatsigService } from '@statsig/angular-bindings';

@Component({
  standalone: true,
  selector: 'app-experiment',
  imports: [CommonModule],
  template: `<div *ngIf="experimentValue">Experiment Value: {{ experimentValue }}</div>`,
})
export class ExperimentComponent implements OnInit {
  experimentValue: string | null = null;

  constructor(private statsigService: StatsigService) {}

  ngOnInit(): void {
    const experiment = this.statsigService.getExperiment('experiment_name');
    this.experimentValue = experiment.get('experiment_key', 'default');
  }
}

```

--------------------------------

### Start Recording via Imported Function

Source: https://docs.statsig.com/en/session-replay/configure

Imports and calls the startRecording function directly using your client SDK key when you don't have access to the client instance. This respects the Global Targeting Gate and Global Sampling Rate.

```plaintext
import { startRecording } from '@Statsig/session-replay';
…


startRecording(CLIENT_SDK_KEY)
```

--------------------------------

### Install PHP SDK with Composer

Source: https://docs.statsig.com/en/server/php

Use Composer to install the statsig/statsigsdk package. This is the first step in setting up the SDK.

```bash
composer require statsig/statsigsdk

```
Tokens:
Raw