tools/telemetry/docs/telemetry.core.browser.html - Issue 196383034: Update telemetry docs by running the update_docs script.

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

Issue 196383034: Update telemetry docs by running the update_docs script. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: Created 6 years, 9 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

OLD	NEW
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: module telemetry.core.browser</title>	3 <html><head><title>Python: module telemetry.core.browser</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> <br>	8 <td valign=bottom> <br>

9 <font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a hre f="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry .core.html"><font color="#ffffff">core</font></a>.browser</strong></big></big></ font></td	9 <font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a hre f="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry .core.html"><font color="#ffffff">core</font></a>.browser</strong></big></big></ font></td

10 ><td align=right valign=bottom	10 ><td align=right valign=bottom

11 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href= "../telemetry/core/browser.py">telemetry/core/browser.py</a></font></td></tr></t able>	11 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href= "../telemetry/core/browser.py">telemetry/core/browser.py</a></font></td></tr></t able>

12 <p><tt># Copyright (c) 2012 The Chromium Autho rs. All rights reserved.<br>	12 <p><tt># Copyright (c) 2012 The Chromium Autho rs. All rights reserved.<br>

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

14 # found in the LICENSE file.</tt></p>	14 # found in the LICENSE file.</tt></p>

15 <p>	15 <p>

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

17 <tr bgcolor="#aa55cc">	17 <tr bgcolor="#aa55cc">

18 <td colspan=3 valign=bottom> <br>	18 <td colspan=3 valign=bottom> <br>

19 <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big ></font></td></tr>	19 <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big ></font></td></tr>

20	20

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

22 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=t op><a href="telemetry.core.chrome.browser_backend.html">telemetry.core.chrome.br owser_backend</a><br>	22 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=t op><a href="telemetry.core.backends.browser_backend.html">telemetry.core.backend s.browser_backend</a><br>

23 <a href="telemetry.core.browser_credentials.html">telemetry.core.browser_credent ials</a><br>	23 <a href="telemetry.core.browser_credentials.html">telemetry.core.browser_credent ials</a><br>

24 <a href="telemetry.core.extension_dict.html">telemetry.core.extension_dict</a><b r>	24 <a href="telemetry.decorators.html">telemetry.decorators</a><br>

25 </td><td width="25%" valign=top><a href="os.html">os</a><br>	25 <a href="telemetry.core.exceptions.html">telemetry.core.exceptions</a><br>

26 <a href="telemetry.core.platform.html">telemetry.core.platform</a><br>	26 </td><td width="25%" valign=top><a href="telemetry.core.extension_dict.html">tel emetry.core.extension_dict</a><br>

	27 <a href="telemetry.core.local_server.html">telemetry.core.local_server</a><br>

	28 <a href="telemetry.core.memory_cache_http_server.html">telemetry.core.memory_cac he_http_server</a><br>

	29 <a href="os.html">os</a><br>

	30 </td><td width="25%" valign=top><a href="telemetry.core.platform.html">telemetry .core.platform</a><br>

27 <a href="telemetry.core.platform.profiler.profiler_finder.html">telemetry.core.p latform.profiler.profiler_finder</a><br>	31 <a href="telemetry.core.platform.profiler.profiler_finder.html">telemetry.core.p latform.profiler.profiler_finder</a><br>

28 </td><td width="25%" valign=top><a href="telemetry.core.tab_list.html">telemetry .core.tab_list</a><br>	32 <a href="telemetry.core.tab_list.html">telemetry.core.tab_list</a><br>

29 <a href="telemetry.core.temporary_http_server.html">telemetry.core.temporary_htt p_server</a><br>

30 <a href="telemetry.core.wpr_modes.html">telemetry.core.wpr_modes</a><br>	33 <a href="telemetry.core.wpr_modes.html">telemetry.core.wpr_modes</a><br>

