summaryrefslogtreecommitdiffstats
path: root/tools/tryselect/docs/index.rst
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 01:13:27 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 01:13:27 +0000
commit40a355a42d4a9444dc753c04c6608dade2f06a23 (patch)
tree871fc667d2de662f171103ce5ec067014ef85e61 /tools/tryselect/docs/index.rst
parentAdding upstream version 124.0.1. (diff)
downloadfirefox-adbda400be353e676059e335c3c0aaf99e719475.tar.xz
firefox-adbda400be353e676059e335c3c0aaf99e719475.zip
Adding upstream version 125.0.1.upstream/125.0.1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'tools/tryselect/docs/index.rst')
-rw-r--r--tools/tryselect/docs/index.rst35
1 files changed, 35 insertions, 0 deletions
diff --git a/tools/tryselect/docs/index.rst b/tools/tryselect/docs/index.rst
index 8978a72eaf..c42b7fbfb8 100644
--- a/tools/tryselect/docs/index.rst
+++ b/tools/tryselect/docs/index.rst
@@ -56,6 +56,41 @@ line instead, such as by using ``curl``:
.. _attach-job-review:
+Profiler symbols for try builds
+-------------------------------
+
+When profiling a tryserver build, you don't get symbols by default. You have to trigger
+an additional `upload-symbols` job on your try push so that the symbols are available
+on the symbol server.
+
+You can trigger this job manually in the Treeherder UI, using "Add new jobs (Search)...".
+
+Assuming you want to profile a "shippable" build (recommended), follow these steps:
+
+ 1. On the treeherder push, click the dropdown triangle in the top right corner.
+ 2. Select "Add new jobs (Search)..."
+ 3. Enter "shippable sym" in the search box and press enter.
+ 4. Important: Check the "Use full job list" checkbox.
+ 5. Pick the job for your try build. For Windows 64 bit builds, the job name is ``build-win64-shippable/opt-upload-symbols`` (this was written in February 2024).
+ 6. Click "Add selected", scroll down, and click "Trigger (1) Selected Jobs".
+
+Around ten minutes later, the symbols will be available on the symbol server, and profile symbolication will succeed.
+
+For other build types, choose the corresponding job for your build type. The job names all
+end in ``-upload-symbols``, and share a prefix with the build job.
+
+.. image:: img/treeherder-trigger-symbols.png
+
+If you've already captured a profile from a try build before the symbols were available, you can
+fix up the collected profile once the symbols are available. To do so, in the Firefox Profiler UI,
+click the "Profile Info" button in the top right corner, and then click the "Re-symbolicate profile"
+button in the panel.
+
+If you want to trigger the upload-symbol job when pushing to try, you can pick it in the list
+when running ``./mach try fuzzy --full`` - the ``--full`` part is necessary.
+The ``-upload-symbols`` task has a dependency on the build task, so you don't have to trigger
+the build task separately if you do this.
+
Adding Try jobs to a Phabricator patch
--------------------------------------