workflowAnalyticsEvents.tsx 7.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180
  1. import type {ResolutionStatus} from 'sentry/types';
  2. import {CommonGroupAnalyticsData} from 'sentry/utils/events';
  3. import {Tab} from 'sentry/views/issueDetails/types';
  4. type RuleViewed = {
  5. alert_type: 'issue' | 'metric';
  6. project_id: string;
  7. };
  8. interface IssueDetailsWithAlert extends CommonGroupAnalyticsData {
  9. project_id: number;
  10. /** The time that the alert was initially fired. */
  11. alert_date?: string;
  12. /** Id of the rule that triggered the alert */
  13. alert_rule_id?: string;
  14. /** The type of alert notification - email/slack */
  15. alert_type?: string;
  16. }
  17. export type BaseEventAnalyticsParams = {
  18. event_id: string;
  19. has_commit: boolean;
  20. has_release: boolean;
  21. has_source_maps: boolean;
  22. has_trace: boolean;
  23. num_commits: number;
  24. num_in_app_stack_frames: number;
  25. num_stack_frames: number;
  26. num_threads_with_names: number;
  27. error_has_replay?: boolean;
  28. error_has_user_feedback?: boolean;
  29. event_errors?: string;
  30. event_platform?: string;
  31. event_type?: string;
  32. frames_with_sourcemaps_percent?: number;
  33. frames_without_source_maps_percent?: number;
  34. has_otel?: boolean;
  35. release_user_agent?: string;
  36. sdk_name?: string;
  37. sdk_version?: string;
  38. };
  39. type BaseTour = {
  40. duration: number;
  41. step: number;
  42. };
  43. type ReleasesTour = BaseTour & {project_id: string};
  44. export type TeamInsightsEventParameters = {
  45. 'alert_builder.filter': {query: string; session_id?: string};
  46. 'alert_details.viewed': {alert_id: number};
  47. 'alert_rule_details.viewed': {alert: string; has_chartcuterie: string; rule_id: number};
  48. 'alert_rules.viewed': {sort: string};
  49. 'alert_stream.viewed': {};
  50. 'alert_wizard.option_selected': {alert_type: string};
  51. 'alert_wizard.option_viewed': {alert_type: string};
  52. 'edit_alert_rule.add_row': {
  53. name: string;
  54. project_id: string;
  55. type: string;
  56. };
  57. 'edit_alert_rule.incompatible_rule': {};
  58. 'edit_alert_rule.notification_test': {success: boolean};
  59. 'edit_alert_rule.viewed': RuleViewed;
  60. 'issue_alert_rule_details.edit_clicked': {rule_id: number};
  61. 'issue_details.action_clicked': IssueDetailsWithAlert & {
  62. action_type:
  63. | 'deleted'
  64. | 'mark_reviewed'
  65. | 'bookmarked'
  66. | 'subscribed'
  67. | 'shared'
  68. | 'discarded'
  69. | 'open_in_discover'
  70. | 'assign'
  71. | ResolutionStatus;
  72. action_status_details?: string;
  73. action_substatus?: string;
  74. assigned_suggestion_reason?: string;
  75. assigned_type?: string;
  76. };
  77. 'issue_details.attachment_tab.screenshot_modal_deleted': {};
  78. 'issue_details.attachment_tab.screenshot_modal_download': {};
  79. 'issue_details.attachment_tab.screenshot_modal_opened': {};
  80. 'issue_details.attachment_tab.screenshot_title_clicked': {};
  81. 'issue_details.event_json_clicked': {group_id: number};
  82. 'issue_details.event_navigation_clicked': {button: string; project_id: number};
  83. 'issue_details.issue_tab.screenshot_dropdown_deleted': {};
  84. 'issue_details.issue_tab.screenshot_dropdown_download': {};
  85. 'issue_details.issue_tab.screenshot_modal_deleted': {};
  86. 'issue_details.issue_tab.screenshot_modal_download': {};
  87. 'issue_details.issue_tab.screenshot_modal_opened': {};
  88. 'issue_details.merged_tab.unmerge_clicked': {
  89. /**
  90. * comma separated list of event ids that were unmerged
  91. */
  92. event_ids_unmerged: string;
  93. group_id: string;
  94. total_unmerged: number;
  95. };
  96. 'issue_details.suspect_commits.commit_clicked': IssueDetailsWithAlert & {
  97. has_pull_request: boolean;
  98. };
  99. 'issue_details.suspect_commits.pull_request_clicked': IssueDetailsWithAlert;
  100. 'issue_details.tab_changed': IssueDetailsWithAlert & {
  101. tab: Tab;
  102. };
  103. 'project_creation_page.created': {
  104. issue_alert: 'Default' | 'Custom' | 'No Rule';
  105. project_id: string;
  106. rule_id: string;
  107. };
  108. 'project_detail.change_chart': {chart_index: number; metric: string};
  109. 'project_detail.open_anr_issues': {};
  110. 'project_detail.open_discover': {};
  111. 'project_detail.open_issues': {};
  112. 'project_detail.performance_tour.advance': BaseTour;
  113. 'project_detail.performance_tour.close': BaseTour;
  114. 'project_detail.releases_tour.advance': ReleasesTour;
  115. 'project_detail.releases_tour.close': ReleasesTour;
  116. 'release_detail.pagination': {direction: string};
  117. 'releases_list.click_add_release_health': {
  118. project_id: number;
  119. };
  120. };
  121. export type TeamInsightsEventKey = keyof TeamInsightsEventParameters;
  122. export const workflowEventMap: Record<TeamInsightsEventKey, string | null> = {
  123. 'alert_builder.filter': 'Alert Builder: Filter',
  124. 'alert_details.viewed': 'Alert Details: Viewed',
  125. 'alert_rule_details.viewed': 'Alert Rule Details: Viewed',
  126. 'alert_rules.viewed': 'Alert Rules: Viewed',
  127. 'alert_stream.viewed': 'Alert Stream: Viewed',
  128. 'alert_wizard.option_selected': 'Alert Wizard: Option Selected',
  129. 'alert_wizard.option_viewed': 'Alert Wizard: Option Viewed',
  130. 'edit_alert_rule.add_row': 'Edit Alert Rule: Add Row',
  131. 'edit_alert_rule.viewed': 'Edit Alert Rule: Viewed',
  132. 'edit_alert_rule.incompatible_rule': 'Edit Alert Rule: Incompatible Rule',
  133. 'edit_alert_rule.notification_test': 'Edit Alert Rule: Notification Test',
  134. 'issue_alert_rule_details.edit_clicked': 'Issue Alert Rule Details: Edit Clicked',
  135. 'issue_details.action_clicked': 'Issue Details: Action Clicked',
  136. 'issue_details.attachment_tab.screenshot_title_clicked':
  137. 'Attachment Tab: Screenshot title clicked',
  138. 'issue_details.attachment_tab.screenshot_modal_deleted':
  139. 'Attachment Tab: Screenshot deleted from modal',
  140. 'issue_details.attachment_tab.screenshot_modal_download':
  141. 'Attachment Tab: Screenshot downloaded from modal',
  142. 'issue_details.attachment_tab.screenshot_modal_opened':
  143. 'Attachment Tab: Screenshot modal opened',
  144. 'issue_details.event_json_clicked': 'Issue Details: Event JSON Clicked',
  145. 'issue_details.event_navigation_clicked': 'Issue Details: Event Navigation Clicked',
  146. 'issue_details.issue_tab.screenshot_dropdown_deleted':
  147. 'Issue Details: Screenshot deleted from dropdown',
  148. 'issue_details.issue_tab.screenshot_dropdown_download':
  149. 'Issue Details: Screenshot downloaded from dropdown',
  150. 'issue_details.issue_tab.screenshot_modal_deleted':
  151. 'Issue Details: Screenshot deleted from modal',
  152. 'issue_details.issue_tab.screenshot_modal_download':
  153. 'Issue Details: Screenshot downloaded from modal',
  154. 'issue_details.issue_tab.screenshot_modal_opened':
  155. 'Issue Details: Screenshot modal opened',
  156. 'issue_details.suspect_commits.commit_clicked': 'Issue Details: Suspect Commit Clicked',
  157. 'issue_details.suspect_commits.pull_request_clicked':
  158. 'Issue Details: Suspect Pull Request Clicked',
  159. 'issue_details.tab_changed': 'Issue Details: Tab Changed',
  160. 'issue_details.merged_tab.unmerge_clicked': 'Issue Details: Unmerge Clicked',
  161. 'project_creation_page.created': 'Project Create: Project Created',
  162. 'project_detail.open_issues': 'Project Detail: Open issues from project detail',
  163. 'project_detail.open_discover': 'Project Detail: Open discover from project detail',
  164. 'project_detail.open_anr_issues': 'Project Detail: Open issues from ANR rate scorecard',
  165. 'project_detail.change_chart': 'Project Detail: Change Chart',
  166. 'project_detail.performance_tour.advance': 'Project Detail: Performance Tour Advance',
  167. 'project_detail.performance_tour.close': 'Project Detail: Performance Tour Close',
  168. 'project_detail.releases_tour.advance': 'Project Detail: Releases Tour Advance',
  169. 'project_detail.releases_tour.close': 'Project Detail: Releases Tour Close',
  170. 'release_detail.pagination': 'Release Detail: Pagination',
  171. 'releases_list.click_add_release_health': 'Releases List: Click Add Release Health',
  172. };