Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(208)

Side by Side 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, 10 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 unified diff | Download patch
OLDNEW
(Empty)
1
2 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3 <html><head><title>Python: module telemetry.web_perf.timeline_interaction_record </title>
4 <meta charset="utf-8">
5 </head><body bgcolor="#f0f0f8">
6
7 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
8 <tr bgcolor="#7799ee">
9 <td valign=bottom>&nbsp;<br>
10 <font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a hre f="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry .web_perf.html"><font color="#ffffff">web_perf</font></a>.timeline_interaction_r ecord</strong></big></big></font></td
11 ><td align=right valign=bottom
12 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href= "../telemetry/web_perf/timeline_interaction_record.py">telemetry/web_perf/timeli ne_interaction_record.py</a></font></td></tr></table>
13 <p><tt>#&nbsp;Copyright&nbsp;2014&nbsp;The&nbsp;Chromium&nbsp;Authors.&nbsp; All&nbsp;rights&nbsp;reserved.<br>
14 #&nbsp;Use&nbsp;of&nbsp;this&nbsp;source&nbsp;code&nbsp;is&nbsp;governed&nbsp;by &nbsp;a&nbsp;BSD-style&nbsp;license&nbsp;that&nbsp;can&nbsp;be<br>
15 #&nbsp;found&nbsp;in&nbsp;the&nbsp;LICENSE&nbsp;file.</tt></p>
16 <p>
17 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
18 <tr bgcolor="#aa55cc">
19 <td colspan=3 valign=bottom>&nbsp;<br>
20 <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big ></font></td></tr>
21
22 <tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td> &nbsp;</td>
23 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=t op><a href="telemetry.decorators.html">telemetry.decorators</a><br>
24 </td><td width="25%" valign=top><a href="re.html">re</a><br>
25 </td><td width="25%" valign=top><a href="telemetry.timeline.bounds.html">telemet ry.timeline.bounds</a><br>
26 </td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
27 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
28 <tr bgcolor="#ee77aa">
29 <td colspan=3 valign=bottom>&nbsp;<br>
30 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big ></font></td></tr>
31
32 <tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td> &nbsp;</td>
33 <td width="100%"><dl>
34 <dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__. object</a>
35 </font></dt><dd>
36 <dl>
37 <dt><font face="helvetica, arial"><a href="telemetry.web_perf.timeline_interacti on_record.html#TimelineInteractionRecord">TimelineInteractionRecord</a>
38 </font></dt></dl>
39 </dd>
40 <dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions .Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException< /a>)
41 </font></dt><dd>
42 <dl>
43 <dt><font face="helvetica, arial"><a href="telemetry.web_perf.timeline_interacti on_record.html#ThreadTimeRangeOverlappedException">ThreadTimeRangeOverlappedExce ption</a>
44 </font></dt><dd>
45 <dl>
46 <dt><font face="helvetica, arial"><a href="telemetry.web_perf.timeline_interacti on_record.html#NoThreadTimeDataException">NoThreadTimeDataException</a>
47 </font></dt></dl>
48 </dd>
49 </dl>
50 </dd>
51 </dl>
52 <p>
53 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
54 <tr bgcolor="#ffc8d8">
55 <td colspan=3 valign=bottom>&nbsp;<br>
56 <font color="#000000" face="helvetica, arial"><a name="NoThreadTimeDataException ">class <strong>NoThreadTimeDataException</strong></a>(<a href="telemetry.web_pe rf.timeline_interaction_record.html#ThreadTimeRangeOverlappedException">ThreadTi meRangeOverlappedException</a>)</font></td></tr>
57
58 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
59 <td colspan=2><tt><a href="exceptions.html#Exception">Exception</a>&nbsp;that&nb sp;can&nbsp;be&nbsp;thrown&nbsp;if&nbsp;there&nbsp;is&nbsp;not&nbsp;sufficient&n bsp;thread&nbsp;time&nbsp;data<br>
60 to&nbsp;compute&nbsp;the&nbsp;overlapped&nbsp;thread&nbsp;time&nbsp;range.<br>&n bsp;</tt></td></tr>
61 <tr><td>&nbsp;</td>
62 <td width="100%"><dl><dt>Method resolution order:</dt>
63 <dd><a href="telemetry.web_perf.timeline_interaction_record.html#NoThreadTimeDat aException">NoThreadTimeDataException</a></dd>
64 <dd><a href="telemetry.web_perf.timeline_interaction_record.html#ThreadTimeRange OverlappedException">ThreadTimeRangeOverlappedException</a></dd>
65 <dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
66 <dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
67 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
68 </dl>
69 <hr>
70 Data descriptors inherited from <a href="telemetry.web_perf.timeline_interaction _record.html#ThreadTimeRangeOverlappedException">ThreadTimeRangeOverlappedExcept ion</a>:<br>
71 <dl><dt><strong>__weakref__</strong></dt>
72 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp ;(if&nbsp;defined)</tt></dd>
73 </dl>
74 <hr>
75 Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception< /a>:<br>
76 <dl><dt><a name="NoThreadTimeDataException-__init__"><strong>__init__</strong></ a>(...)</dt><dd><tt>x.<a href="#NoThreadTimeDataException-__init__">__init__</a> (...)&nbsp;initializes&nbsp;x;&nbsp;see&nbsp;help(type(x))&nbsp;for&nbsp;signatu re</tt></dd></dl>
77
78 <hr>
79 Data and other attributes inherited from <a href="exceptions.html#Exception">exc eptions.Exception</a>:<br>
80 <dl><dt><strong>__new__</strong> = &lt;built-in method __new__ of type object&gt ;<dd><tt>T.<a href="#NoThreadTimeDataException-__new__">__new__</a>(S,&nbsp;...) &nbsp;-&gt;&nbsp;a&nbsp;new&nbsp;<a href="__builtin__.html#object">object</a>&nb sp;with&nbsp;type&nbsp;S,&nbsp;a&nbsp;subtype&nbsp;of&nbsp;T</tt></dl>
81
82 <hr>
83 Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseEx ception</a>:<br>
84 <dl><dt><a name="NoThreadTimeDataException-__delattr__"><strong>__delattr__</str ong></a>(...)</dt><dd><tt>x.<a href="#NoThreadTimeDataException-__delattr__">__d elattr__</a>('name')&nbsp;&lt;==&gt;&nbsp;del&nbsp;x.name</tt></dd></dl>
85
86 <dl><dt><a name="NoThreadTimeDataException-__getattribute__"><strong>__getattrib ute__</strong></a>(...)</dt><dd><tt>x.<a href="#NoThreadTimeDataException-__geta ttribute__">__getattribute__</a>('name')&nbsp;&lt;==&gt;&nbsp;x.name</tt></dd></ dl>
87
88 <dl><dt><a name="NoThreadTimeDataException-__getitem__"><strong>__getitem__</str ong></a>(...)</dt><dd><tt>x.<a href="#NoThreadTimeDataException-__getitem__">__g etitem__</a>(y)&nbsp;&lt;==&gt;&nbsp;x[y]</tt></dd></dl>
89
90 <dl><dt><a name="NoThreadTimeDataException-__getslice__"><strong>__getslice__</s trong></a>(...)</dt><dd><tt>x.<a href="#NoThreadTimeDataException-__getslice__"> __getslice__</a>(i,&nbsp;j)&nbsp;&lt;==&gt;&nbsp;x[i:j]<br>
91 &nbsp;<br>
92 Use&nbsp;of&nbsp;negative&nbsp;indices&nbsp;is&nbsp;not&nbsp;supported.</tt></dd ></dl>
93
94 <dl><dt><a name="NoThreadTimeDataException-__reduce__"><strong>__reduce__</stron g></a>(...)</dt></dl>
95
96 <dl><dt><a name="NoThreadTimeDataException-__repr__"><strong>__repr__</strong></ a>(...)</dt><dd><tt>x.<a href="#NoThreadTimeDataException-__repr__">__repr__</a> ()&nbsp;&lt;==&gt;&nbsp;repr(x)</tt></dd></dl>
97
98 <dl><dt><a name="NoThreadTimeDataException-__setattr__"><strong>__setattr__</str ong></a>(...)</dt><dd><tt>x.<a href="#NoThreadTimeDataException-__setattr__">__s etattr__</a>('name',&nbsp;value)&nbsp;&lt;==&gt;&nbsp;x.name&nbsp;=&nbsp;value</ tt></dd></dl>
99
100 <dl><dt><a name="NoThreadTimeDataException-__setstate__"><strong>__setstate__</s trong></a>(...)</dt></dl>
101
102 <dl><dt><a name="NoThreadTimeDataException-__str__"><strong>__str__</strong></a> (...)</dt><dd><tt>x.<a href="#NoThreadTimeDataException-__str__">__str__</a>()&n bsp;&lt;==&gt;&nbsp;str(x)</tt></dd></dl>
103
104 <dl><dt><a name="NoThreadTimeDataException-__unicode__"><strong>__unicode__</str ong></a>(...)</dt></dl>
105
106 <hr>
107 Data descriptors inherited from <a href="exceptions.html#BaseException">exceptio ns.BaseException</a>:<br>
108 <dl><dt><strong>__dict__</strong></dt>
109 </dl>
110 <dl><dt><strong>args</strong></dt>
111 </dl>
112 <dl><dt><strong>message</strong></dt>
113 </dl>
114 </td></tr></table> <p>
115 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
116 <tr bgcolor="#ffc8d8">
117 <td colspan=3 valign=bottom>&nbsp;<br>
118 <font color="#000000" face="helvetica, arial"><a name="ThreadTimeRangeOverlapped Exception">class <strong>ThreadTimeRangeOverlappedException</strong></a>(<a href ="exceptions.html#Exception">exceptions.Exception</a>)</font></td></tr>
119
120 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
121 <td colspan=2><tt><a href="exceptions.html#Exception">Exception</a>&nbsp;that&nb sp;can&nbsp;be&nbsp;thrown&nbsp;when&nbsp;computing&nbsp;overlapped&nbsp;thread& nbsp;time&nbsp;range<br>
122 with&nbsp;other&nbsp;events.<br>&nbsp;</tt></td></tr>
123 <tr><td>&nbsp;</td>
124 <td width="100%"><dl><dt>Method resolution order:</dt>
125 <dd><a href="telemetry.web_perf.timeline_interaction_record.html#ThreadTimeRange OverlappedException">ThreadTimeRangeOverlappedException</a></dd>
126 <dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
127 <dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
128 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
129 </dl>
130 <hr>
131 Data descriptors defined here:<br>
132 <dl><dt><strong>__weakref__</strong></dt>
133 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp ;(if&nbsp;defined)</tt></dd>
134 </dl>
135 <hr>
136 Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception< /a>:<br>
137 <dl><dt><a name="ThreadTimeRangeOverlappedException-__init__"><strong>__init__</ strong></a>(...)</dt><dd><tt>x.<a href="#ThreadTimeRangeOverlappedException-__in it__">__init__</a>(...)&nbsp;initializes&nbsp;x;&nbsp;see&nbsp;help(type(x))&nbs p;for&nbsp;signature</tt></dd></dl>
138
139 <hr>
140 Data and other attributes inherited from <a href="exceptions.html#Exception">exc eptions.Exception</a>:<br>
141 <dl><dt><strong>__new__</strong> = &lt;built-in method __new__ of type object&gt ;<dd><tt>T.<a href="#ThreadTimeRangeOverlappedException-__new__">__new__</a>(S,& nbsp;...)&nbsp;-&gt;&nbsp;a&nbsp;new&nbsp;<a href="__builtin__.html#object">obje ct</a>&nbsp;with&nbsp;type&nbsp;S,&nbsp;a&nbsp;subtype&nbsp;of&nbsp;T</tt></dl>
142
143 <hr>
144 Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseEx ception</a>:<br>
145 <dl><dt><a name="ThreadTimeRangeOverlappedException-__delattr__"><strong>__delat tr__</strong></a>(...)</dt><dd><tt>x.<a href="#ThreadTimeRangeOverlappedExceptio n-__delattr__">__delattr__</a>('name')&nbsp;&lt;==&gt;&nbsp;del&nbsp;x.name</tt> </dd></dl>
146
147 <dl><dt><a name="ThreadTimeRangeOverlappedException-__getattribute__"><strong>__ getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#ThreadTimeRangeOverlapp edException-__getattribute__">__getattribute__</a>('name')&nbsp;&lt;==&gt;&nbsp; x.name</tt></dd></dl>
148
149 <dl><dt><a name="ThreadTimeRangeOverlappedException-__getitem__"><strong>__getit em__</strong></a>(...)</dt><dd><tt>x.<a href="#ThreadTimeRangeOverlappedExceptio n-__getitem__">__getitem__</a>(y)&nbsp;&lt;==&gt;&nbsp;x[y]</tt></dd></dl>
150
151 <dl><dt><a name="ThreadTimeRangeOverlappedException-__getslice__"><strong>__gets lice__</strong></a>(...)</dt><dd><tt>x.<a href="#ThreadTimeRangeOverlappedExcept ion-__getslice__">__getslice__</a>(i,&nbsp;j)&nbsp;&lt;==&gt;&nbsp;x[i:j]<br>
152 &nbsp;<br>
153 Use&nbsp;of&nbsp;negative&nbsp;indices&nbsp;is&nbsp;not&nbsp;supported.</tt></dd ></dl>
154
155 <dl><dt><a name="ThreadTimeRangeOverlappedException-__reduce__"><strong>__reduce __</strong></a>(...)</dt></dl>
156
157 <dl><dt><a name="ThreadTimeRangeOverlappedException-__repr__"><strong>__repr__</ strong></a>(...)</dt><dd><tt>x.<a href="#ThreadTimeRangeOverlappedException-__re pr__">__repr__</a>()&nbsp;&lt;==&gt;&nbsp;repr(x)</tt></dd></dl>
158
159 <dl><dt><a name="ThreadTimeRangeOverlappedException-__setattr__"><strong>__setat tr__</strong></a>(...)</dt><dd><tt>x.<a href="#ThreadTimeRangeOverlappedExceptio n-__setattr__">__setattr__</a>('name',&nbsp;value)&nbsp;&lt;==&gt;&nbsp;x.name&n bsp;=&nbsp;value</tt></dd></dl>
160
161 <dl><dt><a name="ThreadTimeRangeOverlappedException-__setstate__"><strong>__sets tate__</strong></a>(...)</dt></dl>
162
163 <dl><dt><a name="ThreadTimeRangeOverlappedException-__str__"><strong>__str__</st rong></a>(...)</dt><dd><tt>x.<a href="#ThreadTimeRangeOverlappedException-__str_ _">__str__</a>()&nbsp;&lt;==&gt;&nbsp;str(x)</tt></dd></dl>
164
165 <dl><dt><a name="ThreadTimeRangeOverlappedException-__unicode__"><strong>__unico de__</strong></a>(...)</dt></dl>
166
167 <hr>
168 Data descriptors inherited from <a href="exceptions.html#BaseException">exceptio ns.BaseException</a>:<br>
169 <dl><dt><strong>__dict__</strong></dt>
170 </dl>
171 <dl><dt><strong>args</strong></dt>
172 </dl>
173 <dl><dt><strong>message</strong></dt>
174 </dl>
175 </td></tr></table> <p>
176 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
177 <tr bgcolor="#ffc8d8">
178 <td colspan=3 valign=bottom>&nbsp;<br>
179 <font color="#000000" face="helvetica, arial"><a name="TimelineInteractionRecord ">class <strong>TimelineInteractionRecord</strong></a>(<a href="__builtin__.html #object">__builtin__.object</a>)</font></td></tr>
180
181 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
182 <td colspan=2><tt>Represents&nbsp;an&nbsp;interaction&nbsp;that&nbsp;took&nbsp;p lace&nbsp;during&nbsp;a&nbsp;timeline&nbsp;recording.<br>
183 &nbsp;<br>
184 As&nbsp;a&nbsp;page&nbsp;runs,&nbsp;typically&nbsp;a&nbsp;number&nbsp;of&nbsp;di fferent&nbsp;(simulated)&nbsp;user&nbsp;interactions<br>
185 take&nbsp;place.&nbsp;For&nbsp;instance,&nbsp;a&nbsp;user&nbsp;might&nbsp;click& nbsp;a&nbsp;button&nbsp;in&nbsp;a&nbsp;mail&nbsp;app&nbsp;causing&nbsp;a<br>
186 popup&nbsp;to&nbsp;animate&nbsp;in.&nbsp;Then&nbsp;they&nbsp;might&nbsp;press&nb sp;another&nbsp;button&nbsp;that&nbsp;sends&nbsp;data&nbsp;to&nbsp;a<br>
187 server&nbsp;and&nbsp;simultaneously&nbsp;closes&nbsp;the&nbsp;popup&nbsp;without &nbsp;an&nbsp;animation.&nbsp;These&nbsp;are&nbsp;two<br>
188 interactions.<br>
189 &nbsp;<br>
190 From&nbsp;the&nbsp;point&nbsp;of&nbsp;view&nbsp;of&nbsp;the&nbsp;page,&nbsp;each &nbsp;interaction&nbsp;might&nbsp;have&nbsp;a&nbsp;different<br>
191 label:&nbsp;ClickComposeButton&nbsp;and&nbsp;SendEmail,&nbsp;for&nbsp;instance.& nbsp;From&nbsp;the&nbsp;point<br>
192 of&nbsp;view&nbsp;of&nbsp;the&nbsp;benchmarking&nbsp;harness,&nbsp;the&nbsp;labe ls&nbsp;aren't&nbsp;so&nbsp;interesting&nbsp;as&nbsp;what<br>
193 the&nbsp;performance&nbsp;expectations&nbsp;are&nbsp;for&nbsp;that&nbsp;interact ion:&nbsp;was&nbsp;it&nbsp;loading<br>
194 resources&nbsp;from&nbsp;the&nbsp;network?&nbsp;was&nbsp;there&nbsp;an&nbsp;anim ation?<br>
195 &nbsp;<br>
196 Determining&nbsp;these&nbsp;things&nbsp;is&nbsp;hard&nbsp;to&nbsp;do,&nbsp;simpl y&nbsp;by&nbsp;observing&nbsp;the&nbsp;state&nbsp;given&nbsp;to<br>
197 a&nbsp;page&nbsp;from&nbsp;javascript.&nbsp;There&nbsp;are&nbsp;hints,&nbsp;for& nbsp;instance&nbsp;if&nbsp;network&nbsp;requests&nbsp;are<br>
198 sent,&nbsp;or&nbsp;if&nbsp;a&nbsp;CSS&nbsp;animation&nbsp;is&nbsp;pending.&nbsp; But&nbsp;this&nbsp;is&nbsp;by&nbsp;no&nbsp;means&nbsp;a&nbsp;complete<br>
199 story.<br>
200 &nbsp;<br>
201 Instead,&nbsp;we&nbsp;expect&nbsp;pages&nbsp;to&nbsp;mark&nbsp;up&nbsp;the&nbsp; timeline&nbsp;what&nbsp;they&nbsp;are&nbsp;doing,&nbsp;with<br>
202 label&nbsp;and&nbsp;flags&nbsp;indicating&nbsp;the&nbsp;semantics&nbsp;of&nbsp;t hat&nbsp;interaction.&nbsp;This<br>
203 is&nbsp;currently&nbsp;done&nbsp;by&nbsp;pushing&nbsp;markers&nbsp;into&nbsp;the &nbsp;console.time/timeEnd&nbsp;API:&nbsp;this<br>
204 for&nbsp;instance&nbsp;can&nbsp;be&nbsp;issued&nbsp;in&nbsp;JS:<br>
205 &nbsp;<br>
206 &nbsp;&nbsp;&nbsp;var&nbsp;str&nbsp;=&nbsp;'Interaction.SendEmail';<br>
207 &nbsp;&nbsp;&nbsp;console.time(str);<br>
208 &nbsp;&nbsp;&nbsp;setTimeout(function()&nbsp;{<br>
209 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;console.timeEnd(str);<br>
210 &nbsp;&nbsp;&nbsp;},&nbsp;1000);<br>
211 &nbsp;<br>
212 When&nbsp;run&nbsp;with&nbsp;perf.measurements.timeline_based_measurement&nbsp;r unning,&nbsp;this&nbsp;will<br>
213 then&nbsp;cause&nbsp;a&nbsp;<a href="#TimelineInteractionRecord">TimelineInterac tionRecord</a>&nbsp;to&nbsp;be&nbsp;created&nbsp;for&nbsp;this&nbsp;range&nbsp;w ith<br>
214 all&nbsp;metrics&nbsp;reported&nbsp;for&nbsp;the&nbsp;marked&nbsp;up&nbsp;1000ms &nbsp;time-range.<br>
215 &nbsp;<br>
216 The&nbsp;valid&nbsp;interaction&nbsp;flags&nbsp;are:<br>
217 &nbsp;&nbsp;&nbsp;*&nbsp;repeatable:&nbsp;Allows&nbsp;other&nbsp;interactions&nb sp;to&nbsp;use&nbsp;the&nbsp;same&nbsp;label<br>&nbsp;</tt></td></tr>
218 <tr><td>&nbsp;</td>
219 <td width="100%">Methods defined here:<br>
220 <dl><dt><a name="TimelineInteractionRecord-GetBounds"><strong>GetBounds</strong> </a>(*args, **kwargs)</dt></dl>
221
222 <dl><dt><a name="TimelineInteractionRecord-GetOverlappedThreadTimeForSlice"><str ong>GetOverlappedThreadTimeForSlice</strong></a>(self, timeline_slice)</dt><dd>< tt>Get&nbsp;the&nbsp;thread&nbsp;duration&nbsp;of&nbsp;timeline_slice&nbsp;that& nbsp;overlaps&nbsp;with&nbsp;this&nbsp;record.<br>
223 &nbsp;<br>
224 There&nbsp;are&nbsp;two&nbsp;cases&nbsp;:<br>
225 &nbsp;<br>
226 Case&nbsp;1:&nbsp;timeline_slice&nbsp;runs&nbsp;in&nbsp;the&nbsp;same&nbsp;threa d&nbsp;as&nbsp;the&nbsp;record.<br>
227 &nbsp;<br>
228 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&n bsp;|&nbsp;&nbsp;&nbsp;&nbsp;[&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;timeline _slice&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;]<br>
229 &nbsp;&nbsp;THREAD&nbsp;1&nbsp;&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|& nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nb sp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp ;&nbsp;&nbsp;&nbsp;|<br>
230 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&n bsp;|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;rec ord&nbsp;starts&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp ;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;record&nbsp;ends<br>
231 &nbsp;<br>
232 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&n bsp;&nbsp;&nbsp;&nbsp;&nbsp;(relative&nbsp;order&nbsp;in&nbsp;thread&nbsp;time)< br>
233 &nbsp;<br>
234 &nbsp;&nbsp;As&nbsp;the&nbsp;thread&nbsp;timestamps&nbsp;in&nbsp;timeline_slice& nbsp;and&nbsp;record&nbsp;are&nbsp;consistent,&nbsp;we<br>
235 &nbsp;&nbsp;simply&nbsp;use&nbsp;them&nbsp;to&nbsp;compute&nbsp;the&nbsp;overlap .<br>
236 &nbsp;<br>
237 Case&nbsp;2:&nbsp;timeline_slice&nbsp;runs&nbsp;in&nbsp;a&nbsp;different&nbsp;th read&nbsp;from&nbsp;the&nbsp;record's.<br>
238 &nbsp;<br>
239 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&n bsp;|<br>
240 &nbsp;&nbsp;THREAD&nbsp;2&nbsp;&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;&nbsp;[&nbsp ;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;timeline_slice&nbsp;&nbsp;&nbsp;&nbsp;&nbsp ;&nbsp;&nbsp;&nbsp;&nbsp;]<br>
241 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&n bsp;|<br>
242 &nbsp;<br>
243 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&n bsp;|<br>
244 &nbsp;&nbsp;THREAD&nbsp;1&nbsp;&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;& nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nb sp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp ;&nbsp;|<br>
245 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&n bsp;|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;record&nbsp;sta rts&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp ;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;record&nbsp;ends<br>
246 &nbsp;<br>
247 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&n bsp;&nbsp;&nbsp;&nbsp;&nbsp;(relative&nbsp;order&nbsp;in&nbsp;wall-time)<br>
248 &nbsp;<br>
249 &nbsp;&nbsp;Unlike&nbsp;case&nbsp;1,&nbsp;thread&nbsp;timestamps&nbsp;of&nbsp;a& nbsp;thread&nbsp;are&nbsp;measured&nbsp;by&nbsp;its<br>
250 &nbsp;&nbsp;thread-specific&nbsp;clock,&nbsp;which&nbsp;is&nbsp;inconsistent&nbs p;with&nbsp;that&nbsp;of&nbsp;the&nbsp;other<br>
251 &nbsp;&nbsp;thread,&nbsp;and&nbsp;thus&nbsp;can't&nbsp;be&nbsp;used&nbsp;to&nbsp ;compute&nbsp;the&nbsp;overlapped&nbsp;thread&nbsp;duration.<br>
252 &nbsp;&nbsp;Hence,&nbsp;we&nbsp;use&nbsp;a&nbsp;heuristic&nbsp;to&nbsp;compute&n bsp;the&nbsp;overlap&nbsp;(see<br>
253 &nbsp;&nbsp;_GetOverlappedThreadTimeForSliceInDifferentThread&nbsp;for&nbsp;more &nbsp;details)<br>
254 &nbsp;<br>
255 Args:<br>
256 &nbsp;&nbsp;timeline_slice:&nbsp;An&nbsp;instance&nbsp;of&nbsp;telemetry.timelin e.slice.Slice</tt></dd></dl>
257
258 <dl><dt><a name="TimelineInteractionRecord-__init__"><strong>__init__</strong></ a>(self, label, start, end, async_event<font color="#909090">=None</font>, flags <font color="#909090">=None</font>)</dt></dl>
259
260 <dl><dt><a name="TimelineInteractionRecord-__repr__"><strong>__repr__</strong></ a>(self)</dt></dl>
261
262 <hr>
263 Class methods defined here:<br>
264 <dl><dt><a name="TimelineInteractionRecord-FromAsyncEvent"><strong>FromAsyncEven t</strong></a>(cls, async_event)<font color="#909090"><font face="helvetica, ari al"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt ><dd><tt>Construct&nbsp;an&nbsp;timeline_interaction_record&nbsp;from&nbsp;an&nb sp;async&nbsp;event.<br>
265 Args:<br>
266 &nbsp;&nbsp;async_event:&nbsp;An&nbsp;instance&nbsp;of<br>
267 &nbsp;&nbsp;&nbsp;&nbsp;telemetry.timeline.async_slices.AsyncSlice</tt></dd></dl >
268
269 <hr>
270 Data descriptors defined here:<br>
271 <dl><dt><strong>__dict__</strong></dt>
272 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)< /tt></dd>
273 </dl>
274 <dl><dt><strong>__weakref__</strong></dt>
275 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp ;(if&nbsp;defined)</tt></dd>
276 </dl>
277 <dl><dt><strong>end</strong></dt>
278 </dl>
279 <dl><dt><strong>label</strong></dt>
280 </dl>
281 <dl><dt><strong>repeatable</strong></dt>
282 </dl>
283 <dl><dt><strong>start</strong></dt>
284 </dl>
285 </td></tr></table></td></tr></table><p>
286 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
287 <tr bgcolor="#eeaa77">
288 <td colspan=3 valign=bottom>&nbsp;<br>
289 <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></b ig></font></td></tr>
290
291 <tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td> &nbsp;</td>
292 <td width="100%"><dl><dt><a name="-GetJavaScriptMarker"><strong>GetJavaScriptMar ker</strong></a>(label, flags)</dt><dd><tt>Computes&nbsp;the&nbsp;marker&nbsp;st ring&nbsp;of&nbsp;an&nbsp;interaction&nbsp;record.<br>
293 &nbsp;<br>
294 This&nbsp;marker&nbsp;string&nbsp;can&nbsp;be&nbsp;used&nbsp;with&nbsp;JavaScrip t&nbsp;API&nbsp;console.time()<br>
295 and&nbsp;console.timeEnd()&nbsp;to&nbsp;mark&nbsp;the&nbsp;beginning&nbsp;and&nb sp;end&nbsp;of&nbsp;the<br>
296 interaction&nbsp;record..<br>
297 &nbsp;<br>
298 Args:<br>
299 &nbsp;&nbsp;label:&nbsp;The&nbsp;label&nbsp;used&nbsp;to&nbsp;identify&nbsp;the& nbsp;interaction&nbsp;record.<br>
300 &nbsp;&nbsp;flags:&nbsp;the&nbsp;flags&nbsp;for&nbsp;the&nbsp;interaction&nbsp;r ecord&nbsp;see&nbsp;FLAGS&nbsp;above.<br>
301 &nbsp;<br>
302 Returns:<br>
303 &nbsp;&nbsp;The&nbsp;interaction&nbsp;record&nbsp;marker&nbsp;string&nbsp;(e.g., &nbsp;Interaction.Label/flag1,flag2).<br>
304 &nbsp;<br>
305 Raises:<br>
306 &nbsp;&nbsp;AssertionError:&nbsp;If&nbsp;one&nbsp;or&nbsp;more&nbsp;of&nbsp;the& nbsp;flags&nbsp;is&nbsp;unrecognized.</tt></dd></dl>
307 <dl><dt><a name="-IsTimelineInteractionRecord"><strong>IsTimelineInteractionRec ord</strong></a>(event_name)</dt></dl>
308 </td></tr></table><p>
309 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
310 <tr bgcolor="#55aa55">
311 <td colspan=3 valign=bottom>&nbsp;<br>
312 <font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></ font></td></tr>
313
314 <tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td> &nbsp;</td>
315 <td width="100%"><strong>FLAGS</strong> = ['repeatable']<br>
316 <strong>REPEATABLE</strong> = 'repeatable'</td></tr></table>
317 </body></html>
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698