content.tsx 26 KB

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