tools/telemetry/docs/pydoc/telemetry.web_perf.timeline_interaction_record.html - Issue 1647513002: Delete tools/telemetry.

Unified Diff: tools/telemetry/docs/pydoc/telemetry.web_perf.timeline_interaction_record.html

Issue 1647513002: Delete tools/telemetry. (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master

Patch Set: Created 4 years, 11 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View side-by-side diff with in-line comments

Download patch

« no previous file with comments | « tools/telemetry/docs/pydoc/telemetry.web_perf.timeline_based_page_test.html ('k') | tools/telemetry/docs/pydoc/telemetry.wpr.html » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

Index: tools/telemetry/docs/pydoc/telemetry.web_perf.timeline_interaction_record.html

diff --git a/tools/telemetry/docs/pydoc/telemetry.web_perf.timeline_interaction_record.html b/tools/telemetry/docs/pydoc/telemetry.web_perf.timeline_interaction_record.html

deleted file mode 100644

index 34a1639990bcd584e8981189081e40de855d5725..0000000000000000000000000000000000000000

--- a/tools/telemetry/docs/pydoc/telemetry.web_perf.timeline_interaction_record.html

+++ /dev/null

@@ -1,317 +0,0 @@

-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">

-<html><head><title>Python: module telemetry.web_perf.timeline_interaction_record</title>

-<meta charset="utf-8">

-</head><body bgcolor="#f0f0f8">

-<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">

-<tr bgcolor="#7799ee">

-<td valign=bottom>

-  <big><big><a href="telemetry.html">telemetry</a>.<a href="telemetry.web_perf.html">web_perf</a>.timeline_interaction_record</big></big></td

-><td align=right valign=bottom

-><a href=".">index</a> <a href="../telemetry/web_perf/timeline_interaction_record.py">telemetry/web_perf/timeline_interaction_record.py</a></td></tr></table>

- <tt># Copyright 2014 The Chromium Authors. All rights reserved.

-# Use of this source code is governed by a BSD-style license that can be

-# found in the LICENSE file.</tt>

-

-<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

-<tr bgcolor="#aa55cc">

-<td colspan=3 valign=bottom>

-<big>Modules</big></td></tr>

-<tr><td bgcolor="#aa55cc"><tt>      </tt></td><td> </td>

-<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="telemetry.decorators.html">telemetry.decorators</a>

-</td><td width="25%" valign=top><a href="re.html">re</a>

-</td><td width="25%" valign=top><a href="telemetry.timeline.bounds.html">telemetry.timeline.bounds</a>

-</td><td width="25%" valign=top></td></tr></table></td></tr></table>

-<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

-<tr bgcolor="#ee77aa">

-<td colspan=3 valign=bottom>

-<big>Classes</big></td></tr>

-<tr><td bgcolor="#ee77aa"><tt>      </tt></td><td> </td>

-<td width="100%"><dl>

-<dt><a href="__builtin__.html#object">__builtin__.object</a>

-</dt><dd>

-<dl>

-<dt><a href="telemetry.web_perf.timeline_interaction_record.html#TimelineInteractionRecord">TimelineInteractionRecord</a>

-</dt></dl>

-</dd>

-<dt><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>)

-</dt><dd>

-<dl>

-<dt><a href="telemetry.web_perf.timeline_interaction_record.html#ThreadTimeRangeOverlappedException">ThreadTimeRangeOverlappedException</a>

-</dt><dd>

-<dl>

-<dt><a href="telemetry.web_perf.timeline_interaction_record.html#NoThreadTimeDataException">NoThreadTimeDataException</a>

-</dt></dl>

-</dd>

-</dl>

-</dd>

-</dl>

-

-<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

-<tr bgcolor="#ffc8d8">

-<td colspan=3 valign=bottom>

-<a name="NoThreadTimeDataException">class NoThreadTimeDataException</a>(<a href="telemetry.web_perf.timeline_interaction_record.html#ThreadTimeRangeOverlappedException">ThreadTimeRangeOverlappedException</a>)</td></tr>

-<tr bgcolor="#ffc8d8"><td rowspan=2><tt>   </tt></td>

-<td colspan=2><tt><a href="exceptions.html#Exception">Exception</a> that can be thrown if there is not sufficient thread time data

-to compute the overlapped thread time range.  </tt></td></tr>

