uploading_symbol.rst (3016B)
1 Uploading symbols to Mozilla's symbol server 2 ============================================ 3 4 As a third-party releasing your own builds of Firefox or B2G, you should 5 consider uploading debug symbols from the builds to Mozilla's symbol 6 server. If you have not disabled crash reporting in your builds, crash 7 reports will be submitted to `Mozilla's crash reporting 8 server <https://crash-stats.mozilla.org/>`__. Without the debug symbols 9 that match your build the crash reports will not contain actionable 10 information. 11 12 Symbols can be uploaded either via a web browser or a web API. 13 14 15 Building a Symbol Package 16 ------------------------- 17 18 To upload symbols, you need to build a symbol package. This is a 19 .zip file which contains the symbol files in a specific directory structure. 20 21 If you are building Firefox,or a similar application using the Mozilla 22 build system, you can build the symbol package using a make target: 23 24 :: 25 26 ./mach buildsymbols 27 28 This will create a symbol package in ``dist/`` named something like 29 ``firefox-77.0a1.en-US.linux-x86_64.crashreporter-symbols.zip`` . 30 31 This step requires the ``dump_syms`` tool which should have been automatically 32 installed when you setup the Firefox build with ``./mach bootstrap``. If for 33 some reason it's missing or outdated running the bootstrap step again will 34 retrieve and install an up-to-date version of the tool. 35 36 Uploading symbols 37 ----------------- 38 39 Symbols are uploaded via your account on symbols.mozilla.org. Visit 40 https://symbols.mozilla.org and log in. Then request upload 41 permission by filing a bug in the Socorro component using `this 42 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>`__. 43 If you don't have an account yet use the template to request one. 44 45 After symbol upload is turned on, you can upload the symbol archive 46 directly using the web form at https://symbols.mozilla.org/uploads. 47 It is also possible to upload via automated scripts: see the `symbol upload API 48 docs <https://tecken.readthedocs.io/en/latest/>`__ for more 49 details.