Index: tools/run-perf-test.cfg |
diff --git a/tools/run-perf-test.cfg b/tools/run-perf-test.cfg |
index b10026b3e537fd4a2704df3c14d4a6670b86345c..2529fca92f3657cbd6adf52146995b8144c34d0b 100644 |
--- a/tools/run-perf-test.cfg |
+++ b/tools/run-perf-test.cfg |
@@ -1,7 +1,77 @@ |
+# Copyright 2013 The Chromium Authors. All rights reserved. |
+# Use of this source code is governed by a BSD-style license that can be |
+# found in the LICENSE file. |
+ |
+"""Config file for Run Performance Test Bot |
+ |
+This script is intended for use by anyone that wants to run a remote performance |
+test. Modify the config below and add the command to run the performance test, |
+the metric you're interested in, and repeat/discard parameters. You can then |
+run a git try <bot>. |
+ |
+Changes to this file should never be submitted. |
+ |
+Args: |
+ 'command': This is the full command line to pass to the |
+ bisect-perf-regression.py script in order to execute the test. |
+ 'metric': The name of the metric to parse out from the results of the |
+ performance test. You can retrieve the metric by looking at the stdio of |
+ the performance test. Look for lines of the format: |
+ |
+ RESULT <graph>: <trace>= <value> <units> |
+ |
+ The metric name is "<graph>/<trace>". |
+ 'repeat_count': The number of times to repeat the performance test. |
+ 'max_time_minutes': The script will attempt to run the performance test |
+ "repeat_count" times, unless it exceeds "max_time_minutes". |
+ 'truncate_percent': Discard the highest/lowest % values from performance test. |
+ |
+Sample config: |
+ |
config = { |
- "command": "python tools/perf/run_benchmark --browser=release memory.top_7_stress_slimming_paint", |
- "max_time_minutes": "120", |
- "repeat_count": "1", |
- "target_arch": "ia32", |
- "truncate_percent": "0" |
-} |
+ 'command': './tools/perf/run_benchmark --browser=release smoothness.key_mobile_sites', |
+ 'metric': 'mean_frame_time/mean_frame_time', |
+ 'repeat_count': '20', |
+ 'max_time_minutes': '20', |
+ 'truncate_percent': '25', |
+} |
+ |
+On Windows: |
+ - If you're calling a python script you will need to add "python" to |
+the command: |
+ |
+config = { |
+ 'command': 'python tools/perf/run_benchmark -v --browser=release smoothness.key_mobile_sites', |
+ 'metric': 'mean_frame_time/mean_frame_time', |
+ 'repeat_count': '20', |
+ 'max_time_minutes': '20', |
+ 'truncate_percent': '25', |
+} |
+ |
+ |
+On ChromeOS: |
+ - Script accepts either ChromeOS versions, or unix timestamps as revisions. |
+ - You don't need to specify --identity and --remote, they will be added to |
+ the command using the bot's BISECT_CROS_IP and BISECT_CROS_BOARD values. |
+ |
+config = { |
+ 'command': './tools/perf/run_benchmark -v '\ |
+ '--browser=cros-chrome-guest '\ |
+ 'smoothness.key_mobile_sites', |
+ 'metric': 'mean_frame_time/mean_frame_time', |
+ 'repeat_count': '20', |
+ 'max_time_minutes': '20', |
+ 'truncate_percent': '25', |
+} |
+ |
+""" |
+ |
+config = { |
+ 'command': '', |
+ 'metric': '', |
+ 'repeat_count': '', |
+ 'max_time_minutes': '', |
+ 'truncate_percent': '', |
+} |
+ |
+# Workaround git try issue, see crbug.com/257689 |