-<tr><td> </td>

-<td width="100%"><dl><dt>Method resolution order:</dt>

-<dd><a href="telemetry.web_perf.timeline_interaction_record.html#NoThreadTimeDataException">NoThreadTimeDataException</a></dd>

-<dd><a href="telemetry.web_perf.timeline_interaction_record.html#ThreadTimeRangeOverlappedException">ThreadTimeRangeOverlappedException</a></dd>

-<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>

-<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>

-<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

-</dl>

-<hr>

-Data descriptors inherited from <a href="telemetry.web_perf.timeline_interaction_record.html#ThreadTimeRangeOverlappedException">ThreadTimeRangeOverlappedException</a>:

-<dl><dt>__weakref__</dt>

-<dd><tt>list of weak references to the object (if defined)</tt></dd>

-</dl>

-<hr>

-Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

-<dl><dt><a name="NoThreadTimeDataException-__init__">__init__</a>(...)</dt><dd><tt>x.<a href="#NoThreadTimeDataException-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl>

-<hr>

-Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

-<dl><dt>__new__ = <built-in method __new__ of type object><dd><tt>T.<a href="#NoThreadTimeDataException-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl>

-<hr>

-Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

-<dl><dt><a name="NoThreadTimeDataException-__delattr__">__delattr__</a>(...)</dt><dd><tt>x.<a href="#NoThreadTimeDataException-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>

-<dl><dt><a name="NoThreadTimeDataException-__getattribute__">__getattribute__</a>(...)</dt><dd><tt>x.<a href="#NoThreadTimeDataException-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>

-<dl><dt><a name="NoThreadTimeDataException-__getitem__">__getitem__</a>(...)</dt><dd><tt>x.<a href="#NoThreadTimeDataException-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>

-<dl><dt><a name="NoThreadTimeDataException-__getslice__">__getslice__</a>(...)</dt><dd><tt>x.<a href="#NoThreadTimeDataException-__getslice__">__getslice__</a>(i, j) <==> x[i:j]

-

-Use of negative indices is not supported.</tt></dd></dl>

-<dl><dt><a name="NoThreadTimeDataException-__reduce__">__reduce__</a>(...)</dt></dl>

-<dl><dt><a name="NoThreadTimeDataException-__repr__">__repr__</a>(...)</dt><dd><tt>x.<a href="#NoThreadTimeDataException-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl>

-<dl><dt><a name="NoThreadTimeDataException-__setattr__">__setattr__</a>(...)</dt><dd><tt>x.<a href="#NoThreadTimeDataException-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>

-<dl><dt><a name="NoThreadTimeDataException-__setstate__">__setstate__</a>(...)</dt></dl>

-<dl><dt><a name="NoThreadTimeDataException-__str__">__str__</a>(...)</dt><dd><tt>x.<a href="#NoThreadTimeDataException-__str__">__str__</a>() <==> str(x)</tt></dd></dl>

-<dl><dt><a name="NoThreadTimeDataException-__unicode__">__unicode__</a>(...)</dt></dl>

-<hr>

-Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

-<dl><dt>__dict__</dt>

-</dl>

-<dl><dt>args</dt>

-</dl>

-<dl><dt>message</dt>

-</dl>

-</td></tr></table>

-<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

-<tr bgcolor="#ffc8d8">

-<td colspan=3 valign=bottom>

-<a name="ThreadTimeRangeOverlappedException">class ThreadTimeRangeOverlappedException</a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</td></tr>

-<tr bgcolor="#ffc8d8"><td rowspan=2><tt>   </tt></td>

-<td colspan=2><tt><a href="exceptions.html#Exception">Exception</a> that can be thrown when computing overlapped thread time range

-with other events.  </tt></td></tr>

-<tr><td> </td>

-<td width="100%"><dl><dt>Method resolution order:</dt>

-<dd><a href="telemetry.web_perf.timeline_interaction_record.html#ThreadTimeRangeOverlappedException">ThreadTimeRangeOverlappedException</a></dd>

-<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>

-<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>

-<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

-</dl>

-<hr>

-Data descriptors defined here:

-<dl><dt>__weakref__</dt>

-<dd><tt>list of weak references to the object (if defined)</tt></dd>

-</dl>

-<hr>

-Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

-<dl><dt><a name="ThreadTimeRangeOverlappedException-__init__">__init__</a>(...)</dt><dd><tt>x.<a href="#ThreadTimeRangeOverlappedException-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl>

-<hr>

-Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

-<dl><dt>__new__ = <built-in method __new__ of type object><dd><tt>T.<a href="#ThreadTimeRangeOverlappedException-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl>

-<hr>

-Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

-<dl><dt><a name="ThreadTimeRangeOverlappedException-__delattr__">__delattr__</a>(...)</dt><dd><tt>x.<a href="#ThreadTimeRangeOverlappedException-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>

-<dl><dt><a name="ThreadTimeRangeOverlappedException-__getattribute__">__getattribute__</a>(...)</dt><dd><tt>x.<a href="#ThreadTimeRangeOverlappedException-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>

-<dl><dt><a name="ThreadTimeRangeOverlappedException-__getitem__">__getitem__</a>(...)</dt><dd><tt>x.<a href="#ThreadTimeRangeOverlappedException-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>

-<dl><dt><a name="ThreadTimeRangeOverlappedException-__getslice__">__getslice__</a>(...)</dt><dd><tt>x.<a href="#ThreadTimeRangeOverlappedException-__getslice__">__getslice__</a>(i, j) <==> x[i:j]

-

-Use of negative indices is not supported.</tt></dd></dl>

-<dl><dt><a name="ThreadTimeRangeOverlappedException-__reduce__">__reduce__</a>(...)</dt></dl>

-<dl><dt><a name="ThreadTimeRangeOverlappedException-__repr__">__repr__</a>(...)</dt><dd><tt>x.<a href="#ThreadTimeRangeOverlappedException-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl>

-<dl><dt><a name="ThreadTimeRangeOverlappedException-__setattr__">__setattr__</a>(...)</dt><dd><tt>x.<a href="#ThreadTimeRangeOverlappedException-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>

-<dl><dt><a name="ThreadTimeRangeOverlappedException-__setstate__">__setstate__</a>(...)</dt></dl>

-<dl><dt><a name="ThreadTimeRangeOverlappedException-__str__">__str__</a>(...)</dt><dd><tt>x.<a href="#ThreadTimeRangeOverlappedException-__str__">__str__</a>() <==> str(x)</tt></dd></dl>

-<dl><dt><a name="ThreadTimeRangeOverlappedException-__unicode__">__unicode__</a>(...)</dt></dl>

-<hr>

-Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

-<dl><dt>__dict__</dt>

-</dl>

-<dl><dt>args</dt>

-</dl>

-<dl><dt>message</dt>

-</dl>

-</td></tr></table>

-<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

-<tr bgcolor="#ffc8d8">

-<td colspan=3 valign=bottom>

-<a name="TimelineInteractionRecord">class TimelineInteractionRecord</a>(<a href="__builtin__.html#object">__builtin__.object</a>)</td></tr>

-<tr bgcolor="#ffc8d8"><td rowspan=2><tt>   </tt></td>

-<td colspan=2><tt>Represents an interaction that took place during a timeline recording.

-

-As a page runs, typically a number of different (simulated) user interactions

-take place. For instance, a user might click a button in a mail app causing a

-popup to animate in. Then they might press another button that sends data to a

-server and simultaneously closes the popup without an animation. These are two

-interactions.

-

-From the point of view of the page, each interaction might have a different

-label: ClickComposeButton and SendEmail, for instance. From the point

-of view of the benchmarking harness, the labels aren't so interesting as what

-the performance expectations are for that interaction: was it loading

-resources from the network? was there an animation?

-

-Determining these things is hard to do, simply by observing the state given to

-a page from javascript. There are hints, for instance if network requests are

-sent, or if a CSS animation is pending. But this is by no means a complete

-story.

-

-Instead, we expect pages to mark up the timeline what they are doing, with

-label and flags indicating the semantics of that interaction. This

-is currently done by pushing markers into the console.time/timeEnd API: this

-for instance can be issued in JS:

-

-   var str = 'Interaction.SendEmail';

-   console.time(str);

-   setTimeout(function() {

-     console.timeEnd(str);

-   }, 1000);

-

-When run with perf.measurements.timeline_based_measurement running, this will

-then cause a <a href="#TimelineInteractionRecord">TimelineInteractionRecord</a> to be created for this range with

-all metrics reported for the marked up 1000ms time-range.

-

