Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(1099)

Unified Diff: pkg/analysis_server/benchmark/readme.md

Issue 2986293002: Redo our benchmarks; add a benchmark/benchmarks.dart tool. (Closed)
Patch Set: copyright year Created 3 years, 4 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
Index: pkg/analysis_server/benchmark/readme.md
diff --git a/pkg/analysis_server/benchmark/readme.md b/pkg/analysis_server/benchmark/readme.md
new file mode 100644
index 0000000000000000000000000000000000000000..b87b691eca5b2519197f041c1fc319480abd8ab7
--- /dev/null
+++ b/pkg/analysis_server/benchmark/readme.md
@@ -0,0 +1,37 @@
+# Analysis Server Benchmarks
+
+## How to run the benchmarks
+
+To see a list of all available benchmarks, run:
+
+```
+dart benchmarks/benchmarks.dart list
+```
+
+To run an individual benchmark, run:
+
+```
+dart benchmarks/benchmarks.dart run <benchmark-id>
+```
+
+## How they're tested
+
+In order to make sure that our benchmarks don't regress in terms of their
+ability to run, we create one unit test per benchmark, and run those tests
+as part of our normal CI test suite.
+
+To save time on the CI, we only run one iteration of each benchmark
+(`--repeat=1`), and we run the benchmark on a smaller data set (`--quick`).
+
+See `test/benchmark_test.dart`.
+
+## To add a new benchmark
+
+Register the new benchmark in then main() method of benchmarks/benchmarks.dart.
+
+## On the bots
+
+Our benchmarks run on a continuous performance testing system. It will run
+any benchmark produced by the `benchmarks/benchmarks.dart list` command.
+
+To not run a benchmark on the bot, define the benchmark with the `disable` flag.
« no previous file with comments | « pkg/analysis_server/benchmark/perf/completion_timing_tests.dart ('k') | pkg/analysis_server/test/benchmarks_test.dart » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698