2020-02-18 20:41:20 -07:00
|
|
|
## Resources for Go's trace viewer
|
2015-01-30 03:31:43 -07:00
|
|
|
|
2020-02-18 20:41:20 -07:00
|
|
|
Go execution trace UI (`go tool trace`) embeds
|
|
|
|
Chrome's trace viewer (Catapult) following the
|
|
|
|
[instructions](
|
|
|
|
https://chromium.googlesource.com/catapult/+/refs/heads/master/tracing/docs/embedding-trace-viewer.md). This directory contains
|
|
|
|
the helper files to embed Chrome's trace viewer.
|
|
|
|
|
|
|
|
The current resources were generated/copied from
|
|
|
|
[`Catapult@9508452e18f130c98499cb4c4f1e1efaedee8962`](
|
|
|
|
https://chromium.googlesource.com/catapult/+/9508452e18f130c98499cb4c4f1e1efaedee8962).
|
|
|
|
|
|
|
|
### Updating `trace_viewer_full.html`
|
|
|
|
|
|
|
|
The file was generated by catapult's `vulcanize_trace_viewer` command.
|
2015-05-09 21:04:04 -06:00
|
|
|
```
|
2020-02-18 20:41:20 -07:00
|
|
|
$ git clone https://chromium.googlesource.com/catapult
|
|
|
|
$ cd catapult
|
|
|
|
$ ./tracing/bin/vulcanize_trace_viewer --config=full
|
|
|
|
$ cp tracing/bin/trace_viewer_full.html $GOROOT/misc/trace/trace_viewer_full.html
|
2015-05-09 21:04:04 -06:00
|
|
|
```
|
2020-02-18 20:41:20 -07:00
|
|
|
|
2016-04-14 08:31:42 -06:00
|
|
|
We are supposed to use --config=lean (produces smaller html),
|
|
|
|
but it is broken at the moment:
|
|
|
|
https://github.com/catapult-project/catapult/issues/2247
|
2015-05-09 21:04:04 -06:00
|
|
|
|
2020-02-18 20:41:20 -07:00
|
|
|
### Updating `webcomponents.min.js`
|
|
|
|
|
|
|
|
`webcomponents.min.js` is necessary to let the trace viewer page
|
|
|
|
to import the `trace_viewer_full.html`.
|
|
|
|
This is copied from the catapult repo.
|
|
|
|
|
|
|
|
```
|
|
|
|
$ cp third_party/polymer/components/webcomponentsjs/webcomponents.min.js $GOROOT/misc/trace/webcomponents.min.js
|
|
|
|
```
|
|
|
|
|
|
|
|
## Licenses
|
|
|
|
|
2015-05-09 21:04:04 -06:00
|
|
|
The license for trace-viewer is as follows:
|
|
|
|
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
|
|
|
|
//
|
|
|
|
// Redistribution and use in source and binary forms, with or without
|
|
|
|
// modification, are permitted provided that the following conditions are
|
|
|
|
// met:
|
|
|
|
//
|
|
|
|
// * Redistributions of source code must retain the above copyright
|
|
|
|
// notice, this list of conditions and the following disclaimer.
|
|
|
|
// * Redistributions in binary form must reproduce the above
|
|
|
|
// copyright notice, this list of conditions and the following disclaimer
|
|
|
|
// in the documentation and/or other materials provided with the
|
2020-02-18 20:41:20 -07:00
|
|
|
// distribution.
|
|
|
|
// * Neither the name of Google Inc. nor the names of its
|
|
|
|
// contributors may be used to endorse or promote products derived from
|
|
|
|
// this software without specific prior written permission.
|
|
|
|
//
|
|
|
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
|
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
|
|
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
|
|
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
|
|
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
|
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
|
|
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
|
|
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
|
|
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
|
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
|
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
|
|
|
|
The license for webcomponents.min.js is as follows:
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @license
|
|
|
|
* Copyright (c) 2014 The Polymer Project Authors. All rights reserved.
|
|
|
|
* This code may only be used under the BSD style license found at http://polymer.github.io/LICENSE.txt
|
|
|
|
* The complete set of authors may be found at http://polymer.github.io/AUTHORS.txt
|
|
|
|
* The complete set of contributors may be found at http://polymer.github.io/CONTRIBUTORS.txt
|
|
|
|
* Code distributed by Google as part of the polymer project is also
|
|
|
|
* subject to an additional IP rights grant found at http://polymer.github.io/PATENTS.txt
|
|
|
|
*/
|
|
|
|
// Copyright (c) 2014 The Polymer Authors. All rights reserved.
|
|
|
|
//
|
|
|
|
// Redistribution and use in source and binary forms, with or without
|
|
|
|
// modification, are permitted provided that the following conditions are
|
|
|
|
// met:
|
|
|
|
//
|
|
|
|
// * Redistributions of source code must retain the above copyright
|
|
|
|
// notice, this list of conditions and the following disclaimer.
|
|
|
|
// * Redistributions in binary form must reproduce the above
|
|
|
|
// copyright notice, this list of conditions and the following disclaimer
|
|
|
|
// in the documentation and/or other materials provided with the
|
2015-05-09 21:04:04 -06:00
|
|
|
// distribution.
|
|
|
|
// * Neither the name of Google Inc. nor the names of its
|
|
|
|
// contributors may be used to endorse or promote products derived from
|
|
|
|
// this software without specific prior written permission.
|
|
|
|
//
|
|
|
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
|
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
|
|
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
|
|
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
|
|
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
|
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
|
|
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
|
|
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
|
|
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
|
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
|
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|