searchAnalyticsEvents.tsx 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899
  1. import {ShortcutType} from 'sentry/components/smartSearchBar/types';
  2. type SearchEventBase = {
  3. query: string;
  4. search_type: string;
  5. search_source?: string;
  6. };
  7. type OpenEvent = {};
  8. type SelectEvent = {result_type: string; source_type: string; query?: string};
  9. type QueryEvent = {query: string};
  10. type ProjectSelectorEvent = {path: string};
  11. export type SearchEventParameters = {
  12. 'command_palette.open': OpenEvent;
  13. 'command_palette.query': QueryEvent;
  14. 'command_palette.select': SelectEvent;
  15. 'omnisearch.open': {};
  16. 'organization_saved_search.selected': {
  17. id: number;
  18. is_global: boolean;
  19. query: string;
  20. search_type: string;
  21. visibility: string;
  22. };
  23. 'projectselector.clear': ProjectSelectorEvent;
  24. 'projectselector.direct_selection': ProjectSelectorEvent;
  25. 'projectselector.multi_button_clicked': ProjectSelectorEvent & {
  26. button_type: 'all' | 'my';
  27. };
  28. 'projectselector.toggle': ProjectSelectorEvent & {
  29. action: 'added' | 'removed';
  30. };
  31. 'projectselector.update': ProjectSelectorEvent & {
  32. count: number;
  33. multi: boolean;
  34. };
  35. 'search.invalid_field': Omit<SearchEventBase, 'query'> & {attempted_field_name: string};
  36. 'search.operator_autocompleted': SearchEventBase & {search_operator: string};
  37. 'search.pin': {
  38. action: 'pin' | 'unpin';
  39. search_type: string;
  40. query?: string;
  41. };
  42. 'search.saved_search_create': {
  43. name: string;
  44. query: string;
  45. search_type: string;
  46. sort: string;
  47. visibility: string;
  48. };
  49. 'search.saved_search_open_create_modal': OpenEvent;
  50. 'search.saved_search_sidebar_toggle_clicked': {open: boolean};
  51. 'search.search_with_invalid': SearchEventBase;
  52. 'search.searched': SearchEventBase & {search_source?: string};
  53. 'search.shortcut_used': SearchEventBase & {
  54. shortcut_method: 'hotkey' | 'click';
  55. shortcut_type: ShortcutType;
  56. search_source?: string;
  57. };
  58. 'settings_search.open': OpenEvent;
  59. 'settings_search.query': QueryEvent;
  60. 'settings_search.select': SelectEvent;
  61. 'sidebar_help.open': OpenEvent;
  62. 'sidebar_help.query': QueryEvent;
  63. 'sidebar_help.select': SelectEvent;
  64. };
  65. export type SearchEventKey = keyof SearchEventParameters;
  66. export const searchEventMap: Record<SearchEventKey, string | null> = {
  67. 'search.searched': 'Search: Performed search',
  68. 'search.operator_autocompleted': 'Search: Operator Autocompleted',
  69. 'search.shortcut_used': 'Search: Shortcut Used',
  70. 'search.search_with_invalid': 'Search: Attempted Invalid Search',
  71. 'search.invalid_field': 'Search: Unsupported Field Warning Shown',
  72. 'organization_saved_search.selected':
  73. 'Organization Saved Search: Selected saved search',
  74. 'settings_search.open': 'settings_search Open',
  75. 'command_palette.open': 'command_palette Open',
  76. 'sidebar_help.open': 'sidebar_help Open',
  77. 'settings_search.select': 'settings_search Select',
  78. 'command_palette.select': 'command_palette Select',
  79. 'sidebar_help.select': 'sidebar_help Select',
  80. 'settings_search.query': 'settings_search Query',
  81. 'command_palette.query': 'command_palette Query',
  82. 'sidebar_help.query': 'sidebar_help Query',
  83. 'projectselector.direct_selection': 'Project Selector: Direct Selection',
  84. 'projectselector.update': 'Project Selector: Update',
  85. 'projectselector.clear': 'Project Selector: Clear',
  86. 'projectselector.toggle': 'Project Selector: Toggle',
  87. 'projectselector.multi_button_clicked': 'Project Selector: Multi Button Clicked',
  88. 'search.pin': 'Search: Pin',
  89. 'search.saved_search_create': 'Search: Saved Search Created',
  90. 'search.saved_search_open_create_modal': 'Search: Saved Search Modal Opened',
  91. 'search.saved_search_sidebar_toggle_clicked':
  92. 'Search: Saved Search Sidebar Toggle Clicked',
  93. 'omnisearch.open': 'Omnisearch: Open',
  94. };