corysanin/tubestation
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Bug 1908308 - Update the help message for many perf tests as well as related documentation r=sparky,perftest-reviewers

Browse Source 
Differential Revision: https://phabricator.services.mozilla.com/D242029
This commit is contained in:
Julien Wajsberg
2025-03-24 12:42:04 +00:00
parent f043951f48
commit a3b5e16bba
13 changed files with 32 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
devtools/docs/contributor/tests/performance-tests-damp.md
View File

@@ -46,6 +46,8 @@ to focus on just one subtest run:
./mach talos-test --suite damp --subtests custom.webconsole --cycles 1 --tppagecycles 1 --gecko-profile --gecko-profile-entries 100000000
```
It's also possible to specify more configuration such as the profiled threads, the sampling interval or the profiler features being enabled. The parameters used in a profiling run can be copied directly from the about:profiling page in any Nightly build: click the button at the top of the page, then pick the option "Copy parameters for performance tests".
## How to run it on try?
```bash

4
devtools/docs/contributor/tests/writing-perf-tests.md
View File

@@ -130,9 +130,11 @@ Also, you can record a profile while running the test. To do that, execute:
```
./mach talos-test --suite damp --subtest ${your-test-name} --cycles 1 --tppagecycles 1 --gecko-profile --gecko-profile-entries 100000000
```
`--gecko-profile` enables the profiler
`--gecko-profile` enables the profiler<br>
`--gecko-profile-entries` defines the profiler buffer size, which needs to be large while recording performance tests
It's also possible to specify more configuration such as the profiled threads, the sampling interval or the profiler features being enabled. The parameters used in a profiling run can be copied directly from the about:profiling page in any Nightly build: click the button at the top of the page, then pick the option "Copy parameters for performance tests".
Once it is done executing, the profile lives in a zip file you have to uncompress like this:
```
unzip testing/mozharness/build/blobber_upload_dir/profile_damp.zip

5
testing/mozharness/mozharness/mozilla/testing/raptor.py
View File

@@ -284,7 +284,10 @@ class Raptor(
"dest": "gecko_profile",
"action": "store_true",
"default": False,
"help": "Whether to profile the test run and save the profile results.",
"help": (
"Whether to profile the test run and save the profile results. "
"Copy paste the parameters used in this profiling run directly from about:profiling in Nightly."
),
},
],
[

5
testing/mozharness/mozharness/mozilla/testing/talos.py
View File

@@ -179,7 +179,10 @@ class Talos(
"dest": "gecko_profile",
"action": "store_true",
"default": False,
"help": "Whether or not to profile the test run and save the profile results",
"help": (
"Whether to profile the test run and save the profile results. "
"Copy paste the parameters used in this profiling run directly from about:profiling in Nightly."
),
},
],
[

2
testing/perfdocs/generated/browsertime.rst
View File

@@ -276,6 +276,8 @@ To run gecko profiling using Raptor-Browsertime you can add the ``--gecko-profil
./mach raptor -t amazon --gecko-profile
It's also possible to specify more configuration such as the profiled threads, the sampling interval or the profiler features being enabled. The parameters used in a profiling run can be copied directly from the about:profiling page in any Nightly build: click the button at the top of the page, then pick the option "Copy parameters for performance tests".
Note that vanilla Browsertime does support Gecko Profiling but **it does not symbolicate the profiles** so it is **not recommended** to use for debugging performance regressions/improvements.
Gathering a Chrome trace with Raptor-Browsertime

3
testing/perfdocs/generated/mach-try-perf.rst
View File

@@ -92,7 +92,8 @@ The tool is built to be conservative about the number of tests to run, so if you
--env ENV Set an environment variable, of the form FOO=BAR. Can
be passed in multiple times.
--gecko-profile Create and upload a gecko profile during talos/raptor
tasks.
tasks. Copy paste the parameters used in this profiling
run directly from about:profiling in Nightly.
--gecko-profile-interval GECKO_PROFILE_INTERVAL
How frequently to take samples (ms)
--gecko-profile-entries GECKO_PROFILE_ENTRIES

2
testing/perfdocs/generated/perftest-in-a-nutshell.rst
View File

@@ -183,7 +183,7 @@ You can also find the profiles in the artifacts tab of the Raptor test:
:scale: 50%
:align: center
To generate the profiles locally, you can pass the flags ``--extra-profiler-run`` or ``--gecko-profile`` which repeat the test for an extra iteration with the profiler enabled, or run the test from the beginning with the profiler enabled for three iterations, respectively.
To generate the profiles locally, you can pass the flags ``--extra-profiler-run`` or ``--gecko-profile`` which repeat the test for an extra iteration with the profiler enabled, or run the test from the beginning with the profiler enabled for three iterations, respectively. It's also possible to specify more configuration such as the profiled threads, the sampling interval or the profiler features being enabled. The parameters used in a profiling run can be copied directly from the about:profiling page in any Nightly build: click the button at the top of the page, then pick the option "Copy parameters for performance tests".
Side-by-Side
------------

3
testing/performance/mach-try-perf/perfdocs/index.rst
View File

@@ -92,7 +92,8 @@ The tool is built to be conservative about the number of tests to run, so if you
--env ENV Set an environment variable, of the form FOO=BAR. Can
be passed in multiple times.
--gecko-profile Create and upload a gecko profile during talos/raptor
tasks.
tasks. Copy paste the parameters used in this profiling
run directly from about:profiling in Nightly.
--gecko-profile-interval GECKO_PROFILE_INTERVAL
How frequently to take samples (ms)
--gecko-profile-entries GECKO_PROFILE_ENTRIES

2
testing/performance/perftest-in-a-nutshell/perfdocs/index.rst
View File

@@ -183,7 +183,7 @@ You can also find the profiles in the artifacts tab of the Raptor test:
:scale: 50%
:align: center
To generate the profiles locally, you can pass the flags ``--extra-profiler-run`` or ``--gecko-profile`` which repeat the test for an extra iteration with the profiler enabled, or run the test from the beginning with the profiler enabled for three iterations, respectively.
To generate the profiles locally, you can pass the flags ``--extra-profiler-run`` or ``--gecko-profile`` which repeat the test for an extra iteration with the profiler enabled, or run the test from the beginning with the profiler enabled for three iterations, respectively. It's also possible to specify more configuration such as the profiled threads, the sampling interval or the profiler features being enabled. The parameters used in a profiling run can be copied directly from the about:profiling page in any Nightly build: click the button at the top of the page, then pick the option "Copy parameters for performance tests".
Side-by-Side
------------

5
testing/raptor/raptor/cmdline.py
View File

@@ -186,10 +186,11 @@ def create_parser(mach_interface=False):
"--gecko-profile",
action="store_true",
dest="gecko_profile",
help="Profile the run and out-put the results in $MOZ_UPLOAD_DIR. "
help="Profile the run and output the results in $MOZ_UPLOAD_DIR. "
"After talos is finished, profiler.firefox.com will be launched in Firefox "
"so you can analyze the local profiles. To disable auto-launching of "
"profiler.firefox.com, set the DISABLE_PROFILE_LAUNCH=1 env var.",
"profiler.firefox.com, set the DISABLE_PROFILE_LAUNCH=1 env var. "
"Copy paste the parameters used in this profiling run directly from about:profiling in Nightly.",
)
add_arg(
"--gecko-profile-entries",

2
testing/raptor/raptor/perfdocs/browsertime.rst
View File

@@ -276,6 +276,8 @@ To run gecko profiling using Raptor-Browsertime you can add the ``--gecko-profil
./mach raptor -t amazon --gecko-profile
It's also possible to specify more configuration such as the profiled threads, the sampling interval or the profiler features being enabled. The parameters used in a profiling run can be copied directly from the about:profiling page in any Nightly build: click the button at the top of the page, then pick the option "Copy parameters for performance tests".
Note that vanilla Browsertime does support Gecko Profiling but **it does not symbolicate the profiles** so it is **not recommended** to use for debugging performance regressions/improvements.
Gathering a Chrome trace with Raptor-Browsertime

3
testing/talos/talos/cmdline.py
View File

@@ -144,7 +144,8 @@ def create_parser(mach_interface=False):
"After talos is finished, profiler.firefox.com will be launched in "
"Firefox so you can analyze the local profiles. To disable "
"auto-launching of profiler.firefox.com set the "
"DISABLE_PROFILE_LAUNCH=1 env var.",
"DISABLE_PROFILE_LAUNCH=1 env var. "
"Copy paste the parameters used in this profiling run directly from about:profiling in Nightly.",
)
add_arg(
"--gecko-profile-interval",

5
tools/tryselect/task_config.py
View File

@@ -438,7 +438,10 @@ class GeckoProfile(TryConfig):
"dest": "profile",
"action": "store_true",
"default": False,
"help": "Create and upload a gecko profile during talos/raptor tasks.",
"help": (
"Create and upload a gecko profile during talos/raptor tasks. "
"Copy paste the parameters used in this profiling run directly from about:profiling in Nightly."
),
},
],
[