-
Notifications
You must be signed in to change notification settings - Fork 380
Launchdarkly subscription docs #1052
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
58 changes: 58 additions & 0 deletions
58
src/connections/destinations/catalog/launchdarkly-subscription/index.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
--- | ||
title: LaunchDarkly Events Destination | ||
rewrite: true | ||
--- | ||
LaunchDarkly is a feature management platform that empowers development teams to safely deliver and control software through feature flags. | ||
|
||
LaunchDarkly users can run experiments on any feature flag, with custom events as metrics. You can look for an existing custom event from Segment, and start recording data against it as a metric in your LaunchDarkly experiment. | ||
|
||
This destination is maintained by LaunchDarkly. For any issues with the destination, [contact the LaunchDarkly support team](mailto:support@launchdarkly.com). | ||
|
||
## Getting Started | ||
|
||
{% include content/connection-modes.md %} | ||
|
||
1. From the Destinations catalog page in the Segment App, click **Add Destination**. | ||
2. Search for “LaunchDarkly” in the Destinations Catalog, and select the LaunchDarkly destination. | ||
3. Choose which Source should send data to the LaunchDarkly destination. | ||
4. Go to the LaunchDarkly [Account Settings](https://app.launchdarkly.com/settings/projects), and find and copy the client-side ID from your default project. | ||
5. Enter this ID as the **API Key** in the “LaunchDarkly” destination settings in Segment. | ||
|
||
## Track | ||
If you aren't familiar with the Segment Spec, take a look at the [Track method documentation](https://segment.com/docs/connections/spec/track/) to learn about what it does. An example call would look like: | ||
|
||
```json | ||
{ | ||
"anonymousId": "23adfd82-aa0f-45a7-a756-24f2a7a4c8955", | ||
"type": "track", | ||
"properties": { | ||
"value": 99.84, | ||
}, | ||
"userId": "test-user-s6dndc", | ||
"event": "Order Completed" | ||
} | ||
``` | ||
|
||
LaunchDarkly ingests that call as: | ||
|
||
```json | ||
{ | ||
"kind": "custom", | ||
"key": "Order Completed", | ||
"userKey": "userId", | ||
"creationDate": 1592588370692, | ||
"metricValue": 99.84, | ||
"data": { | ||
"value": 99.84, | ||
} | ||
} | ||
``` | ||
|
||
> note "" | ||
> **Note**: The LaunchDarkly Metric must be actively recording and have a Feature Flag attached for Segment events to appear in your LaunchDarkly Project. | ||
|
||
Segment sends Track calls to LaunchDarkly as a `track` event. It appears on your [Debugger page](https://app.launchdarkly.com/default/production/debugger/goals). | ||
|
||
`track` events map to a Metric if the Segment event name exactly matches the Name of an active LaunchDarkly experiment metric. | ||
|
||
The `userKey` field maps to the `userId` field; if there is no `userId` field, LaunchDarkly uses `anonymousId` field for the `userKey` field. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.