Commit 6517fa74 authored by Dean Michael Berris's avatar Dean Michael Berris Committed by Commit Bot

Whitespace Change for Pinpoint Sections

Improve layout of the documentation in the README file.

R=johnchen@chromium.org, wenbinzhang@google.com

Change-Id: I7f8303ca5a68f78a7b971999463264eb3abd7f82
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2160667Reviewed-by: default avatarJohn Chen <johnchen@chromium.org>
Commit-Queue: Dean Berris <dberris@chromium.org>
Cr-Commit-Position: refs/heads/master@{#762717}
parent 877011d3
...@@ -7,46 +7,43 @@ ...@@ -7,46 +7,43 @@
This directory contains benchmarks and infrastructure to test Chrome and This directory contains benchmarks and infrastructure to test Chrome and
Chromium and output performance measurements. The benchmarks are run on the Chromium and output performance measurements. The benchmarks are run on the
[perf waterfall](https://ci.chromium.org/p/chrome/g/chrome.perf/console). Most of the [perf waterfall](https://ci.chromium.org/p/chrome/g/chrome.perf/console). Most
benchmarks are run using of the benchmarks are run using
[Telemetry](https://chromium.googlesource.com/catapult.git/+/HEAD/telemetry/README.md), [Telemetry](https://chromium.googlesource.com/catapult.git/+/HEAD/telemetry/README.md),
which is a framework for driving Chrome through test cases ("stories"). which is a framework for driving Chrome through test cases ("stories").
Telemetry often Telemetry often makes use of
makes use of [Web Page Replay [Web Page Replay (WPR)](https://chromium.googlesource.com/catapult.git/+/HEAD/web_page_replay_go/README.md)
(WPR)](https://chromium.googlesource.com/catapult.git/+/HEAD/web_page_replay_go/README.md)
to save a version of a website so that we can measure performance without fear to save a version of a website so that we can measure performance without fear
of the website changing underneath us. of the website changing underneath us.
For doing measurements, Telemetry usually For doing measurements, Telemetry usually makes use of an event tracing system
makes use of an event tracing system built into Chromium. Event data is tracked as built into Chromium. Event data is tracked as Chromium runs. After Chromium
Chromium runs. After Chromium finishes running that event data is processed by either finishes running that event data is processed by either
[TBMv2](https://chromium.googlesource.com/catapult.git/+/HEAD/tracing/tracing/metrics) [TBMv2](https://chromium.googlesource.com/catapult.git/+/HEAD/tracing/tracing/metrics)
(which is the current system) or (which is the current system) or
[TBMv3](https://chromium.googlesource.com/chromium/src/+/HEAD/tools/perf/core/tbmv3) [TBMv3](https://chromium.googlesource.com/chromium/src/+/HEAD/tools/perf/core/tbmv3)
(which is an experimental new system) to create measurements. (which is an experimental new system) to create measurements.
Those measurements Those measurements are uploaded to the
are uploaded to [ChromePerf Dashboard](https://chromeperf.appspot.com/) which [ChromePerf Dashboard](https://chromeperf.appspot.com/) which charts
charts measurements over time and alerts on regressions. Regressions can be measurements over time and alerts on regressions. Regressions can be bisected
bisected using [Pinpoint](https://pinpoint-dot-chromeperf.appspot.com/) to using [Pinpoint](https://pinpoint-dot-chromeperf.appspot.com/) to figure out
figure out which Chromium change caused them. which Chromium change caused them.
Pinpoint can also be used to run Pinpoint can also be used to run try jobs against machines in our data centers.
try jobs against machines in our data centers. Information about available Information about available platforms for testing is available to Googlers at
platforms for testing is available to Googlers at [Chrome Benchmarking [Chrome Benchmarking Sheet](https://goto.google.com/chrome-benchmarking-sheet).
Sheet](https://goto.google.com/chrome-benchmarking-sheet).
Please also read the [Chrome Speed][speed] documentation to Please also read the [Chrome Speed][speed] documentation to learn more about the
learn more about the team organization and, in particular, the top level view team organization and, in particular, the top level view of
of [How Chrome Measures Performance][chrome_perf_how]. [How Chrome Measures Performance][chrome_perf_how].
# Performance tools # Performance tools
This directory contains a variety of tools that can be used to run This directory contains a variety of tools that can be used to run benchmarks,
benchmarks, interact with speed services, and manage performance waterfall interact with speed services, and manage performance waterfall configurations.
configurations. It also has commands for running functional unittests. It also has commands for running functional unittests.
[speed]: /docs/speed/README.md [speed]: /docs/speed/README.md
[chrome_perf_how]: /docs/speed/how_does_chrome_measure_performance.md [chrome_perf_how]: /docs/speed/how_does_chrome_measure_performance.md
...@@ -68,8 +65,8 @@ This may require you to set up your `gsutil config` first. ...@@ -68,8 +65,8 @@ This may require you to set up your `gsutil config` first.
This command allows running benchmarks defined in the chromium repository, This command allows running benchmarks defined in the chromium repository,
specifically in [tools/perf/benchmarks][benchmarks_dir]. If you need it, specifically in [tools/perf/benchmarks][benchmarks_dir]. If you need it,
documentation is available on how to [run benchmarks locally][run_locally] documentation is available on how to [run benchmarks locally][run_locally] and
and how to properly [set up your device][device_setup]. how to properly [set up your device][device_setup].
[benchmarks_dir]: https://cs.chromium.org/chromium/src/tools/perf/benchmarks/ [benchmarks_dir]: https://cs.chromium.org/chromium/src/tools/perf/benchmarks/
[run_locally]: https://chromium.googlesource.com/catapult.git/+/HEAD/telemetry/docs/run_benchmarks_locally.md [run_locally]: https://chromium.googlesource.com/catapult.git/+/HEAD/telemetry/docs/run_benchmarks_locally.md
...@@ -79,16 +76,15 @@ and how to properly [set up your device][device_setup]. ...@@ -79,16 +76,15 @@ and how to properly [set up your device][device_setup].
A helper script to automate various tasks related to the update of A helper script to automate various tasks related to the update of
[Web Page Recordings][wpr] for our benchmarks. In can help creating new [Web Page Recordings][wpr] for our benchmarks. In can help creating new
recordings from live websites, replay those to make sure they recordings from live websites, replay those to make sure they work, upload them
work, upload them to cloud storage, and finally send a CL to review with the to cloud storage, and finally send a CL to review with the new recordings.
new recordings.
[wpr]: https://github.com/catapult-project/catapult/tree/master/web_page_replay_go [wpr]: https://github.com/catapult-project/catapult/tree/master/web_page_replay_go
## pinpoint_cli ## pinpoint_cli
A command line interface to the [pinpoint][] service. Allows to create new A command line interface to the [pinpoint][] service. Allows to create new jobs,
jobs, check the status of jobs, and fetch their measurements as csv files. check the status of jobs, and fetch their measurements as csv files.
[pinpoint]: https://pinpoint-dot-chromeperf.appspot.com [pinpoint]: https://pinpoint-dot-chromeperf.appspot.com
...@@ -101,10 +97,10 @@ A command line interface to the [flakiness dashboard][]. ...@@ -101,10 +97,10 @@ A command line interface to the [flakiness dashboard][].
## soundwave ## soundwave
Allows to fetch data from the [Chrome Performance Dashboard][chromeperf] and Allows to fetch data from the [Chrome Performance Dashboard][chromeperf] and
stores it locally on a SQLite database for further analysis and processing. stores it locally on a SQLite database for further analysis and processing. It
It also allows defining [studies][], pre-sets of measurements a team is also allows defining [studies][], pre-sets of measurements a team is interested
interested in tracking, and uploads them to cloud storage to visualize with the in tracking, and uploads them to cloud storage to visualize with the help of
help of [Data Studio][]. This currently backs the [v8][v8_dashboard] and [Data Studio][]. This currently backs the [v8][v8_dashboard] and
[health][health_dashboard] dashboards. [health][health_dashboard] dashboards.
[chromeperf]: https://chromeperf.appspot.com/ [chromeperf]: https://chromeperf.appspot.com/
...@@ -115,9 +111,9 @@ help of [Data Studio][]. This currently backs the [v8][v8_dashboard] and ...@@ -115,9 +111,9 @@ help of [Data Studio][]. This currently backs the [v8][v8_dashboard] and
## pinboard ## pinboard
Allows scheduling daily [pinpoint][] jobs to compare measurements with/without Allows scheduling daily [pinpoint][] jobs to compare measurements with/without a
a patch being applied. This is useful for teams developing a new feature behind patch being applied. This is useful for teams developing a new feature behind a
a flag, who wants to track the effects on performance as the development of flag, who wants to track the effects on performance as the development of their
their feature progresses. Processed data for relevant measurements is uploaded feature progresses. Processed data for relevant measurements is uploaded to
to cloud storage, where it can be read by [Data Studio][]. cloud storage, where it can be read by [Data Studio][]. This also backs data
This also backs data displayed on the [v8][v8_dashboard] dashboard. displayed on the [v8][v8_dashboard] dashboard.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment