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

Side by Side Diff: tools/telemetry/docs/telemetry.html

Issue 16154007: [Telemetry] Add a page set option to use all cold page loads. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Update docs Created 7 years, 6 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 | Annotate | Revision Log
« no previous file with comments | « no previous file | tools/telemetry/docs/telemetry.core.chrome.html » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 1
2 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> 2 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3 <html><head><title>Python: package telemetry</title> 3 <html><head><title>Python: package telemetry</title>
4 </head><body bgcolor="#f0f0f8"> 4 </head><body bgcolor="#f0f0f8">
5 5
6 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> 6 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
7 <tr bgcolor="#7799ee"> 7 <tr bgcolor="#7799ee">
8 <td valign=bottom>&nbsp;<br> 8 <td valign=bottom>&nbsp;<br>
9 <font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong>teleme try</strong></big></big></font></td 9 <font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong>teleme try</strong></big></big></font></td
10 ><td align=right valign=bottom 10 ><td align=right valign=bottom
(...skipping 258 matching lines...) Expand 10 before | Expand all | Expand 10 after
269 Put&nbsp;together:<br> 269 Put&nbsp;together:<br>
270 &nbsp;<br> 270 &nbsp;<br>
271 &nbsp;&nbsp;&nbsp;def&nbsp;<a href="#PageMeasurement-MeasurePage">MeasurePage</a >(self,&nbsp;page,&nbsp;tab,&nbsp;results):<br> 271 &nbsp;&nbsp;&nbsp;def&nbsp;<a href="#PageMeasurement-MeasurePage">MeasurePage</a >(self,&nbsp;page,&nbsp;tab,&nbsp;results):<br>
272 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;res&nbsp;=&nbsp;tab.EvaluateJavaScript('2+2')<br> 272 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;res&nbsp;=&nbsp;tab.EvaluateJavaScript('2+2')<br>
273 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;if&nbsp;res&nbsp;!=&nbsp;4:<br> 273 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;if&nbsp;res&nbsp;!=&nbsp;4:<br>
274 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;raise&nbsp;Exception('Oh,&nbsp;wow.')< br> 274 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;raise&nbsp;Exception('Oh,&nbsp;wow.')< br>
275 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;results.Add('two_plus_two',&nbsp;'count',&nbsp;res )</tt></dd></dl> 275 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;results.Add('two_plus_two',&nbsp;'count',&nbsp;res )</tt></dd></dl>
276 276
277 <dl><dt><a name="PageMeasurement-PrepareResults"><strong>PrepareResults</strong> </a>(self, options)</dt></dl> 277 <dl><dt><a name="PageMeasurement-PrepareResults"><strong>PrepareResults</strong> </a>(self, options)</dt></dl>
278 278
279 <dl><dt><a name="PageMeasurement-__init__"><strong>__init__</strong></a>(self, a ction_name_to_run<font color="#909090">=''</font>, needs_browser_restart_after_e ach_run<font color="#909090">=False</font>, discard_first_result<font color="#90 9090">=False</font>)</dt></dl> 279 <dl><dt><a name="PageMeasurement-__init__"><strong>__init__</strong></a>(self, a ction_name_to_run<font color="#909090">=''</font>, needs_browser_restart_after_e ach_run<font color="#909090">=False</font>, discard_first_result<font color="#90 9090">=False</font>, clear_cache_before_each_run<font color="#909090">=False</fo nt>)</dt></dl>
280 280
281 <hr> 281 <hr>
282 Data descriptors defined here:<br> 282 Data descriptors defined here:<br>
283 <dl><dt><strong>output_format_choices</strong></dt> 283 <dl><dt><strong>output_format_choices</strong></dt>
284 </dl> 284 </dl>
285 <dl><dt><strong>results_are_the_same_on_every_page</strong></dt> 285 <dl><dt><strong>results_are_the_same_on_every_page</strong></dt>
286 <dd><tt>By&nbsp;default,&nbsp;measurements&nbsp;are&nbsp;assumed&nbsp;to&nbsp;ou tput&nbsp;the&nbsp;same&nbsp;values&nbsp;for&nbsp;every<br> 286 <dd><tt>By&nbsp;default,&nbsp;measurements&nbsp;are&nbsp;assumed&nbsp;to&nbsp;ou tput&nbsp;the&nbsp;same&nbsp;values&nbsp;for&nbsp;every<br>
287 page.&nbsp;This&nbsp;allows&nbsp;incremental&nbsp;output,&nbsp;for&nbsp;example& nbsp;in&nbsp;CSV.&nbsp;If,&nbsp;however,&nbsp;the<br> 287 page.&nbsp;This&nbsp;allows&nbsp;incremental&nbsp;output,&nbsp;for&nbsp;example& nbsp;in&nbsp;CSV.&nbsp;If,&nbsp;however,&nbsp;the<br>
288 measurement&nbsp;discovers&nbsp;what&nbsp;values&nbsp;it&nbsp;can&nbsp;report&nb sp;as&nbsp;it&nbsp;goes,&nbsp;and&nbsp;those&nbsp;values<br> 288 measurement&nbsp;discovers&nbsp;what&nbsp;values&nbsp;it&nbsp;can&nbsp;report&nb sp;as&nbsp;it&nbsp;goes,&nbsp;and&nbsp;those&nbsp;values<br>
289 may&nbsp;vary&nbsp;from&nbsp;page&nbsp;to&nbsp;page,&nbsp;you&nbsp;need&nbsp;to& nbsp;override&nbsp;this&nbsp;function&nbsp;and&nbsp;return<br> 289 may&nbsp;vary&nbsp;from&nbsp;page&nbsp;to&nbsp;page,&nbsp;you&nbsp;need&nbsp;to& nbsp;override&nbsp;this&nbsp;function&nbsp;and&nbsp;return<br>
(...skipping 42 matching lines...) Expand 10 before | Expand all | Expand 10 after
332 <hr> 332 <hr>
333 Data descriptors inherited from <a href="telemetry.page.page_test.html#PageTest" >telemetry.page.page_test.PageTest</a>:<br> 333 Data descriptors inherited from <a href="telemetry.page.page_test.html#PageTest" >telemetry.page.page_test.PageTest</a>:<br>
334 <dl><dt><strong>__dict__</strong></dt> 334 <dl><dt><strong>__dict__</strong></dt>
335 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)< /tt></dd> 335 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)< /tt></dd>
336 </dl> 336 </dl>
337 <dl><dt><strong>__weakref__</strong></dt> 337 <dl><dt><strong>__weakref__</strong></dt>
338 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp ;(if&nbsp;defined)</tt></dd> 338 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp ;(if&nbsp;defined)</tt></dd>
339 </dl> 339 </dl>
340 <dl><dt><strong>action_name_to_run</strong></dt> 340 <dl><dt><strong>action_name_to_run</strong></dt>
341 </dl> 341 </dl>
342 <dl><dt><strong>clear_cache_before_each_run</strong></dt>
343 <dd><tt>When&nbsp;set&nbsp;to&nbsp;True,&nbsp;the&nbsp;browser's&nbsp;disk&nbsp; and&nbsp;memory&nbsp;cache&nbsp;will&nbsp;be&nbsp;cleared<br>
344 before&nbsp;each&nbsp;run.</tt></dd>
345 </dl>
342 <dl><dt><strong>discard_first_result</strong></dt> 346 <dl><dt><strong>discard_first_result</strong></dt>
343 <dd><tt>When&nbsp;set&nbsp;to&nbsp;True,&nbsp;the&nbsp;first&nbsp;run&nbsp;of&nb sp;the&nbsp;test&nbsp;is&nbsp;discarded.&nbsp;&nbsp;This&nbsp;is<br> 347 <dd><tt>When&nbsp;set&nbsp;to&nbsp;True,&nbsp;the&nbsp;first&nbsp;run&nbsp;of&nb sp;the&nbsp;test&nbsp;is&nbsp;discarded.&nbsp;&nbsp;This&nbsp;is<br>
344 useful&nbsp;for&nbsp;cases&nbsp;where&nbsp;it's&nbsp;desirable&nbsp;to&nbsp;have &nbsp;some&nbsp;test&nbsp;resource&nbsp;cached&nbsp;so<br> 348 useful&nbsp;for&nbsp;cases&nbsp;where&nbsp;it's&nbsp;desirable&nbsp;to&nbsp;have &nbsp;some&nbsp;test&nbsp;resource&nbsp;cached&nbsp;so<br>
345 the&nbsp;first&nbsp;run&nbsp;of&nbsp;the&nbsp;test&nbsp;can&nbsp;warm&nbsp;thing s&nbsp;up.</tt></dd> 349 the&nbsp;first&nbsp;run&nbsp;of&nbsp;the&nbsp;test&nbsp;can&nbsp;warm&nbsp;thing s&nbsp;up.</tt></dd>
346 </dl> 350 </dl>
347 </td></tr></table> <p> 351 </td></tr></table> <p>
348 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 352 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
349 <tr bgcolor="#ffc8d8"> 353 <tr bgcolor="#ffc8d8">
350 <td colspan=3 valign=bottom>&nbsp;<br> 354 <td colspan=3 valign=bottom>&nbsp;<br>
351 <font color="#000000" face="helvetica, arial"><a name="Tab">class <strong>Tab</s trong></a>(<a href="telemetry.core.web_contents.html#WebContents">telemetry.core .web_contents.WebContents</a>)</font></td></tr> 355 <font color="#000000" face="helvetica, arial"><a name="Tab">class <strong>Tab</s trong></a>(<a href="telemetry.core.web_contents.html#WebContents">telemetry.core .web_contents.WebContents</a>)</font></td></tr>
(...skipping 19 matching lines...) Expand all
371 <dl><dt><a name="Tab-Activate"><strong>Activate</strong></a>(self)</dt><dd><tt>B rings&nbsp;this&nbsp;tab&nbsp;to&nbsp;the&nbsp;foreground&nbsp;asynchronously.<b r> 375 <dl><dt><a name="Tab-Activate"><strong>Activate</strong></a>(self)</dt><dd><tt>B rings&nbsp;this&nbsp;tab&nbsp;to&nbsp;the&nbsp;foreground&nbsp;asynchronously.<b r>
372 &nbsp;<br> 376 &nbsp;<br>
373 Not&nbsp;all&nbsp;browsers&nbsp;or&nbsp;browser&nbsp;versions&nbsp;support&nbsp; this&nbsp;method.<br> 377 Not&nbsp;all&nbsp;browsers&nbsp;or&nbsp;browser&nbsp;versions&nbsp;support&nbsp; this&nbsp;method.<br>
374 Be&nbsp;sure&nbsp;to&nbsp;check&nbsp;browser.supports_tab_control.<br> 378 Be&nbsp;sure&nbsp;to&nbsp;check&nbsp;browser.supports_tab_control.<br>
375 &nbsp;<br> 379 &nbsp;<br>
376 Please&nbsp;note:&nbsp;this&nbsp;is&nbsp;asynchronous.&nbsp;There&nbsp;is&nbsp;a &nbsp;delay&nbsp;between&nbsp;this&nbsp;call<br> 380 Please&nbsp;note:&nbsp;this&nbsp;is&nbsp;asynchronous.&nbsp;There&nbsp;is&nbsp;a &nbsp;delay&nbsp;between&nbsp;this&nbsp;call<br>
377 and&nbsp;the&nbsp;page's&nbsp;documentVisibilityState&nbsp;becoming&nbsp;'visibl e',&nbsp;and&nbsp;yet&nbsp;more<br> 381 and&nbsp;the&nbsp;page's&nbsp;documentVisibilityState&nbsp;becoming&nbsp;'visibl e',&nbsp;and&nbsp;yet&nbsp;more<br>
378 delay&nbsp;until&nbsp;the&nbsp;actual&nbsp;tab&nbsp;is&nbsp;visible&nbsp;to&nbsp ;the&nbsp;user.&nbsp;None&nbsp;of&nbsp;these&nbsp;delays<br> 382 delay&nbsp;until&nbsp;the&nbsp;actual&nbsp;tab&nbsp;is&nbsp;visible&nbsp;to&nbsp ;the&nbsp;user.&nbsp;None&nbsp;of&nbsp;these&nbsp;delays<br>
379 are&nbsp;included&nbsp;in&nbsp;this&nbsp;call.</tt></dd></dl> 383 are&nbsp;included&nbsp;in&nbsp;this&nbsp;call.</tt></dd></dl>
380 384
385 <dl><dt><a name="Tab-ClearCache"><strong>ClearCache</strong></a>(self)</dt><dd>< tt>Clears&nbsp;the&nbsp;browser's&nbsp;HTTP&nbsp;disk&nbsp;cache&nbsp;and&nbsp;t he&nbsp;tab's&nbsp;HTTP&nbsp;memory&nbsp;cache.</tt></dd></dl>
386
381 <dl><dt><a name="Tab-CollectGarbage"><strong>CollectGarbage</strong></a>(self)</ dt></dl> 387 <dl><dt><a name="Tab-CollectGarbage"><strong>CollectGarbage</strong></a>(self)</ dt></dl>
382 388
383 <dl><dt><a name="Tab-GetCookieByName"><strong>GetCookieByName</strong></a>(self, name, timeout<font color="#909090">=60</font>)</dt><dd><tt>Returns&nbsp;the&nbs p;value&nbsp;of&nbsp;the&nbsp;cookie&nbsp;by&nbsp;the&nbsp;given&nbsp;|name|.</t t></dd></dl> 389 <dl><dt><a name="Tab-GetCookieByName"><strong>GetCookieByName</strong></a>(self, name, timeout<font color="#909090">=60</font>)</dt><dd><tt>Returns&nbsp;the&nbs p;value&nbsp;of&nbsp;the&nbsp;cookie&nbsp;by&nbsp;the&nbsp;given&nbsp;|name|.</t t></dd></dl>
384 390
385 <dl><dt><a name="Tab-Navigate"><strong>Navigate</strong></a>(self, url, script_t o_evaluate_on_commit<font color="#909090">=None</font>, timeout<font color="#909 090">=60</font>)</dt><dd><tt>Navigates&nbsp;to&nbsp;url.<br> 391 <dl><dt><a name="Tab-Navigate"><strong>Navigate</strong></a>(self, url, script_t o_evaluate_on_commit<font color="#909090">=None</font>, timeout<font color="#909 090">=60</font>)</dt><dd><tt>Navigates&nbsp;to&nbsp;url.<br>
386 &nbsp;<br> 392 &nbsp;<br>
387 If&nbsp;|script_to_evaluate_on_commit|&nbsp;is&nbsp;given,&nbsp;the&nbsp;script& nbsp;source&nbsp;string&nbsp;will&nbsp;be<br> 393 If&nbsp;|script_to_evaluate_on_commit|&nbsp;is&nbsp;given,&nbsp;the&nbsp;script& nbsp;source&nbsp;string&nbsp;will&nbsp;be<br>
388 evaluated&nbsp;when&nbsp;the&nbsp;navigation&nbsp;is&nbsp;committed.&nbsp;This&n bsp;is&nbsp;after&nbsp;the&nbsp;context&nbsp;of<br> 394 evaluated&nbsp;when&nbsp;the&nbsp;navigation&nbsp;is&nbsp;committed.&nbsp;This&n bsp;is&nbsp;after&nbsp;the&nbsp;context&nbsp;of<br>
389 the&nbsp;page&nbsp;exists,&nbsp;but&nbsp;before&nbsp;any&nbsp;script&nbsp;on&nbs p;the&nbsp;page&nbsp;itself&nbsp;has&nbsp;executed.</tt></dd></dl> 395 the&nbsp;page&nbsp;exists,&nbsp;but&nbsp;before&nbsp;any&nbsp;script&nbsp;on&nbs p;the&nbsp;page&nbsp;itself&nbsp;has&nbsp;executed.</tt></dd></dl>
390 396
(...skipping 83 matching lines...) Expand 10 before | Expand all | Expand 10 after
474 <td width="100%"><dl><dt><a name="-RunPage"><strong>RunPage</strong></a> = Run(t est, page_set, options)</dt><dd><tt>Runs&nbsp;a&nbsp;given&nbsp;test&nbsp;agains t&nbsp;a&nbsp;given&nbsp;page_set&nbsp;with&nbsp;the&nbsp;given&nbsp;options.</t t></dd></dl> 480 <td width="100%"><dl><dt><a name="-RunPage"><strong>RunPage</strong></a> = Run(t est, page_set, options)</dt><dd><tt>Runs&nbsp;a&nbsp;given&nbsp;test&nbsp;agains t&nbsp;a&nbsp;given&nbsp;page_set&nbsp;with&nbsp;the&nbsp;given&nbsp;options.</t t></dd></dl>
475 </td></tr></table><p> 481 </td></tr></table><p>
476 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 482 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
477 <tr bgcolor="#55aa55"> 483 <tr bgcolor="#55aa55">
478 <td colspan=3 valign=bottom>&nbsp;<br> 484 <td colspan=3 valign=bottom>&nbsp;<br>
479 <font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></ font></td></tr> 485 <font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></ font></td></tr>
480 486
481 <tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td> &nbsp;</td> 487 <tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td> &nbsp;</td>
482 <td width="100%"><strong>__all__</strong> = ['Browser', 'BrowserOptions', 'PageM easurement', 'RunPage', 'Tab']</td></tr></table> 488 <td width="100%"><strong>__all__</strong> = ['Browser', 'BrowserOptions', 'PageM easurement', 'RunPage', 'Tab']</td></tr></table>
483 </body></html> 489 </body></html>
OLDNEW
« no previous file with comments | « no previous file | tools/telemetry/docs/telemetry.core.chrome.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698