blob: 10da93e7c3936a9ef9a1ac9df881d20456f4d6e3 [file] [log] [blame] [view]
Przemyslaw Pietrzkiewicz1d909942015-08-28 16:27:56 +02001# benchmark
2
3This application connects to another mojo application, collects traces during
4indicated period of time and computes a number of results based on the collected
5traces. It can be used to measure performance of a mojo app, provided that the
6app being benchmarked participates in the [tracing
Przemyslaw Pietrzkiewicz91a18d92015-08-31 15:08:01 +02007ecosystem](../../mojo/services/tracing/public/interfaces/tracing.mojom).
Przemyslaw Pietrzkiewicz1d909942015-08-28 16:27:56 +02008
9## Arguments
10
Przemyslaw Pietrzkiewiczddfda662015-09-16 15:56:39 +020011The benchmarking app **requires** the following arguments:
Przemyslaw Pietrzkiewicz1d909942015-08-28 16:27:56 +020012
13 - `--app=<app_url>` - url of the application to be benchmarked
14 - `--duration=<duration_seconds>` - duration of the benchmark in seconds
15
Przemyslaw Pietrzkiewiczddfda662015-09-16 15:56:39 +020016The following arguments are **optional**:
17
18 - `--trace-output=<output_file_path>` - local file path at which the collected trace
19 will be written
20
21Any other arguments are assumed to be descriptions of measurements to be
Przemyslaw Pietrzkiewicz1d909942015-08-28 16:27:56 +020022conducted on the collected trace data. Each measurement has to be of form:
23`<measurement_type>/<trace_event_category>/<trace_event_name>`.
24
25The following measurement types are available:
26
27 - `time_until` - measures time until the first occurence of the event named
28 `trace_event_name` in category `trace_event_category`.
29 - `avg_duration` - measures average duration of all events named
30 `trace_event_name` in category `trace_event_category`.
31
32## Runner script
33
Przemyslaw Pietrzkiewicz91a18d92015-08-31 15:08:01 +020034Devtools offers [a helper script](../../mojo/devtools/common/mojo_benchmark)
Przemyslaw Pietrzkiewicz845d0982015-09-14 15:55:43 +020035allowing to run a list of benchmarks in controlled caching conditions, both
Przemyslaw Pietrzkiewiczddfda662015-09-16 15:56:39 +020036on **Android** and **Linux**.