1 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 4 found in the LICENSE file. 5--> 6![Trace Viewer Logo](https://raw.githubusercontent.com/catapult-project/catapult/master/tracing/images/trace-viewer-circle-blue.png) 7 8Trace-Viewer is the javascript frontend for Chrome [about:tracing](http://dev.chromium.org/developers/how-tos/trace-event-profiling-tool) and [Android 9systrace](http://developer.android.com/tools/help/systrace.html). 10 11It provides rich analysis and visualization capabilities for many types of trace 12files. 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-PhYUmn5OOQtYMH4h6I0nSsKchNAySU/preview). Trace viewer can be [embedded](https://github.com/catapult-project/catapult/wiki/Embedding-Trace-Viewer) as a component in your own code, or used from a plain checkout to turn trace files into standalone, emailable HTML files from the commandline: 14 15``` 16$CATAPULT/tracing/bin/trace2html my_trace.json --output=my_trace.html && open my_trace.html 17``` 18 19Its easy to [extend trace viewer](https://github.com/catapult-project/catapult/wiki/Extending-and-Customizing-Trace-Viewer) to support your favorite trace format, or add domain specific visualizations to the UI to simplify drilling down into complex data. 20 21Contributing, quick version 22=== 23We welcome contributions! To hack on this code. 24 25There are two type of tests. 26 27### In the browser 28 29Run http server `$CATAPULT/bin/run_dev_server`. In any browser, navigate to `http://localhost:8003/` 30 31**Unit tests**| **Descripton** 32--- | --- 33All tests | http://localhost:8003/tests.html 34All tests with short format | http://localhost:8003/tracing/tests.html?shortFormat 35An individual test suite(such as ui/foo_test.js) | http://localhost:8003/tests.html?testSuiteName=ui.foo 36Tests named foo| http://localhost:8003/tests.html?testFilterString=foo 37 38### On command 39 40**Unit tests**| **Description** 41--- | --- 42All python tests | `$CATAPULT/tracing/bin/run_py_tests` 43All tracing tests in d8 environment | `$CATAPULT/tracing/bin/run_vinn_tests` 44All tests | `$CATAPULT/tracing/bin/run_tests` 45 46Make sure tests pass before sending us changelist. **We use rietveld for codereview**. For more details, esp on rietveld, [read our contributing guide](https://github.com/catapult-project/catapult/blob/master/CONTRIBUTING.md) or check out the [trace viewer wiki](https://github.com/catapult-project/catapult/wiki/Trace-Viewer-Getting-Started). 47 48Contact Us 49=== 50Join our Google Group: 51* [tracing@chromium.org](https://groups.google.com/a/chromium.org/forum/#!forum/tracing) 52