Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00
Code Issues Projects Releases Wiki Activity

Docs: remove extra warning from impression data doc (#1906)

Browse Source 
I don't think we need the extra caution under the "example setup"
section.

Also: apply formatting + minor rewording of availability.
This commit is contained in:
Thomas Heartman 2022-08-10 12:41:22 +02:00 committed by GitHub
parent f206795d97
commit 1d158f7e45
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
website/docs/advanced/impression-data.md
View File

@ -2,8 +2,10 @@
title: Impression data
---
:::info Availability
The impression data feature was introduced in **Unleash 4.7**. Listening for events requires [an SDK that supports impression data events](../sdks/index.md#server-side-sdk-compatibility-table). In addition to supported server side SDKs impression data are available in JavaScript-based proxy clients.
:::info
Availability The impression data feature was introduced in **Unleash 4.7**. It is available in the JavaScript-based proxy clients and in some server-side SDKs. Please refer to the [SDK compatibility table](../sdks/index.md#server-side-sdk-compatibility-table) for an overview of server-side SDKs that support it.
:::
Unleash can provide you with **impression data** about the toggles in your application. Impression data contains information about a specific feature toggle activation check: The client SDK will emit an **impression event** whenever it calls `isEnabled` or `getVariant`.
@ -23,16 +25,16 @@ The `getVariant` event contains all the information found in an `isEnabled` even
This table describes all the properties on the impression events:
| Property name | Description | Event type |
|---------------|--------------------------------------------------------------------------------------|--------------------------|
| `eventType` | The type of the event: `isEnabled` or `getVariant` | All |
| `eventId` | A globally unique id (GUID) assigned to this event. | All |
| `context` | A representation of the current [Unleash Context](../user_guide/unleash-context.md). | All |
| `enabled` | Whether the toggle was enabled or not at when the client made the request. | All |
| `featureName` | The name of the feature toggle. | All |
| `variant` | The name of the active variant | `getVariant` events only |
| Property name | Description | Event type |
| --- | --- | --- |
| `eventType` | The type of the event: `isEnabled` or `getVariant` | All |
| `eventId` | A globally unique id (GUID) assigned to this event. | All |
| `context` | A representation of the current [Unleash Context](../user_guide/unleash-context.md). | All |
| `enabled` | Whether the toggle was enabled or not at when the client made the request. | All |
| `featureName` | The name of the feature toggle. | All |
| `variant` | The name of the active variant | `getVariant` events only |
### Example `isEnabled` event {#example-isenabled}
### Example `isEnabled` event {#example-isenabled}
```js
{
@ -48,10 +50,8 @@ This table describes all the properties on the impression events:
}
```
### Example `getVariant` event {#example-getvariant}
```js
{
eventType: 'getVariant',
@ -69,8 +69,7 @@ This table describes all the properties on the impression events:
## Enabling impression data
Impression data is strictly an **opt-in** feature and must be enabled on a **per-toggle basis**.
You can enable and disable it both when you create a toggle and when you edit a toggle.
Impression data is strictly an **opt-in** feature and must be enabled on a **per-toggle basis**. You can enable and disable it both when you create a toggle and when you edit a toggle.
You can enable impression data via the impression data toggle in the admin UI's toggle creation form. You can also go via the [the API, using the `impressionData` option](../api/admin/feature-toggles-api-v2.md#create-toggle). For more detailed instructions, see [the section on enabling impression data in the how-to guide for capturing impression data](../how-to/how-to-capture-impression-data.mdx#step-1).
@ -78,10 +77,6 @@ You can enable impression data via the impression data toggle in the admin UI's
## Example setup
:::caution
This functionality is currently only supported in the JavaScript-based proxy clients and some of our SDKs, please see the [compatibility table for SDKs](../sdks/index.md#server-side-sdk-compatibility-table).
:::
The exact setup will vary depending on your [client SDK](../sdks/index.md). The below example configures the [Unleash Proxy client](/sdks/proxy-javascript) to listen for impression events and log them to the console. If "my-feature-toggle" is configured to emit impression data, then it will trigger an impression event as soon as Unleash is ready.
```js
@ -93,12 +88,12 @@ const unleash = new UnleashClient({
unleash.start();
unleash.on("ready", () => {
unleash.isEnabled("my-feature-toggle");
})
unleash.on('ready', () => {
unleash.isEnabled('my-feature-toggle');
});
unleash.on("impression", (event) => {
unleash.on('impression', (event) => {
// Capture the event here and pass it internal data lake or analytics provider
console.log(event);
})
});
```