31 </td><td width="25%" valign=top><a href="telemetry.core.wpr_server.html">telemet ry.core.wpr_server</a><br>	34 </td><td width="25%" valign=top><a href="telemetry.core.wpr_server.html">telemet ry.core.wpr_server</a><br>

32 </td></tr></table></td></tr></table><p>	35 </td></tr></table></td></tr></table><p>

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

34 <tr bgcolor="#ee77aa">	37 <tr bgcolor="#ee77aa">

35 <td colspan=3 valign=bottom> <br>	38 <td colspan=3 valign=bottom> <br>

36 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big ></font></td></tr>	39 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big ></font></td></tr>

37	40

38 <tr><td bgcolor="#ee77aa"><tt>      </tt></td><td>  </td>	41 <tr><td bgcolor="#ee77aa"><tt>      </tt></td><td>  </td>

39 <td width="100%"><dl>	42 <td width="100%"><dl>

(...skipping 21 matching lines...) Expand all Loading...
61   with browser_to_create.Create() as browser:<br>	64   with browser_to_create.Create() as browser:<br>

62     ... do all your operations on&n bsp;browser here<br> </tt></td></tr>	65     ... do all your operations on&n bsp;browser here<br> </tt></td></tr>

63 <tr><td> </td>	66 <tr><td> </td>

64 <td width="100%">Methods defined here:<br>	67 <td width="100%">Methods defined here:<br>

65 <dl><dt><a name="Browser-Close"><strong>Close</strong></a>(self)</dt><dd><tt>Clo ses this browser.</tt></dd></dl>	68 <dl><dt><a name="Browser-Close"><strong>Close</strong></a>(self)</dt><dd><tt>Clo ses this browser.</tt></dd></dl>

66	69

67 <dl><dt><a name="Browser-GetStackTrace"><strong>GetStackTrace</strong></a>(self) </dt></dl>	70 <dl><dt><a name="Browser-GetStackTrace"><strong>GetStackTrace</strong></a>(self) </dt></dl>

68	71

69 <dl><dt><a name="Browser-GetStandardOutput"><strong>GetStandardOutput</strong></ a>(self)</dt></dl>	72 <dl><dt><a name="Browser-GetStandardOutput"><strong>GetStandardOutput</strong></ a>(self)</dt></dl>

70	73

71 <dl><dt><a name="Browser-GetTraceResultAndReset"><strong>GetTraceResultAndReset< /strong></a>(self)</dt><dd><tt>Returns the result of the&nbs p;trace, as TraceResult <a href="__builtin__.html#object">object< /a>.</tt></dd></dl>	74 <dl><dt><a name="Browser-GetSystemInfo"><strong>GetSystemInfo</strong></a>(self) </dt><dd><tt>Returns low-level information about the sy stem, if available.<br>

	75  <br>

	76 See the documentation of the SystemInfo class&nbsp ;for more details.</tt></dd></dl>

72	77

73 <dl><dt><a name="Browser-SetHTTPServerDirectories"><strong>SetHTTPServerDirector ies</strong></a>(self, paths)</dt><dd><tt>Returns True if the&nbs p;HTTP server was started, False otherwise.</tt></dd></ dl>	78 <dl><dt><a name="Browser-SetHTTPServerDirectories"><strong>SetHTTPServerDirector ies</strong></a>(self, paths)</dt><dd><tt>Returns True if the&nbs p;HTTP server was started, False otherwise.</tt></dd></ dl>

74	79

75 <dl><dt><a name="Browser-SetReplayArchivePath"><strong>SetReplayArchivePath</str ong></a>(self, archive_path, append_to_existing_wpr<font color="#909090">=False< /font>, make_javascript_deterministic<font color="#909090">=True</font>)</dt></d l>	80 <dl><dt><a name="Browser-SetReplayArchivePath"><strong>SetReplayArchivePath</str ong></a>(self, archive_path, append_to_existing_wpr<font color="#909090">=False< /font>, make_javascript_deterministic<font color="#909090">=True</font>)</dt></d l>

76	81

