Socorro: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
(→‎Planning: Correcting the link to ElasticSearch API)
(update and add links to docs)
 
(25 intermediate revisions by 8 users not shown)
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.   


[[Socorro/SocorroServer|Socorro Server]] is a Python API and a collection of applications and web services that use the API. The applications together embody a set of servers to take crash dumps generated by remote clients, process using the breakpad_stackdump application and save the results in HBase. Additional processes aggregate and filter data for storage in a relational database.
[https://github.com/mozilla-services/socorro/ Socorro] is a crash ingestion pipeline for collecting, processing, and reporting on crashes from Breakpad.


[[Socorro/SocorroUI|Socorro UI]] is the web interface for viewing and parsing crash reports, as well as aggregated data surrounding crash reports.  It is written in PHP atop the Kohana framework.
See [https://socorro.readthedocs.io Socorro documentation] for how to add support for new products, fix signature generation, add new crash annotations to crash reports, and other things.


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


* [[Socorro/Architecture_Overview|Architecture Overview]]
Bugs can be filed at: https://bugzilla.mozilla.org/enter_bug.cgi?format=__standard__&product=Socorro
* [[Socorro/Glossary|Glossary]]


= Code Repository =
Thank you for filing bugs!


The Socorro project is currently hosted on Google Code at http://code.google.com/p/socorro/ .
= Contributing to Socorro =


The project will be moving to Github in the near future.  Once this move takes place, we will update the documentation here accordingly.
The Socorro project is currently hosted on Github at: https://github.com/mozilla-services/socorro


== Committing Code to Socorro ==
Socorro is an open source project and we welcome code contributions.


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=Webtools&component=Socorro&resolution=--- browse through open Socorro bugs] or [https://bugzilla.mozilla.org/enter_bug.cgi?product=Webtools&component=Socorro add a new Socorro bug].
= Writing tools to use Socorro data =


* [[Socorro/SocorroUI/Code Review|Socorro Code Review Practices]]
You can test and learn about the Socorro API here:
* [[Socorro/SocorroServer/Coding Standards|Socorro Server Coding Standards]] (Python)
* [[Socorro/SocorroUI/Coding Standards|Socorro UI Coding Standards]] (PHP)
* [[Breakpad/SVNStandards|SVN standards]]


== Staging and Testing ==
https://crash-stats.mozilla.org/api/
* We use both trunk and release branches. Please see [[Socorro/Release_Branch_Strategy|Release Branch Strategy]] page for more info.
* [https://hudson.mozilla.org/job/socorro/ Hudson] watches for checkins, runs unit/functional tests
* QA has Selenium tests on a separate Hudson instance (runs against staging)
* [https://intranet.mozilla.org/Socorro_Staging Staging] environments.  We will shortly have two: one running trunk and one running the release branch.  Right now there is one.  It automatically picks up builds from Hudson against trunk.


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]].
= Staging and Testing =


= Planning  =
* Circle CI for testing: https://circleci.com/gh/mozilla-services/socorro
 
* stage: https://crash-stats.allizom.org/
*[[Breakpad/Status Meetings|Status Meetings]]
*[[Socorro:SOLR_API|Solr API Specs]]
*[[Socorro/ElasticSearch_API|Middleware API Documentation]]
 
= Roadmap =
 
*[[SocorroRoadmap2010]]
*[http://spreadsheets.google.com/ccc?key=t6zyWLsUinWwzS2_igS2grQ Q4 2010 Schedule]
*[[Breakpad/2009Q3RoadMap|Q4 2009]]
*[[Breakpad/2009Q3RoadMap|Q3 2009]]
*[[Breakpad/2009Q3RoadMap|Q2 2009]]


= Contact Us =
= Contact Us =
Line 55: Line 36:
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:
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:


* irc: irc.mozilla.org #breakpad
* matrix: #breakpad
* email: socorro-dev@mozilla.com
* email: socorro-dev@mozilla.com
* mailing list: tools-socorro@lists.mozilla.org (https://lists.mozilla.org/listinfo/tools-socorro)
* mailing list: tools-socorro@lists.mozilla.org (https://lists.mozilla.org/listinfo/tools-socorro)

Latest revision as of 17:46, 17 April 2020

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.

See Socorro documentation for how to add support for new products, fix signature generation, add new crash annotations to crash reports, and other things.

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.org/api/

Staging and Testing

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:

Retrieved from "https://wiki.allizom.org/index.php?title=Socorro&oldid=1226259"