2020-09-22 09:25:36 +03:00
|
|
|
Uploading symbols to Mozilla's symbol server
|
|
|
|
|
============================================
|
|
|
|
|
|
|
|
|
|
As a third-party releasing your own builds of Firefox or B2G, you should
|
|
|
|
|
consider uploading debug symbols from the builds to Mozilla's symbol
|
|
|
|
|
server. If you have not disabled crash reporting in your builds, crash
|
|
|
|
|
reports will be submitted to `Mozilla's crash reporting
|
2020-12-12 11:41:20 +03:00
|
|
|
server <https://crash-stats.mozilla.org/>`__. Without the debug symbols
|
2020-09-22 09:25:36 +03:00
|
|
|
that match your build the crash reports will not contain actionable
|
|
|
|
|
information.
|
|
|
|
|
|
|
|
|
|
Symbols can be uploaded either via a web browser or a web API.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Building a Symbol Package
|
|
|
|
|
-------------------------
|
|
|
|
|
|
|
|
|
|
To upload symbols, you need to build a symbol package. This is a
|
2020-10-08 17:32:54 +03:00
|
|
|
.zip file which contains the symbol files in a specific directory structure.
|
2020-09-22 09:25:36 +03:00
|
|
|
|
|
|
|
|
If you are building Firefox,or a similar application using the Mozilla
|
|
|
|
|
build system, you can build the symbol package using a make target:
|
|
|
|
|
|
|
|
|
|
::
|
|
|
|
|
|
|
|
|
|
./mach buildsymbols
|
|
|
|
|
|
|
|
|
|
This will create a symbol package in ``dist/`` named something like
|
|
|
|
|
``firefox-77.0a1.en-US.linux-x86_64.crashreporter-symbols.zip`` .
|
|
|
|
|
|
2020-10-08 17:32:54 +03:00
|
|
|
This step requires the ``dump_syms`` tool which should have been automatically
|
|
|
|
|
installed when you setup the Firefox build with ``./mach bootstrap``. If for
|
|
|
|
|
some reason it's missing or outdated running the bootstrap step again will
|
|
|
|
|
retrieve and install an up-to-date version of the tool.
|
2020-09-22 09:25:36 +03:00
|
|
|
|
|
|
|
|
Uploading symbols
|
|
|
|
|
-----------------
|
|
|
|
|
|
2020-10-08 17:32:54 +03:00
|
|
|
Symbols are uploaded via your account on symbols.mozilla.org. Visit
|
|
|
|
|
https://symbols.mozilla.org and log in. Then request upload
|
2020-09-22 09:25:36 +03:00
|
|
|
permission by filing a bug in the Socorro component using `this
|
2020-10-08 17:32:54 +03:00
|
|
|
template <https://bugzilla.mozilla.org/enter_bug.cgi?assigned_to=nobody%40mozilla.org&bug_ignored=0&bug_severity=--&bug_status=NEW&bug_type=task&cc=gsvelto%40mozilla.com&cc=willkg%40mozilla.com&cf_fx_iteration=---&cf_fx_points=---&comment=What%20e-mail%20account%20are%20you%20requesting%20access%20for%3F%0D%0A...%0D%0A%0D%0AWhat%20symbols%20will%20you%20be%20uploading%20using%20this%20account%3F%0D%0A...%0D%0A%0D%0AIs%20there%20somebody%20at%20Mozilla%20who%20can%20vouch%20for%20you%3F%0D%0A...%0D%0A&component=Upload&contenttypemethod=list&contenttypeselection=text%2Fplain&defined_groups=1&filed_via=standard_form&flag_type-4=X&flag_type-607=X&flag_type-800=X&flag_type-803=X&flag_type-936=X&form_name=enter_bug&maketemplate=Remember%20values%20as%20bookmarkable%20template&op_sys=Unspecified&priority=--&product=Tecken&rep_platform=Unspecified&short_desc=Symbol-upload%20permission%20for%20%3CPerson%3E&target_milestone=---&version=unspecified>`__.
|
|
|
|
|
If you don't have an account yet use the template to request one.
|
2020-09-22 09:25:36 +03:00
|
|
|
|
|
|
|
|
After symbol upload is turned on, you can upload the symbol archive
|
2020-10-08 17:32:54 +03:00
|
|
|
directly using the web form at https://symbols.mozilla.org/uploads.
|
|
|
|
|
It is also possible to upload via automated scripts: see the `symbol upload API
|
|
|
|
|
docs <https://tecken.readthedocs.io/en/latest/>`__ for more
|
2020-09-22 09:25:36 +03:00
|
|
|
details.
|