77 <dl><dt><a name="Browser-StartProfiling"><strong>StartProfiling</strong></a>(sel f, options, base_output_file)</dt><dd><tt>Starts profiling using  \|options\|.profiler_tool. Results are saved to<br>	82 <dl><dt><a name="Browser-Start"><strong>Start</strong></a>(self)</dt></dl>

	83

	84 <dl><dt><a name="Browser-StartLocalServer"><strong>StartLocalServer</strong></a> (self, server)</dt><dd><tt>Starts a LocalServer and associat es it with this browser.<br>

	85  <br>

	86 It will be closed when the browser closes.</t t></dd></dl>

	87

	88 <dl><dt><a name="Browser-StartProfiling"><strong>StartProfiling</strong></a>(sel f, profiler_name, base_output_file)</dt><dd><tt>Starts profiling using  \|profiler_name\|. Results are saved to<br>

78 \|base_output_file\|.<process_name>.</tt></dd></dl>	89 \|base_output_file\|.<process_name>.</tt></dd></dl>

79	90

80 <dl><dt><a name="Browser-StartTracing"><strong>StartTracing</strong></a>(self, c ustom_categories<font color="#909090">=None</font>, timeout<font color="#909090" >=10</font>)</dt></dl>	91 <dl><dt><a name="Browser-StartTracing"><strong>StartTracing</strong></a>(self, c ustom_categories<font color="#909090">=None</font>, timeout<font color="#909090" >=10</font>)</dt></dl>

81	92

82 <dl><dt><a name="Browser-StopProfiling"><strong>StopProfiling</strong></a>(self) </dt><dd><tt>Stops all active profilers and saves  their results.</tt></dd></dl>	93 <dl><dt><a name="Browser-StopProfiling"><strong>StopProfiling</strong></a>(self) </dt><dd><tt>Stops all active profilers and saves  their results.<br>

	94  <br>

	95 Returns:<br>

	96   A list of filenames produced by the&nb sp;profiler.</tt></dd></dl>

83	97

84 <dl><dt><a name="Browser-StopTracing"><strong>StopTracing</strong></a>(self)</dt ></dl>	98 <dl><dt><a name="Browser-StopTracing"><strong>StopTracing</strong></a>(self)</dt ><dd><tt>Stops tracing and returns the result as&n bsp;TimelineData <a href="__builtin__.html#object">object</a>.</tt></dd></d l>

85	99

86 <dl><dt><a name="Browser-__enter__"><strong>__enter__</strong></a>(self)</dt></d l>	100 <dl><dt><a name="Browser-__enter__"><strong>__enter__</strong></a>(self)</dt></d l>

87	101

88 <dl><dt><a name="Browser-__exit__"><strong>__exit__</strong></a>(self, *args)</d t></dl>	102 <dl><dt><a name="Browser-__exit__"><strong>__exit__</strong></a>(self, *args)</d t></dl>

89	103

90 <dl><dt><a name="Browser-__init__"><strong>__init__</strong></a>(self, backend, platform_backend)</dt></dl>	104 <dl><dt><a name="Browser-__init__"><strong>__init__</strong></a>(self, backend, platform_backend)</dt></dl>

91	105

92 <dl><dt><a name="Browser-is_profiler_active"><strong>is_profiler_active</strong> </a>(self, profiler_name)</dt></dl>	106 <dl><dt><a name="Browser-is_profiler_active"><strong>is_profiler_active</strong> </a>(self, profiler_name)</dt></dl>

93	107

94 <hr>	108 <hr>

95 Data descriptors defined here:<br>	109 Data descriptors defined here:<br>

96 <dl><dt><strong>__dict__</strong></dt>	110 <dl><dt><strong>__dict__</strong></dt>

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

98 </dl>	112 </dl>

99 <dl><dt><strong>__weakref__</strong></dt>	113 <dl><dt><strong>__weakref__</strong></dt>

100 <dd><tt>list of weak references to the object&nbsp ;(if defined)</tt></dd>	114 <dd><tt>list of weak references to the object&nbsp ;(if defined)</tt></dd>

101 </dl>	115 </dl>

102 <dl><dt><strong>browser_type</strong></dt>	116 <dl><dt><strong>browser_type</strong></dt>

103 </dl>	117 </dl>

	118 <dl><dt><strong>cpu_stats</strong></dt>

	119 <dd><tt>Returns a dict of cpu statistics for  the system.<br>

	120 { 'Browser': {<br>

	121     'CpuProcessTime': S,<br>

	122     'TotalTime': T<br>

	123   },<br>

	124   'Gpu': {<br>

	125     'CpuProcessTime': S,<br>

	126     'TotalTime': T<br>

	127   },<br>

	128   'Renderer': {<br>

	129     'CpuProcessTime': S,<br>

	130     'TotalTime': T<br>

	131   }<br>

	132 }<br>

	133 Any of the above keys may be missing on& nbsp;a per-platform basis.</tt></dd>

	134 </dl>

104 <dl><dt><strong>extensions</strong></dt>	135 <dl><dt><strong>extensions</strong></dt>

105 <dd><tt>Returns the extension dictionary if it exi sts.</tt></dd>	136 </dl>

	137 <dl><dt><strong>foreground_tab</strong></dt>

106 </dl>	138 </dl>

107 <dl><dt><strong>http_server</strong></dt>	139 <dl><dt><strong>http_server</strong></dt>

108 </dl>	140 </dl>

109 <dl><dt><strong>io_stats</strong></dt>	141 <dl><dt><strong>io_stats</strong></dt>

110 <dd><tt>Returns a dict of IO statistics for t he browser:<br>	142 <dd><tt>Returns a dict of IO statistics for t he browser:<br>

111 { 'Browser': {<br>	143 { 'Browser': {<br>

112     'ReadOperationCount': W,<br>	144     'ReadOperationCount': W,<br>

113     'WriteOperationCount': X,<br>	145     'WriteOperationCount': X,<br>

114     'ReadTransferCount': Y,<br>	146     'ReadTransferCount': Y,<br>

115     'WriteTransferCount': Z<br>	147     'WriteTransferCount': Z<br>

116   },<br>	148   },<br>

117   'Gpu': {<br>	149   'Gpu': {<br>

118     'ReadOperationCount': W,<br>	150     'ReadOperationCount': W,<br>

119     'WriteOperationCount': X,<br>	151     'WriteOperationCount': X,<br>

120     'ReadTransferCount': Y,<br>	152     'ReadTransferCount': Y,<br>

121     'WriteTransferCount': Z<br>	153     'WriteTransferCount': Z<br>

122   },<br>	154   },<br>

123   'Renderer': {<br>	155   'Renderer': {<br>

124     'ReadOperationCount': W,<br>	156     'ReadOperationCount': W,<br>

125     'WriteOperationCount': X,<br>	157     'WriteOperationCount': X,<br>

126     'ReadTransferCount': Y,<br>	158     'ReadTransferCount': Y,<br>

127     'WriteTransferCount': Z<br>	159     'WriteTransferCount': Z<br>

128   }<br>	160   }<br>

129 }</tt></dd>	161 }</tt></dd>

130 </dl>	162 </dl>

131 <dl><dt><strong>is_content_shell</strong></dt>	163 <dl><dt><strong>is_content_shell</strong></dt>

132 <dd><tt>Returns whether this browser is a content& nbsp;shell, only.</tt></dd>	164 <dd><tt>Returns whether this browser is a content& nbsp;shell, only.</tt></dd>

133 </dl>	165 </dl>

	166 <dl><dt><strong>is_tracing_running</strong></dt>

	167 </dl>

	168 <dl><dt><strong>local_servers</strong></dt>

	169 <dd><tt>Returns the currently running local servers.</t t></dd>

	170 </dl>

134 <dl><dt><strong>memory_stats</strong></dt>	171 <dl><dt><strong>memory_stats</strong></dt>

135 <dd><tt>Returns a dict of memory statistics for&nb sp;the browser:<br>	172 <dd><tt>Returns a dict of memory statistics for&nb sp;the browser:<br>

136 { 'Browser': {<br>	173 { 'Browser': {<br>

137     'VM': S,<br>	174     'VM': R,<br>

138     'VMPeak': T,<br>	175     'VMPeak': S,<br>

139     'WorkingSetSize': U,<br>	176     'WorkingSetSize': T,<br>

140     'WorkingSetSizePeak': V,<br>	177     'WorkingSetSizePeak': U,<br>

141     'ProportionalSetSize': W,<br>	178     'ProportionalSetSize': V,<br>

142     'PrivateDirty': X<br>	179     'PrivateDirty': W<br>

143   },<br>	180   },<br>

144   'Gpu': {<br>	181   'Gpu': {<br>

145     'VM': S,<br>	182     'VM': R,<br>

146     'VMPeak': T,<br>	183     'VMPeak': S,<br>

147     'WorkingSetSize': U,<br>	184     'WorkingSetSize': T,<br>

148     'WorkingSetSizePeak': V,<br>	185     'WorkingSetSizePeak': U,<br>

149     'ProportionalSetSize': W,<br>	186     'ProportionalSetSize': V,<br>

150     'PrivateDirty': X<br>	187     'PrivateDirty': W<br>

151   },<br>	188   },<br>

152   'Renderer': {<br>	189   'Renderer': {<br>

153     'VM': S,<br>	190     'VM': R,<br>

154     'VMPeak': T,<br>	191     'VMPeak': S,<br>

155     'WorkingSetSize': U,<br>	192     'WorkingSetSize': T,<br>

156     'WorkingSetSizePeak': V,<br>	193     'WorkingSetSizePeak': U,<br>

157     'ProportionalSetSize': W,<br>	194     'ProportionalSetSize': V,<br>

158     'PrivateDirty': X<br>	195     'PrivateDirty': W<br>

159   },<br>	196   },<br>

160   'SystemCommitCharge': Y,<br>	197   'SystemCommitCharge': X,<br>

	198   'SystemTotalPhysicalMemory': Y,<br>

161   'ProcessCount': Z,<br>	199   'ProcessCount': Z,<br>

162 }<br>	200 }<br>

163 Any of the above keys may be missing on& nbsp;a per-platform basis.</tt></dd>	201 Any of the above keys may be missing on& nbsp;a per-platform basis.</tt></dd>

164 </dl>	202 </dl>

165 <dl><dt><strong>platform</strong></dt>	203 <dl><dt><strong>platform</strong></dt>

166 </dl>	204 </dl>

167 <dl><dt><strong>supports_extensions</strong></dt>	205 <dl><dt><strong>supports_extensions</strong></dt>

168 </dl>	206 </dl>

	207 <dl><dt><strong>supports_system_info</strong></dt>

	208 </dl>

169 <dl><dt><strong>supports_tab_control</strong></dt>	209 <dl><dt><strong>supports_tab_control</strong></dt>

170 </dl>	210 </dl>

171 <dl><dt><strong>supports_tracing</strong></dt>	211 <dl><dt><strong>supports_tracing</strong></dt>

172 </dl>	212 </dl>

	213 <dl><dt><strong>synthetic_gesture_source_type</strong></dt>

	214 </dl>

173 <dl><dt><strong>tabs</strong></dt>	215 <dl><dt><strong>tabs</strong></dt>

174 </dl>	216 </dl>

175 </td></tr></table></td></tr></table>	217 </td></tr></table></td></tr></table>

176 </body></html>	218 </body></html>

OLD	NEW

« no previous file with comments | « tools/telemetry/docs/telemetry.core.html ('k') | tools/telemetry/docs/telemetry.core.browser_credentials.html » ('j') | no next file with comments »