-
Notifications
You must be signed in to change notification settings - Fork 247
fix(compass-data-modeling): add telemetry for diagram created COMPASS-9525 #7090
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
Conversation
b5c7585 to
099d6e7
Compare
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.
Pull Request Overview
Adds telemetry support for when a data modeling diagram is created in Compass.
- Introduces a new
DataModelingDiagramCreatedevent type in the telemetry schema. - Tracks the “Data Modeling Diagram Created” event (with collection count) in the analysis process.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| packages/compass-telemetry/src/telemetry-events.ts | Added DataModelingDiagramCreated event type and union |
| packages/compass-data-modeling/src/store/analysis-process.ts | Emitted telemetry event in startAnalysis |
Comments suppressed due to low confidence (2)
packages/compass-telemetry/src/telemetry-events.ts:2879
- [nitpick] Add a JSDoc comment above this type to explain when the
DataModelingDiagramCreatedevent is dispatched and clarify thenum_collectionspayload.
type DataModelingDiagramCreated = CommonEvent<{
packages/compass-data-modeling/src/store/analysis-process.ts:208
- Add a unit test for
startAnalysisthat spies onservices.trackand asserts it's called with the "Data Modeling Diagram Created" event and correctnum_collectionsvalue.
services.track('Data Modeling Diagram Created', {
|
|
||
| type DataModelingDiagramCreated = CommonEvent<{ |
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.
You probably want to add the @category to this event as well, so that it shows up in tracking plan something like this or else it would land on Other events
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.
Thanks @mabaasit !
099d6e7 to
44f3522
Compare
Adds
Data Modeling Diagram Createdevent