Socorro: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
m (→‎Documentation on installing Socorro: Note with link to overall crash reporter documentation)
(update socorro wiki page)
Line 5: Line 5:
[[Breakpad]] is a set of libraries by Mozilla products for client-side crash reporting.   
[[Breakpad]] is a set of libraries by Mozilla products for client-side crash reporting.   


[https://github.com/mozilla/socorro/ Socorro] is a server for collecting, processing and reporting on crashes from Breakpad.
[https://github.com/mozilla-services/socorro/ Socorro] is a crash ingestion pipeline for collecting, processing and reporting on crashes from Breakpad.


= How to file a bug for Socorro =
= How to file a bug for Socorro =


Thanks for finding and reporting a bug!
Bugs can be filed at: https://bugzilla.mozilla.org/enter_bug.cgi?format=__standard__&product=Socorro


If this is your first time filing a bug with Bugzilla, you may find this [https://bugzilla.mozilla.org/enter_bug.cgi?format=guided Guided Bug Entry form] useful.  You can leave the Version set to 'unspecified' if you don't know which version of Socorro you are using.
Thank you for filing bugs!
 
If you're well-versed with Bugzilla, you may find our [https://bugzilla.mozilla.org/enter_bug.cgi?product=Socorro&component=General Regular Bug Entry form] more to your liking. The important fields to set in this form are: component, summary, description, and (if known) assignee, blockers, depends. Don't worry, we'll set the values of the fields you don't have answers for.
 
= Documentation on installing Socorro =
 
Documentation on installing Socorro is at [http://socorro.readthedocs.org/ Socorro Documentation on readthedocs.org]
More background is in the [https://firefox-source-docs.mozilla.org/toolkit/crashreporter/crashreporter/index.html crash reporter documentation].


= Contributing to Socorro =
= Contributing to Socorro =


The Socorro project is currently hosted on Github at https://github.com/mozilla/socorro
The Socorro project is currently hosted on Github at: https://github.com/mozilla-services/socorro


Socorro is an open source project and we welcome code contributions.  You may use [http://bugzilla.mozilla.org Bugzilla] to [https://bugzilla.mozilla.org/buglist.cgi?product=Socorro&resolution=--- browse through open Socorro bugs] or [https://bugzilla.mozilla.org/enter_bug.cgi?product=Socorro add a new Socorro bug].
Socorro is an open source project and we welcome code contributions.


= Writing tools to use Socorro data =
= Writing tools to use Socorro data =
Here are some examples of tools people have written to use or analyze crash-stats data.
* Kairo's crash report tools:  [https://hg.mozilla.org/users/kairo_kairo.at/crash-report-tools/file/b7ef0aea6b41 repo] | [https://crash-analysis.mozilla.com/rkaiser/0000.overview.html web interface]
* bsmedberg's socorro toolbox: [https://github.com/bsmedberg/socorro-toolbox/ repo]


You can test and learn about the Socorro API here:
You can test and learn about the Socorro API here:


https://crash-stats.mozilla.com/api/
https://crash-stats.mozilla.com/api/
Or for internal Mozilla, use, the Middleware API is documented here:
http://socorro.readthedocs.org/en/latest/middleware.html


= Staging and Testing =
= Staging and Testing =
* [https://travis-ci.org/mozilla/socorro Travis] watches for checkins, runs unit/functional tests
* QA has Selenium tests on a separate Jenkins instance (runs against staging)


There is an extraction script to create a copy of the production PostgreSQL database containing only a few weeks of data. It is documented in [[ExtractDBscript]].
* Circle CI for testing: https://circleci.com/gh/mozilla-services/socorro
* stage: https://crash-stats.allizom.org/


= Planning  =
= Planning  =


*[[Breakpad/Status Meetings|Status Meetings]]
We have weekly meetings, though few people attend them. If you'd like to attend a meeting, let us know on #breakpad on IRC.


= Contact Us =
= Contact Us =

Revision as of 18:31, 1 February 2019

Socorro is the name for the Mozilla Crash Stats project. It is an open source project which other companies are also using for crash statistics.

Overview

Breakpad is a set of libraries by Mozilla products for client-side crash reporting.

Socorro is a crash ingestion pipeline for collecting, processing and reporting on crashes from Breakpad.

How to file a bug for Socorro

Bugs can be filed at: https://bugzilla.mozilla.org/enter_bug.cgi?format=__standard__&product=Socorro

Thank you for filing bugs!

Contributing to Socorro

The Socorro project is currently hosted on Github at: https://github.com/mozilla-services/socorro

Socorro is an open source project and we welcome code contributions.

Writing tools to use Socorro data

You can test and learn about the Socorro API here:

https://crash-stats.mozilla.com/api/

Staging and Testing

Planning

We have weekly meetings, though few people attend them. If you'd like to attend a meeting, let us know on #breakpad on IRC.

Contact Us

We will be happy to answer your questions to help you get your Socorro install up off the ground. You may contact the Socorro team at either: