Ruby SDK reference

Overview

This topic documents how to get started with the server-side Ruby SDK, and links to reference information on all of the supported features.

Getting started

After you complete the Getting Started process, follow these instructions to start using the LaunchDarkly SDK in your Ruby application.

First, install the LaunchDarkly SDK as a dependency in your application using your application's dependency manager. Refer to the SDK releases page to identify the latest version if you want to depend on a specific version.

If you are using Bundler, you can add gem "launchdarkly-server-sdk" to your Gemfile and run bundle install. Otherwise, you can install the gem directly:

gem install launchdarkly-server-sdk
COPY

Next, import the LaunchDarkly client in your application code. This step may not be necessary if you are using a framework that automatically loads all dependencies, as Rails does.

Here's how:

require 'ldclient-rb'
COPY

After you install and import the SDK, create a single, shared instance of LDClient. Specify your SDK key here to authorize your application to connect to a particular environment within LaunchDarkly.

Here's how:

client = LaunchDarkly::LDClient.new("sdk-key-123abc")
COPY

You can use client to check which variation a particular context will receive for a given feature flag. To learn more, read Evaluating flags and Flag evaluation reasons. For more information about how contexts are specified, read User and context configuration.

Here's how:

context = LaunchDarkly::LDContext.with_key("user@test.com")
show_feature = client.variation("your.flag.key", context, false)
if show_feature
  # application code to show the feature
else
  # the code to run if the feature is off
COPY

Initializing LDClient in a Rails Application

To use LaunchDarkly in a Rails application, initialize the client in config/initializers/launchdarkly.rb:

Rails.configuration.client = LaunchDarkly::LDClient.new("sdk-key-123abc")
COPY

To use LaunchDarkly with the Rails application preloader Spring, we recommend using an after_fork callback in the config/spring.rb file:

Spring.after_fork do
  Rails.configuration.client = LaunchDarkly::LDClient.new('sdk-key-123abc')
end
COPY

Similarly, with Unicorn, you'll need to specify an after_fork hook in your unicorn.rb config file:

after_fork do |server,worker|
  Rails.configuration.client = LaunchDarkly::LDClient.new('sdk-key-123abc')
end
COPY

If you use the Puma web server, we recommend initializing the client in on_worker_boot, as well as initializing in the Rails app:

on_worker_boot do
  Rails.configuration.client = LaunchDarkly::LDClient.new('sdk-key-123abc')
end
COPY

If you use the Passenger web server, we recommend initializing the client in config.ru, or from any code called while loading config.ru:

if defined?(PhusionPassenger)
  PhusionPassenger.on_event(:starting_worker_process) do |forked|
    Rails.configuration.client = LaunchDarkly::LDClient.new('sdk-key-123abc')
  end
end
COPY

Lastly, shut down the client when your application terminates. This frees the resources the worker threads were using and provides an explicit signal for the Ruby SDK to send the remaining event data back to LaunchDarkly. To learn more, read Shutting down.

Supported features

This SDK supports the following features:

• Anonymous contexts and users
• Big Segments
• Configuration
• Evaluating flags
• Flag evaluation reasons
• Flushing events
• Getting all flags
• Identifying and changing contexts
• Logging configuration
• Monitoring SDK status
• Offline mode
• Private attributes
• Reading flags from a file
• Relay Proxy configuration
  • Using proxy mode
  • Using daemon mode
• Secure mode
• Sending custom events
• Service endpoint configuration
• Shutting down
• Storing data
• Subscribing to flag changes
• Test data sources
• User and context configuration
• Web proxy configuration