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

Unified Diff: tools/telemetry/docs/telemetry.core.platform.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

« no previous file with comments | « tools/telemetry/docs/telemetry.core.memory_cache_http_server.html ('k') | tools/telemetry/docs/telemetry.core.platform.android_platform_backend.html » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

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

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

index 66d420cb0b246cf7cc18c1ce5df9ce147c5710f7..9cd7adde2ec4221eecc48e5b49c315c5608d4dbf 100644

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

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

@@ -20,15 +20,24 @@

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

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

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

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

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

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

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

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

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

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

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

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

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

-<a href="telemetry.core.platform.profiler.html">profiler (package)</a>

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

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

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

+<a href="telemetry.core.platform.power_monitor.html">power_monitor (package)</a>

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

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

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

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

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

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

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

@@ -57,17 +66,41 @@ possible. It's important to note that platforms&nb

API, so check with IsFooBar() for availability.  </tt></td></tr>

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

+<dl><dt><a name="Platform-CanCaptureVideo">CanCaptureVideo</a>(self)</dt><dd><tt>Returns a bool indicating whether the platform supports video capture.</tt></dd></dl>

+<dl><dt><a name="Platform-CanFlushIndividualFilesFromSystemCache">CanFlushIndividualFilesFromSystemCache</a>(self)</dt><dd><tt>Returns true if the disk cache can be flushed for specific files.</tt></dd></dl>

+<dl><dt><a name="Platform-CanLaunchApplication">CanLaunchApplication</a>(self, application)</dt><dd><tt>Returns whether the platform can launch the given application.</tt></dd></dl>

+<dl><dt><a name="Platform-CanMonitorPowerAsync">CanMonitorPowerAsync</a>(self)</dt><dd><tt>Returns True iff power can be monitored asynchronously via

+<a href="#Platform-StartMonitoringPowerAsync">StartMonitoringPowerAsync</a>() and <a href="#Platform-StopMonitoringPowerAsync">StopMonitoringPowerAsync</a>().</tt></dd></dl>

+<dl><dt><a name="Platform-CanMonitorPowerSync">CanMonitorPowerSync</a>(self)</dt><dd><tt>Returns True iff power can be monitored synchronously via

+<a href="#Platform-MonitorPowerSync">MonitorPowerSync</a>().</tt></dd></dl>

<dl><dt><a name="Platform-CanMonitorThermalThrottling">CanMonitorThermalThrottling</a>(self)</dt><dd><tt>Platforms may be able to detect thermal throttling.

Some fan-less computers go into a reduced performance mode when their heat

exceeds a certain threshold. Performance tests in particular should use this

API to detect if this has happened and interpret results accordingly.</tt></dd></dl>

+<dl><dt><a name="Platform-FlushEntireSystemCache">FlushEntireSystemCache</a>(self)</dt><dd><tt>Flushes the OS's file cache completely.

+

+This function may require root or administrator access.</tt></dd></dl>

+<dl><dt><a name="Platform-FlushSystemCacheForDirectory">FlushSystemCacheForDirectory</a>(self, directory, ignoring=None)</dt><dd><tt>Flushes the OS's file cache for the specified directory.

+

+Any files or directories inside |directory| matching a name in the

+|ignoring| list will be skipped.

+

+This function does not require root or administrator access.</tt></dd></dl>

<dl><dt><a name="Platform-GetOSName">GetOSName</a>(self)</dt><dd><tt>Returns a string description of the <a href="#Platform">Platform</a> OS.

Examples: WIN, MAC, LINUX, CHROMEOS</tt></dd></dl>

-<dl><dt><a name="Platform-GetOSVersionName">GetOSVersionName</a>(self)</dt><dd><tt>Returns a string description of the <a href="#Platform">Platform</a> OS version.

+<dl><dt><a name="Platform-GetOSVersionName">GetOSVersionName</a>(self)</dt><dd><tt>Returns a logically sortable, string-like description of the <a href="#Platform">Platform</a> OS

+version.

Examples: VISTA, WIN7, LION, MOUNTAINLION</tt></dd></dl>

@@ -75,10 +108,41 @@ Examples: VISTA, WIN7, LION, MOUNTAINLION</tt></dd></dl>

<dl><dt><a name="Platform-HasBeenThermallyThrottled">HasBeenThermallyThrottled</a>(self)</dt><dd><tt>Returns True if the device has been thermally throttled.</tt></dd></dl>

+<dl><dt><a name="Platform-InstallApplication">InstallApplication</a>(self, application)</dt><dd><tt>Installs the given application.</tt></dd></dl>

+<dl><dt><a name="Platform-IsApplicationRunning">IsApplicationRunning</a>(self, application)</dt><dd><tt>Returns whether an application is currently running.</tt></dd></dl>

