Implement Feature Flags (Ruby)

Overview

This developer guide will assist you in configuring your server-side Ruby platform for Feature Flags using the Mixpanel Ruby SDK. Feature Flags allow you to control the rollout of your features, conduct A/B testing, and manage application behavior without deploying new code.

Prerequisites

Before implementing Feature Flags, ensure:

• You are on an Enterprise subscription plan and have the Mixpanel Ruby SDK installed. If not, please follow this doc to install the SDK. The minimum supported version is v3.0.0
• You have your Project Token from your Mixpanel Project Settings

Flag Evaluation Scenarios

There are two scenarios available for using the Ruby SDK for feature flagging: Local Evaluation and Remote Evaluation.

For local evaluation, the SDK will poll Mixpanel servers for feature flag configurations. Assignment of user contexts to variants will be done locally within the SDK. This mode is recommended for low latency since there is no network call made at assignment time.

For remote evaluation, the SDK will make a network call to Mixpanel servers at assignment time. This mode is recommended for use cases where you want to leverage Mixpanel cohorts for user targeting or sticky variants for persistent variant assignments.

In either case there is also the capability to evaluate all flags for a given user context at once, to avoid needing to make multiple calls to get individual flag variants for the same user. This is particularly useful for remote evaluation to avoid incurring additional network calls.

Local Evaluation

Targeting by Mixpanel cohorts and sticky variants are not supported in Local Evaluation mode.

• The SDK is configured with a local_flags_config hash that specifies parameters:

  1. api_host - If your project is in the EU/IN region, this should be set to route to api-eu.mixpanel.com/api-in.mixpanel.com respectively.
  2. enable_polling - This should be set to true to enable polling for new flag configurations.
  3. polling_interval_in_seconds - This is the interval in seconds at which the SDK will poll Mixpanel servers for feature flag configurations.

• The SDK will continue to poll for the lifetime of the SDK instance or until stopped.

require 'mixpanel-ruby'

local_config = {
  api_host: 'api.mixpanel.com',
  enable_polling: true,
  polling_interval_in_seconds: 60
}

tracker = Mixpanel::Tracker.new('YOUR_PROJECT_TOKEN', local_flags_config: local_config)

# If enable_polling is set to false, this will fetch definitions only once for the lifetime of the SDK.
tracker.local_flags.start_polling_for_definitions!

# This should be the 'key' of the feature flag from Mixpanel's UX.
flag_key = 'sample-flag'

# This is the fallback variant to return if the user context is not in a rollout group for the flag.
fallback_variant = 'control'

# Current user context for evaluation.
# At minimum, this needs to include the user's distinct_id.
# If any of your feature flags use a Variant Assignment Key other than 'distinct_id', this should also include those keys for evaluation. For example, 'company_id' below
# If any of your feature flags use Runtime targeting, this should also include 'custom_properties' for evaluation
user_context = {
  'distinct_id' => '1234',
  'company_id' => 'X',
  'custom_properties' => {
    'platform' => 'ruby'
  }
}

# Gets the assigned variant for the flag for the given user context.
# This will return the fallback_variant if the user context is not in an assignment group for the flag.
variant_value = tracker.local_flags.get_variant_value(flag_key, fallback_variant, user_context)

# Check if a feature is enabled (returns boolean)
if tracker.local_flags.is_enabled?('new_feature', user_context)
  # Feature is enabled
else
  # Feature is disabled
end

Remote Evaluation

• The SDK is configured with a remote_flags_config hash to use remote evaluation.

Get a specific variant

require 'mixpanel-ruby'

remote_config = {
  api_host: 'api.mixpanel.com',
  request_timeout_in_seconds: 10
}

tracker = Mixpanel::Tracker.new('YOUR_PROJECT_TOKEN', remote_flags_config: remote_config)

# get_variant_value usage is the same as for local evaluation, but will make a network call to Mixpanel servers at assignment time.
variant_value = tracker.remote_flags.get_variant_value(flag_key, fallback_variant, user_context)

# is_enabled? also works with remote flags
if tracker.remote_flags.is_enabled?('beta_feature', user_context)
  # Feature is enabled
else
  # Feature is disabled
end

Evaluate all flags at once

Below is a remote evaluation sample of evaluating all flags for a given user context at once.

require 'mixpanel-ruby'

user_context = {
  'distinct_id' => '1234'
}

remote_config = {
  api_host: 'api.mixpanel.com',
  request_timeout_in_seconds: 10
}

tracker = Mixpanel::Tracker.new('YOUR_PROJECT_TOKEN', remote_flags_config: remote_config)

# Returns a hash, mapping flag keys to assigned variants ONLY for flags that the user context is in an assignment group for.
# By default, this will not track an exposure event.
variants = tracker.remote_flags.get_all_variants(user_context)

# Given a flag key and the selected variant for that key, manually track an exposure event for a given flag and assigned variant, after exposing the user to the variant
tracker.remote_flags.track_exposure_event(flag_key, selected_variant, user_context)