• HOME
  • INTEGRATIONS
  • SDKS
  • GUIDES
  • API DOCS
No results for ""
EXPAND ALL
launchdarkly.com

EDIT ON GITHUB

Sleuth

Read time: 2 minutes
Last edited: Jun 23, 2020

Overview

This topic explains how to use the LaunchDarkly Sleuth integration.

The LaunchDarkly Sleuth integration tracks feature flags as a source of change in your DevOps tools. Sleuth captures the full state of your LaunchDarkly feature flags at deployment time. This helps you keep track of the affected code deploys, what environment the change occurred in, who changed the flag, and flag descriptions and values before and after code deploys.

Prerequisites

To connect Sleuth to LaunchDarkly, you must meet the following prerequisites:

  • You must have access to your LaunchDarkly credentials and
  • A LaunchDarkly account with a writer, owner, or admin role.

The integration is initiated from your Sleuth account. After you connect it, you do not need to take further action. There are no Sleuth settings or preferences to configure in LaunchDarkly.

Make sure your role in LaunchDarkly allows you to modify integrations
If you get a notification that the integration is connected, but cannot access deploy data in Sleuth, confirm that your LaunchDarkly role allows you to enable external apps. If you are a Reader, or have a custom role that restricts these permissions, the integration may not work.

Setting up the Sleuth integration

To connect the Sleuth integration with LaunchDarkly:

  1. Log into your Sleuth Dashboard.
  2. In the left sidebar, click Integrations.
  3. Click enable in the LaunchDarkly card in the Change Sources tab.
  4. Click Authorize. This allows Sleuth to read and modify your LaunchDarkly data.
You must authorize Sleuth for the integration to work
If you click Deny, the integration cannot access your flag data.

The LaunchDarkly authorization dialog.
The LaunchDarkly authorization dialog.

  1. Confirm that the integration has connected LaunchDarkly and Sleuth when LaunchDarkly enabled (Connected as user) is displayed in the LaunchDarkly integration card.

A successfully connected integration.
A successfully connected integration.

Configuring the Sleuth integration

Now that you've set up the Sleuth LaunchDarkly integration, you must configure Sleuth to know which feature flags it should track.

To select a LaunchDarkly project and environment to track:

  1. Navigate to the Integrations page in LaunchDarkly and find the Sleuth integration card.
  2. Click LaunchDarkly feature flags enabled.

The LaunchDarkly feature flags enabled button.
The LaunchDarkly feature flags enabled button.

  1. Select the Feature Flag Project and Environment you want to track.

The feature flag change source setup in Sleuth.
The feature flag change source setup in Sleuth.

  1. Give the integration a Name.
  2. Click Create.

After the connection is established, the Sleuth trend graph appears. Use this graph to monitor how your feature flags impact your code over time. You're setnow sit back and let Sleuth track your code over time.

The Sleuth trend graph.
The Sleuth trend graph.

Tracking multiple projects and environments
To track multiple LaunchDarkly projects and environments in Sleuth, create a new Sleuth project and attach each LaunchDarkly project or environment to Sleuth individually. You can create as many Sleuth projects as you need to track any number of feature flag project and environment combinations. To learn more, read Sleuth's documentation.

Removing the Sleuth integration

To remove the Sleuth integration:

  1. Log in to your Sleuth account.
  2. In the left sidebar, click Integrations.
  3. Click disable in the LaunchDarkly card in the Change Sources tab.
  4. Confirm that the integration has been removed when LaunchDarkly disabled - enable is displayed in the LaunchDarkly integration card.

Deleting the LaunchDarkly integration in Sleuth
Deleting the LaunchDarkly integration in Sleuth

This removes the LaunchDarkly integration.

Getting Slack notifications from Sleuth

With the Slack integration in Sleuth, you can notify your entire team, or just the commit author or PR initiator, of a code change. This includes feature flag changes.

To learn more, read Sleuth's documentation.

The Sleuth Slack integration works independently from the LaunchDarkly Slack integration. If you use both, you may see notifications from both Sleuth and LaunchDarkly about flag activity.

To learn more about the LaunchDarkly Slack integation, read Slack.