1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852 |
- import type {Theme} from '@emotion/react';
- import type {Client} from 'sentry/api';
- import type {RawSpanType} from 'sentry/components/events/interfaces/spans/types';
- import {pickBarColor} from 'sentry/components/performance/waterfall/utils';
- import type {Organization} from 'sentry/types';
- import type {Event, EventTransaction, Measurement} from 'sentry/types/event';
- import {MobileVital, WebVital} from 'sentry/utils/fields';
- import type {
- TraceError as TraceErrorType,
- TraceFullDetailed,
- TracePerformanceIssue,
- TraceSplitResults,
- } from 'sentry/utils/performance/quickTrace/types';
- import {
- isTraceError,
- isTraceTransaction,
- } from 'sentry/utils/performance/quickTrace/utils';
- import {TraceType} from '../traceDetails/newTraceDetailsContent';
- import {isRootTransaction} from '../traceDetails/utils';
- import {
- isAutogroupedNode,
- isMissingInstrumentationNode,
- isParentAutogroupedNode,
- isRootNode,
- isSiblingAutogroupedNode,
- isSpanNode,
- isTraceErrorNode,
- isTraceNode,
- isTransactionNode,
- shouldAddMissingInstrumentationSpan,
- } from './guards';
- /**
- *
- * This file implements the tree data structure that is used to represent a trace. We do
- * this both for performance reasons as well as flexibility. The requirement for a tree
- * is to support incremental patching and updates. This is important because we want to
- * be able to fetch more data as the user interacts with the tree, and we want to be able
- * efficiently update the tree as we receive more data.
- *
- * The trace is represented as a tree with different node value types (transaction or span)
- * Each tree node contains a reference to its parent and a list of references to its children,
- * as well as a reference to the value that the node holds. Each node also contains
- * some meta data and state about the node, such as if it is expanded or zoomed in. The benefit
- * of abstracting parts of the UI state is that the tree will persist user actions such as expanding
- * or collapsing nodes which would have otherwise been lost when individual nodes are remounted in the tree.
- *
- * Each tree holds a list reference, which is a live reference to a flattened representation
- * of the tree (used to render the tree in the UI). Since the list is mutable (and we want to keep it that way for performance
- * reasons as we want to support mutations on traces with ~100k+ nodes), callers need to manage reactivity themselves.
- *
- * An alternative, but not recommended approach is to call build() on the tree after each mutation,
- * which will iterate over all of the children and build a fresh list reference.
- *
- * In most cases, the initial tree is a list of transactions containing other transactions. Each transaction can
- * then be expanded into a list of spans which can also in some cases be expanded.
- *
- * - trace - trace
- * |- parent transaction --> when expanding |- parent transaction
- * |- child transaction |- span
- * |- span this used to be a transaction,
- * |- child transaction span <- but is now be a list of spans
- * |- span belonging to the transaction
- * this results in child txns to be lost,
- * which is a confusing user experience
- *
- * The tree supports autogrouping of spans vertically or as siblings. When that happens, a autogrouped node of either a vertical or
- * sibling type is inserted as an intermediary node. In the vertical case, the autogrouped node
- * holds the reference to the head and tail of the autogrouped sequence. In the sibling case, the autogrouped node
- * holds a reference to the children that are part of the autogrouped sequence. When expanding and collapsing these nodes,
- * the tree perform a reference swap to either point to the head (when expanded) or tail (when collapsed) of the autogrouped sequence.
- *
- * In vertical grouping case, the following happens:
- *
- * - root - root
- * - trace - trace
- * |- transaction |- transaction
- * |- span 1 <-| these become autogrouped |- autogrouped (head=span1, tail=span3, children points to children of tail)
- * |- span 2 |- as they are inserted into |- other span (parent points to autogrouped node)
- * |- span 3 <-| the tree.
- * |- other span
- *
- * When the autogrouped node is expanded the UI needs to show the entire collapsed chain, so we swap the tail children to point
- * back to the tail, and have autogrouped node point to it's head as the children.
- *
- * - root - root
- * - trace - trace
- * |- transaction |- transaction
- * |- autogrouped (head=span1, tail=span3) <- when expanding |- autogrouped (head=span1, tail=span3, children points to head)
- * | other span (paren points to autogrouped) |- span 1 (head)
- * |- span 2
- * |- span 3 (tail)
- * |- other span (children of tail, parent points to tail)
- *
- * Notes and improvements:
- * - the notion of expanded and zoomed is confusing, they stand for the same idea from a UI pov
- * - there is an annoying thing wrt span and transaction nodes where we either store data on _children or _spanChildren
- * this is because we want to be able to store both transaction and span nodes in the same tree, but it makes for an
- * annoying API. A better design would have been to create an invisible meta node that just points to the correct children
- * - instead of storing span children separately, we should have meta tree nodes that handle pointing to the correct children
- */
- export declare namespace TraceTree {
- type Transaction = TraceFullDetailed;
- interface Span extends RawSpanType {
- childTransaction: Transaction | undefined;
- event: EventTransaction;
- }
- type Trace = TraceSplitResults<Transaction>;
- type TraceError = TraceErrorType;
- type Profile = {profile_id: string; space: [number, number]};
- interface MissingInstrumentationSpan {
- start_timestamp: number;
- timestamp: number;
- type: 'missing_instrumentation';
- }
- interface SiblingAutogroup extends RawSpanType {
- autogrouped_by: {
- description: string;
- op: string;
- };
- }
- interface ChildrenAutogroup extends RawSpanType {
- autogrouped_by: {
- op: string;
- };
- }
- type NodeValue =
- | Trace
- | Transaction
- | TraceError
- | Span
- | MissingInstrumentationSpan
- | SiblingAutogroup
- | ChildrenAutogroup
- | null;
- type NodePath = `${'txn' | 'span' | 'ag' | 'trace' | 'ms' | 'error'}:${string}`;
- type Metadata = {
- event_id: string | undefined;
- project_slug: string | undefined;
- };
- type Indicator = {
- duration: number;
- label: string;
- measurement: Measurement;
- poor: boolean;
- start: number;
- type: 'cls' | 'fcp' | 'fp' | 'lcp' | 'ttfb';
- };
- }
- function cacheKey(organization: Organization, project_slug: string, event_id: string) {
- return organization.slug + ':' + project_slug + ':' + event_id;
- }
- function fetchTransactionSpans(
- api: Client,
- organization: Organization,
- project_slug: string,
- event_id: string
- ): Promise<EventTransaction> {
- return api.requestPromise(
- `/organizations/${organization.slug}/events/${project_slug}:${event_id}/`
- );
- }
- function measurementToTimestamp(
- start_timestamp: number,
- measurement: number,
- unit: string
- ) {
- if (unit === 'second') {
- return start_timestamp + measurement;
- }
- if (unit === 'millisecond') {
- return start_timestamp + measurement / 1e3;
- }
- if (unit === 'nanosecond') {
- return start_timestamp + measurement / 1e9;
- }
- throw new TypeError(`Unsupported measurement unit', ${unit}`);
- }
- function maybeInsertMissingInstrumentationSpan(
- parent: TraceTreeNode<TraceTree.NodeValue>,
- node: TraceTreeNode<TraceTree.Span>
- ) {
- const previousSpan = parent.spanChildren[parent.spanChildren.length - 1];
- if (!previousSpan || !isSpanNode(previousSpan)) {
- return;
- }
- if (node.value.start_timestamp - previousSpan.value.timestamp < 0.1) {
- return;
- }
- const missingInstrumentationSpan = new MissingInstrumentationNode(
- parent,
- {
- type: 'missing_instrumentation',
- start_timestamp: previousSpan.value.timestamp,
- timestamp: node.value.start_timestamp,
- },
- {
- event_id: undefined,
- project_slug: undefined,
- },
- previousSpan,
- node
- );
- parent.spanChildren.push(missingInstrumentationSpan);
- }
- export function makeTraceNodeBarColor(
- theme: Theme,
- node: TraceTreeNode<TraceTree.NodeValue>
- ): string {
- if (isTransactionNode(node)) {
- return pickBarColor(node.value['transaction.op']);
- }
- if (isSpanNode(node)) {
- return pickBarColor(node.value.op);
- }
- if (isAutogroupedNode(node)) {
- return theme.blue300;
- }
- if (isMissingInstrumentationNode(node)) {
- return theme.gray300;
- }
- if (isTraceErrorNode(node)) {
- return theme.red300;
- }
- return pickBarColor('default');
- }
- function shouldCollapseNodeByDefault(node: TraceTreeNode<TraceTree.NodeValue>) {
- if (isSpanNode(node)) {
- // Android creates TCP connection spans which are noisy and not useful in most cases
- if (node.value.op === 'http.client' && node.value.origin === 'auto.http.okhttp') {
- return true;
- }
- }
- return false;
- }
- // cls is not included as it is a cumulative layout shift and not a single point in time
- const RENDERABLE_MEASUREMENTS = [
- WebVital.TTFB,
- WebVital.FP,
- WebVital.FCP,
- WebVital.LCP,
- MobileVital.TIME_TO_FULL_DISPLAY,
- MobileVital.TIME_TO_INITIAL_DISPLAY,
- ].map(n => n.replace('measurements.', ''));
- const MEASUREMENT_ACRONYM_MAPPING = {
- [MobileVital.TIME_TO_FULL_DISPLAY.replace('measurements.', '')]: 'TTFD',
- [MobileVital.TIME_TO_INITIAL_DISPLAY.replace('measurements.', '')]: 'TTID',
- };
- const MEASUREMENT_THRESHOLDS = {
- [WebVital.TTFB.replace('measurements.', '')]: 600,
- [WebVital.FP.replace('measurements.', '')]: 3000,
- [WebVital.FCP.replace('measurements.', '')]: 3000,
- [WebVital.LCP.replace('measurements.', '')]: 4000,
- [MobileVital.TIME_TO_INITIAL_DISPLAY.replace('measurements.', '')]: 2000,
- };
- export class TraceTree {
- type: 'loading' | 'empty' | 'error' | 'trace' = 'trace';
- root: TraceTreeNode<null> = TraceTreeNode.Root();
- indicators: TraceTree.Indicator[] = [];
- eventsCount: number = 0;
- private _spanPromises: Map<string, Promise<Event>> = new Map();
- private _list: TraceTreeNode<TraceTree.NodeValue>[] = [];
- static Empty() {
- const tree = new TraceTree().build();
- tree.type = 'empty';
- return tree;
- }
- static Loading(metadata: TraceTree.Metadata, tree?: TraceTree | null): TraceTree {
- const t = tree ? TraceTree.FromTree(tree) : makeExampleTrace(metadata);
- t.type = 'loading';
- return t;
- }
- static Error(metadata: TraceTree.Metadata, tree?: TraceTree | null): TraceTree {
- const t = tree ? TraceTree.FromTree(tree) : makeExampleTrace(metadata);
- t.type = 'error';
- return t;
- }
- static FromTree(tree: TraceTree): TraceTree {
- const newTree = new TraceTree();
- newTree.root = tree.root.cloneDeep() as TraceTreeNode<null>;
- newTree.indicators = tree.indicators;
- newTree._list = tree._list;
- return newTree;
- }
- static FromTrace(trace: TraceTree.Trace): TraceTree {
- const tree = new TraceTree();
- let traceStart = Number.POSITIVE_INFINITY;
- let traceEnd = Number.NEGATIVE_INFINITY;
- const traceNode = new TraceTreeNode(tree.root, trace, {
- event_id: undefined,
- project_slug: undefined,
- });
- // Trace is always expanded by default
- tree.root.children.push(traceNode);
- function visit(
- parent: TraceTreeNode<TraceTree.NodeValue | null>,
- value: TraceFullDetailed | TraceTree.TraceError
- ) {
- const node = new TraceTreeNode(parent, value, {
- project_slug: value && 'project_slug' in value ? value.project_slug : undefined,
- event_id: value && 'event_id' in value ? value.event_id : undefined,
- });
- node.canFetch = true;
- tree.eventsCount += 1;
- if (isTraceTransaction(value)) {
- for (const error of value.errors) {
- traceNode.errors.add(error);
- }
- for (const performanceIssue of value.performance_issues) {
- traceNode.performance_issues.add(performanceIssue);
- }
- } else {
- traceNode.errors.add(value);
- }
- if (parent) {
- parent.children.push(node as TraceTreeNode<TraceTree.NodeValue>);
- }
- if ('start_timestamp' in value && value.start_timestamp < traceStart) {
- traceStart = value.start_timestamp;
- }
- if ('timestamp' in value && typeof value.timestamp === 'number') {
- // Errors don't have 'start_timestamp', so we adjust traceStart
- // with an errors 'timestamp'
- if (isTraceError(value)) {
- traceStart = Math.min(value.timestamp, traceStart);
- }
- traceEnd = Math.max(value.timestamp, traceEnd);
- }
- if (value && 'measurements' in value) {
- tree.collectMeasurements(
- traceStart,
- value.measurements as Record<string, Measurement>,
- tree.indicators
- );
- }
- if (value && 'children' in value) {
- for (const child of value.children) {
- visit(node, child);
- }
- }
- return node;
- }
- const transactionQueue = trace.transactions ?? [];
- const orphanErrorsQueue = trace.orphan_errors ?? [];
- let tIdx = 0;
- let oIdx = 0;
- const tLen = transactionQueue.length;
- const oLen = orphanErrorsQueue.length;
- while (tIdx < tLen || oIdx < oLen) {
- const transaction = transactionQueue[tIdx];
- const orphan = orphanErrorsQueue[oIdx];
- if (transaction && orphan) {
- if (
- typeof orphan.timestamp === 'number' &&
- transaction.start_timestamp <= orphan.timestamp
- ) {
- visit(traceNode, transaction);
- tIdx++;
- } else {
- visit(traceNode, orphan);
- oIdx++;
- }
- } else if (transaction) {
- visit(traceNode, transaction);
- tIdx++;
- } else if (orphan) {
- visit(traceNode, orphan);
- oIdx++;
- }
- }
- if (tree.indicators.length > 0) {
- tree.indicators.sort((a, b) => a.start - b.start);
- for (const indicator of tree.indicators) {
- if (indicator.start > traceEnd) {
- traceEnd = indicator.start;
- }
- indicator.start *= traceNode.multiplier;
- }
- }
- traceNode.space = [
- traceStart * traceNode.multiplier,
- (traceEnd - traceStart) * traceNode.multiplier,
- ];
- tree.root.space = [
- traceStart * traceNode.multiplier,
- (traceEnd - traceStart) * traceNode.multiplier,
- ];
- return tree.build();
- }
- get shape(): TraceType {
- const trace = this.root.children[0];
- if (!trace) {
- return TraceType.EMPTY_TRACE;
- }
- if (!isTraceNode(trace)) {
- throw new TypeError('Not trace node');
- }
- const {transactions, orphan_errors} = trace.value;
- const {roots, orphans} = (transactions ?? []).reduce(
- (counts, transaction) => {
- if (isRootTransaction(transaction)) {
- counts.roots++;
- } else {
- counts.orphans++;
- }
- return counts;
- },
- {roots: 0, orphans: 0}
- );
- if (roots === 0) {
- if (orphans > 0) {
- return TraceType.NO_ROOT;
- }
- if (orphan_errors && orphan_errors.length > 0) {
- return TraceType.ONLY_ERRORS;
- }
- return TraceType.EMPTY_TRACE;
- }
- if (roots === 1) {
- if (orphans > 0) {
- return TraceType.BROKEN_SUBTRACES;
- }
- return TraceType.ONE_ROOT;
- }
- if (roots > 1) {
- return TraceType.MULTIPLE_ROOTS;
- }
- throw new Error('Unknown trace type');
- }
- static FromSpans(
- parent: TraceTreeNode<TraceTree.NodeValue>,
- data: Event,
- spans: RawSpanType[],
- options: {sdk: string | undefined} | undefined
- ): TraceTreeNode<TraceTree.NodeValue> {
- parent.invalidate(parent);
- const platformHasMissingSpans = shouldAddMissingInstrumentationSpan(options?.sdk);
- const parentIsSpan = isSpanNode(parent);
- const lookuptable: Record<
- RawSpanType['span_id'],
- TraceTreeNode<TraceTree.Span | TraceTree.Transaction>
- > = {};
- if (parent.spanChildren.length > 0) {
- parent.zoomedIn = true;
- return parent;
- }
- if (parentIsSpan) {
- if (parent.value && 'span_id' in parent.value) {
- lookuptable[parent.value.span_id] = parent as TraceTreeNode<TraceTree.Span>;
- }
- }
- const transactionsToSpanMap = new Map<string, TraceTreeNode<TraceTree.Transaction>>();
- for (const child of parent.children) {
- if (
- isTransactionNode(child) &&
- 'parent_span_id' in child.value &&
- typeof child.value.parent_span_id === 'string'
- ) {
- transactionsToSpanMap.set(child.value.parent_span_id, child);
- }
- continue;
- }
- for (const span of spans) {
- const childTransaction = transactionsToSpanMap.get(span.span_id);
- const spanNodeValue: TraceTree.Span = {
- ...span,
- event: data as EventTransaction,
- childTransaction: childTransaction?.value,
- };
- const node: TraceTreeNode<TraceTree.Span> = new TraceTreeNode(null, spanNodeValue, {
- event_id: undefined,
- project_slug: undefined,
- });
- for (const error of getRelatedSpanErrorsFromTransaction(span, parent)) {
- node.errors.add(error);
- }
- for (const performanceIssue of getRelatedPerformanceIssuesFromTransaction(
- span,
- parent
- )) {
- node.performance_issues.add(performanceIssue);
- }
- // This is the case where the current span is the parent of a txn at the
- // trace level. When zooming into the parent of the txn, we want to place a copy
- // of the txn as a child of the parenting span.
- if (childTransaction) {
- const clonedChildTxn =
- childTransaction.cloneDeep() as unknown as TraceTreeNode<TraceTree.Span>;
- node.spanChildren.push(clonedChildTxn);
- clonedChildTxn.parent = node;
- }
- lookuptable[span.span_id] = node;
- if (span.parent_span_id) {
- const spanParentNode = lookuptable[span.parent_span_id];
- if (spanParentNode) {
- node.parent = spanParentNode;
- if (platformHasMissingSpans) {
- maybeInsertMissingInstrumentationSpan(spanParentNode, node);
- }
- spanParentNode.spanChildren.push(node);
- continue;
- }
- }
- if (platformHasMissingSpans) {
- maybeInsertMissingInstrumentationSpan(parent, node);
- }
- parent.spanChildren.push(node);
- node.parent = parent;
- }
- parent.zoomedIn = true;
- TraceTree.AutogroupSiblingSpanNodes(parent);
- TraceTree.AutogroupDirectChildrenSpanNodes(parent);
- return parent;
- }
- static AutogroupDirectChildrenSpanNodes(
- root: TraceTreeNode<TraceTree.NodeValue>
- ): void {
- const queue = [root];
- while (queue.length > 0) {
- const node = queue.pop()!;
- if (node.children.length > 1 || !isSpanNode(node)) {
- for (const child of node.children) {
- queue.push(child);
- }
- continue;
- }
- const head = node;
- let tail = node;
- let groupMatchCount = 0;
- const errors: TraceErrorType[] = [];
- const performance_issues: TracePerformanceIssue[] = [];
- let start = head.value.start_timestamp;
- let end = head.value.timestamp;
- while (
- tail &&
- tail.children.length === 1 &&
- isSpanNode(tail.children[0]) &&
- tail.children[0].value.op === head.value.op
- ) {
- if ((tail?.errors?.size ?? 0) > 0) {
- errors.push(...tail?.errors);
- }
- if ((tail?.performance_issues?.size ?? 0) > 0) {
- performance_issues.push(...tail.performance_issues);
- }
- // Collect start/end of all nodes in the list
- // so that we can properly render a autogrouped bar that
- // encapsulates all the nodes in the list
- if (tail.value.start_timestamp < start) {
- start = tail.value.start_timestamp;
- }
- if (tail.value.timestamp > end) {
- end = tail.value.timestamp;
- }
- groupMatchCount++;
- tail = tail.children[0];
- }
- // Checking the tail node for errors as it is not included in the grouping
- // while loop, but is hidden when the autogrouped node is collapsed
- if ((tail?.errors?.size ?? 0) > 0) {
- errors.push(...tail?.errors);
- }
- if ((tail?.performance_issues?.size ?? 0) > 0) {
- performance_issues.push(...tail.performance_issues);
- }
- if (groupMatchCount < 1) {
- for (const child of head.children) {
- queue.push(child);
- }
- continue;
- }
- const autoGroupedNode = new ParentAutogroupNode(
- node.parent,
- {
- ...head.value,
- start_timestamp: start,
- timestamp: end,
- autogrouped_by: {
- op: head.value && 'op' in head.value ? head.value.op ?? '' : '',
- },
- },
- {
- event_id: undefined,
- project_slug: undefined,
- },
- head,
- tail
- );
- if (!node.parent) {
- throw new Error('Parent node is missing, this should be unreachable code');
- }
- autoGroupedNode.groupCount = groupMatchCount + 1;
- for (const error of errors) {
- autoGroupedNode.errors.add(error);
- }
- for (const performanceIssue of performance_issues) {
- autoGroupedNode.performance_issues.add(performanceIssue);
- }
- autoGroupedNode.space = [
- start * autoGroupedNode.multiplier,
- (end - start) * autoGroupedNode.multiplier,
- ];
- for (const c of tail.children) {
- c.parent = autoGroupedNode;
- queue.push(c);
- }
- const index = node.parent.children.indexOf(node);
- node.parent.children[index] = autoGroupedNode;
- }
- }
- static AutogroupSiblingSpanNodes(root: TraceTreeNode<TraceTree.NodeValue>): void {
- const queue = [root];
- while (queue.length > 0) {
- const node = queue.pop()!;
- for (const child of node.children) {
- queue.push(child);
- }
- if (node.children.length < 5) {
- continue;
- }
- let index = 0;
- let matchCount = 0;
- while (index < node.children.length) {
- const current = node.children[index] as TraceTreeNode<TraceTree.Span>;
- const next = node.children[index + 1] as TraceTreeNode<TraceTree.Span>;
- if (
- next &&
- next.children.length === 0 &&
- current.children.length === 0 &&
- next.value.op === current.value.op &&
- next.value.description === current.value.description
- ) {
- matchCount++;
- // If the next node is the last node in the list, we keep iterating
- if (index + 1 < node.children.length) {
- index++;
- continue;
- }
- }
- if (matchCount >= 4) {
- const autoGroupedNode = new SiblingAutogroupNode(
- node,
- {
- ...current.value,
- autogrouped_by: {
- op: current.value.op ?? '',
- description: current.value.description ?? '',
- },
- },
- {
- event_id: undefined,
- project_slug: undefined,
- }
- );
- autoGroupedNode.groupCount = matchCount + 1;
- const start = index - matchCount;
- let start_timestamp = Number.MAX_SAFE_INTEGER;
- let timestamp = Number.MIN_SAFE_INTEGER;
- for (let j = start; j < start + matchCount + 1; j++) {
- const child = node.children[j];
- if (
- child.value &&
- 'timestamp' in child.value &&
- typeof child.value.timestamp === 'number' &&
- child.value.timestamp > timestamp
- ) {
- timestamp = child.value.timestamp;
- }
- if (
- child.value &&
- 'start_timestamp' in child.value &&
- typeof child.value.start_timestamp === 'number' &&
- child.value.start_timestamp < start_timestamp
- ) {
- start_timestamp = child.value.start_timestamp;
- }
- if (!isSpanNode(child)) {
- throw new TypeError(
- 'Expected child of autogrouped node to be a span node.'
- );
- }
- if (child.has_errors) {
- for (const error of child.errors) {
- autoGroupedNode.errors.add(error);
- }
- for (const performanceIssue of child.performance_issues) {
- autoGroupedNode.performance_issues.add(performanceIssue);
- }
- }
- autoGroupedNode.children.push(node.children[j]);
- autoGroupedNode.children[autoGroupedNode.children.length - 1].parent =
- autoGroupedNode;
- }
- autoGroupedNode.space = [
- start_timestamp * autoGroupedNode.multiplier,
- (timestamp - start_timestamp) * autoGroupedNode.multiplier,
- ];
- node.children.splice(start, matchCount + 1, autoGroupedNode);
- index = start + 1;
- matchCount = 0;
- } else {
- index++;
- matchCount = 0;
- }
- }
- }
- }
- collectMeasurements(
- start_timestamp: number,
- measurements: Record<string, Measurement>,
- indicators: TraceTree.Indicator[]
- ): void {
- for (const measurement of RENDERABLE_MEASUREMENTS) {
- const value = measurements[measurement];
- if (!value) {
- continue;
- }
- const timestamp = measurementToTimestamp(
- start_timestamp,
- value.value,
- value.unit ?? 'millisecond'
- );
- indicators.push({
- start: timestamp,
- duration: 0,
- measurement: value,
- poor: MEASUREMENT_THRESHOLDS[measurement]
- ? value.value > MEASUREMENT_THRESHOLDS[measurement]
- : false,
- type: measurement as TraceTree.Indicator['type'],
- label: (MEASUREMENT_ACRONYM_MAPPING[measurement] ?? measurement).toUpperCase(),
- });
- }
- }
- // Returns boolean to indicate if node was updated
- expand(node: TraceTreeNode<TraceTree.NodeValue>, expanded: boolean): boolean {
- if (expanded === node.expanded) {
- return false;
- }
- // Expanding is not allowed for zoomed in nodes
- if (node.zoomedIn) {
- return false;
- }
- if (node instanceof ParentAutogroupNode) {
- // In parent autogrouping, we perform a node swap and either point the
- // head or tails of the autogrouped sequence to the autogrouped node
- if (node.expanded) {
- const index = this._list.indexOf(node);
- const autogroupedChildren = node.getVisibleChildren();
- this._list.splice(index + 1, autogroupedChildren.length);
- const newChildren = node.tail.getVisibleChildren();
- for (const c of node.tail.children) {
- c.parent = node;
- }
- this._list.splice(index + 1, 0, ...newChildren);
- } else {
- node.head.parent = node;
- const index = this._list.indexOf(node);
- const childrenCount = node.getVisibleChildrenCount();
- this._list.splice(index + 1, childrenCount);
- node.getVisibleChildrenCount();
- const newChildren = [node.head].concat(
- node.head.getVisibleChildren() as TraceTreeNode<TraceTree.Span>[]
- );
- for (const c of node.children) {
- c.parent = node.tail;
- }
- this._list.splice(index + 1, 0, ...newChildren);
- }
- node.invalidate(node);
- node.expanded = expanded;
- return true;
- }
- if (node.expanded) {
- const index = this._list.indexOf(node);
- this._list.splice(index + 1, node.getVisibleChildrenCount());
- // Flip expanded after collecting visible children
- node.expanded = expanded;
- } else {
- const index = this._list.indexOf(node);
- // Flip expanded so that we can collect visible children
- node.expanded = expanded;
- this._list.splice(index + 1, 0, ...node.getVisibleChildren());
- }
- node.expanded = expanded;
- return true;
- }
- zoomIn(
- node: TraceTreeNode<TraceTree.NodeValue>,
- zoomedIn: boolean,
- options: {
- api: Client;
- organization: Organization;
- }
- ): Promise<Event | null> {
- if (zoomedIn === node.zoomedIn) {
- return Promise.resolve(null);
- }
- if (!zoomedIn) {
- const index = this._list.indexOf(node);
- const childrenCount = node.getVisibleChildrenCount();
- this._list.splice(index + 1, childrenCount);
- node.zoomedIn = zoomedIn;
- node.invalidate(node);
- if (node.expanded) {
- this._list.splice(index + 1, 0, ...node.getVisibleChildren());
- }
- return Promise.resolve(null);
- }
- const key = cacheKey(
- options.organization,
- node.metadata.project_slug!,
- node.metadata.event_id!
- );
- const promise =
- this._spanPromises.get(key) ??
- fetchTransactionSpans(
- options.api,
- options.organization,
- node.metadata.project_slug!,
- node.metadata.event_id!
- );
- node.fetchStatus = 'loading';
- promise
- .then(data => {
- node.fetchStatus = 'resolved';
- const spans = data.entries.find(s => s.type === 'spans');
- if (!spans) {
- return data;
- }
- // Remove existing entries from the list
- const index = this._list.indexOf(node);
- if (node.expanded) {
- const childrenCount = node.getVisibleChildrenCount();
- if (childrenCount > 0) {
- this._list.splice(index + 1, childrenCount);
- }
- }
- // Api response is not sorted
- if (spans.data) {
- spans.data.sort((a, b) => a.start_timestamp - b.start_timestamp);
- }
- TraceTree.FromSpans(node, data, spans.data, {sdk: data.sdk?.name});
- const spanChildren = node.getVisibleChildren();
- this._list.splice(index + 1, 0, ...spanChildren);
- return data;
- })
- .catch(_e => {
- node.fetchStatus = 'error';
- });
- this._spanPromises.set(key, promise);
- return promise;
- }
- toList(): TraceTreeNode<TraceTree.NodeValue>[] {
- const list: TraceTreeNode<TraceTree.NodeValue>[] = [];
- function visit(node: TraceTreeNode<TraceTree.NodeValue>) {
- list.push(node);
- if (!node.expanded) {
- return;
- }
- for (const child of node.children) {
- visit(child);
- }
- }
- for (const child of this.root.children) {
- visit(child);
- }
- return list;
- }
- get list(): ReadonlyArray<TraceTreeNode<TraceTree.NodeValue>> {
- return this._list;
- }
- /**
- * Prints the tree in a human readable format, useful for debugging and testing
- */
- print() {
- // root nodes are -1 indexed, so we add 1 to the depth so .repeat doesnt throw
- const print = this.list
- .map(t => printNode(t, 0))
- .filter(Boolean)
- .join('\n');
- // eslint-disable-next-line no-console
- console.log(print);
- }
- build() {
- this._list = this.toList();
- return this;
- }
- }
- export class TraceTreeNode<T extends TraceTree.NodeValue> {
- canFetch: boolean = false;
- fetchStatus: 'resolved' | 'error' | 'idle' | 'loading' = 'idle';
- parent: TraceTreeNode<TraceTree.NodeValue> | null = null;
- value: T;
- expanded: boolean = false;
- zoomedIn: boolean = false;
- metadata: TraceTree.Metadata = {
- project_slug: undefined,
- event_id: undefined,
- };
- errors: Set<TraceErrorType> = new Set<TraceErrorType>();
- performance_issues: Set<TracePerformanceIssue> = new Set<TracePerformanceIssue>();
- multiplier: number;
- space: [number, number] | null = null;
- profiles: TraceTree.Profile[] = [];
- private unit: 'milliseconds' = 'milliseconds';
- private _depth: number | undefined;
- private _children: TraceTreeNode<TraceTree.NodeValue>[] = [];
- private _spanChildren: TraceTreeNode<
- TraceTree.Span | TraceTree.MissingInstrumentationSpan
- >[] = [];
- private _connectors: number[] | undefined = undefined;
- constructor(
- parent: TraceTreeNode<TraceTree.NodeValue> | null,
- value: T,
- metadata: TraceTree.Metadata
- ) {
- this.parent = parent ?? null;
- this.value = value;
- this.metadata = metadata;
- this.multiplier = this.unit === 'milliseconds' ? 1e3 : 1;
- if (value && 'timestamp' in value && 'start_timestamp' in value) {
- this.space = [
- value.start_timestamp * this.multiplier,
- (value.timestamp - value.start_timestamp) * this.multiplier,
- ];
- } else if (value && 'timestamp' in value && typeof value.timestamp === 'number') {
- this.space = [value.timestamp * this.multiplier, 0];
- }
- if (
- isTraceErrorNode(this) &&
- 'timestamp' in this.value &&
- typeof this.value.timestamp === 'number'
- ) {
- this.space = [this.value.timestamp * this.multiplier, 0];
- }
- if (value && 'profile_id' in value && typeof value.profile_id === 'string') {
- this.profiles.push({profile_id: value.profile_id, space: this.space ?? [0, 0]});
- }
- if (isTransactionNode(this)) {
- this.canFetch = true;
- }
- if (isTransactionNode(this) || isTraceNode(this) || isSpanNode(this)) {
- this.expanded = true;
- }
- if (shouldCollapseNodeByDefault(this)) {
- this.expanded = false;
- }
- if (isTransactionNode(this)) {
- this.errors = new Set(this.value.errors);
- this.performance_issues = new Set(this.value.performance_issues);
- }
- // For error nodes, its value is the only associated issue.
- if (isTraceErrorNode(this)) {
- this.errors = new Set([this.value]);
- }
- }
- cloneDeep(): TraceTreeNode<T> | ParentAutogroupNode | SiblingAutogroupNode {
- let node: TraceTreeNode<T> | ParentAutogroupNode | SiblingAutogroupNode;
- if (isParentAutogroupedNode(this)) {
- node = new ParentAutogroupNode(
- this.parent,
- this.value,
- this.metadata,
- this.head,
- this.tail
- );
- node.groupCount = this.groupCount;
- } else {
- node = new TraceTreeNode(this.parent, this.value, this.metadata);
- }
- if (!node) {
- throw new Error('CloneDeep is not implemented');
- }
- node.expanded = this.expanded;
- node.zoomedIn = this.zoomedIn;
- node.canFetch = this.canFetch;
- node.space = this.space;
- node.metadata = this.metadata;
- if (isParentAutogroupedNode(node)) {
- node.head = node.head.cloneDeep() as TraceTreeNode<TraceTree.Span>;
- node.tail = node.tail.cloneDeep() as TraceTreeNode<TraceTree.Span>;
- node.head.parent = node;
- // If the node is not expanded, the parent of the tail points to the
- // autogrouped node. If the node is expanded, the parent of the children
- // of the tail points to the autogrouped node.
- if (!node.expanded) {
- for (const c of node.tail.children) {
- c.parent = node;
- }
- } else {
- for (const c of node.children) {
- c.parent = node.tail;
- }
- }
- node.head.parent = node;
- node.tail.parent = node;
- } else {
- for (const child of this.children) {
- const childClone = child.cloneDeep() as TraceTreeNode<TraceTree.Span>;
- node.children.push(childClone);
- childClone.parent = node;
- }
- }
- return node;
- }
- get isOrphaned() {
- return this.parent?.value && 'orphan_errors' in this.parent.value;
- }
- get isLastChild() {
- if (!this.parent || this.parent.children.length === 0) {
- return true;
- }
- return this.parent.children[this.parent.children.length - 1] === this;
- }
- /**
- * Return a lazily calculated depth of the node in the tree.
- * Root node has a value of -1 as it is abstract.
- */
- get depth(): number {
- if (typeof this._depth === 'number') {
- return this._depth;
- }
- let depth = -2;
- let node: TraceTreeNode<any> | null = this;
- while (node) {
- if (typeof node.parent?.depth === 'number') {
- this._depth = node.parent.depth + 1;
- return this._depth;
- }
- depth++;
- node = node.parent;
- }
- this._depth = depth;
- return this._depth;
- }
- get has_errors(): boolean {
- return this.errors.size > 0 || this.performance_issues.size > 0;
- }
- get parent_transaction(): TraceTreeNode<TraceTree.Transaction> | null {
- let node: TraceTreeNode<TraceTree.NodeValue> | null = this.parent;
- while (node) {
- if (isTransactionNode(node)) {
- return node;
- }
- node = node.parent;
- }
- return null;
- }
- /**
- * Returns the depth levels at which the row should draw vertical connectors
- * negative values mean connector points to an orphaned node
- */
- get connectors(): number[] {
- if (this._connectors !== undefined) {
- return this._connectors!;
- }
- this._connectors = [];
- if (!this.parent) {
- return this._connectors;
- }
- if (this.parent?.connectors !== undefined) {
- this._connectors = [...this.parent.connectors];
- if (this.isLastChild || this.value === null) {
- return this._connectors;
- }
- this.connectors.push(this.isOrphaned ? -this.depth : this.depth);
- return this._connectors;
- }
- let node: TraceTreeNode<T> | TraceTreeNode<TraceTree.NodeValue> | null = this.parent;
- while (node) {
- if (node.value === null) {
- break;
- }
- if (node.isLastChild) {
- node = node.parent;
- continue;
- }
- this._connectors.push(node.isOrphaned ? -node.depth : node.depth);
- node = node.parent;
- }
- return this._connectors;
- }
- /**
- * Returns the children that the node currently points to.
- * The logic here is a consequence of the tree design, where we want to be able to store
- * both transaction and span nodes in the same tree. This results in an annoying API where
- * we either store span children separately or transaction children separately. A better design
- * would have been to create an invisible meta node that always points to the correct children.
- */
- get children(): TraceTreeNode<TraceTree.NodeValue>[] {
- if (isAutogroupedNode(this)) {
- return this._children;
- }
- if (isSpanNode(this)) {
- return this.canFetch && !this.zoomedIn ? [] : this.spanChildren;
- }
- if (isTransactionNode(this)) {
- return this.zoomedIn ? this._spanChildren : this._children;
- }
- return this._children;
- }
- set children(children: TraceTreeNode<TraceTree.NodeValue>[]) {
- this._children = children;
- }
- get spanChildren(): TraceTreeNode<
- TraceTree.Span | TraceTree.MissingInstrumentationSpan
- >[] {
- return this._spanChildren;
- }
- /**
- * Invalidate the visual data used to render the tree, forcing it
- * to be recalculated on the next render. This is useful when for example
- * the tree is expanded or collapsed, or when the tree is mutated and
- * the visual data is no longer valid as the indentation changes
- */
- invalidate(root?: TraceTreeNode<TraceTree.NodeValue>) {
- this._connectors = undefined;
- this._depth = undefined;
- if (root) {
- const queue = [...this.children];
- if (isParentAutogroupedNode(this)) {
- queue.push(this.head);
- }
- while (queue.length > 0) {
- const next = queue.pop()!;
- next.invalidate();
- if (isParentAutogroupedNode(next)) {
- queue.push(next.head);
- }
- for (let i = 0; i < next.children.length; i++) {
- queue.push(next.children[i]);
- }
- }
- }
- }
- getVisibleChildrenCount(): number {
- const stack: TraceTreeNode<TraceTree.NodeValue>[] = [];
- let count = 0;
- if (
- this.expanded ||
- isParentAutogroupedNode(this) ||
- isMissingInstrumentationNode(this)
- ) {
- for (let i = this.children.length - 1; i >= 0; i--) {
- stack.push(this.children[i]);
- }
- }
- while (stack.length > 0) {
- const node = stack.pop()!;
- count++;
- // Since we're using a stack and it's LIFO, reverse the children before pushing them
- // to ensure they are processed in the original left-to-right order.
- if (node.expanded || isParentAutogroupedNode(node)) {
- for (let i = node.children.length - 1; i >= 0; i--) {
- stack.push(node.children[i]);
- }
- }
- }
- return count;
- }
- getVisibleChildren(): TraceTreeNode<TraceTree.NodeValue>[] {
- const stack: TraceTreeNode<TraceTree.NodeValue>[] = [];
- const children: TraceTreeNode<TraceTree.NodeValue>[] = [];
- if (
- this.expanded ||
- isParentAutogroupedNode(this) ||
- isMissingInstrumentationNode(this)
- ) {
- for (let i = this.children.length - 1; i >= 0; i--) {
- stack.push(this.children[i]);
- }
- }
- while (stack.length > 0) {
- const node = stack.pop()!;
- children.push(node);
- // Since we're using a stack and it's LIFO, reverse the children before pushing them
- // to ensure they are processed in the original left-to-right order.
- if (node.expanded || isParentAutogroupedNode(node)) {
- for (let i = node.children.length - 1; i >= 0; i--) {
- stack.push(node.children[i]);
- }
- }
- }
- return children;
- }
- // Returns the min path required to reach the node from the root.
- // @TODO: skip nodes that do not require fetching
- get path(): TraceTree.NodePath[] {
- const nodes: TraceTreeNode<TraceTree.NodeValue>[] = [this];
- let current: TraceTreeNode<TraceTree.NodeValue> | null = this.parent;
- if (isSpanNode(this) || isAutogroupedNode(this)) {
- while (
- current &&
- (isSpanNode(current) || (isAutogroupedNode(current) && !current.expanded))
- ) {
- current = current.parent;
- }
- }
- while (current) {
- if (isTransactionNode(current)) {
- nodes.push(current);
- }
- if (isSpanNode(current)) {
- nodes.push(current);
- while (current.parent) {
- if (isTransactionNode(current.parent)) {
- break;
- }
- if (isAutogroupedNode(current.parent) && current.parent.expanded) {
- break;
- }
- current = current.parent;
- }
- }
- if (isAutogroupedNode(current)) {
- nodes.push(current);
- }
- current = current.parent;
- }
- return nodes.map(nodeToId);
- }
- print() {
- // root nodes are -1 indexed, so we add 1 to the depth so .repeat doesnt throw
- const offset = this.depth === -1 ? 1 : 0;
- const nodes = [this, ...this.getVisibleChildren()];
- const print = nodes
- .map(t => printNode(t, offset))
- .filter(Boolean)
- .join('\n');
- // eslint-disable-next-line no-console
- console.log(print);
- }
- static Find(
- root: TraceTreeNode<TraceTree.NodeValue>,
- predicate: (node: TraceTreeNode<TraceTree.NodeValue>) => boolean
- ): TraceTreeNode<TraceTree.NodeValue> | null {
- const queue = [root];
- while (queue.length > 0) {
- const next = queue.pop()!;
- if (predicate(next)) return next;
- for (const child of next.children) {
- queue.push(child);
- }
- }
- return null;
- }
- static Root() {
- return new TraceTreeNode(null, null, {
- event_id: undefined,
- project_slug: undefined,
- });
- }
- }
- export class MissingInstrumentationNode extends TraceTreeNode<TraceTree.MissingInstrumentationSpan> {
- next: TraceTreeNode<TraceTree.Span>;
- previous: TraceTreeNode<TraceTree.Span>;
- constructor(
- parent: TraceTreeNode<TraceTree.NodeValue>,
- node: TraceTree.MissingInstrumentationSpan,
- metadata: TraceTree.Metadata,
- previous: TraceTreeNode<TraceTree.Span>,
- next: TraceTreeNode<TraceTree.Span>
- ) {
- super(parent, node, metadata);
- this.next = next;
- this.previous = previous;
- }
- }
- export class ParentAutogroupNode extends TraceTreeNode<TraceTree.ChildrenAutogroup> {
- head: TraceTreeNode<TraceTree.Span>;
- tail: TraceTreeNode<TraceTree.Span>;
- groupCount: number = 0;
- profiles: TraceTree.Profile[] = [];
- private _autogroupedSegments: [number, number][] | undefined;
- constructor(
- parent: TraceTreeNode<TraceTree.NodeValue> | null,
- node: TraceTree.ChildrenAutogroup,
- metadata: TraceTree.Metadata,
- head: TraceTreeNode<TraceTree.Span>,
- tail: TraceTreeNode<TraceTree.Span>
- ) {
- super(parent, node, metadata);
- this.expanded = false;
- this.head = head;
- this.tail = tail;
- }
- get children() {
- if (this.expanded) {
- return [this.head];
- }
- return this.tail.children;
- }
- get has_errors(): boolean {
- return this.errors.size > 0 || this.performance_issues.size > 0;
- }
- get autogroupedSegments(): [number, number][] {
- if (this._autogroupedSegments) {
- return this._autogroupedSegments;
- }
- const children: TraceTreeNode<TraceTree.NodeValue>[] = [];
- let start: TraceTreeNode<TraceTree.NodeValue> | undefined = this.head;
- while (start && start !== this.tail) {
- children.push(start);
- start = start.children[0];
- }
- children.push(this.tail);
- this._autogroupedSegments = computeAutogroupedBarSegments(children);
- return this._autogroupedSegments;
- }
- }
- export class SiblingAutogroupNode extends TraceTreeNode<TraceTree.SiblingAutogroup> {
- groupCount: number = 0;
- profiles: TraceTree.Profile[] = [];
- private _autogroupedSegments: [number, number][] | undefined;
- constructor(
- parent: TraceTreeNode<TraceTree.NodeValue> | null,
- node: TraceTree.SiblingAutogroup,
- metadata: TraceTree.Metadata
- ) {
- super(parent, node, metadata);
- this.expanded = false;
- }
- get has_errors(): boolean {
- return this.errors.size > 0 || this.performance_issues.size > 0;
- }
- get autogroupedSegments(): [number, number][] {
- if (this._autogroupedSegments) {
- return this._autogroupedSegments;
- }
- this._autogroupedSegments = computeAutogroupedBarSegments(this.children);
- return this._autogroupedSegments;
- }
- }
- function partialTransaction(
- partial: Partial<TraceTree.Transaction>
- ): TraceTree.Transaction {
- return {
- start_timestamp: 0,
- timestamp: 0,
- errors: [],
- performance_issues: [],
- parent_span_id: '',
- span_id: '',
- parent_event_id: '',
- project_id: 0,
- 'transaction.duration': 0,
- 'transaction.op': 'db',
- 'transaction.status': 'ok',
- generation: 0,
- project_slug: '',
- event_id: `event_id`,
- transaction: `transaction`,
- children: [],
- ...partial,
- };
- }
- export function makeExampleTrace(metadata: TraceTree.Metadata): TraceTree {
- const trace: TraceTree.Trace = {
- transactions: [],
- orphan_errors: [],
- };
- function randomBetween(min: number, max: number) {
- return Math.floor(Math.random() * (max - min + 1) + min);
- }
- let start = new Date().getTime();
- const root = partialTransaction({
- ...metadata,
- generation: 0,
- start_timestamp: start,
- transaction: 'root transaction',
- timestamp: start + randomBetween(100, 200),
- });
- trace.transactions.push(root);
- for (let i = 0; i < 50; i++) {
- const end = start + randomBetween(100, 200);
- const nest = i > 0 && Math.random() > 0.33;
- if (nest) {
- const parent = root.children[root.children.length - 1];
- parent.children.push(
- partialTransaction({
- ...metadata,
- generation: 0,
- start_timestamp: start,
- transaction: `parent transaction ${i}`,
- timestamp: end,
- })
- );
- parent.timestamp = end;
- } else {
- root.children.push(
- partialTransaction({
- ...metadata,
- generation: 0,
- start_timestamp: start,
- transaction: 'loading...',
- ['transaction.op']: 'loading',
- timestamp: end,
- })
- );
- }
- start = end;
- }
- const tree = TraceTree.FromTrace(trace);
- return tree;
- }
- function nodeToId(n: TraceTreeNode<TraceTree.NodeValue>): TraceTree.NodePath {
- if (isTransactionNode(n)) {
- return `txn:${n.value.event_id}`;
- }
- if (isSpanNode(n)) {
- return `span:${n.value.span_id}`;
- }
- if (isAutogroupedNode(n)) {
- if (isParentAutogroupedNode(n)) {
- return `ag:${n.head.value.span_id}`;
- }
- if (isSiblingAutogroupedNode(n)) {
- const child = n.children[0];
- if (isSpanNode(child)) {
- return `ag:${child.value.span_id}`;
- }
- }
- }
- if (isTraceNode(n)) {
- return `trace:root`;
- }
- if (isTraceErrorNode(n)) {
- return `error:${n.value.event_id}`;
- }
- if (isRootNode(n)) {
- throw new Error('A path to root node does not exist as the node is virtual');
- }
- if (isMissingInstrumentationNode(n)) {
- if (n.previous) {
- return `ms:${n.previous.value.span_id}`;
- }
- if (n.next) {
- return `ms:${n.next.value.span_id}`;
- }
- throw new Error('Missing instrumentation node must have a previous or next node');
- }
- throw new Error('Not implemented');
- }
- export function computeAutogroupedBarSegments(
- nodes: TraceTreeNode<TraceTree.NodeValue>[]
- ): [number, number][] {
- if (nodes.length === 0) {
- return [];
- }
- if (nodes.length === 1) {
- const space = nodes[0].space;
- if (!space) {
- throw new Error(
- 'Autogrouped node child has no defined space. This should not happen.'
- );
- }
- return [space];
- }
- const first = nodes[0];
- const multiplier = first.multiplier;
- if (!isSpanNode(first)) {
- throw new Error('Autogrouped node must have span children');
- }
- const segments: [number, number][] = [];
- let start = first.value.start_timestamp;
- let end = first.value.timestamp;
- let i = 1;
- while (i < nodes.length) {
- const next = nodes[i];
- if (!isSpanNode(next)) {
- throw new Error('Autogrouped node must have span children');
- }
- if (next.value.start_timestamp > end) {
- segments.push([start * multiplier, (end - start) * multiplier]);
- start = next.value.start_timestamp;
- end = next.value.timestamp;
- i++;
- } else {
- end = next.value.timestamp;
- i++;
- }
- }
- segments.push([start * multiplier, (end - start) * multiplier]);
- return segments;
- }
- // Returns a list of errors related to the txn with ids matching the span id
- function getRelatedSpanErrorsFromTransaction(
- span: RawSpanType,
- node?: TraceTreeNode<TraceTree.NodeValue>
- ): TraceErrorType[] {
- if (!node || !node.value || !isTransactionNode(node)) {
- return [];
- }
- if (!node?.value?.errors?.length) {
- return [];
- }
- const errors: TraceErrorType[] = [];
- for (const error of node.value.errors) {
- if (error.span === span.span_id) {
- errors.push(error);
- }
- }
- return errors;
- }
- // Returns a list of performance errors related to the txn with ids matching the span id
- function getRelatedPerformanceIssuesFromTransaction(
- span: RawSpanType,
- node?: TraceTreeNode<TraceTree.NodeValue>
- ): TracePerformanceIssue[] {
- if (!node || !node.value || !isTransactionNode(node)) {
- return [];
- }
- if (!node?.value?.performance_issues?.length && !node?.value?.errors?.length) {
- return [];
- }
- const performanceIssues: TracePerformanceIssue[] = [];
- for (const perfIssue of node.value.performance_issues) {
- for (const s of perfIssue.span) {
- if (s === span.span_id) {
- performanceIssues.push(perfIssue);
- }
- }
- for (const suspect of perfIssue.suspect_spans) {
- if (suspect === span.span_id) {
- performanceIssues.push(perfIssue);
- }
- }
- }
- return performanceIssues;
- }
- function printNode(t: TraceTreeNode<TraceTree.NodeValue>, offset: number): string {
- // +1 because we may be printing from the root which is -1 indexed
- const padding = ' '.repeat(t.depth + offset);
- if (isAutogroupedNode(t)) {
- if (isParentAutogroupedNode(t)) {
- return padding + `parent autogroup (${t.groupCount})`;
- }
- if (isSiblingAutogroupedNode(t)) {
- return padding + `sibling autogroup (${t.groupCount})`;
- }
- return padding + 'autogroup';
- }
- if (isSpanNode(t)) {
- return padding + (t.value.op || t.value.span_id || 'unknown span');
- }
- if (isTransactionNode(t)) {
- return padding + (t.value.transaction || 'unknown transaction');
- }
- if (isMissingInstrumentationNode(t)) {
- return padding + 'missing_instrumentation';
- }
- if (isRootNode(t)) {
- return padding + 'Root';
- }
- if (isTraceNode(t)) {
- return padding + 'Trace';
- }
- if (isTraceErrorNode(t)) {
- return padding + (t.value.event_id || t.value.level) || 'unknown trace error';
- }
- return 'unknown node';
- }
|