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

Unified 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 side-by-side diff with in-line comments

Download patch

Index: tools/telemetry/docs/telemetry.core.browser.html

diff --git a/tools/telemetry/docs/telemetry.core.browser.html b/tools/telemetry/docs/telemetry.core.browser.html

index 78dfc77d1aae368b090ee433dfe8954287c14a25..629741908a687c13cf8e0e1ee6faafd9059d41df 100644

--- a/tools/telemetry/docs/telemetry.core.browser.html

+++ b/tools/telemetry/docs/telemetry.core.browser.html

@@ -19,14 +19,17 @@

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

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

+<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="telemetry.core.backends.browser_backend.html">telemetry.core.backends.browser_backend</a>

<a href="telemetry.core.browser_credentials.html">telemetry.core.browser_credentials</a>

-<a href="telemetry.core.extension_dict.html">telemetry.core.extension_dict</a>

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

-<a href="telemetry.core.platform.html">telemetry.core.platform</a>

+<a href="telemetry.decorators.html">telemetry.decorators</a>

+<a href="telemetry.core.exceptions.html">telemetry.core.exceptions</a>

+</td><td width="25%" valign=top><a href="telemetry.core.extension_dict.html">telemetry.core.extension_dict</a>

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

+<a href="telemetry.core.memory_cache_http_server.html">telemetry.core.memory_cache_http_server</a>

+<a href="os.html">os</a>

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

<a href="telemetry.core.platform.profiler.profiler_finder.html">telemetry.core.platform.profiler.profiler_finder</a>

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

-<a href="telemetry.core.temporary_http_server.html">telemetry.core.temporary_http_server</a>

+<a href="telemetry.core.tab_list.html">telemetry.core.tab_list</a>

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

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

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

@@ -68,20 +71,31 @@ the browser. Or better yet:

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

-<dl><dt><a name="Browser-GetTraceResultAndReset">GetTraceResultAndReset</a>(self)</dt><dd><tt>Returns the result of the trace, as TraceResult <a href="__builtin__.html#object">object</a>.</tt></dd></dl>

+<dl><dt><a name="Browser-GetSystemInfo">GetSystemInfo</a>(self)</dt><dd><tt>Returns low-level information about the system, if available.

+

+See the documentation of the SystemInfo class for more details.</tt></dd></dl>

<dl><dt><a name="Browser-SetHTTPServerDirectories">SetHTTPServerDirectories</a>(self, paths)</dt><dd><tt>Returns True if the HTTP server was started, False otherwise.</tt></dd></dl>

<dl><dt><a name="Browser-SetReplayArchivePath">SetReplayArchivePath</a>(self, archive_path, append_to_existing_wpr=False, make_javascript_deterministic=True)</dt></dl>

-<dl><dt><a name="Browser-StartProfiling">StartProfiling</a>(self, options, base_output_file)</dt><dd><tt>Starts profiling using |options|.profiler_tool. Results are saved to

+<dl><dt><a name="Browser-Start">Start</a>(self)</dt></dl>

+<dl><dt><a name="Browser-StartLocalServer">StartLocalServer</a>(self, server)</dt><dd><tt>Starts a LocalServer and associates it with this browser.

+

+It will be closed when the browser closes.</tt></dd></dl>

+<dl><dt><a name="Browser-StartProfiling">StartProfiling</a>(self, profiler_name, base_output_file)</dt><dd><tt>Starts profiling using |profiler_name|. Results are saved to

|base_output_file|.<process_name>.</tt></dd></dl>

<dl><dt><a name="Browser-StartTracing">StartTracing</a>(self, custom_categories=None, timeout=10)</dt></dl>

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

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

+

+Returns:

+  A list of filenames produced by the profiler.</tt></dd></dl>

-<dl><dt><a name="Browser-StopTracing">StopTracing</a>(self)</dt></dl>

+<dl><dt><a name="Browser-StopTracing">StopTracing</a>(self)</dt><dd><tt>Stops tracing and returns the result as TimelineData <a href="__builtin__.html#object">object</a>.</tt></dd></dl>

<dl><dt><a name="Browser-__enter__">__enter__</a>(self)</dt></dl>

@@ -101,8 +115,26 @@ Data descriptors defined here:

</dl>

<dl><dt>browser_type</dt>

</dl>

+<dl><dt>cpu_stats</dt>

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

+{ 'Browser': {

+    'CpuProcessTime': S,

+    'TotalTime': T

+  },

+  'Gpu': {

+    'CpuProcessTime': S,

+    'TotalTime': T

+  },

+  'Renderer': {

+    'CpuProcessTime': S,

+    'TotalTime': T

+  }

+}

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

+</dl>

<dl><dt>extensions</dt>

-<dd><tt>Returns the extension dictionary if it exists.</tt></dd>

+</dl>

+<dl><dt>foreground_tab</dt>

</dl>

<dl><dt>http_server</dt>

</dl>

@@ -131,33 +163,39 @@ Data descriptors defined here:

<dl><dt>is_content_shell</dt>

<dd><tt>Returns whether this browser is a content shell, only.</tt></dd>

</dl>

+<dl><dt>is_tracing_running</dt>

+</dl>

+<dl><dt>local_servers</dt>

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

+</dl>

<dl><dt>memory_stats</dt>

<dd><tt>Returns a dict of memory statistics for the browser:

{ 'Browser': {

-    'VM': S,

-    'VMPeak': T,

-    'WorkingSetSize': U,

-    'WorkingSetSizePeak': V,

-    'ProportionalSetSize': W,

-    'PrivateDirty': X

+    'VM': R,

+    'VMPeak': S,

+    'WorkingSetSize': T,

+    'WorkingSetSizePeak': U,

+    'ProportionalSetSize': V,

+    'PrivateDirty': W

},

'Gpu': {

-    'VM': S,

-    'VMPeak': T,

-    'WorkingSetSize': U,

-    'WorkingSetSizePeak': V,

-    'ProportionalSetSize': W,

-    'PrivateDirty': X

+    'VM': R,

+    'VMPeak': S,

+    'WorkingSetSize': T,

+    'WorkingSetSizePeak': U,

+    'ProportionalSetSize': V,

+    'PrivateDirty': W

},

'Renderer': {

-    'VM': S,

-    'VMPeak': T,

-    'WorkingSetSize': U,

-    'WorkingSetSizePeak': V,

-    'ProportionalSetSize': W,

-    'PrivateDirty': X

+    'VM': R,

+    'VMPeak': S,

+    'WorkingSetSize': T,

+    'WorkingSetSizePeak': U,

+    'ProportionalSetSize': V,

+    'PrivateDirty': W

},

-  'SystemCommitCharge': Y,

+  'SystemCommitCharge': X,

+  'SystemTotalPhysicalMemory': Y,

'ProcessCount': Z,

}

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

@@ -166,10 +204,14 @@ Any of the above keys may be missing on&

</dl>

<dl><dt>supports_extensions</dt>

</dl>

+<dl><dt>supports_system_info</dt>

+</dl>

<dl><dt>supports_tab_control</dt>

</dl>

<dl><dt>supports_tracing</dt>

</dl>

+<dl><dt>synthetic_gesture_source_type</dt>

+</dl>

</dl>

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

« 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 »