Closed
Bug 1306643
Opened 8 years ago
Closed 6 years ago
Document our existing signature rules
Categories
(Socorro :: Signature, task, P2)
Socorro
Signature
Tracking
(Not tracked)
RESOLVED
FIXED
People
(Reporter: ted, Assigned: willkg)
Details
Attachments
(1 file)
We have a bunch of signature generation rules in use, basically everything from this point on in this file: https://github.com/mozilla/socorro/blob/ed67c74e4d831f9c5df77dc70348351ed27ec6b6/socorro/processor/signature_utilities.py#L538 It would be nice if we had them documented. In particular, this page has a nice "Signature Generation Algorithm" section but it fails to mention any of them: https://github.com/mozilla/socorro/tree/master/socorro/siglists
Assignee | ||
Comment 1•6 years ago
|
||
Making this a P2. We've done some work at signature generation documentation: https://socorro.readthedocs.io/en/latest/signaturegeneration.html However, it doesn't list the rules and what the rules do. I think it's not too hard to do that and it will further surface what's going on.
Component: General → Signature
Priority: -- → P2
Assignee | ||
Comment 2•6 years ago
|
||
Grabbing this to do now. Then I'll cut a new version of socorro-siggen.
Assignee: nobody → willkg
Status: NEW → ASSIGNED
Assignee | ||
Comment 3•6 years ago
|
||
Comment 4•6 years ago
|
||
Commits pushed to master at https://github.com/mozilla-services/socorro https://github.com/mozilla-services/socorro/commit/700a7a927c84d19104ec82b2048f9e7b99ddbf4c fix bug 1306643: document signature generation pipeline This adds a command that generates a restructured text file, the generated file, and tweaks the docs to include that in the signature generation chapter. This also documents the signature generation rules. https://github.com/mozilla-services/socorro/commit/9519c744250467effc55a9f0897c241aa50d9c00 Merge pull request #4577 from willkg/1306643-document-signature fix bug 1306643: document signature generation pipeline
Status: ASSIGNED → RESOLVED
Closed: 6 years ago
Resolution: --- → FIXED
Assignee | ||
Comment 5•6 years ago
|
||
I landed this and readthedocs re-generated the docs. It's here: https://socorro.readthedocs.io/en/latest/signaturegeneration.html#signature-generation-rules-pipeline Is it beautiful? I don't think so. Is it informative? Maybe? Ted: Is this helpful at all? If not, what kind of information would you like? Would it help to have examples of how each rule transforms the signature?
Assignee | ||
Comment 6•6 years ago
|
||
Reopening and needsinfoing Ted.
Status: RESOLVED → REOPENED
Flags: needinfo?(ted)
Resolution: FIXED → ---
Assignee | ||
Comment 7•6 years ago
|
||
I think this is good enough for now. We can iterate further as issues arise.
Status: REOPENED → RESOLVED
Closed: 6 years ago → 6 years ago
Flags: needinfo?(ted)
Resolution: --- → FIXED
Reporter | ||
Comment 8•6 years ago
|
||
Sorry for not responding to that needinfo, but that looks great! We can obviously improve some of the comments so they make more sense in standalone doc form, but that's a great start!
You need to log in
before you can comment on or make changes to this bug.
Description
•