starfishAnalyticsEvents.tsx 1.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  1. export type StarfishEventParameters = {
  2. 'starfish.chart.zoom': {
  3. end: number;
  4. start: number;
  5. route?: string;
  6. };
  7. 'starfish.page_filter.data_change': {
  8. end: string;
  9. relative: string;
  10. start: string;
  11. };
  12. 'starfish.pageview': {
  13. route: string;
  14. };
  15. 'starfish.request': {
  16. duration: number;
  17. statusCode?: string;
  18. };
  19. 'starfish.samples.loaded': {
  20. count: number;
  21. };
  22. 'starfish.web_service_view.breakdown.display_change': {
  23. display: string;
  24. };
  25. 'starfish.web_service_view.breakdown.legend_change': {
  26. selected: string[];
  27. toggled: string;
  28. };
  29. 'starfish.web_service_view.endpoint_list.endpoint.clicked': {
  30. endpoint: string;
  31. };
  32. 'starfish.web_service_view.endpoint_list.header.clicked': {
  33. direction: string;
  34. header: string;
  35. };
  36. 'starfish.web_service_view.endpoint_list.search': {
  37. query: string;
  38. };
  39. };
  40. export type StarfishEventKey = keyof StarfishEventParameters;
  41. export const starfishEventMap: Record<keyof StarfishEventParameters, string> = {
  42. 'starfish.chart.zoom': 'Starfish: Chart Zoomed',
  43. 'starfish.pageview': 'Starfish: Page Viewed',
  44. 'starfish.request': 'Starfish: API Request Completed',
  45. 'starfish.samples.loaded': 'Starfish: Samples Loaded',
  46. 'starfish.web_service_view.endpoint_list.endpoint.clicked':
  47. 'Starfish: Web Service View Endpoint List Endpoint Clicked',
  48. 'starfish.web_service_view.endpoint_list.header.clicked':
  49. 'Starfish: Web Service View Endpoint List Header Clicked',
  50. 'starfish.web_service_view.endpoint_list.search':
  51. 'Starfish: Web Service View Endpoint List Search',
  52. 'starfish.web_service_view.breakdown.display_change':
  53. 'Starfish: Web Service View Breakdown Display Changed',
  54. 'starfish.page_filter.data_change': 'Starfish: Page Filter Data Changed',
  55. 'starfish.web_service_view.breakdown.legend_change':
  56. 'Starfish: Web Service View Breakdown Legend Changed',
  57. };