write specification for crash report
Categories
(Socorro :: General, task, P2)
Tracking
(Not tracked)
People
(Reporter: willkg, Assigned: willkg)
Details
Attachments
(2 files)
When I wrote Antenna, I wrote a rough requirements doc that also covers the structure of the crash report:
https://antenna.readthedocs.io/en/latest/spec_v1.html#crash-reports-and-the-current-collector
However, that's both out of date, tangled with other Antenna requirements, and probably wrong in some places, too.
This bug covers writing up a crash report specification that lives in the Socorro docs that covers:
- the structure of a crash report
- important fields in the crash report
- different ways to generate a minimal crash report
- what socorro does with malformed crash reports
|
Assignee | |
Comment 1•6 years ago
|
||
|
|
Assignee | |
Comment 2•6 years ago
|
||
Gabriele: When you have a chance, can you go through this crash report specification pull request and point out issues?
|
||
Comment 3•6 years ago
|
||
LGTM, I just left a comment for a nit but it seems correct and exhaustive to me.
|
|
Assignee | |
Comment 4•6 years ago
|
||
willkg merged PR #5165: "bug 1608111: initial crash report v0 specification" in 545d1ea.
That covers v0.
I need to write v1 now.
|
|
Assignee | |
Comment 5•6 years ago
|
||
Gabriele: I added the bits about the JSON-encoded value for specifying annotations. Does this look ok? Does the language I used make sense?
|
|
||
Comment 6•6 years ago
|
||
Looking good, it's just very hard to describe the part about annotations that contain JSON themselves. Maybe we should put a simple example there?
|
|
Assignee | |
Comment 7•6 years ago
|
||
willkg merged PR #5167: "bug 1608111: add single JSON-encoded value bits to specification" in 8d6e93b.
This is all set now. Marking as FIXED.
Description
•