1288310 - Improve documentation about analyzing clusters of crash reports

Status: RESOLVED FIXED

(Socorro :: General, task)

Description

[Nicholas Nethercote [inactive]]

We have poor documentation about crash reports. It's incomplete and spread across various places. I want to consolidate and improve it.

This bug is about documentation to help analyze clusters of crash reports. (Bug 1288309 is about documentation for understanding individual crash reports.)

Comment 1

[Nicholas Nethercote [inactive]]

Just to clarify, this bug is about things like the following:

- Searching through crash reports, including faceting

- Dealing with clusters of crash reports, e.g. all those with the same signature

- Top crasher lists

Comment 2

[Marco Castelluccio [:marco]]

At some point, I will write some documentation for my correlation tool to explain how to use it for generic crash groups. Currently it automatically runs for crash groups defined by signatures, but in theory it can be used to manually analyze generic groups of crashes.

Examples:
- analyzing the crashes before/after a certain change: https://bugzilla.mozilla.org/show_bug.cgi?id=1284322#c21;
- analyzing the differences in the population of crashes between two Firefox versions: https://github.com/marco-c/crashcorrelations/blob/365d7da2e5b3947cd29add19340536bb5bb8552d/47%20vs%2050%20Population%20Difference.ipynb (this could also be useful to weigh crashes or to understand what we need to test more).

Comment 3

[Nicholas Nethercote [inactive]]

What I originally had in mind here was to write docs on how to use crash-stats search, particular faceting, which is powerful but easy to overlook. But docs about correlations would be good too :)

Comment 4

[Nicholas Nethercote [inactive]]

(In reply to Nicholas Nethercote [:njn] from comment #3)
> What I originally had in mind here was to write docs on how to use
> crash-stats search, particular faceting, which is powerful but easy to
> overlook.

I have done this:

https://developer.mozilla.org/en-US/docs/A_guide_to_searching_crash_reports

Adrian and Sheppy, would you mind reading over it? Thank you.

Comment 5

[[DEACTIVATED] Adrian Gaudebert]

Looks good to me!

Comment 6

[Nicholas Nethercote [inactive]]

I'm declaring victory here. Sheppy, I'll happily take any subsequent feedback you might have, but there's no need to block closing this bug on that.

Comment 7

[Lonnen :lonnen]

I know this is resolved, but wanted to highlight for the still interested:

Ryan Harter has been putting together a git book of Firefox Data Documentation, including tools, cookbooks, and tutorials. It is also supported by the data tools and data platform teams.

https://github.com/harterrt/telemetry-docs
https://harterrt.github.io/telemetry-docs/

Should we consider replicating these docs there in some form?