diff --git a/website/docs/how-to/how-to-send-impression-data-to-a-sink.md b/website/docs/how-to/how-to-send-impression-data-to-a-sink.md index 702c7f0a45..1ab7a664ae 100644 --- a/website/docs/how-to/how-to-send-impression-data-to-a-sink.md +++ b/website/docs/how-to/how-to-send-impression-data-to-a-sink.md @@ -2,9 +2,9 @@ title: How to send impression data to a sink --- -Unleash allows you to gather [**impression data**](../advanced/impression-data.md) from your feature toggles, giving you complete visibility into who checked what toggles and when. What you do with this data is entirely up to you, but a common use case is to send it off to an aggregation and analytics service such as [Google Analytics](https://analytics.google.com/) or [Posthog](https://posthog.com/). +Unleash allows you to gather [**impression data**](../advanced/impression-data.md) from your feature toggles, giving you complete visibility into who checked what toggles and when. What you do with this data is entirely up to you, but a common use case is to send it off to an aggregation and analytics service such as [Posthog](https://posthog.com/) or [Google Analytics](https://analytics.google.com/). -This guide will take you through everything you need to do in Unleash to facilitate such a workflow. It will show you how to send data to Google Analytics (and Posthog?) as an example sink, but the exact same principles will apply to any other service of the same kind. +This guide will take you through everything you need to do in Unleash to facilitate such a workflow. It will show you how to send data to Posthog as an example sink, but the exact same principles will apply to any other service of the same kind. ## Prerequisites @@ -19,15 +19,88 @@ When you have those things sorted, follow the below steps. ## Enable impression data for your feature toggle {#step-1} -This is in the admin UI ... you do this by +Because impression data is an **opt-in feature**, the first step is to enable it for the feature you want to gather data from. You can use both the UI and the API. -### Enabling impression data for new toggles +### Enabling impression data for new feature toggles + +When you create a new feature toggle via the UI, there's an option at the end of the form that you must enable. + +![The create feature toggle form. There's a toggle at the end of the form that enables or disables impression data. It's labeled "impression data".](/img/enable-impression-data.png) + +### Enabling impression data for existing feature toggles -### Enabling impression data for existing toggles ## Capture impression events in your client {#step-2} +### Initialize your analytics service -## Transform the data {#step-3} +``` js +posthog.identify(userId); +``` -## Send the event data to your sink {#step-4} +### Set up a listener + +``` js +unleash.on("impression", (event) => { + posthog.capture(event.eventType, { + ...event.context, + distinct_id: event.context?.userId, + featureName: event.featureName, + enabled: event.enabled, + variant: event.variant, + }); +}); +``` + +option: + + +``` js +unleash.on("impression", (event) => { + posthog.capture(event.eventType, transform(event)); +}); +``` + +### Transform and record the data {#step-3} + +Posthog requires the `distinct_id` property. For the rest, we'll just spread everything into a flat object. + +``` js +const transform = (event) => ({ + ...event.context, + distinct_id: event.context?.userId, + featureName: event.featureName, + enabled: event.enabled, + variant: event.variant, +}) +``` + +## Full example + +```js +import posthog from "posthog-js"; + +const unleash = new UnleashClient({ + url: 'https://eu.unleash-hosted.com/hosted/proxy', + clientKey: 'your-proxy-key', + appName: 'my-webapp', +}); + +posthog.identify(userId); + +unleash.start(); + +unleash.on("ready", () => { + unleash.isEnabled("my-feature-toggle"); +}) + +unleash.on("impression", (event) => { + posthog.capture(event.eventType, { + ...event.context, + distinct_id: event.context?.userId, + featureName: event.featureName, + enabled: event.enabled, + variant: event.variant, + }); +}) +``` diff --git a/website/static/img/enable-impression-data.png b/website/static/img/enable-impression-data.png new file mode 100644 index 0000000000..0ee7a3910a Binary files /dev/null and b/website/static/img/enable-impression-data.png differ