columnEditModal.tsx 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134
  1. import {Fragment, useEffect, useState} from 'react';
  2. import {css} from '@emotion/react';
  3. import styled from '@emotion/styled';
  4. import {ModalRenderProps} from 'sentry/actionCreators/modal';
  5. import {Button} from 'sentry/components/button';
  6. import ButtonBar from 'sentry/components/buttonBar';
  7. import ExternalLink from 'sentry/components/links/externalLink';
  8. import {DISCOVER2_DOCS_URL} from 'sentry/constants';
  9. import {t, tct} from 'sentry/locale';
  10. import {space} from 'sentry/styles/space';
  11. import {Organization} from 'sentry/types';
  12. import {trackAnalyticsEvent} from 'sentry/utils/analytics';
  13. import {CustomMeasurementCollection} from 'sentry/utils/customMeasurements/customMeasurements';
  14. import {Column} from 'sentry/utils/discover/fields';
  15. import {FieldKey} from 'sentry/utils/fields';
  16. import theme from 'sentry/utils/theme';
  17. import useTags from 'sentry/utils/useTags';
  18. import {generateFieldOptions} from 'sentry/views/discover/utils';
  19. import ColumnEditCollection from './columnEditCollection';
  20. type Props = {
  21. columns: Column[];
  22. measurementKeys: null | string[];
  23. // Fired when column selections have been applied.
  24. onApply: (columns: Column[]) => void;
  25. organization: Organization;
  26. customMeasurements?: CustomMeasurementCollection;
  27. spanOperationBreakdownKeys?: string[];
  28. } & ModalRenderProps;
  29. function ColumnEditModal(props: Props) {
  30. const {
  31. Header,
  32. Body,
  33. Footer,
  34. measurementKeys,
  35. spanOperationBreakdownKeys,
  36. organization,
  37. onApply,
  38. closeModal,
  39. customMeasurements,
  40. } = props;
  41. // Only run once for each organization.id.
  42. useEffect(() => {
  43. trackAnalyticsEvent({
  44. eventKey: 'discover_v2.column_editor.open',
  45. eventName: 'Discoverv2: Open column editor',
  46. organization_id: parseInt(organization.id, 10),
  47. });
  48. }, [organization.id]);
  49. const tags = useTags();
  50. const tagKeys = Object.keys(tags);
  51. const [columns, setColumns] = useState<Column[]>(props.columns);
  52. function handleApply() {
  53. onApply(columns);
  54. closeModal();
  55. }
  56. const fieldOptions = generateFieldOptions({
  57. organization,
  58. tagKeys,
  59. measurementKeys,
  60. spanOperationBreakdownKeys,
  61. customMeasurements:
  62. organization.features.includes('dashboards-mep') ||
  63. organization.features.includes('mep-rollout-flag')
  64. ? Object.values(customMeasurements ?? {}).map(({key, functions}) => ({
  65. key,
  66. functions,
  67. }))
  68. : undefined,
  69. });
  70. return (
  71. <Fragment>
  72. <Header closeButton>
  73. <h4>{t('Edit Columns')}</h4>
  74. </Header>
  75. <Body>
  76. <Instruction>
  77. {tct(
  78. 'To group events, add [functionLink: functions] f(x) that may take in additional parameters. [fieldTagLink: Tag and field] columns will help you view more details about the events (i.e. title).',
  79. {
  80. functionLink: (
  81. <ExternalLink href="https://docs.sentry.io/product/discover-queries/query-builder/#filter-by-table-columns" />
  82. ),
  83. fieldTagLink: (
  84. <ExternalLink href="https://docs.sentry.io/product/sentry-basics/search/searchable-properties/#event-properties" />
  85. ),
  86. }
  87. )}
  88. </Instruction>
  89. <ColumnEditCollection
  90. columns={columns}
  91. fieldOptions={fieldOptions}
  92. filterAggregateParameters={option =>
  93. option.value.meta.name !== FieldKey.TOTAL_COUNT
  94. }
  95. onChange={setColumns}
  96. organization={organization}
  97. />
  98. </Body>
  99. <Footer>
  100. <ButtonBar gap={1}>
  101. <Button priority="default" href={DISCOVER2_DOCS_URL} external>
  102. {t('Read the Docs')}
  103. </Button>
  104. <Button aria-label={t('Apply')} priority="primary" onClick={handleApply}>
  105. {t('Apply')}
  106. </Button>
  107. </ButtonBar>
  108. </Footer>
  109. </Fragment>
  110. );
  111. }
  112. const Instruction = styled('div')`
  113. margin-bottom: ${space(4)};
  114. `;
  115. const modalCss = css`
  116. @media (min-width: ${theme.breakpoints.medium}) {
  117. width: auto;
  118. max-width: 900px;
  119. }
  120. `;
  121. export default ColumnEditModal;
  122. export {modalCss};