Skip to content
Open
Show file tree
Hide file tree
Changes from 24 commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
cddef24
feat(profile): add profile command to surface CPU profiling data
BYK Feb 5, 2026
4ac04d6
fix(profile): handle empty profiles and fix percentage calculation
BYK Feb 5, 2026
e757183
feat(profile): add transaction aliases for quick reference
BYK Feb 5, 2026
ce939e1
chore: regenerate SKILL.md for profile commands
BYK Feb 5, 2026
86c2ab1
test: add unit and property tests for transaction aliases
BYK Feb 5, 2026
0e78088
Merge main into feat/profile-command
BYK Feb 6, 2026
456ebf5
chore: regenerate SKILL.md after merge
BYK Feb 6, 2026
7068f49
fix(profile): ensure extractTransactionSegment never returns numeric …
BYK Feb 6, 2026
b14520f
fix(profile): address PR review comments
BYK Feb 6, 2026
f98c5de
chore: regenerate SKILL.md after adding --web flag to profile list
BYK Feb 6, 2026
cb96897
refactor(profile): replace --org/--project flags with positional args
BYK Feb 9, 2026
e6fada5
chore: trigger CI
BYK Feb 9, 2026
dd20ce9
Merge main into feat/profile-command
BYK Feb 9, 2026
f329ace
test(profile): add tests for analyzer, formatters, and URLs
BYK Feb 9, 2026
56ff6ac
test(profile): add command-level tests for list and view
BYK Feb 9, 2026
e44e230
fix(test): use uniqueArray in alias prefix property test
BYK Feb 9, 2026
de41ae2
fix: address all 6 BugBot review comments on profile commands
BYK Feb 9, 2026
44f682e
fix: deduplicate resolveListTarget and rename formatDuration to forma…
BYK Feb 9, 2026
c685648
fix: resolve bare transaction names and formatDurationMs boundary rou…
BYK Feb 9, 2026
ab7d707
fix: exclude current fingerprint in stale alias detection queries
BYK Feb 9, 2026
c83e27b
fix: guard against empty aliases from hyphen/underscore-only transact…
BYK Feb 9, 2026
9ce148d
fix: prefix-based disambiguation to avoid alias overlap, and null-saf…
BYK Feb 9, 2026
0d5c2b3
fix: use nullish() for ProfileFunctionRow fields to accept null from API
BYK Feb 9, 2026
c7d75ab
Merge remote-tracking branch 'origin/main' into feat/profile-command
BYK Feb 17, 2026
b615452
fix(profile): remove unused orgDisplay/projectDisplay from ResolvedPr…
BYK Feb 17, 2026
d45567e
fix(profile): improve output formatting
BYK Feb 17, 2026
ec75c70
feat(profile): add SAMPLES column and docs page
BYK Feb 17, 2026
d35a878
chore: regenerate SKILL.md
github-actions[bot] Feb 17, 2026
2185365
fix(profile): address BugBot review comments
BYK Feb 17, 2026
3817e60
fix(db): use TABLE_SCHEMAS for transaction_aliases and bump schema to v6
BYK Feb 17, 2026
043a7af
fix(profile): align table header columns with data rows
BYK Feb 17, 2026
9a362cc
fix(profile): fix alias pattern and schema repair robustness
BYK Feb 17, 2026
47e63fd
fix(profile): fix invalid --org flag in error suggestion
BYK Feb 17, 2026
16f269c
fix(profile): simplify explicit target resolution and add disambiguat…
BYK Feb 17, 2026
ff4195f
fix(profile): use exhaustive switch check in view.ts default case
BYK Feb 17, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions plugins/sentry-cli/skills/sentry-cli/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -548,6 +548,31 @@ sentry log view my-org/backend 968c763c740cfda8b6728f27fb9e9b01
sentry log list --json | jq '.[] | select(.level == "error")'
```

### Profile

Analyze CPU profiling data

#### `sentry profile list <target>`

List transactions with profiling data

**Flags:**
- `--period <value> - Time period: 1h, 24h, 7d, 14d, 30d - (default: "24h")`
- `-n, --limit <value> - Maximum number of transactions to return - (default: "20")`
- `--json - Output as JSON`
- `-w, --web - Open in browser`

#### `sentry profile view <args...>`

View CPU profiling analysis for a transaction

**Flags:**
- `--period <value> - Stats period: 1h, 24h, 7d, 14d, 30d - (default: "24h")`
- `-n, --limit <value> - Number of hot paths to show (max 20) - (default: "10")`
- `--allFrames - Include library/system frames (default: user code only)`
- `--json - Output as JSON`
- `-w, --web - Open in browser`

### Trace

View distributed traces
Expand Down
2 changes: 2 additions & 0 deletions src/app.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import { logRoute } from "./commands/log/index.js";
import { listCommand as logListCommand } from "./commands/log/list.js";
import { orgRoute } from "./commands/org/index.js";
import { listCommand as orgListCommand } from "./commands/org/list.js";
import { profileRoute } from "./commands/profile/index.js";
import { projectRoute } from "./commands/project/index.js";
import { listCommand as projectListCommand } from "./commands/project/list.js";
import { repoRoute } from "./commands/repo/index.js";
Expand All @@ -42,6 +43,7 @@ export const routes = buildRouteMap({
issue: issueRoute,
event: eventRoute,
log: logRoute,
profile: profileRoute,
trace: traceRoute,
api: apiCommand,
issues: issueListCommand,
Expand Down
1 change: 1 addition & 0 deletions src/commands/event/view.ts
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,7 @@ export function parsePositionalArgs(args: string[]): {

/**
* Resolved target type for event commands.
* Uses ResolvedTarget from resolve-target.ts.
* @internal Exported for testing
*/
export type ResolvedEventTarget = {
Expand Down
19 changes: 19 additions & 0 deletions src/commands/profile/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import { buildRouteMap } from "@stricli/core";
import { listCommand } from "./list.js";
import { viewCommand } from "./view.js";

export const profileRoute = buildRouteMap({
routes: {
list: listCommand,
view: viewCommand,
},
docs: {
brief: "Analyze CPU profiling data",
fullDescription:
"View and analyze CPU profiling data from your Sentry projects.\n\n" +
"Commands:\n" +
" list List transactions with profiling data\n" +
" view View CPU profiling analysis for a transaction",
hideRoute: {},
},
});
262 changes: 262 additions & 0 deletions src/commands/profile/list.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,262 @@
/**
* sentry profile list
*
* List transactions with profiling data from Sentry.
* Uses the Explore Events API with the profile_functions dataset.
*/

import { buildCommand, numberParser } from "@stricli/core";
import type { SentryContext } from "../../context.js";
import { getProject, listProfiledTransactions } from "../../lib/api-client.js";
import { parseOrgProjectArg } from "../../lib/arg-parsing.js";
import { openInBrowser } from "../../lib/browser.js";
import {
buildTransactionFingerprint,
setTransactionAliases,
} from "../../lib/db/transaction-aliases.js";
import { ContextError } from "../../lib/errors.js";
import {
divider,
formatProfileListFooter,
formatProfileListHeader,
formatProfileListRow,
formatProfileListTableHeader,
writeJson,
} from "../../lib/formatters/index.js";
import {
resolveOrgAndProject,
resolveProjectBySlug,
} from "../../lib/resolve-target.js";
import { buildProfilingSummaryUrl } from "../../lib/sentry-urls.js";
import { buildTransactionAliases } from "../../lib/transaction-alias.js";
import type { TransactionAliasEntry, Writer } from "../../types/index.js";
import { parsePeriod } from "./shared.js";

type ListFlags = {
readonly period: string;
readonly limit: number;
readonly json: boolean;
readonly web: boolean;
};

/** Usage hint for ContextError messages */
const USAGE_HINT = "sentry profile list <org>/<project>";

/** Resolved org and project for profile list */
type ResolvedListTarget = {
org: string;
project: string;
detectedFrom?: string;
};

/**
* Resolve org/project from parsed argument or auto-detection.
*
* @throws {ContextError} When target cannot be resolved
*/
async function resolveListTarget(
target: string | undefined,
cwd: string
): Promise<ResolvedListTarget> {
const parsed = parseOrgProjectArg(target);

switch (parsed.type) {
case "org-all":
throw new ContextError(
"Project",
"Profile listing requires a specific project.\n\n" +
"Usage: sentry profile list <org>/<project>"
);

case "explicit": {
const resolved = await resolveOrgAndProject({
org: parsed.org,
project: parsed.project,
cwd,
usageHint: USAGE_HINT,
});
if (!resolved) {
throw new ContextError("Organization and project", USAGE_HINT);
}
return resolved;
}

case "project-search":
return await resolveProjectBySlug(parsed.projectSlug, USAGE_HINT);

case "auto-detect": {
const resolved = await resolveOrgAndProject({
cwd,
usageHint: USAGE_HINT,
});
if (!resolved) {
throw new ContextError("Organization and project", USAGE_HINT);
}
return resolved;
}

default: {
const _exhaustiveCheck: never = parsed;
throw new ContextError(
`Unexpected target type: ${_exhaustiveCheck}`,
USAGE_HINT
);
}
}
}

/**
* Write empty state message when no profiles are found.
*/
function writeEmptyState(stdout: Writer, orgProject: string): void {
stdout.write(`No profiling data found for ${orgProject}.\n`);
stdout.write(
"\nMake sure profiling is enabled for your project and that profile data has been collected.\n"
);
}

export const listCommand = buildCommand({
docs: {
brief: "List transactions with profiling data",
fullDescription:
"List transactions that have CPU profiling data in Sentry.\n\n" +
"Target specification:\n" +
" sentry profile list # auto-detect from DSN or config\n" +
" sentry profile list <org>/<proj> # explicit org and project\n" +
" sentry profile list <project> # find project across all orgs\n\n" +
"The command shows transactions with profile counts and p75 timing data.",
},
parameters: {
positional: {
kind: "tuple",
parameters: [
{
placeholder: "target",
brief: "Target: <org>/<project> or <project>",
parse: String,
optional: true,
},
],
},
flags: {
period: {
kind: "parsed",
parse: parsePeriod,
brief: "Time period: 1h, 24h, 7d, 14d, 30d",
default: "24h",
},
limit: {
kind: "parsed",
parse: numberParser,
brief: "Maximum number of transactions to return",
default: "20",
},
json: {
kind: "boolean",
brief: "Output as JSON",
default: false,
},
web: {
kind: "boolean",
brief: "Open in browser",
default: false,
},
},
aliases: { n: "limit", w: "web" },
},
async func(
this: SentryContext,
flags: ListFlags,
target?: string
): Promise<void> {
const { stdout, cwd, setContext } = this;

// Resolve org and project from positional arg or auto-detection
const resolvedTarget = await resolveListTarget(target, cwd);

// Set telemetry context
setContext([resolvedTarget.org], [resolvedTarget.project]);

// Get project to retrieve numeric ID (required for profile API and web URLs)
const project = await getProject(
resolvedTarget.org,
resolvedTarget.project
);

// Open in browser if requested
if (flags.web) {
await openInBrowser(
stdout,
buildProfilingSummaryUrl(resolvedTarget.org, project.id),
"profiling"
);
return;
}

// Fetch profiled transactions
const response = await listProfiledTransactions(
resolvedTarget.org,
project.id,
{
statsPeriod: flags.period,
limit: flags.limit,
}
);

const orgProject = `${resolvedTarget.org}/${resolvedTarget.project}`;

// Build and store transaction aliases for later use with profile view
const transactionInputs = response.data
.filter((row) => row.transaction)
.map((row) => ({
transaction: row.transaction as string,
orgSlug: resolvedTarget.org,
projectSlug: resolvedTarget.project,
}));

const aliases = buildTransactionAliases(transactionInputs);

// Store aliases with fingerprint for cache validation
const fingerprint = buildTransactionFingerprint(
resolvedTarget.org,
resolvedTarget.project,
flags.period
);
setTransactionAliases(aliases, fingerprint);

// Build alias lookup map for formatting
const aliasMap = new Map<string, TransactionAliasEntry>();
for (const alias of aliases) {
aliasMap.set(alias.transaction, alias);
}

// JSON output
if (flags.json) {
writeJson(stdout, response.data);
return;
}

// Empty state
if (response.data.length === 0) {
writeEmptyState(stdout, orgProject);
return;
}

// Human-readable output with aliases
const hasAliases = aliases.length > 0;
stdout.write(`${formatProfileListHeader(orgProject, flags.period)}\n\n`);
stdout.write(`${formatProfileListTableHeader(hasAliases)}\n`);
stdout.write(`${divider(82)}\n`);

for (const row of response.data) {
const alias = row.transaction ? aliasMap.get(row.transaction) : undefined;
stdout.write(`${formatProfileListRow(row, alias)}\n`);
}

stdout.write(formatProfileListFooter(hasAliases));

if (resolvedTarget.detectedFrom) {
stdout.write(`\n\nDetected from ${resolvedTarget.detectedFrom}\n`);
}
},
});
22 changes: 22 additions & 0 deletions src/commands/profile/shared.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
/**
* Shared utilities for profile commands.
*/

/** Valid period values for profiling queries */
export const VALID_PERIODS = ["1h", "24h", "7d", "14d", "30d"];

/**
* Parse and validate a stats period string.
*
* @param value - Period string to validate
* @returns The validated period string
* @throws Error if the period is not in VALID_PERIODS
*/
export function parsePeriod(value: string): string {
if (!VALID_PERIODS.includes(value)) {
throw new Error(
`Invalid period. Must be one of: ${VALID_PERIODS.join(", ")}`
);
}
return value;
}
Loading
Loading