docs: add RFC on error signature strings for failure grouping - #5033
Closed
brandonjackson wants to merge 2 commits into
Closed
docs: add RFC on error signature strings for failure grouping#5033brandonjackson wants to merge 2 commits into
brandonjackson wants to merge 2 commits into
Conversation
Proposes candidate formats for a single groupable "error signature" per failed work order, so we can answer "what breaks most often, and where?". Split into options buildable on today's data (outcome, error_type, job id, adaptor version, log lines) and options needing new data (a controlled error vocabulary, the currently-discarded error_message, adaptor-level detail). Recommends storing one structured key and displaying it at three resolutions. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SeVwW7tdLZh6ttoc1DFHdU
Rewrites the RFC around the real error vocabulary in openfn/kit rather
than only what Lightning stores. Documents all 18 worker error classes
with their severity, the error_type Lightning actually receives, and a
plain-English cause.
Key findings that reshape the proposal:
- error_type on the wire is subtype || type || name, so RuntimeError and
RuntimeCrash reach us as TypeError/ReferenceError etc. Exit reason and
error type must be paired to identify a cause.
- Line/column, source-mapped to the user's own code, is already in our
database for fail-severity errors, inside the step's saved output under
errors.<step id>.
- The worker always logs "{error_type}: {error_message}" from source R/T,
so the message is recoverable with a reliable anchor.
- Three ambiguities blunt any signature: TimeoutError means two different
things, three classes report ValidationError, and blame class is
derivable today but unstored.
Shifts focus to high-resolution options per the goal of one signature per
root cause, and recommends a stable key plus human rendering with the line
number displayed but excluded from the key.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01SeVwW7tdLZh6ttoc1DFHdU
|
The PR only adds a documentation file ( Security Review ✅
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #5033 +/- ##
=======================================
- Coverage 90.5% 90.5% -0.1%
=======================================
Files 425 425
Lines 20237 20237
=======================================
- Hits 18318 18307 -11
- Misses 1919 1930 +11 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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
2 participants
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.
Proposes candidate formats for a single groupable "error signature" per
failed work order, so we can answer "what breaks most often, and where?".
Split into options buildable on today's data (outcome, error_type, job id,
adaptor version, log lines) and options needing new data (a controlled
error vocabulary, the currently-discarded error_message, adaptor-level
detail). Recommends storing one structured key and displaying it at three
resolutions.
Co-Authored-By: Claude Opus 5 noreply@anthropic.com
Claude-Session: https://claude.ai/code/session_01SeVwW7tdLZh6ttoc1DFHdU