OLD | NEW |
1 | 1 |
2 <!-- Copyright 2015 The Chromium Authors. All rights reserved. | 2 <!-- Copyright 2015 The Chromium Authors. All rights reserved. |
3 Use of this source code is governed by a BSD-style license that can be | 3 Use of this source code is governed by a BSD-style license that can be |
4 found in the LICENSE file. | 4 found in the LICENSE file. |
5 --> | 5 --> |
6 ![Trace Viewer Logo](https://raw.githubusercontent.com/catapult-project/catapult
/master/tracing/images/trace-viewer-circle-blue.png) | 6 ![Trace Viewer Logo](https://raw.githubusercontent.com/catapult-project/catapult
/master/tracing/images/trace-viewer-circle-blue.png) |
7 | 7 |
8 Trace-Viewer is the javascript frontend for Chrome [about:tracing](http://dev.ch
romium.org/developers/how-tos/trace-event-profiling-tool) and [Android | 8 Trace-Viewer is the javascript frontend for Chrome [about:tracing](http://dev.ch
romium.org/developers/how-tos/trace-event-profiling-tool) and [Android |
9 systrace](http://developer.android.com/tools/help/systrace.html). | 9 systrace](http://developer.android.com/tools/help/systrace.html). |
10 | 10 |
11 It provides rich analysis and visualization capabilities for many types of trace | 11 It provides rich analysis and visualization capabilities for many types of trace |
12 files. Its particularly good at viewing linux kernel traces (aka [ftrace](https:
//www.kernel.org/doc/Documentation/trace/ftrace.txt)) and Chrome's | 12 files. Its particularly good at viewing linux kernel traces (aka [ftrace](https:
//www.kernel.org/doc/Documentation/trace/ftrace.txt)) and Chrome's |
13 [trace_event format](https://docs.google.com/document/d/1CvAClvFfyA5R-PhYUmn5OOQ
tYMH4h6I0nSsKchNAySU/preview). Trace viewer can be [embedded](https://github.com
/catapult-project/catapult/wiki/Embedding-Trace-Viewer) as a component in your o
wn code, or used from a plain checkout to turn trace files into standalone, emai
lable HTML files from the commandline: | 13 [trace_event format](https://docs.google.com/document/d/1CvAClvFfyA5R-PhYUmn5OOQ
tYMH4h6I0nSsKchNAySU/preview). Trace viewer can be [embedded](https://github.com
/catapult-project/catapult/wiki/Embedding-Trace-Viewer) as a component in your o
wn code, or used from a plain checkout to turn trace files into standalone, emai
lable HTML files from the commandline: |
14 | 14 |
15 ./tracing/trace2html my_trace.json --output=my_trace.html && open my_trace.h
tml | 15 ``` |
| 16 $CATAPULT/tracing/bin/trace2html my_trace.json --output=my_trace.html && open my
_trace.html |
| 17 ``` |
16 | 18 |
17 Its easy to [extend trace viewer](https://github.com/catapult-project/catapult/w
iki/Extending-and-Customizing-Trace-Viewer) to support your favorite trace forma
t, or add domain specific visualizations to the UI to simplify drilling down int
o complex data. | 19 Its easy to [extend trace viewer](https://github.com/catapult-project/catapult/w
iki/Extending-and-Customizing-Trace-Viewer) to support your favorite trace forma
t, or add domain specific visualizations to the UI to simplify drilling down int
o complex data. |
18 | 20 |
19 Contributing, quick version | 21 Contributing, quick version |
20 =========================================================================== | 22 === |
21 We welcome contributions! To hack on this code, from toplevel: | 23 We welcome contributions! To hack on this code. |
22 ./bin/run_dev_server | |
23 | 24 |
24 In any browser, navigate to | 25 There are two type of tests. |
25 http://localhost:8003/ | |
26 | 26 |
27 To run all python unittests: | 27 ### In the browser |
28 ./tracing/run_py_tests | |
29 | 28 |
30 To run all tracing unittests in d8 environment: | 29 Run http server `$CATAPULT/bin/run_dev_server`. In any browser, navigate to `htt
p://localhost:8003/` |
31 ./tracing/run_vinn_tests | |
32 | 30 |
33 To run all the unittests, you can also do: | 31 **Unit tests**| **Descripton** |
| 32 --- | --- |
| 33 All tests | http://localhost:8003/tests.html |
| 34 All tests with short format | http://localhost:8003/tracing/tests.html?shortForm
at |
| 35 An individual test suite(such as ui/foo_test.js) | http://localhost:8003/tests.h
tml?testSuiteName=ui.foo |
| 36 Tests named foo| http://localhost:8003/tests.html?testFilterString=foo |
34 | 37 |
35 ./tracing/run_tests | 38 ### On command |
| 39 |
| 40 **Unit tests**| **Description** |
| 41 --- | --- |
| 42 All python tests | `$CATAPULT/tracing/bin/run_py_tests` |
| 43 All tracing tests in d8 environment | `$CATAPULT/tracing/bin/run_vinn_tests` |
| 44 All tests | `$CATAPULT/tracing/bin/run_tests` |
36 | 45 |
37 Make sure tests pass before sending us changelist. **We use rietveld for coderev
iew**. For more details, esp on rietveld, [read our contributing guide](https://
github.com/catapult-project/catapult/blob/master/CONTRIBUTING.md) or check out t
he [trace viewer wiki](https://github.com/catapult-project/catapult/wiki/Trace-V
iewer-Getting-Started). | 46 Make sure tests pass before sending us changelist. **We use rietveld for coderev
iew**. For more details, esp on rietveld, [read our contributing guide](https://
github.com/catapult-project/catapult/blob/master/CONTRIBUTING.md) or check out t
he [trace viewer wiki](https://github.com/catapult-project/catapult/wiki/Trace-V
iewer-Getting-Started). |
38 | 47 |
39 Contact Us | 48 Contact Us |
40 =========================================================================== | 49 === |
41 Join our Google Group: | 50 Join our Google Group: |
42 * [tracing@chromium.org](https://groups.google.com/a/chromium.org/forum/#!forum/
tracing) | 51 * [tracing@chromium.org](https://groups.google.com/a/chromium.org/forum/#!forum/
tracing) |
OLD | NEW |