-The valid interaction flags are:

-   * repeatable: Allows other interactions to use the same label  </tt></td></tr>

-<tr><td> </td>

-<td width="100%">Methods defined here:

-<dl><dt><a name="TimelineInteractionRecord-GetBounds">GetBounds</a>(*args, **kwargs)</dt></dl>

-<dl><dt><a name="TimelineInteractionRecord-GetOverlappedThreadTimeForSlice">GetOverlappedThreadTimeForSlice</a>(self, timeline_slice)</dt><dd><tt>Get the thread duration of timeline_slice that overlaps with this record.

-

-There are two cases :

-

-Case 1: timeline_slice runs in the same thread as the record.

-

-              |    [       timeline_slice         ]

-  THREAD 1    |                  |                              |

-              |            record starts                    record ends

-

-                  (relative order in thread time)

-

-  As the thread timestamps in timeline_slice and record are consistent, we

-  simply use them to compute the overlap.

-

-Case 2: timeline_slice runs in a different thread from the record's.

-

-              |

-  THREAD 2    |    [       timeline_slice         ]

-              |

-

-              |

-  THREAD 1    |               |                               |

-              |          record starts                      record ends

-

-                  (relative order in wall-time)

-

-  Unlike case 1, thread timestamps of a thread are measured by its

-  thread-specific clock, which is inconsistent with that of the other

-  thread, and thus can't be used to compute the overlapped thread duration.

-  Hence, we use a heuristic to compute the overlap (see

-  _GetOverlappedThreadTimeForSliceInDifferentThread for more details)

-

-Args:

-  timeline_slice: An instance of telemetry.timeline.slice.Slice</tt></dd></dl>

-<dl><dt><a name="TimelineInteractionRecord-__init__">__init__</a>(self, label, start, end, async_event=None, flags=None)</dt></dl>

-<dl><dt><a name="TimelineInteractionRecord-__repr__">__repr__</a>(self)</dt></dl>

-<hr>

-Class methods defined here:

-<dl><dt><a name="TimelineInteractionRecord-FromAsyncEvent">FromAsyncEvent</a>(cls, async_event) from <a href="__builtin__.html#type">__builtin__.type</a></dt><dd><tt>Construct an timeline_interaction_record from an async event.

-Args:

-  async_event: An instance of

-    telemetry.timeline.async_slices.AsyncSlice</tt></dd></dl>

-<hr>

-Data descriptors defined here:

-<dl><dt>__dict__</dt>

-<dd><tt>dictionary for instance variables (if defined)</tt></dd>

-</dl>

-<dl><dt>__weakref__</dt>

-<dd><tt>list of weak references to the object (if defined)</tt></dd>

-</dl>

-<dl><dt>end</dt>

-</dl>

-<dl><dt>label</dt>

-</dl>

-<dl><dt>repeatable</dt>

-</dl>

-<dl><dt>start</dt>

-</dl>

-</td></tr></table></td></tr></table>

-<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

-<tr bgcolor="#eeaa77">

-<td colspan=3 valign=bottom>

-<big>Functions</big></td></tr>

-<tr><td bgcolor="#eeaa77"><tt>      </tt></td><td> </td>

-<td width="100%"><dl><dt><a name="-GetJavaScriptMarker">GetJavaScriptMarker</a>(label, flags)</dt><dd><tt>Computes the marker string of an interaction record.

-

-This marker string can be used with JavaScript API console.time()

-and console.timeEnd() to mark the beginning and end of the

-interaction record..

-

-Args:

-  label: The label used to identify the interaction record.

-  flags: the flags for the interaction record see FLAGS above.

-

-Returns:

-  The interaction record marker string (e.g., Interaction.Label/flag1,flag2).

-

-Raises:

-  AssertionError: If one or more of the flags is unrecognized.</tt></dd></dl>

- <dl><dt><a name="-IsTimelineInteractionRecord">IsTimelineInteractionRecord</a>(event_name)</dt></dl>

-</td></tr></table>

-<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

-<tr bgcolor="#55aa55">

-<td colspan=3 valign=bottom>

-<big>Data</big></td></tr>

-<tr><td bgcolor="#55aa55"><tt>      </tt></td><td> </td>

-<td width="100%">FLAGS = ['repeatable']

-REPEATABLE = 'repeatable'</td></tr></table>

-</body></html>