error: document the error.* module + error.create reporting#41
Merged
Conversation
Rename the error-detection actions to the new error.* module across the docs (deployment.errors -> error.list, deployment.errorGet -> error.get, deployment.errorUpdate -> error.update) and update the permission gating: reads by error.list / error.get, triage by error.update, all previously deployment.logs. Document the new error.create capability: a running deployment or SDK reports its own application errors directly; a reported error and a log-mined trace with the same stack signature merge into one issue (shared fingerprint). Covers the request shape (events[] with required type, kind defaulting to generic, frames[].func/file/line, batch up to 100), auth (service-account key OR a me.generateToken scoped token attenuated to error.create), the secret-safety note (notifications carry only the exception type, never title/sample), and a concrete curl example. Adds the error report CLI command and error.create MCP tool to the reference pages. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011d4bVuGLnCbcJD9ZvastPH
|
Preview deleted (PR closed). |
….error The api PR renamed the new/regressed-issue change event from deployment.error to error.detected (resource error, action detected) as part of the error.* module. Update the Notifications section's event name, the subscribe example, and the wildcard hint (error.* not deployment.*). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011d4bVuGLnCbcJD9ZvastPH
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
1 participant
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.
Updates the docs for the new
error.*API module and the newerror.createdirect-reporting capability (tracks deploys-app/api#106).Rename
The error-detection actions move to the dedicated
error.*module everywhere in the docs:deployment.errors->error.listdeployment.errorGet->error.getdeployment.errorUpdate->error.updatePermission gating is updated to match: list reads gated by
error.list, single-issue reads byerror.get, and triage (resolve / mute / reopen) byerror.update(previouslydeployment.logs). The secret-safety note now points aterror.get. Touches the error-detection page, the API function catalog (content/api/conventions.md), and the MCP reference (content/automation/mcp.md).New:
error.createDocuments the headline new capability — a running deployment or embedded SDK reports its own application errors directly instead of relying only on log mining. A reported error and a log-mined trace with the same stack signature merge into one issue (shared fingerprint), so reporting never double-counts what mining would catch.
{ project, location, name, events: [...] }; each event has requiredtype,kind(defaults togeneric),title,frames: [{func, file, line}],sample,pod,ts; batch up to 100 events.me.generateTokenscoped token attenuated toerror.create(least-privilege, short-lived). No new infra.type, nevertitle/sample.curlexample posting tohttps://api.deploys.app/error.create.deploys error reportCLI command and theerror.createMCP tool.Verification
hugo --minifybuilds clean (56 pages, no errors/warnings); all intra-page anchors resolve (verified theerror.createsection anchorreporting-errors-from-your-app--errorcreate); zero remainingdeployment.errors/deployment.errorGet/deployment.errorUpdatereferences.🤖 Generated with Claude Code
https://claude.ai/code/session_011d4bVuGLnCbcJD9ZvastPH