• Home
  • Integrations
  • SDKs
  • Guides
  • API docs
No results for ""
EXPAND ALL

GIVE DOCS FEEDBACK

Segment

Read time: 3 minutes
Last edited: Feb 29, 2024

Overview

This topic explains how to configure your existing Segment account to send events to LaunchDarkly metrics.

This lets you use Segment events as custom metric events in LaunchDarkly experiments, so you can measure results immediately, without any instrumentation, code, or delays.

After you connect LaunchDarkly and Segment, you can use the name of the existing Segment event when you create a custom metric to include it in your experiment immediately.

Here is an image of the custom metric panel:

A LaunchDarkly experiment custom metric with a unique name.
A LaunchDarkly experiment custom metric with a unique name.

Setting up the Segment integration

To set up the integration, you must have access to your Segment and LaunchDarkly accounts. You will need them both to connect them to each other.

Copying your LaunchDarkly client-side ID

To copy your LaunchDarkly client-side ID:

  1. Navigate to the Account settings page.
  2. Click the Projects tab.
  3. Click the name of the project you would like to receive events from Segment from. The Environments tab appears.
  4. Click the environment's client-side ID to copy it to your clipboard.

Connecting Segment to LaunchDarkly

To connect Segment to LaunchDarkly:

  1. Navigate to the Segment app's Destinations page.
  2. Click Add Destination.
  3. Find LaunchDarkly (Actions) in the Destination Catalog.
The LaunchDarkly (Actions) listing in the Segment Destination catalog.
The LaunchDarkly (Actions) listing in the Segment Destination catalog.
  1. Click Configure LaunchDarkly (Actions).
  2. Choose which Segment Source should send data to the LaunchDarkly destination.
  3. Click Next.
  4. Fill in the Destination name field with the name of your choice.
  5. Click Save.
  6. Paste the client-side ID from the previous procedure into the LaunchDarkly client-side ID field.
  7. Click Save Changes.
  8. Click the Enable Destination radio button.
  9. Click Save Changes.
The LaunchDarkly (Actions) Basic Settings form in Segment.
The LaunchDarkly (Actions) Basic Settings form in Segment.
  1. Navigate to the Mappings tab.
  2. Click New Mapping.
  3. Click Track Event.
  4. The Edit: Track Event page guides you through the process of mapping Segment Track events to LaunchDarkly experimentation events. The default settings should be acceptable for most customers.
  5. Click Save.
  6. On the Mappings tab, click the radio buttons associated with the Track Event mapping to begin sending events to LaunchDarkly.

How the integration works

After you connect Segment and LaunchDarkly, events from the source you choose can appear as custom metric events in LaunchDarkly experiments. This process fails if LaunchDarkly fails to recognize events Segment sends to it as Experimentation events.

LaunchDarkly correlates the metric events sent from Segment with LaunchDarkly context keys. This correlation uses the Segment user ID, if it is present. Otherwise, the correlation uses the Segment anonymous ID.

To register events from Segment in a LaunchDarkly experiment, you must meet the following criteria:

  • The name of the Segment event is identical to the name of the custom metric in your LaunchDarkly experiment. When the Segment event and LaunchDarkly metric have identical names, events from Segment will appear as events in the LaunchDarkly experiment with which the metric is associated.
  • The LaunchDarkly metric must be attached to a flag and the experiment must be recording. To learn how to create metrics in LaunchDarkly, read Metrics.

You can associate the track event as a custom event at the time you set up a new metric. To learn more about track events, read Segment's documentation.