[Connector Builder] Add Segment event tracking #21686
Conversation
| // so the analytics events won't fire just from the user switching between streams, as desired | ||
| if (isFetchedAfterMount) { | ||
| if (errorMessage) { | ||
| analyticsService.track(Namespace.CONNECTOR_BUILDER, Action.STREAM_TEST_FAILURE, { |
There was a problem hiding this comment.
This is called on every state update:
- Make an actual stream test which results in failure: works as expected
- Afterwards, change something in the UI - another failure event is recorded (even if the user didn't click on test).
This happens because jsonManifest.streams changes its reference on every state update.
Idea to fix this: Use the streams via ref and re-run the hook on streamReadData
There was a problem hiding this comment.
@flash1293 since we separately decided to not send the stream JSON body in these events, I no longer had the issue of this depending on jsonManifest.streams and re-firing for every state change. However, I did need to add a couple more changes here to have this useEffect be dependent on dataUpdatedAt and errorUpdatedAt from the react-query, to make the events be tracked when a user clicks Test again and the results don't change. See commit: 09967f0
With these changes, I believe this is now working properly, but definitely lmk if you think anything else should be changed here.
|
@flash1293 I believe I've addressed the feedback here and it should be ready for another look |
|
Looks like the e2e test failure is legit - as the route is part of the workspace now, it shows the signup form: |
There was a problem hiding this comment.
LGTM, there is one thing that probably should be adjusted but I don't think another round of review is necessary - when switching the stream view by switching the stream name in the testing panel, no event is fired, but it's essentially the same thing as switching from the left hand side bar.
| @@ -152,6 +149,10 @@ export const SchemaDiffView: React.FC<SchemaDiffViewProps> = ({ inferredSchema } | |||
| variant="secondary" | |||
| onClick={() => { | |||
| helpers.setValue(formattedSchema); | |||
| analyticsService.track(Namespace.CONNECTOR_BUILDER, Action.OVERWRITE_SCHEMA, { | |||
| actionDescription: "Declared schema ovewritten by detected schema", | |||
There was a problem hiding this comment.
nit typo ovewritten -> overwritten (also in the other occurences)
What
Resolves #20863
Captures the events as listed in the
Track (Connector Builder)tab of this spreadsheet: https://docs.google.com/spreadsheets/d/1lGLmLIhiSPt_-oaEf3CpK-IxXnCO0NRHurvmWldoA2w/edit#gid=1297906000(except for the Connector Created event, since that functionality does not exist yet)
How
Uses the AnalyticsService to send various events to Segment. I followed the existing convention of not using i18n for the action descriptions as these are not displayed to users and only used for internal tracking.
In order to test this properly, you need to sign into Amplitude and search for events starting with
Airbyte.UI.ConnectorBuilder.Here is a screenshot with a bunch of these tracked events shown in that platform (the CSV export does not actually export these events, just the single user list, and I couldn't find a great way to export these as text)