Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 | 817x 72x 745x 373x 372x 36x 36x 36x 336x 336x 336x 336x 33x 228x 210x 6x 11x 44x 11x 44x 11x 72x 11x 5936x 2966x 2966x 2962x 2966x 2966x 2962x 2966x 2488x 2966x 607x 607x 2966x 17x 629x 629x 2949x 629x 629x 629x 315x 315x 303x 303x 315x 315x 315x 297x 315x 313x 313x 315x 315x 15x 8x 7x 1x 1x 1x 6x 14x 14x 14x 8x 6x 33x 15x 15x 19x 19x 3x 16x 16x 16x 16x 3x 16x 19x 10x 10x 10x 33x 33x 6x 6x 6x 6x 6x 6x 6x 6x 6x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 33x | /**
* Trace-specific formatters
*
* Provides formatting utilities for displaying Sentry traces in the CLI.
* Includes flat span utilities for `span list` and `span view` commands.
*/
import type {
SpanListItem,
TraceSpan,
TransactionListItem,
} from "../../types/index.js";
import type { TraceItemDetail } from "../api/traces.js";
import { REDUNDANT_DETAIL_ATTRS } from "../api/traces.js";
import {
colorTag,
escapeMarkdownCell,
escapeMarkdownInline,
mdKvTable,
mdRow,
mdTableHeader,
renderInlineMarkdown,
renderMarkdown,
} from "./markdown.js";
import { colorizeSql, formatSqlBlock, isDbSpanOp } from "./sql.js";
import { type Column, formatTable } from "./table.js";
import { renderTextTable } from "./text-table.js";
import { computeSpanDurationMs, formatRelativeTime } from "./time-utils.js";
/**
* Format a duration in milliseconds to a human-readable string.
*
* - < 1s: "245ms"
* - < 60s: "1.24s"
* - >= 60s: "2m 15s"
*
* @param ms - Duration in milliseconds
* @returns Formatted duration string
*/
export function formatTraceDuration(ms: number): string {
if (!Number.isFinite(ms) || ms < 0) {
return "—";
}
if (ms < 1000) {
return `${Math.round(ms)}ms`;
}
if (ms < 60_000) {
// Check if toFixed(2) would round up to 60.00s
const secs = Number((ms / 1000).toFixed(2));
Eif (secs < 60) {
return `${secs.toFixed(2)}s`;
}
// Fall through to minutes format
}
// Round total seconds first, then split into mins/secs to avoid "Xm 60s"
const totalSecs = Math.round(ms / 1000);
const mins = Math.floor(totalSecs / 60);
const secs = totalSecs % 60;
return `${mins}m ${secs}s`;
}
/** Column headers for the streaming trace table (`:` suffix = right-aligned) */
const TRACE_TABLE_COLS = ["Trace ID", "Transaction", "Duration:", "When"];
/**
* Extract the four cell values for a trace row.
*
* Shared by {@link formatTraceRow} (streaming) and {@link formatTraceTable}
* (batch) so cell formatting stays consistent between the two paths.
*
* @param item - Transaction list item from the API
* @returns `[traceId, transaction, duration, when]` markdown-safe strings
*/
export function buildTraceRowCells(
item: TransactionListItem
): [string, string, string, string] {
return [
`\`${item.trace}\``,
escapeMarkdownCell(item.transaction || "unknown"),
formatTraceDuration(item["transaction.duration"]),
formatRelativeTime(item.timestamp),
];
}
/**
* Format a single transaction row for streaming output (follow/live mode).
*
* In plain mode (non-TTY / `SENTRY_PLAIN_OUTPUT=1`): emits a markdown table
* row so streamed output composes into a valid CommonMark document.
* In rendered mode (TTY): emits ANSI-styled text via `mdRow`.
*
* @param item - Transaction list item from the API
* @returns Formatted row string with newline
*/
export function formatTraceRow(item: TransactionListItem): string {
return mdRow(buildTraceRowCells(item));
}
/**
* Format column header for traces list in plain (non-TTY) mode.
*
* Emits a proper markdown table header + separator row so that
* the streamed rows compose into a valid CommonMark document when redirected.
* In TTY mode, use StreamingTable for row-by-row output instead.
*
* @returns Header string (includes trailing newline)
*/
export function formatTracesHeader(): string {
return `${mdTableHeader(TRACE_TABLE_COLS)}\n`;
}
/**
* Build a rendered markdown table for a batch list of trace transactions.
*
* Uses {@link buildTraceRowCells} to share cell formatting with
* {@link formatTraceRow}. Pre-rendered ANSI codes are preserved through the
* pipeline via cli-table3's `string-width`-aware column sizing.
*
* @param items - Transaction list items from the API
* @returns Rendered terminal string with Unicode-bordered table
*/
export function formatTraceTable(items: TransactionListItem[]): string {
const headers = TRACE_TABLE_COLS.map((c) =>
c.endsWith(":") ? c.slice(0, -1) : c
);
const alignments = TRACE_TABLE_COLS.map((c) =>
c.endsWith(":") ? ("right" as const) : ("left" as const)
);
const rows = items.map((item) =>
buildTraceRowCells(item).map((c) => renderInlineMarkdown(c))
);
return renderTextTable(headers, rows, { alignments });
}
/** Trace summary computed from a span tree */
export type TraceSummary = {
/** The 32-character trace ID */
traceId: string;
/** Total trace duration in milliseconds */
duration: number;
/** Total number of spans in the trace */
spanCount: number;
/** Project slugs involved in the trace */
projects: string[];
/** Root transaction name (e.g., "GET /api/users") */
rootTransaction?: string;
/** Root operation type (e.g., "http.server") */
rootOp?: string;
/** Trace start time as Unix timestamp (seconds) */
startTimestamp: number;
};
/**
* Check whether a timestamp from a span is usable for duration calculations.
* Filters out zero, negative, NaN, and non-finite values that would corrupt
* min/max computations.
*/
function isValidTimestamp(ts: number): boolean {
return Number.isFinite(ts) && ts > 0;
}
/**
* Recursively count spans and collect metadata from a span tree.
*/
function walkSpanTree(
span: TraceSpan,
isRoot: boolean,
state: {
spanCount: number;
minStart: number;
maxEnd: number;
projects: Set<string>;
rootTransaction?: string;
rootOp?: string;
}
): void {
state.spanCount += 1;
// Only use timestamps that are valid positive numbers.
// Some spans have start_timestamp=0 or timestamp=0 which would corrupt
// the min/max calculations and produce NaN/Infinity durations.
if (isValidTimestamp(span.start_timestamp)) {
state.minStart = Math.min(state.minStart, span.start_timestamp);
}
// The API may return `end_timestamp` instead of `timestamp` depending on
// the span source. Prefer `end_timestamp` when present and non-zero,
// fall back to `timestamp`. Use || so that 0 (invalid) falls through.
const endTs = span.end_timestamp || span.timestamp;
if (endTs !== undefined && isValidTimestamp(endTs)) {
state.maxEnd = Math.max(state.maxEnd, endTs);
}
if (span.project_slug) {
state.projects.add(span.project_slug);
}
if (isRoot && !state.rootTransaction) {
state.rootTransaction = span.transaction ?? span.description ?? undefined;
state.rootOp = span["transaction.op"] ?? span.op;
}
for (const child of span.children ?? []) {
walkSpanTree(child, false, state);
}
}
/**
* Compute a summary from a trace span tree.
* Walks the full tree to calculate duration, span count, and involved projects.
*
* Duration is computed from the min `start_timestamp` and max `end_timestamp`
* (or `timestamp`) across all spans. Returns `NaN` duration when no valid
* timestamps are found (e.g., all spans have `start_timestamp: 0`).
*
* @param traceId - The trace ID
* @param spans - Root-level spans from the /trace/ API
* @returns Computed trace summary (duration may be NaN if timestamps are missing)
*/
export function computeTraceSummary(
traceId: string,
spans: TraceSpan[]
): TraceSummary {
const state = {
spanCount: 0,
minStart: Number.POSITIVE_INFINITY,
maxEnd: 0,
projects: new Set<string>(),
rootTransaction: undefined as string | undefined,
rootOp: undefined as string | undefined,
};
for (const span of spans) {
walkSpanTree(span, true, state);
}
// If no valid timestamps were found, minStart stays at +Infinity and maxEnd stays at 0.
// Produce NaN duration in that case so formatTraceDuration() renders "—".
const hasValidRange =
Number.isFinite(state.minStart) &&
state.maxEnd > 0 &&
state.maxEnd >= state.minStart;
const duration = hasValidRange
? (state.maxEnd - state.minStart) * 1000
: Number.NaN;
return {
traceId,
duration,
spanCount: state.spanCount,
projects: [...state.projects],
rootTransaction: state.rootTransaction,
rootOp: state.rootOp,
startTimestamp: state.minStart,
};
}
/**
* Format trace summary for human-readable display as rendered markdown.
* Shows metadata including root transaction, duration, span count, and projects.
*
* @param summary - Computed trace summary
* @returns Rendered terminal string
*/
export function formatTraceSummary(summary: TraceSummary): string {
const kvRows: [string, string][] = [];
if (summary.rootTransaction) {
const opPrefix = summary.rootOp ? `[\`${summary.rootOp}\`] ` : "";
kvRows.push([
"Root",
`${opPrefix}${escapeMarkdownCell(summary.rootTransaction)}`,
]);
}
kvRows.push(["Duration", formatTraceDuration(summary.duration)]);
kvRows.push(["Spans", String(summary.spanCount)]);
if (summary.projects.length > 0) {
kvRows.push(["Projects", summary.projects.join(", ")]);
}
if (Number.isFinite(summary.startTimestamp) && summary.startTimestamp > 0) {
const date = new Date(summary.startTimestamp * 1000);
kvRows.push(["Started", date.toLocaleString("sv-SE")]);
}
const md = `## Trace \`${summary.traceId}\`\n\n${mdKvTable(kvRows)}\n`;
return renderMarkdown(md);
}
// ---------------------------------------------------------------------------
// Flat span utilities (for span list / span view)
// ---------------------------------------------------------------------------
/** Flat span for list output — no nested children */
export type FlatSpan = {
span_id: string;
parent_span_id?: string | null;
op?: string;
description?: string | null;
duration_ms?: number;
start_timestamp: number;
project_slug?: string;
transaction?: string;
/** Custom attributes from --fields (index signature) */
[key: string]: unknown;
};
/** Result of finding a span by ID in the tree */
export type FoundSpan = {
span: TraceSpan;
depth: number;
ancestors: TraceSpan[];
};
/**
* Find a span by ID in the tree, returning the span, its depth, and ancestor chain.
*
* @param spans - Root-level spans from the /trace/ API
* @param spanId - The span ID to search for
* @returns Found span with depth and ancestors (root→parent), or null
*/
export function findSpanById(
spans: TraceSpan[],
spanId: string
): FoundSpan | null {
function search(
span: TraceSpan,
depth: number,
ancestors: TraceSpan[]
): FoundSpan | null {
if (span.span_id?.toLowerCase() === spanId) {
return { span, depth, ancestors };
}
for (const child of span.children ?? []) {
const found = search(child, depth + 1, [...ancestors, span]);
Eif (found) {
return found;
}
}
return null;
}
for (const root of spans) {
const found = search(root, 0, []);
if (found) {
return found;
}
}
return null;
}
/** Map of CLI shorthand keys to Sentry API span attribute names */
const SPAN_KEY_ALIASES: Record<string, string> = {
op: "span.op",
duration: "span.duration",
};
/**
* Translate CLI shorthand query keys to Sentry API span attribute names.
* Bare words pass through unchanged (server treats them as free-text search).
*
* @param query - Raw query string from --query flag
* @returns Translated query for the spans API
*/
export function translateSpanQuery(query: string): string {
const tokens = query.match(/(?:[^\s"]+|"[^"]*")+/g) ?? [];
return tokens
.map((token) => {
const colonIdx = token.indexOf(":");
if (colonIdx === -1) {
return token;
}
let key = token.slice(0, colonIdx).toLowerCase();
const rest = token.slice(colonIdx);
// Strip negation prefix before alias lookup, re-add after
const negated = key.startsWith("!");
if (negated) {
key = key.slice(1);
}
const resolved = SPAN_KEY_ALIASES[key] ?? key;
return (negated ? "!" : "") + resolved + rest;
})
.join(" ");
}
/**
* Map a SpanListItem from the EAP spans endpoint to a FlatSpan for display.
*
* When `extraFieldNames` are provided (from `--fields` API expansion), the
* corresponding values are copied from the raw API item into the flat span.
* Known output fields are never overwritten by extra fields.
*
* @param item - Span item from the spans search API
* @param extraFieldNames - Additional API field names to copy into the flat span
* @returns FlatSpan suitable for table display
*/
export function spanListItemToFlatSpan(
item: SpanListItem,
extraFieldNames?: string[]
): FlatSpan {
const flat: FlatSpan = {
span_id: item.id,
parent_span_id: item.parent_span ?? undefined,
op: item["span.op"] ?? undefined,
description: item.description ?? undefined,
duration_ms: item["span.duration"] ?? undefined,
start_timestamp: new Date(item.timestamp).getTime() / 1000,
project_slug: item.project,
transaction: item.transaction ?? undefined,
};
Iif (extraFieldNames) {
const raw = item as Record<string, unknown>;
for (const name of extraFieldNames) {
if (name in raw && !(name in flat)) {
flat[name] = raw[name];
}
}
}
return flat;
}
/**
* Project column — auto-prepended when spans come from multiple projects.
* @see formatSpanTable
*/
const PROJECT_COLUMN: Column<FlatSpan> = {
header: "Project",
value: (s) => escapeMarkdownCell(s.project_slug || "—"),
minWidth: 8,
};
/** Column definitions for the flat span table */
const SPAN_TABLE_COLUMNS: Column<FlatSpan>[] = [
{
header: "Span ID",
value: (s) => `\`${s.span_id}\``,
minWidth: 18,
shrinkable: false,
},
{
header: "Op",
value: (s) => escapeMarkdownCell(s.op || "—"),
minWidth: 6,
},
{
header: "Description",
value: (s) => {
const desc = s.description || "(no description)";
return escapeMarkdownCell(isDbSpanOp(s.op) ? colorizeSql(desc) : desc);
},
truncate: true,
},
{
header: "Duration",
value: (s) =>
s.duration_ms !== undefined ? formatTraceDuration(s.duration_ms) : "—",
align: "right",
minWidth: 8,
shrinkable: false,
},
];
/**
* Build dynamic columns for extra attributes requested via `--fields`.
*
* Each extra field gets a column whose value is stringified from the flat
* span's index-signature entry, falling back to "—" when absent.
*/
function buildExtraColumns(extraColumns: string[]): Column<FlatSpan>[] {
return extraColumns.map((name) => ({
header: name,
value: (s: FlatSpan) => {
const v = s[name];
if (v === undefined || v === null) {
return "—";
}
return escapeMarkdownCell(String(v));
},
}));
}
/**
* Format a flat span list as a rendered table string.
*
* When spans come from multiple projects, a "Project" column is automatically
* prepended so the user can see which service each span belongs to.
*
* When `extraColumns` are provided, additional columns are appended after the
* standard columns for custom attributes requested via `--fields`.
*
* Prefer this in return-based command output pipelines.
* Uses {@link formatTable} (return-based) internally.
*
* @param spans - Flat span array to display
* @param extraColumns - Additional column names from --fields API expansion
* @returns Rendered table string
*/
export function formatSpanTable(
spans: FlatSpan[],
extraColumns?: string[]
): string {
// Auto-add Project column when spans come from multiple projects
const projects = new Set(spans.map((s) => s.project_slug).filter(Boolean));
const baseColumns =
projects.size > 1
? [PROJECT_COLUMN, ...SPAN_TABLE_COLUMNS]
: SPAN_TABLE_COLUMNS;
const columns = extraColumns?.length
? [...baseColumns, ...buildExtraColumns(extraColumns)]
: baseColumns;
return formatTable(spans, columns, { truncate: true });
}
/**
* Build key-value rows for a span's metadata.
*/
function buildSpanKvRows(span: TraceSpan, traceId: string): [string, string][] {
const kvRows: [string, string][] = [];
kvRows.push(["Span ID", `\`${span.span_id}\``]);
kvRows.push(["Trace ID", `\`${traceId}\``]);
Iif (span.parent_span_id) {
kvRows.push(["Parent", `\`${span.parent_span_id}\``]);
}
const op = span.op || span["transaction.op"];
Eif (op) {
kvRows.push(["Op", `\`${op}\``]);
}
const desc = span.description || span.transaction;
Eif (desc) {
kvRows.push(["Description", escapeMarkdownCell(desc)]);
}
const durationMs = computeSpanDurationMs(span);
Eif (durationMs !== undefined) {
kvRows.push(["Duration", formatTraceDuration(durationMs)]);
}
Eif (span.project_slug) {
kvRows.push(["Project", span.project_slug]);
}
Eif (isValidTimestamp(span.start_timestamp)) {
const date = new Date(span.start_timestamp * 1000);
kvRows.push(["Started", date.toLocaleString("sv-SE")]);
}
kvRows.push(["Children", String((span.children ?? []).length)]);
return kvRows;
}
/**
* Format an ancestor chain as indented tree lines.
*
* Uses `colorTag()` + `renderMarkdown()` so output respects `NO_COLOR`
* and `isPlainOutput()` instead of leaking raw ANSI escapes.
*/
function formatAncestorChain(ancestors: TraceSpan[]): string {
const lines: string[] = ["", colorTag("muted", "─── Ancestors ───"), ""];
for (let i = 0; i < ancestors.length; i++) {
const a = ancestors[i];
if (!a) {
continue;
}
const indent = " ".repeat(i);
const aOp = a.op || a["transaction.op"] || "unknown";
const aDesc = a.description || a.transaction || "(no description)";
const colorizedDesc = isDbSpanOp(aOp) ? colorizeSql(aDesc) : aDesc;
lines.push(
`${indent}${colorTag("muted", aOp)} — ${escapeMarkdownInline(colorizedDesc)} ${colorTag("muted", `(${a.span_id})`)}`
);
}
return `${renderMarkdown(lines.join("\n"))}\n`;
}
/**
* Format a single span's details for human-readable output.
*
* @param span - The TraceSpan to format
* @param ancestors - Ancestor chain from root to parent
* @param traceId - The trace ID for context
* @returns Rendered terminal string
*/
export function formatSpanDetails(
span: TraceSpan,
ancestors: TraceSpan[],
traceId: string,
detail?: TraceItemDetail
): string {
const kvRows = buildSpanKvRows(span, traceId);
// Append custom attributes from trace-items endpoint when available
Iif (detail) {
appendAttributeRows(kvRows, detail);
}
const md = `## Span \`${span.span_id}\`\n\n${mdKvTable(kvRows)}\n`;
let output = renderMarkdown(md);
const op = span.op || span["transaction.op"];
const desc = span.description || span.transaction;
Iif (desc && isDbSpanOp(op)) {
output += formatSqlBlock(desc);
}
Iif (ancestors.length > 0) {
output += formatAncestorChain(ancestors);
}
return output;
}
/** Max custom attributes to show in human output before truncation */
const MAX_DISPLAY_ATTRS = 10;
/**
* Append notable custom attributes from a TraceItemDetail to KV rows.
* Filters out redundant/internal attributes and truncates after a limit.
*/
function appendAttributeRows(
kvRows: [string, string][],
detail: TraceItemDetail
): void {
const attrs = detail.attributes.filter(
(a) => !(REDUNDANT_DETAIL_ATTRS.has(a.name) || a.name.startsWith("tags["))
);
if (attrs.length === 0) {
return;
}
const shown = attrs.slice(0, MAX_DISPLAY_ATTRS);
for (const attr of shown) {
if (attr.value !== undefined && attr.value !== null && attr.value !== "") {
kvRows.push([attr.name, escapeMarkdownCell(String(attr.value))]);
}
}
if (attrs.length > MAX_DISPLAY_ATTRS) {
kvRows.push([
"...",
`${attrs.length - MAX_DISPLAY_ATTRS} more (use --json)`,
]);
}
}
|