replayAnalyticsEvents.tsx 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116
  1. import type {LayoutKey} from 'sentry/utils/replays/hooks/useReplayLayout';
  2. import {Output} from 'sentry/views/replays/detail/network/details/getOutputType';
  3. export type ReplayEventParameters = {
  4. 'replay.details-data-loaded': {
  5. be_errors: number;
  6. fe_errors: number;
  7. project_platform: string;
  8. replay_errors: number;
  9. total_errors: number;
  10. };
  11. 'replay.details-layout-changed': {
  12. chosen_layout: LayoutKey;
  13. default_layout: LayoutKey;
  14. };
  15. 'replay.details-network-panel-closed': {
  16. is_sdk_setup: boolean;
  17. };
  18. 'replay.details-network-panel-opened': {
  19. is_sdk_setup: boolean;
  20. resource_method: string;
  21. resource_status: string;
  22. resource_type: string;
  23. };
  24. 'replay.details-network-tab-changed': {
  25. is_sdk_setup: boolean;
  26. output: Output;
  27. resource_method: string;
  28. resource_status: string;
  29. resource_type: string;
  30. tab: string;
  31. };
  32. 'replay.details-resized-panel': {
  33. layout: LayoutKey;
  34. slide_motion: 'toTop' | 'toBottom' | 'toLeft' | 'toRight';
  35. };
  36. 'replay.details-tab-changed': {
  37. tab: string;
  38. };
  39. 'replay.details-time-spent': {
  40. seconds: number;
  41. user_email: string;
  42. };
  43. 'replay.details-viewed': {
  44. referrer: undefined | string;
  45. user_email: string;
  46. };
  47. // similar purpose as "replay.details-viewed", however we're capturing the navigation action
  48. // in order to also include a project platform
  49. 'replay.list-navigate-to-details': {
  50. platform: string | undefined;
  51. project_id: string | undefined;
  52. referrer: string;
  53. };
  54. 'replay.list-paginated': {
  55. direction: 'next' | 'prev';
  56. };
  57. 'replay.list-sorted': {
  58. column: string;
  59. };
  60. 'replay.list-time-spent': {
  61. seconds: number;
  62. user_email: string;
  63. };
  64. 'replay.list-view-setup-sidebar': {};
  65. 'replay.play-pause': {
  66. play: boolean;
  67. user_email: string;
  68. };
  69. 'replay.render-issues-group-list': {
  70. platform: string | undefined;
  71. project_id: string | undefined;
  72. };
  73. 'replay.render-player': {
  74. aspect_ratio: 'portrait' | 'landscape';
  75. /*
  76. * What scale is the video as a percent, bucketed into ranges of 10% increments
  77. * example:
  78. * - The video is shown at 25% the normal size
  79. * - in CSS we use the statement `transform: scale(0.25);`
  80. * - The logged value is `20`, because the scale is in the range of 20% to 30%.
  81. */
  82. scale_bucket: 0 | 10 | 20 | 30 | 40 | 50 | 60 | 70 | 80 | 90 | 100;
  83. };
  84. 'replay.search': {
  85. search_keys: string;
  86. };
  87. 'replay.toggle-fullscreen': {
  88. fullscreen: boolean;
  89. user_email: string;
  90. };
  91. };
  92. export type ReplayEventKey = keyof ReplayEventParameters;
  93. export const replayEventMap: Record<ReplayEventKey, string | null> = {
  94. 'replay.details-data-loaded': 'Replay Details Data Loaded',
  95. 'replay.details-layout-changed': 'Changed Replay Details Layout',
  96. 'replay.details-network-panel-closed': 'Closed Replay Network Details Panel',
  97. 'replay.details-network-panel-opened': 'Opened Replay Network Details Panel',
  98. 'replay.details-network-tab-changed': 'Changed Replay Network Details Tab',
  99. 'replay.details-resized-panel': 'Resized Replay Details Panel',
  100. 'replay.details-tab-changed': 'Changed Replay Details Tab',
  101. 'replay.details-time-spent': 'Time Spent Viewing Replay Details',
  102. 'replay.details-viewed': 'Viewed Replay Details',
  103. 'replay.list-navigate-to-details': 'Replays List Navigate to Replay Details',
  104. 'replay.list-paginated': 'Paginated Replay List',
  105. 'replay.list-sorted': 'Sorted Replay List',
  106. 'replay.list-time-spent': 'Time Spent Viewing Replay List',
  107. 'replay.list-view-setup-sidebar': 'Views Set Up Replays Sidebar',
  108. 'replay.play-pause': 'Played/Paused Replay',
  109. 'replay.render-issues-group-list': 'Render Issues Detail Replay List',
  110. 'replay.render-player': 'Rendered ReplayPlayer',
  111. 'replay.search': 'Searched Replay',
  112. 'replay.toggle-fullscreen': 'Toggled Replay Fullscreen',
  113. };