docs(local): document DSN-less capture, client-side wiring, and -f ai filter#1034
Open
sergical wants to merge 1 commit into
Open
docs(local): document DSN-less capture, client-side wiring, and -f ai filter#1034sergical wants to merge 1 commit into
sergical wants to merge 1 commit into
Conversation
`sentry local` worked but a few things were undocumented and bit a user: - No DSN required: with no DSN, events go only to the local server (nothing reaches the user's Sentry org / no production quota); with a DSN set, the SDK sends to both. Make this explicit — it's the main reassurance for using spotlight in local dev. - NEXT_PUBLIC_SENTRY_SPOTLIGHT is injected but the SDK does NOT read it automatically. Server-side SDKs pick up SENTRY_SPOTLIGHT on their own; browser/client SDKs need `spotlight: process.env.NEXT_PUBLIC_SENTRY_SPOTLIGHT` wired into the client config (and other frameworks use VITE_/REACT_APP_). - Document the `-f ai` filter for watching gen_ai/mcp agent spans. Adds an agent-guidance "Capture Events Locally" workflow so the guidance also reaches the generated agent skill (which keeps code blocks, strips prose). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Contributor
|
Contributor
Codecov Results 📊✅ Patch coverage is 100.00%. Project has 4285 uncovered lines. Coverage diff@@ Coverage Diff @@
## main #PR +/-##
==========================================
+ Coverage 82.00% 82.00% —%
==========================================
Files 329 329 —
Lines 23806 23806 —
Branches 15543 15543 —
==========================================
+ Hits 19522 19521 -1
- Misses 4284 4285 +1
- Partials 1643 1642 -1Generated by Codecov Action |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
sentry localworks well, but a few behaviors were undocumented and tripped up a user debugging logs/traces locally. This fills the gaps in thelocalcommand fragment + the agent guidance (which feeds the generated skill).sentry local runinjectsNEXT_PUBLIC_SENTRY_SPOTLIGHT, but no@sentry/*package reads it — only@sentry/node-corereadsSENTRY_SPOTLIGHT(server-side). Browser/client SDKs need it referenced explicitly:VITE_, CRAREACT_APP_). The docs previously implied the client var "just works."-f aifilter. Documented for watchinggen_ai/mcpagent spans while iterating on an agent.Where it lands
docs/src/fragments/commands/local.md→ thelocaldocs page + generated skill reference.docs/src/content/docs/agent-guidance.md→ a new "Capture Events Locally" workflow. Since the skill generator keeps code blocks but strips prose, the key facts are encoded as comments in a bash snippet so they reach the agent skill too.SKILL.md+references/local.mdaccordingly (unrelated date-based reference drift left out; CI auto-commit handles that).Notes
--verify/--timeout/dev-script auto-detect tolocal run). This PR only touches docs/guidance + thelocalreference, so the overlap is limited to the regeneratedreferences/local.md.check:fragmentsandcheck:docs-sectionspass locally.🤖 Generated with Claude Code