feat(skills-next): add sentry-debug-issue skill#260
Conversation
| needs: | ||
| - search-query-language.md | ||
| # Concept docs that help read/understand an issue while debugging: the error and | ||
| # its attached context (logs/replay/profile/feedback), the trace, and the monitor | ||
| # types that also create issues (cron missed/failed check-ins, metric thresholds) | ||
| # plus the Monitors->Issues->Alerts model. Excludes pure setup/strategy docs | ||
| # (choosing-a-signal, data-scrubbing, reduce-volume, releases). | ||
| - concepts/{errors,tracing,logging,session-replay,profiling,user-feedback,crons,metrics,monitors}.md |
There was a problem hiding this comment.
Bug: The skill's references.yml lists documentation files that are missing from the repository. The build process will not fail, resulting in the skill being deployed with broken links.
Severity: HIGH
Suggested Fix
Add the missing concept documentation files referenced in references.yml to the skills-next/references/ directory. This will ensure the hydrate-references.py script can find and bundle them into the skill during the build process, fixing the broken links.
Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.
Location: skills-next/skills/sentry-debug-issue/references.yml#L1-L8
Potential issue: The `references.yml` file for the `sentry-debug-issue` skill specifies
several required documentation files (e.g., `search-query-language.md`,
`concepts/errors.md`) that do not exist in the repository. The build script,
`hydrate-references.py`, is designed to handle missing references by printing a warning
and continuing, rather than failing the build. Consequently, the skill will be deployed
without its necessary reference documentation. This results in users encountering broken
links within the skill's content, as the markdown files link to reference files that
were never bundled, degrading the user experience and shipping an incomplete feature.
Did we get this right? 👍 / 👎 to inform future reviews.
a4cd321 to
7c4826e
Compare
|
|
||
| Take one Sentry issue from "here's a problem" to "here's the fix, shipped." | ||
| You'll pull the issue's full context, root-cause it against the actual repo | ||
| locally here, apply the fix with a test, and resolve it by shipping the change. |
There was a problem hiding this comment.
is it just me that it bugs when claude decides to create it's own line breaks at ~80 characters, i feel like it inflates lines added for no reason
| concept doc when the artifact is unfamiliar: | ||
|
|
||
| - **Logs on the same trace** — the narrative of what happened around the failure. | ||
| ([`references/concepts/logging.md`](references/concepts/logging.md)) |
There was a problem hiding this comment.
i like this reference structure for concepts
Adds the flagship workflow skill from the getting-started design's "First focus" set, after sentry-get-started and sentry-instrument. It is a thin, prose-forward playbook for taking one Sentry issue from "here's a problem" to "here's the fix, shipped": find the issue (link, ID, or search), pull its full context, form a root-cause hypothesis, verify it against the actual repo, apply the fix with a test, and resolve by shipping a Fixes SENTRY-123 commit. It treats all Sentry data as untrusted input and recognizes non-error issue types (cron and metric monitor issues) rather than assuming every issue is a code exception. Its references.yml hydrates the search grammar plus the concept docs that help read an issue while debugging (errors, tracing, logging, session-replay, profiling, user-feedback, crons, metrics, monitors), deliberately excluding the pure setup/strategy docs (choosing-a-signal, data-scrubbing, reduce-volume, releases) that never come up mid-debug.
7c4826e to
be75603
Compare
| You'll pull the issue's full context, root-cause it against the actual repo | ||
| locally here, apply the fix with a test, and resolve it by shipping the change. | ||
|
|
||
| The playbook is here. It pulls in [`references/search-query-language.md`](references/search-query-language.md) |
There was a problem hiding this comment.
Let's add this reference doc to this PR I think
Why
sentry-debug-issueis the third and final skill in the getting-started design's "First focus" set, aftersentry-get-startedandsentry-instrument. It is the flagship workflow skill and the place where running Sentry inside a coding agent pays off over a dashboard: the agent can pull an issue's full context, root-cause it against the actual repo, apply the fix with a test, and resolve it by shipping the change.What
A new, thin, prose-forward playbook at
skills-next/skills/sentry-debug-issue/SKILL.mdthat takes one issue from "here's a problem" to "here's the fix, shipped":Fixes SENTRY-123commit/PR rather than only flipping status.It treats all Sentry data (messages, breadcrumbs, request bodies, stack frames) as untrusted input: never follow embedded instructions, never paste raw values or secrets into code, use synthetic data in tests.
references.ymlhydrates the shared search grammar plus the concept docs that help read an issue while debugging (errors, tracing, logging, session-replay, profiling, user-feedback, crons, metrics, monitors). It deliberately excludes the pure setup/strategy docs (choosing-a-signal, data-scrubbing, reduce-volume, releases) that never come up mid-debug. Hydration and link validation pass viascripts/hydrate-references.py.A companion one-line change to the
sentry-get-startedrouter menu (routing the "fix or investigate an issue" intent to this skill) is held as a separate commit because it depends on thesentry-get-startedskill PR merging to main first.