Segment

Overview

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

Sending Segment events to LaunchDarkly lets you use Segment events as LaunchDarkly metric events.

After you connect LaunchDarkly and Segment, you will use the existing Segment Event Name as the LaunchDarkly metric event key when you create a custom metric.

Here is an image of a LaunchDarkly custom conversion binary metric with the event key called out:

Events are specific to one LaunchDarkly environment. To learn more, read Event keys.

Set 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.

Copy your LaunchDarkly client-side ID

Copy your LaunchDarkly client-side ID by following the instructions at Find and copy SDK credentials for an environment.

You will use this client-side ID in the next section.

Connect 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.

4. Click Configure LaunchDarkly (Actions).
5. Choose which Segment Source should send data to the LaunchDarkly destination.
6. Click Next.
7. Fill in the Destination name field with the name of your choice.
8. Click Save.
9. Paste the client-side ID from the previous procedure into the LaunchDarkly client-side ID field.
10. Click Save Changes.
11. Click the Enable Destination radio button.
12. Click Save Changes.

13. Navigate to the Mappings tab.
14. Click New Mapping.
15. Click Track Event.
16. The Edit: Track Event page guides you through the process of mapping Segment Track events to LaunchDarkly metric events. The default settings should be acceptable for most customers.

17. Click Save.
18. On the Mappings tab, click the radio buttons associated with the Track Event mapping to begin sending events to LaunchDarkly.

To learn more about track events, read Segment's documentation.

After you map Segment events to LaunchDarkly metric events, events from the source you choose appear as custom metric events in LaunchDarkly.

Correlate Segment users with LaunchDarkly contexts

LaunchDarkly correlates Segment metric events with LaunchDarkly context keys using the Segment user ID, if it is present. The Segment user ID must match a LaunchDarkly context key. If the Segment event does not contain a Segment user ID, then LaunchDarkly uses the Segment anonymous ID.

If you are using Segment events in a LaunchDarkly experiment:

• the LaunchDarkly metric must be attached to a flag and the experiment must be recording, and
• the context must be included in the experiment for the event to be included in the experiment results.