1<!-- Copyright 2015 The Chromium Authors. All rights reserved.
2     Use of this source code is governed by a BSD-style license that can be
3     found in the LICENSE file.
4-->
5[![Build Status](https://travis-ci.org/google/trace-viewer.svg?branch=master)](https://travis-ci.org/google/trace-viewer)
6
7![Trace Viewer Logo](https://raw.githubusercontent.com/google/trace-viewer/master/tracing/images/trace-viewer-circle-blue.png)
8
9Trace-Viewer is the javascript frontend for Chrome [about:tracing](http://dev.chromium.org/developers/how-tos/trace-event-profiling-tool) and [Android
10systrace](http://developer.android.com/tools/help/systrace.html).
11
12It provides rich analysis and visualization capabilities for many types of trace
13files. Its particularly good at viewing linux kernel traces (aka [ftrace](https://www.kernel.org/doc/Documentation/trace/ftrace.txt)) and Chrome's
14[trace_event format](https://docs.google.com/document/d/1CvAClvFfyA5R-PhYUmn5OOQtYMH4h6I0nSsKchNAySU/preview). Trace viewer can be [embedded](https://github.com/google/trace-viewer/wiki/Embedding) 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:
15
16    ./tracing/trace2html my_trace.json --output=my_trace.html && open my_trace.html
17
18Its easy to [extend trace viewer](https://github.com/google/trace-viewer/wiki/ExtendingAndCustomizing) to support your favorite trace format, or add domain specific visualizations to the UI to simplify drilling down into complex data.
19
20Contributing, quick version
21===========================================================================
22We welcome contributions! To hack on this code, from toplevel:
23  ./tracing/run_dev_server
24
25In any browser, navigate to
26  http://localhost:8003/
27
28To run all python unittests:
29  ./tracing/run_py_tests
30
31To run all tracing unittests in d8 environment:
32 ./tracing/run_d8_tests
33
34To run all the unittests, you can also do:
35
36 ./tracing/run_tests
37
38Make 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/google/trace-viewer/wiki/Contributing) or check out the [trace viewer wiki](https://github.com/google/trace-viewer/wiki).
39
40Contact Us
41===========================================================================
42Join our Google Groups:
43* [trace-viewer](https://groups.google.com/forum/#!forum/trace-viewer)
44* [trace-viewer-bugs](https://groups.google.com/forum/#!forum/trace-viewer-bugs)
45* [tracing@chromium.org](https://groups.google.com/a/chromium.org/forum/#!forum/tracing) (for c++ backend code)
46