content.tsx 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897
  1. import {Fragment, useCallback, useEffect, useMemo, useState} from 'react';
  2. import {useTheme} from '@emotion/react';
  3. import styled from '@emotion/styled';
  4. import debounce from 'lodash/debounce';
  5. import omit from 'lodash/omit';
  6. import moment from 'moment';
  7. import {Alert} from 'sentry/components/alert';
  8. import {Button} from 'sentry/components/button';
  9. import Count from 'sentry/components/count';
  10. import EmptyStateWarning, {EmptyStreamWrapper} from 'sentry/components/emptyStateWarning';
  11. import * as Layout from 'sentry/components/layouts/thirds';
  12. import ExternalLink from 'sentry/components/links/externalLink';
  13. import LoadingIndicator from 'sentry/components/loadingIndicator';
  14. import {DatePageFilter} from 'sentry/components/organizations/datePageFilter';
  15. import {EnvironmentPageFilter} from 'sentry/components/organizations/environmentPageFilter';
  16. import PageFilterBar from 'sentry/components/organizations/pageFilterBar';
  17. import {normalizeDateTimeParams} from 'sentry/components/organizations/pageFilters/parse';
  18. import {ProjectPageFilter} from 'sentry/components/organizations/projectPageFilter';
  19. import Panel from 'sentry/components/panels/panel';
  20. import PanelHeader from 'sentry/components/panels/panelHeader';
  21. import PanelItem from 'sentry/components/panels/panelItem';
  22. import PerformanceDuration from 'sentry/components/performanceDuration';
  23. import {Tooltip} from 'sentry/components/tooltip';
  24. import {IconArrow} from 'sentry/icons/iconArrow';
  25. import {IconChevron} from 'sentry/icons/iconChevron';
  26. import {IconClose} from 'sentry/icons/iconClose';
  27. import {IconWarning} from 'sentry/icons/iconWarning';
  28. import {t, tct} from 'sentry/locale';
  29. import {space} from 'sentry/styles/space';
  30. import type {PageFilters} from 'sentry/types/core';
  31. import type {MRI} from 'sentry/types/metrics';
  32. import type {Organization} from 'sentry/types/organization';
  33. import {trackAnalytics} from 'sentry/utils/analytics';
  34. import {browserHistory} from 'sentry/utils/browserHistory';
  35. import {getUtcDateString} from 'sentry/utils/dates';
  36. import {getFormattedMQL} from 'sentry/utils/metrics';
  37. import {useApiQuery} from 'sentry/utils/queryClient';
  38. import {decodeInteger, decodeList, decodeScalar} from 'sentry/utils/queryString';
  39. import {useLocation} from 'sentry/utils/useLocation';
  40. import useOrganization from 'sentry/utils/useOrganization';
  41. import usePageFilters from 'sentry/utils/usePageFilters';
  42. import useProjects from 'sentry/utils/useProjects';
  43. import * as ModuleLayout from 'sentry/views/insights/common/components/moduleLayout';
  44. import {type Field, FIELDS, SORTS} from './data';
  45. import {
  46. BREAKDOWN_SLICES,
  47. ProjectRenderer,
  48. SpanBreakdownSliceRenderer,
  49. SpanDescriptionRenderer,
  50. SpanIdRenderer,
  51. SpanTimeRenderer,
  52. TraceBreakdownContainer,
  53. TraceBreakdownRenderer,
  54. TraceIdRenderer,
  55. TraceIssuesRenderer,
  56. } from './fieldRenderers';
  57. import {TracesChart} from './tracesChart';
  58. import {TracesSearchBar} from './tracesSearchBar';
  59. import {
  60. ALL_PROJECTS,
  61. areQueriesEmpty,
  62. getSecondaryNameFromSpan,
  63. getStylingSliceName,
  64. normalizeTraces,
  65. } from './utils';
  66. const DEFAULT_PER_PAGE = 50;
  67. const SPAN_PROPS_DOCS_URL =
  68. 'https://docs.sentry.io/concepts/search/searchable-properties/spans/';
  69. const ONE_MINUTE = 60 * 1000; // in milliseconds
  70. function usePageParams(location) {
  71. const queries = useMemo(() => {
  72. return decodeList(location.query.query);
  73. }, [location.query.query]);
  74. const metricsMax = decodeScalar(location.query.metricsMax);
  75. const metricsMin = decodeScalar(location.query.metricsMin);
  76. const metricsOp = decodeScalar(location.query.metricsOp);
  77. const metricsQuery = decodeScalar(location.query.metricsQuery);
  78. const mri = decodeScalar(location.query.mri);
  79. return {
  80. queries,
  81. metricsMax,
  82. metricsMin,
  83. metricsOp,
  84. metricsQuery,
  85. mri,
  86. };
  87. }
  88. export function Content() {
  89. const location = useLocation();
  90. const organization = useOrganization();
  91. const limit = useMemo(() => {
  92. return decodeInteger(location.query.perPage, DEFAULT_PER_PAGE);
  93. }, [location.query.perPage]);
  94. const {queries, metricsMax, metricsMin, metricsOp, metricsQuery, mri} =
  95. usePageParams(location);
  96. const hasMetric = metricsOp && mri;
  97. const removeMetric = useCallback(() => {
  98. browserHistory.push({
  99. ...location,
  100. query: omit(location.query, [
  101. 'mri',
  102. 'metricsOp',
  103. 'metricsQuery',
  104. 'metricsMax',
  105. 'metricsMin',
  106. ]),
  107. });
  108. }, [location]);
  109. const handleSearch = useCallback(
  110. (searchIndex: number, searchQuery: string) => {
  111. const newQueries = [...queries];
  112. if (newQueries.length === 0) {
  113. // In the odd case someone wants to add search bars before any query has been made, we add both the default one shown and a new one.
  114. newQueries[0] = '';
  115. }
  116. newQueries[searchIndex] = searchQuery;
  117. browserHistory.push({
  118. ...location,
  119. query: {
  120. ...location.query,
  121. cursor: undefined,
  122. query: typeof searchQuery === 'string' ? newQueries : queries,
  123. },
  124. });
  125. },
  126. [location, queries]
  127. );
  128. const handleClearSearch = useCallback(
  129. (searchIndex: number) => {
  130. const newQueries = [...queries];
  131. if (typeof newQueries[searchIndex] !== undefined) {
  132. delete newQueries[searchIndex];
  133. browserHistory.push({
  134. ...location,
  135. query: {
  136. ...location.query,
  137. cursor: undefined,
  138. query: newQueries,
  139. },
  140. });
  141. return true;
  142. }
  143. return false;
  144. },
  145. [location, queries]
  146. );
  147. const sortByTimestamp = organization.features.includes(
  148. 'performance-trace-explorer-sorting'
  149. );
  150. const tracesQuery = useTraces({
  151. limit,
  152. query: queries,
  153. sort: sortByTimestamp ? '-timestamp' : undefined,
  154. mri: hasMetric ? mri : undefined,
  155. metricsMax: hasMetric ? metricsMax : undefined,
  156. metricsMin: hasMetric ? metricsMin : undefined,
  157. metricsOp: hasMetric ? metricsOp : undefined,
  158. metricsQuery: hasMetric ? metricsQuery : undefined,
  159. });
  160. const isLoading = tracesQuery.isFetching;
  161. const isError = !isLoading && tracesQuery.isError;
  162. const isEmpty = !isLoading && !isError && (tracesQuery?.data?.data?.length ?? 0) === 0;
  163. const data = normalizeTraces(
  164. !isLoading && !isError ? tracesQuery?.data?.data : undefined
  165. );
  166. return (
  167. <LayoutMain fullWidth>
  168. <PageFilterBar condensed>
  169. <Tooltip
  170. title={tct(
  171. "Traces stem across multiple projects. You'll need to narrow down which projects you'd like to include per span.[br](ex. [code:project:javascript])",
  172. {
  173. br: <br />,
  174. code: <Code />,
  175. }
  176. )}
  177. position="bottom"
  178. >
  179. <ProjectPageFilter disabled projectOverride={ALL_PROJECTS} />
  180. </Tooltip>
  181. <EnvironmentPageFilter />
  182. <DatePageFilter defaultPeriod="2h" />
  183. </PageFilterBar>
  184. {hasMetric && (
  185. <StyledAlert
  186. type="info"
  187. showIcon
  188. trailingItems={<StyledCloseButton onClick={removeMetric} />}
  189. >
  190. {tct('The metric query [metricQuery] is filtering the results below.', {
  191. metricQuery: (
  192. <strong>
  193. {getFormattedMQL({mri: mri as MRI, op: metricsOp, query: metricsQuery})}
  194. </strong>
  195. ),
  196. })}
  197. </StyledAlert>
  198. )}
  199. {isError && typeof tracesQuery.error?.responseJSON?.detail === 'string' ? (
  200. <StyledAlert type="error" showIcon>
  201. {tracesQuery.error?.responseJSON?.detail}
  202. </StyledAlert>
  203. ) : null}
  204. <TracesSearchBar
  205. queries={queries}
  206. handleSearch={handleSearch}
  207. handleClearSearch={handleClearSearch}
  208. />
  209. <ModuleLayout.Full>
  210. <TracesChart />
  211. </ModuleLayout.Full>
  212. <StyledPanel>
  213. <TracePanelContent>
  214. <StyledPanelHeader align="left" lightText>
  215. {t('Trace ID')}
  216. </StyledPanelHeader>
  217. <StyledPanelHeader align="left" lightText>
  218. {t('Trace Root')}
  219. </StyledPanelHeader>
  220. <StyledPanelHeader align="right" lightText>
  221. {areQueriesEmpty(queries) ? t('Total Spans') : t('Matching Spans')}
  222. </StyledPanelHeader>
  223. <StyledPanelHeader align="left" lightText>
  224. {t('Timeline')}
  225. </StyledPanelHeader>
  226. <StyledPanelHeader align="right" lightText>
  227. {t('Duration')}
  228. </StyledPanelHeader>
  229. <StyledPanelHeader align="right" lightText>
  230. {t('Timestamp')}
  231. {sortByTimestamp ? <IconArrow size="xs" direction="down" /> : null}
  232. </StyledPanelHeader>
  233. <StyledPanelHeader align="right" lightText>
  234. {t('Issues')}
  235. </StyledPanelHeader>
  236. {isLoading && (
  237. <StyledPanelItem span={7} overflow>
  238. <LoadingIndicator />
  239. </StyledPanelItem>
  240. )}
  241. {isError && ( // TODO: need an error state
  242. <StyledPanelItem span={7} overflow>
  243. <EmptyStreamWrapper>
  244. <IconWarning color="gray300" size="lg" />
  245. </EmptyStreamWrapper>
  246. </StyledPanelItem>
  247. )}
  248. {isEmpty && (
  249. <StyledPanelItem span={7} overflow>
  250. <EmptyStateWarning withIcon>
  251. <EmptyStateText size="fontSizeExtraLarge">
  252. {t('No trace results found')}
  253. </EmptyStateText>
  254. <EmptyStateText size="fontSizeMedium">
  255. {tct('Try adjusting your filters or refer to [docSearchProps].', {
  256. docSearchProps: (
  257. <ExternalLink href={SPAN_PROPS_DOCS_URL}>
  258. {t('docs for search properties')}
  259. </ExternalLink>
  260. ),
  261. })}
  262. </EmptyStateText>
  263. </EmptyStateWarning>
  264. </StyledPanelItem>
  265. )}
  266. {data?.map((trace, i) => (
  267. <TraceRow key={trace.trace} trace={trace} defaultExpanded={i === 0} />
  268. ))}
  269. </TracePanelContent>
  270. </StyledPanel>
  271. </LayoutMain>
  272. );
  273. }
  274. function TraceRow({defaultExpanded, trace}: {defaultExpanded; trace: TraceResult}) {
  275. const [expanded, setExpanded] = useState<boolean>(defaultExpanded);
  276. const [highlightedSliceName, _setHighlightedSliceName] = useState('');
  277. const location = useLocation();
  278. const organization = useOrganization();
  279. const queries = useMemo(() => {
  280. return decodeList(location.query.query);
  281. }, [location.query.query]);
  282. const setHighlightedSliceName = useMemo(
  283. () =>
  284. debounce(sliceName => _setHighlightedSliceName(sliceName), 100, {
  285. leading: true,
  286. }),
  287. [_setHighlightedSliceName]
  288. );
  289. const onClickExpand = useCallback(() => setExpanded(e => !e), [setExpanded]);
  290. return (
  291. <Fragment>
  292. <StyledPanelItem align="center" center onClick={onClickExpand}>
  293. <Button
  294. icon={<IconChevron size="xs" direction={expanded ? 'down' : 'right'} />}
  295. aria-label={t('Toggle trace details')}
  296. aria-expanded={expanded}
  297. size="zero"
  298. borderless
  299. onClick={() =>
  300. trackAnalytics('trace_explorer.toggle_trace_details', {
  301. organization,
  302. expanded,
  303. })
  304. }
  305. />
  306. <TraceIdRenderer
  307. traceId={trace.trace}
  308. timestamp={trace.end}
  309. onClick={() =>
  310. trackAnalytics('trace_explorer.open_trace', {
  311. organization,
  312. })
  313. }
  314. location={location}
  315. />
  316. </StyledPanelItem>
  317. <StyledPanelItem align="left" overflow>
  318. <Description>
  319. {trace.project ? (
  320. <ProjectRenderer projectSlug={trace.project} hideName />
  321. ) : null}
  322. {trace.name ? (
  323. <WrappingText>{trace.name}</WrappingText>
  324. ) : (
  325. <EmptyValueContainer>{t('Missing Trace Root')}</EmptyValueContainer>
  326. )}
  327. </Description>
  328. </StyledPanelItem>
  329. <StyledPanelItem align="right">
  330. {areQueriesEmpty(queries) ? (
  331. <Count value={trace.numSpans} />
  332. ) : (
  333. tct('[numerator][space]of[space][denominator]', {
  334. numerator: <Count value={trace.matchingSpans} />,
  335. denominator: <Count value={trace.numSpans} />,
  336. space: <Fragment>&nbsp;</Fragment>,
  337. })
  338. )}
  339. </StyledPanelItem>
  340. <BreakdownPanelItem
  341. align="right"
  342. highlightedSliceName={highlightedSliceName}
  343. onMouseLeave={() => setHighlightedSliceName('')}
  344. >
  345. <TraceBreakdownRenderer
  346. trace={trace}
  347. setHighlightedSliceName={setHighlightedSliceName}
  348. />
  349. </BreakdownPanelItem>
  350. <StyledPanelItem align="right">
  351. <PerformanceDuration milliseconds={trace.duration} abbreviation />
  352. </StyledPanelItem>
  353. <StyledPanelItem align="right">
  354. <SpanTimeRenderer timestamp={trace.end} tooltipShowSeconds />
  355. </StyledPanelItem>
  356. <StyledPanelItem align="right">
  357. <TraceIssuesRenderer
  358. trace={trace}
  359. onClick={() =>
  360. trackAnalytics('trace_explorer.open_in_issues', {
  361. organization,
  362. })
  363. }
  364. />
  365. </StyledPanelItem>
  366. {expanded && (
  367. <SpanTable trace={trace} setHighlightedSliceName={setHighlightedSliceName} />
  368. )}
  369. </Fragment>
  370. );
  371. }
  372. function SpanTable({
  373. trace,
  374. setHighlightedSliceName,
  375. }: {
  376. setHighlightedSliceName: (sliceName: string) => void;
  377. trace: TraceResult;
  378. }) {
  379. const location = useLocation();
  380. const organization = useOrganization();
  381. const {queries, metricsMax, metricsMin, metricsOp, metricsQuery, mri} =
  382. usePageParams(location);
  383. const hasMetric = metricsOp && mri;
  384. const spansQuery = useTraceSpans({
  385. trace,
  386. fields: [
  387. ...FIELDS,
  388. ...SORTS.map(field =>
  389. field.startsWith('-') ? (field.substring(1) as Field) : (field as Field)
  390. ),
  391. ],
  392. datetime: {
  393. // give a 1 minute buffer on each side so that start != end
  394. start: getUtcDateString(moment(trace.start - ONE_MINUTE)),
  395. end: getUtcDateString(moment(trace.end + ONE_MINUTE)),
  396. period: null,
  397. utc: true,
  398. },
  399. limit: 10,
  400. query: queries,
  401. sort: SORTS,
  402. mri: hasMetric ? mri : undefined,
  403. metricsMax: hasMetric ? metricsMax : undefined,
  404. metricsMin: hasMetric ? metricsMin : undefined,
  405. metricsOp: hasMetric ? metricsOp : undefined,
  406. metricsQuery: hasMetric ? metricsQuery : undefined,
  407. });
  408. const isLoading = spansQuery.isFetching;
  409. const isError = !isLoading && spansQuery.isError;
  410. const hasData = !isLoading && !isError && (spansQuery?.data?.data?.length ?? 0) > 0;
  411. const spans = spansQuery.data?.data ?? [];
  412. return (
  413. <SpanTablePanelItem span={7} overflow>
  414. <StyledPanel>
  415. <SpanPanelContent>
  416. <StyledPanelHeader align="left" lightText>
  417. {t('Span ID')}
  418. </StyledPanelHeader>
  419. <StyledPanelHeader align="left" lightText>
  420. {t('Span Description')}
  421. </StyledPanelHeader>
  422. <StyledPanelHeader align="right" lightText />
  423. <StyledPanelHeader align="right" lightText>
  424. {t('Span Duration')}
  425. </StyledPanelHeader>
  426. <StyledPanelHeader align="right" lightText>
  427. {t('Timestamp')}
  428. </StyledPanelHeader>
  429. {isLoading && (
  430. <StyledPanelItem span={5} overflow>
  431. <LoadingIndicator />
  432. </StyledPanelItem>
  433. )}
  434. {isError && ( // TODO: need an error state
  435. <StyledPanelItem span={5} overflow>
  436. <EmptyStreamWrapper>
  437. <IconWarning color="gray300" size="lg" />
  438. </EmptyStreamWrapper>
  439. </StyledPanelItem>
  440. )}
  441. {spans.map(span => (
  442. <SpanRow
  443. organization={organization}
  444. key={span.id}
  445. span={span}
  446. trace={trace}
  447. setHighlightedSliceName={setHighlightedSliceName}
  448. />
  449. ))}
  450. {hasData && spans.length < trace.matchingSpans && (
  451. <MoreMatchingSpans span={5}>
  452. {tct('[more][space]more [matching]spans can be found in the trace.', {
  453. more: <Count value={trace.matchingSpans - spans.length} />,
  454. space: <Fragment>&nbsp;</Fragment>,
  455. matching: areQueriesEmpty(queries) ? '' : 'matching ',
  456. })}
  457. </MoreMatchingSpans>
  458. )}
  459. </SpanPanelContent>
  460. </StyledPanel>
  461. </SpanTablePanelItem>
  462. );
  463. }
  464. function SpanRow({
  465. organization,
  466. span,
  467. trace,
  468. setHighlightedSliceName,
  469. }: {
  470. organization: Organization;
  471. setHighlightedSliceName: (sliceName: string) => void;
  472. span: SpanResult<Field>;
  473. trace: TraceResult;
  474. }) {
  475. const theme = useTheme();
  476. return (
  477. <Fragment>
  478. <StyledSpanPanelItem align="right">
  479. <SpanIdRenderer
  480. projectSlug={span.project}
  481. transactionId={span['transaction.id']}
  482. spanId={span.id}
  483. traceId={trace.trace}
  484. timestamp={span.timestamp}
  485. onClick={() =>
  486. trackAnalytics('trace_explorer.open_trace_span', {
  487. organization,
  488. })
  489. }
  490. />
  491. </StyledSpanPanelItem>
  492. <StyledSpanPanelItem align="left" overflow>
  493. <SpanDescriptionRenderer span={span} />
  494. </StyledSpanPanelItem>
  495. <StyledSpanPanelItem align="right" onMouseLeave={() => setHighlightedSliceName('')}>
  496. <TraceBreakdownContainer>
  497. <SpanBreakdownSliceRenderer
  498. sliceName={span.project}
  499. sliceSecondaryName={getSecondaryNameFromSpan(span)}
  500. sliceStart={Math.ceil(span['precise.start_ts'] * 1000)}
  501. sliceEnd={Math.floor(span['precise.finish_ts'] * 1000)}
  502. trace={trace}
  503. theme={theme}
  504. onMouseEnter={() =>
  505. setHighlightedSliceName(
  506. getStylingSliceName(span.project, getSecondaryNameFromSpan(span)) ?? ''
  507. )
  508. }
  509. />
  510. </TraceBreakdownContainer>
  511. </StyledSpanPanelItem>
  512. <StyledSpanPanelItem align="right">
  513. <PerformanceDuration milliseconds={span['span.duration']} abbreviation />
  514. </StyledSpanPanelItem>
  515. <StyledSpanPanelItem align="right">
  516. <SpanTimeRenderer
  517. timestamp={span['precise.finish_ts'] * 1000}
  518. tooltipShowSeconds
  519. />
  520. </StyledSpanPanelItem>
  521. </Fragment>
  522. );
  523. }
  524. export type SpanResult<F extends string> = Record<F, any>;
  525. export interface TraceResult {
  526. breakdowns: TraceBreakdownResult[];
  527. duration: number;
  528. end: number;
  529. matchingSpans: number;
  530. name: string | null;
  531. numErrors: number;
  532. numOccurrences: number;
  533. numSpans: number;
  534. project: string | null;
  535. slices: number;
  536. start: number;
  537. trace: string;
  538. }
  539. interface TraceBreakdownBase {
  540. duration: number; // Contains the accurate duration for display. Start and end may be quantized.
  541. end: number;
  542. opCategory: string | null;
  543. sdkName: string | null;
  544. sliceEnd: number;
  545. sliceStart: number;
  546. sliceWidth: number;
  547. start: number;
  548. }
  549. type TraceBreakdownProject = TraceBreakdownBase & {
  550. kind: 'project';
  551. project: string;
  552. };
  553. type TraceBreakdownMissing = TraceBreakdownBase & {
  554. kind: 'missing';
  555. project: null;
  556. };
  557. export type TraceBreakdownResult = TraceBreakdownProject | TraceBreakdownMissing;
  558. interface TraceResults {
  559. data: TraceResult[];
  560. meta: any;
  561. }
  562. interface UseTracesOptions {
  563. datetime?: PageFilters['datetime'];
  564. enabled?: boolean;
  565. limit?: number;
  566. metricsMax?: string;
  567. metricsMin?: string;
  568. metricsOp?: string;
  569. metricsQuery?: string;
  570. mri?: string;
  571. query?: string | string[];
  572. sort?: '-timestamp';
  573. }
  574. function useTraces({
  575. datetime,
  576. enabled,
  577. limit,
  578. mri,
  579. metricsMax,
  580. metricsMin,
  581. metricsOp,
  582. metricsQuery,
  583. query,
  584. sort,
  585. }: UseTracesOptions) {
  586. const organization = useOrganization();
  587. const {projects} = useProjects();
  588. const {selection} = usePageFilters();
  589. const path = `/organizations/${organization.slug}/traces/`;
  590. const endpointOptions = {
  591. query: {
  592. project: selection.projects,
  593. environment: selection.environments,
  594. ...(datetime ?? normalizeDateTimeParams(selection.datetime)),
  595. query,
  596. sort,
  597. per_page: limit,
  598. breakdownSlices: BREAKDOWN_SLICES,
  599. mri,
  600. metricsMax,
  601. metricsMin,
  602. metricsOp,
  603. metricsQuery,
  604. },
  605. };
  606. const serializedEndpointOptions = JSON.stringify(endpointOptions);
  607. let queries: string[] = [];
  608. if (Array.isArray(query)) {
  609. queries = query;
  610. } else if (query !== undefined) {
  611. queries = [query];
  612. }
  613. useEffect(() => {
  614. trackAnalytics('trace_explorer.search_request', {
  615. organization,
  616. queries,
  617. });
  618. // `queries` is already included as a dep in serializedEndpointOptions
  619. // eslint-disable-next-line react-hooks/exhaustive-deps
  620. }, [serializedEndpointOptions, organization]);
  621. const result = useApiQuery<TraceResults>([path, endpointOptions], {
  622. staleTime: 0,
  623. refetchOnWindowFocus: false,
  624. retry: false,
  625. enabled,
  626. });
  627. useEffect(() => {
  628. if (result.status === 'success') {
  629. const project_slugs = [...new Set(result.data.data.map(trace => trace.project))];
  630. const project_platforms = projects
  631. .filter(p => project_slugs.includes(p.slug))
  632. .map(p => p.platform ?? '');
  633. trackAnalytics('trace_explorer.search_success', {
  634. organization,
  635. queries,
  636. has_data: result.data.data.length > 0,
  637. num_traces: result.data.data.length,
  638. num_missing_trace_root: result.data.data.filter(trace => trace.name === null)
  639. .length,
  640. project_platforms,
  641. });
  642. } else if (result.status === 'error') {
  643. const response = result.error.responseJSON;
  644. const error =
  645. typeof response?.detail === 'string'
  646. ? response?.detail
  647. : response?.detail?.message;
  648. trackAnalytics('trace_explorer.search_failure', {
  649. organization,
  650. queries,
  651. error: error ?? '',
  652. });
  653. }
  654. // result.status is tied to result.data. No need to explicitly
  655. // include result.data as an additional dep.
  656. // eslint-disable-next-line react-hooks/exhaustive-deps
  657. }, [serializedEndpointOptions, result.status, organization]);
  658. return result;
  659. }
  660. interface SpanResults<F extends string> {
  661. data: SpanResult<F>[];
  662. meta: any;
  663. }
  664. interface UseTraceSpansOptions<F extends string> {
  665. fields: F[];
  666. trace: TraceResult;
  667. datetime?: PageFilters['datetime'];
  668. enabled?: boolean;
  669. limit?: number;
  670. metricsMax?: string;
  671. metricsMin?: string;
  672. metricsOp?: string;
  673. metricsQuery?: string;
  674. mri?: string;
  675. query?: string | string[];
  676. sort?: string[];
  677. }
  678. function useTraceSpans<F extends string>({
  679. fields,
  680. trace,
  681. datetime,
  682. enabled,
  683. limit,
  684. mri,
  685. metricsMax,
  686. metricsMin,
  687. metricsOp,
  688. metricsQuery,
  689. query,
  690. sort,
  691. }: UseTraceSpansOptions<F>) {
  692. const organization = useOrganization();
  693. const {selection} = usePageFilters();
  694. const path = `/organizations/${organization.slug}/trace/${trace.trace}/spans/`;
  695. const endpointOptions = {
  696. query: {
  697. environment: selection.environments,
  698. ...(datetime ?? normalizeDateTimeParams(selection.datetime)),
  699. field: fields,
  700. query,
  701. sort,
  702. per_page: limit,
  703. breakdownSlices: BREAKDOWN_SLICES,
  704. maxSpansPerTrace: 10,
  705. mri,
  706. metricsMax,
  707. metricsMin,
  708. metricsOp,
  709. metricsQuery,
  710. },
  711. };
  712. const result = useApiQuery<SpanResults<F>>([path, endpointOptions], {
  713. staleTime: 0,
  714. refetchOnWindowFocus: false,
  715. retry: false,
  716. enabled,
  717. });
  718. return result;
  719. }
  720. const LayoutMain = styled(Layout.Main)`
  721. display: flex;
  722. flex-direction: column;
  723. gap: ${space(2)};
  724. `;
  725. const StyledPanel = styled(Panel)`
  726. margin-bottom: 0px;
  727. `;
  728. const TracePanelContent = styled('div')`
  729. width: 100%;
  730. display: grid;
  731. grid-template-columns: repeat(1, min-content) auto repeat(2, min-content) 85px 112px 66px;
  732. `;
  733. const SpanPanelContent = styled('div')`
  734. width: 100%;
  735. display: grid;
  736. grid-template-columns: repeat(1, min-content) auto repeat(1, min-content) 160px 85px;
  737. `;
  738. const StyledPanelHeader = styled(PanelHeader)<{align: 'left' | 'right'}>`
  739. white-space: nowrap;
  740. justify-content: ${p => (p.align === 'left' ? 'flex-start' : 'flex-end')};
  741. `;
  742. const EmptyStateText = styled('div')<{size: 'fontSizeExtraLarge' | 'fontSizeMedium'}>`
  743. color: ${p => p.theme.gray300};
  744. font-size: ${p => p.theme[p.size]};
  745. padding-bottom: ${space(1)};
  746. `;
  747. const Description = styled('div')`
  748. ${p => p.theme.overflowEllipsis};
  749. display: flex;
  750. flex-direction: row;
  751. align-items: center;
  752. gap: ${space(1)};
  753. `;
  754. const StyledPanelItem = styled(PanelItem)<{
  755. align?: 'left' | 'center' | 'right';
  756. overflow?: boolean;
  757. span?: number;
  758. }>`
  759. align-items: center;
  760. padding: ${space(1)} ${space(2)};
  761. ${p => (p.align === 'left' ? 'justify-content: flex-start;' : null)}
  762. ${p => (p.align === 'right' ? 'justify-content: flex-end;' : null)}
  763. ${p => (p.overflow ? p.theme.overflowEllipsis : null)};
  764. ${p =>
  765. p.align === 'center'
  766. ? `
  767. justify-content: space-around;`
  768. : p.align === 'left' || p.align === 'right'
  769. ? `text-align: ${p.align};`
  770. : undefined}
  771. ${p => p.span && `grid-column: auto / span ${p.span};`}
  772. white-space: nowrap;
  773. `;
  774. const MoreMatchingSpans = styled(StyledPanelItem)`
  775. color: ${p => p.theme.gray300};
  776. `;
  777. const WrappingText = styled('div')`
  778. width: 100%;
  779. ${p => p.theme.overflowEllipsis};
  780. `;
  781. const StyledSpanPanelItem = styled(StyledPanelItem)`
  782. &:nth-child(10n + 1),
  783. &:nth-child(10n + 2),
  784. &:nth-child(10n + 3),
  785. &:nth-child(10n + 4),
  786. &:nth-child(10n + 5) {
  787. background-color: ${p => p.theme.backgroundSecondary};
  788. }
  789. `;
  790. const SpanTablePanelItem = styled(StyledPanelItem)`
  791. background-color: ${p => p.theme.gray100};
  792. `;
  793. const BreakdownPanelItem = styled(StyledPanelItem)<{highlightedSliceName: string}>`
  794. ${p =>
  795. p.highlightedSliceName
  796. ? `--highlightedSlice-${p.highlightedSliceName}-opacity: 1.0;
  797. --highlightedSlice-${p.highlightedSliceName}-saturate: saturate(1.0) contrast(1.0);
  798. --highlightedSlice-${p.highlightedSliceName}-transform: translateY(0px);
  799. `
  800. : null}
  801. ${p =>
  802. p.highlightedSliceName
  803. ? `
  804. --defaultSlice-opacity: 1.0;
  805. --defaultSlice-saturate: saturate(0.7) contrast(0.9) brightness(1.2);
  806. --defaultSlice-transform: translateY(0px);
  807. `
  808. : `
  809. --defaultSlice-opacity: 1.0;
  810. --defaultSlice-saturate: saturate(1.0) contrast(1.0);
  811. --defaultSlice-transform: translateY(0px);
  812. `}
  813. `;
  814. const EmptyValueContainer = styled('span')`
  815. color: ${p => p.theme.gray300};
  816. `;
  817. const StyledAlert = styled(Alert)`
  818. margin-bottom: 0;
  819. `;
  820. const StyledCloseButton = styled(IconClose)`
  821. cursor: pointer;
  822. `;
  823. const Code = styled('code')`
  824. color: ${p => p.theme.red400};
  825. `;