-
Notifications
You must be signed in to change notification settings - Fork 201
FMEPRD-280 Update Amplitude Integration and Impressions Documentation #11514
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
Open
alai97
wants to merge
4
commits into
main
Choose a base branch
from
fme-amplitude-integration-doc-update
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -32,6 +32,62 @@ Each impression contains these fields. | |
| Traffic type ID and name | Traffic type associated to the feature flag evaluated. | | ||
| Treatment | Treatment that was returned. | | ||
|
||
## Impression properties | ||
|
||
Impression properties allow you to attach custom metadata to impressions generated by an FME SDK when calling `getTreatment`. These properties can be useful for debugging, Live Tail analysis, or downstream external analytics from third-party integrations such as Amplitude. | ||
|
||
An example impression payload: | ||
|
||
```json | ||
{ | ||
"environmentId": "prod", | ||
"feature": "new_ui", | ||
"treatment": "on", | ||
"key": "user_12345", | ||
"timestamp": 1725682200000, | ||
"properties": { // Optional key-value pairs you can append to impressions | ||
"planType": "premium", | ||
"appVersion": "2.3.1", | ||
"region": "us-west" | ||
} | ||
} | ||
``` | ||
|
||
### Supported SDKs for impression properties | ||
|
||
The following SDKs support appending custom properties for each `getTreatment` call: | ||
|
||
<Tabs queryString="impression-properties"> | ||
<TabItem value="client-sdks" label="Client-side SDKs"> | ||
|
||
| **Client-side SDK** | **Version that supports impression properties** | | ||
|----------------------|-----------------------------------------------| | ||
| [Browser SDK](/docs/feature-management-experimentation/sdks-and-infrastructure/client-side-sdks/browser-sdk#append-properties-to-impressions) | 1.2 and later | | ||
| [iOS SDK](/docs/feature-management-experimentation/sdks-and-infrastructure/client-side-sdks/ios-sdk#append-properties-to-impressions) | 3.2.0 and later | | ||
| [JavaScript SDK](/docs/feature-management-experimentation/sdks-and-infrastructure/client-side-sdks/javascript-sdk#append-properties-to-impressions) | 11.2.0 and later | | ||
| [React SDK](/docs/feature-management-experimentation/sdks-and-infrastructure/client-side-sdks/react-sdk#append-properties-to-impressions) | 2.1.0 and later | | ||
| [Redux SDK](/docs/feature-management-experimentation/sdks-and-infrastructure/client-side-sdks/redux-sdk#append-properties-to-impressions) | 2.1.0 and later | | ||
|
||
</TabItem> | ||
<TabItem value="client-suites" label="SDK Suites"> | ||
|
||
| **Client-side SDK Suite** | **Version that supports impression properties** | | ||
|----------------------|-----------------------------------------------| | ||
| [Browser Suite](/docs/feature-management-experimentation/sdks-and-infrastructure/client-side-suites/browser-suite#append-properties-to-impressions) | 2.1.0 and later | | ||
| [iOS Suite](/docs/feature-management-experimentation/sdks-and-infrastructure/client-side-suites/ios-suite#append-properties-to-impressions) | 2.1.0 and later | | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Missing Android Suite from 2.1.0 |
||
</TabItem> | ||
<TabItem value="server-sdks" label="Server-side SDKs"> | ||
|
||
| **Server-side SDK** | **Version that supports impression properties** | | ||
|----------------------|-----------------------------------------------| | ||
| [Java SDK](/docs/feature-management-experimentation/sdks-and-infrastructure/server-side-sdks/java-sdk#append-properties-to-impressions) | 4.15.0 and later | | ||
| [Node.js SDK](/docs/feature-management-experimentation/sdks-and-infrastructure/server-side-sdks/nodejs-sdk#append-properties-to-impressions) | 11.2.0 and later | | ||
|
||
</TabItem> | ||
</Tabs> | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ruby 8.7.0, Python 10.4.0 |
||
|
||
## Tracking impressions | ||
|
||
Impressions are tracked by each Harness FME SDK and are periodically sent to Harness backend servers. | ||
|
@@ -166,7 +222,10 @@ Additionally, if you don’t want to send a customer UUID to Harness as the key, | |
|
||
## Integrations for impression data | ||
|
||
Use our integrations to push FME feature flag impression data to your existing platforms or your data warehouse for a comprehensive view of user engagement and other key use metrics. Integration documentation is available for the following: | ||
Use our integrations to push FME feature flag impression data to your existing platforms or your data warehouse for a comprehensive view of user engagement and other key user metrics. | ||
|
||
Integration documentation is available for the following: | ||
|
||
- [Amazon S3](/docs/feature-management-experimentation/integrations/amazon-s3) | ||
- [Amplitude](/docs/feature-management-experimentation/integrations/amplitude) | ||
- [Full Story](/docs/feature-management-experimentation/integrations/fullstory) | ||
|
@@ -178,4 +237,4 @@ Use our integrations to push FME feature flag impression data to your existing p | |
- [Quantum-Metric](/docs/feature-management-experimentation/integrations/quantummetric) | ||
- [SmartBear Bugsnag](/docs/feature-management-experimentation/integrations/bugsnag) | ||
- [Segment](/docs/feature-management-experimentation/integrations/segment) | ||
- [Webhook (outgoing)](https://help.split.io/hc/en-us/articles/360020700232) | ||
- [Webhook (outgoing)](/docs/feature-management-experimentation/api/webhook/impressions/) |
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
Binary file added
BIN
+56.5 KB
...re-management-experimentation/80-integrations/static/amplitude-impression-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+107 KB
...re-management-experimentation/80-integrations/static/amplitude-impression-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing Android from 5.2.0 and Flutter from 1.0.0