1746872 - fix documentation to support new products better

Status: RESOLVED FIXED

(Socorro :: General, task, P2)

Description

[Will Kahn-Greene [:willkg] ET needinfo? me]

When someone is adding crash reporting to their product, they refer to this "crash report payload spec":

https://socorro.readthedocs.io/en/latest/spec_crashreport.html

That's a little helpful in that it specifies some aspects of the HTTP request, but it's missing a bunch of stuff as well. For example, the Socorro collector will return an HTTP 413 if the payload is too big.

I think we should generalize the crash report payload spec into a more complete spec covering everything regarding the HTTP POST for submitting crash reports. We should also rename it.

Things it should cover better:

1. HTTP response codes, what they mean, and what to do about them
2. better debugging information
3. separate section covering Breakpad upload tool differences rather than have that sprinkled throughout

Comment 1

[Will Kahn-Greene [:willkg] ET needinfo? me]

Attachment: pr 5947: bug 1746872: overhaul crash reporting spec

Comment 2

[Will Kahn-Greene [:willkg] ET needinfo? me]

willkg merged PR #5947: "bug 1746872: overhaul crash reporting spec" in e66a6fc.

Comment 3

[Will Kahn-Greene [:willkg] ET needinfo? me]

That improved a bunch of the spec (in my opinion). However, it doesn't address the "better debugging information" part. Need better docs for that.

Comment 4

[Will Kahn-Greene [:willkg] ET needinfo? me]

Attachment: pr 5948: bug 1746872: add note about upload_file_minidump and improve debugging

Comment 5

[Will Kahn-Greene [:willkg] ET needinfo? me]

willkg merged PR #5948: "bug 1746872: add note about upload_file_minidump and improve debugging" in 3e7555a.

This fleshed out the "better debugging information" section.

Comment 6

[Will Kahn-Greene [:willkg] ET needinfo? me]

I think this is good enough for this pass. Marking as FIXED.