Skip to content

Commit

Permalink
[docs] Update memory-infra/memory_benchmarks on pinpoint jobs
Browse files Browse the repository at this point in the history
Remove reference to no longer existing `run_benchmark try` command, and
describe pinpoint try jobs instead.

Bug: 884146
Change-Id: I95370496463b1adfe046c3bf48d3923e18831bf9
Reviewed-on: https://chromium-review.googlesource.com/c/1349322
Reviewed-by: Dave Tu <dtu@chromium.org>
Commit-Queue: Juan Antonio Navarro Pérez <perezju@chromium.org>
Cr-Commit-Position: refs/heads/master@{#617433}
  • Loading branch information
perezju authored and Commit Bot committed Dec 18, 2018
1 parent f894c4d commit 9e50ddd
Showing 1 changed file with 36 additions and 26 deletions.
62 changes: 36 additions & 26 deletions docs/memory-infra/memory_benchmarks.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,42 @@ buildbot output and a link to the trace file taken during the buildbot run.

## How to run the benchmarks

Benchmarks may be run on a local platform/device or remotely on a try job.
Benchmarks may be run on a local platform/device or remotely on a pinpoint
try job.

### How to run a pinpoint try job

Given a patch already uploaded to code review, try jobs provide a convenient
way to evaluate its memory implications on devices or platforms which
may not be immediately available to developers.

![New pinpoint try job dialog](https://storage.googleapis.com/chromium-docs.appspot.com/yHRMmUqraqJ.png)

To start a try job go to the [pinpoint][] website, click on the `+` button to
create a new job, and fill in the required details:

[pinpoint]: https://pinpoint-dot-chromeperf.appspot.com/

* **Bug ID** (optional): The id of a crbug.com issue where pinpoint can post
updates when the job finishes.
* **Gerrit URL**: URL to the patch you want to test. Note that your patch can
live in chromium or any of its sub-repositories!
* **Bot**: Select a suitable device/platform from the drop-down menu on which
to run your job.
* **Benchmark**: The name of the benchmark to run. If you are interested in
memory try `system_health.memory_mobile` or `system_health.memory_desktop`
as appropriate.
* **Story** (optional): A pattern passed to Telemetry's `--story-filter`
option to only run stories that match the pattern.
* **Extra Test Arguments** (optional): Additional command line arguments for
Telemetry's `run_benchmark`. Of note, if you are interested in running a
small but representative sample of system health stories you can pass
`--story-tag-filter health_check`.

If you have more specific needs, or need to automate the creation of jobs, you
can also consider using [pinpoint_cli][].

[pinpoint_cli]: https://cs.chromium.org/chromium/src/third_party/catapult/experimental/soundwave/bin/pinpoint_cli

### How to run locally

Expand Down Expand Up @@ -138,31 +173,6 @@ on your device and use `--browser android-webview`.
[memory-infra]: /docs/memory-infra/README.md
[webview_install]: https://www.chromium.org/developers/how-tos/build-instructions-android-webview

### How to run a try job

Given a patch on a chromium checkout, try jobs provide a convenient way to
evaluate its memory implications on devices or platforms which
may not be immediately available to developers.

To start a try job [upload a CL][contributing] and run the command, e.g.:

```
$SRC/tools/perf/run_benchmark try android-nexus5 system_health.memory_mobile
```

This will run all of the system health stories for you, and conveniently
provide a `results.html` file comparing measurements with/without your patch.
Options like `--story-filter` and `--pageset-repeat` may also be passed to
this command.

To see the full list of available try bots run the command:

```
$SRC/tools/perf/run_benchmark try list
```

[contributing]: https://www.chromium.org/developers/contributing-code

## Understanding memory metrics

There is a large number of [memory-infra][] metrics, breaking down usage
Expand Down

0 comments on commit 9e50ddd

Please sign in to comment.