<dl><dt><a name="Platform-IsRawDisplayFrameRateSupported">IsRawDisplayFrameRateSupported</a>(self)</dt><dd><tt>Platforms may be able to collect GL surface stats.</tt></dd></dl>

<dl><dt><a name="Platform-IsThermallyThrottled">IsThermallyThrottled</a>(self)</dt><dd><tt>Returns True if the device is currently thermally throttled.</tt></dd></dl>

+<dl><dt><a name="Platform-LaunchApplication">LaunchApplication</a>(self, application, parameters=None, elevate_privilege=False)</dt><dd><tt>"Launches the given |application| with a list of |parameters| on the OS.

+

+Set |elevate_privilege| to launch the application with root or admin rights.

+

+Returns:

+  A popen style process handle for host platforms.</tt></dd></dl>

+<dl><dt><a name="Platform-MonitorPowerSync">MonitorPowerSync</a>(self, duration_ms)</dt><dd><tt>Synchronously monitors power for |duration_ms|.

+

+Returns:

+  A dict of power utilization statistics containing: {

+    # The instantaneous power (voltage * current) reading in milliwatts at

+    # each sample.

+    'power_samples_mw': [mw0, mw1, ..., mwN],

+

+    # The total energy consumption during the sampling period in milliwatt

+    # hours. May be estimated by integrating power samples or may be exact

+    # on supported hardware.

+    'energy_consumption_mwh': mwh,

+

+    # A platform-specific dictionary of additional details about the

+    # utilization of individual hardware components.

+    hw_component_utilization: {

+       ...

+    }

+  }</tt></dd></dl>

<dl><dt><a name="Platform-SetFullPerformanceModeEnabled">SetFullPerformanceModeEnabled</a>(self, enabled)</dt><dd><tt>Platforms may tweak their CPU governor, system status, etc.

Most platforms can operate in a battery saving mode. While good for battery

@@ -86,10 +150,56 @@ life, this can cause confusing performance results

full performance mode on disables these features, which is useful for

performance testing.</tt></dd></dl>

+<dl><dt><a name="Platform-StartMonitoringPowerAsync">StartMonitoringPowerAsync</a>(self)</dt><dd><tt>Starts monitoring power utilization statistics.</tt></dd></dl>

<dl><dt><a name="Platform-StartRawDisplayFrameRateMeasurement">StartRawDisplayFrameRateMeasurement</a>(self)</dt><dd><tt>Start measuring GL surface stats.</tt></dd></dl>

+<dl><dt><a name="Platform-StartVideoCapture">StartVideoCapture</a>(self, min_bitrate_mbps)</dt><dd><tt>Starts capturing video.

+

+Outer framing may be included (from the OS, browser window, and webcam).

+

+Args:

+  min_bitrate_mbps: The minimum capture bitrate in MegaBits Per Second.

+      The platform is free to deliver a higher bitrate if it can do so

+      without increasing overhead.

+

+Raises:

+  ValueError if the required |min_bitrate_mbps| can't be achieved.</tt></dd></dl>

+<dl><dt><a name="Platform-StopMonitoringPowerAsync">StopMonitoringPowerAsync</a>(self)</dt><dd><tt>Stops monitoring power utilization and returns collects stats

+

+Returns:

+  A dict of power utilization statistics containing: {

+    # An identifier for the data provider. Allows to evaluate the precision

+    # of the data. Example values: monsoon, powermetrics, ds2784

+    'identifier': identifier,

+

+    # The instantaneous power (voltage * current) reading in milliwatts at

+    # each sample.

+    'power_samples_mw':  [mw0, mw1, ..., mwN],

+

+    # The total energy consumption during the sampling period in milliwatt

+    # hours. May be estimated by integrating power samples or may be exact

+    # on supported hardware.

+    'energy_consumption_mwh': mwh,

+

+    # A platform-specific dictionary of additional details about the

+    # utilization of individual hardware components.

+    hw_component_utilization: {

+       ...

+    }

+  }</tt></dd></dl>

<dl><dt><a name="Platform-StopRawDisplayFrameRateMeasurement">StopRawDisplayFrameRateMeasurement</a>(self)</dt><dd><tt>Stop measuring GL surface stats.</tt></dd></dl>

+<dl><dt><a name="Platform-StopVideoCapture">StopVideoCapture</a>(self)</dt><dd><tt>Stops capturing video.

+

+Yields:

+  (time_ms, bitmap) tuples representing each video keyframe. Only the first

+  frame in a run of sequential duplicate bitmaps is included.

+    time_ms is milliseconds relative to the first frame.

+    bitmap is a telemetry.core.Bitmap.</tt></dd></dl>

<dl><dt><a name="Platform-__init__">__init__</a>(self, platform_backend)</dt></dl>

<hr>