tools/telemetry/docs/pydoc/telemetry.web_perf.timeline_based_measurement.html - Issue 1647513002: Delete tools/telemetry.

Unified Diff: tools/telemetry/docs/pydoc/telemetry.web_perf.timeline_based_measurement.html

Issue 1647513002: Delete tools/telemetry. (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master

Patch Set: Created 4 years, 11 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/pydoc/telemetry.web_perf.story_test.html ('k') | tools/telemetry/docs/pydoc/telemetry.web_perf.timeline_based_page_test.html » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

Index: tools/telemetry/docs/pydoc/telemetry.web_perf.timeline_based_measurement.html

diff --git a/tools/telemetry/docs/pydoc/telemetry.web_perf.timeline_based_measurement.html b/tools/telemetry/docs/pydoc/telemetry.web_perf.timeline_based_measurement.html

deleted file mode 100644

index 0761e8f49231e36d0807a6dfbd6fa858606d1271..0000000000000000000000000000000000000000

--- a/tools/telemetry/docs/pydoc/telemetry.web_perf.timeline_based_measurement.html

+++ /dev/null

@@ -1,269 +0,0 @@

-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">

-<html><head><title>Python: module telemetry.web_perf.timeline_based_measurement</title>

-<meta charset="utf-8">

-</head><body bgcolor="#f0f0f8">

-<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">

-<tr bgcolor="#7799ee">

-<td valign=bottom>

-  <big><big><a href="telemetry.html">telemetry</a>.<a href="telemetry.web_perf.html">web_perf</a>.timeline_based_measurement</big></big></td

-><td align=right valign=bottom

-><a href=".">index</a> <a href="../telemetry/web_perf/timeline_based_measurement.py">telemetry/web_perf/timeline_based_measurement.py</a></td></tr></table>

- <tt># Copyright 2014 The Chromium Authors. All rights reserved.

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

-# found in the LICENSE file.</tt>

-

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

-<tr bgcolor="#aa55cc">

-<td colspan=3 valign=bottom>

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

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

-<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="telemetry.web_perf.metrics.blob_timeline.html">telemetry.web_perf.metrics.blob_timeline</a>

-<a href="collections.html">collections</a>

-<a href="telemetry.web_perf.metrics.gpu_timeline.html">telemetry.web_perf.metrics.gpu_timeline</a>

-<a href="telemetry.web_perf.metrics.indexeddb_timeline.html">telemetry.web_perf.metrics.indexeddb_timeline</a>

-<a href="telemetry.web_perf.metrics.layout.html">telemetry.web_perf.metrics.layout</a>

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

-<a href="telemetry.web_perf.metrics.memory_timeline.html">telemetry.web_perf.metrics.memory_timeline</a>

-<a href="telemetry.timeline.model.html">telemetry.timeline.model</a>

-<a href="telemetry.web_perf.metrics.responsiveness_metric.html">telemetry.web_perf.metrics.responsiveness_metric</a>

-<a href="telemetry.web_perf.smooth_gesture_util.html">telemetry.web_perf.smooth_gesture_util</a>

-</td><td width="25%" valign=top><a href="telemetry.web_perf.metrics.smoothness.html">telemetry.web_perf.metrics.smoothness</a>

-<a href="telemetry.web_perf.story_test.html">telemetry.web_perf.story_test</a>

-<a href="telemetry.web_perf.metrics.text_selection.html">telemetry.web_perf.metrics.text_selection</a>

-<a href="telemetry.web_perf.metrics.timeline_based_metric.html">telemetry.web_perf.metrics.timeline_based_metric</a>

-<a href="telemetry.web_perf.timeline_interaction_record.html">telemetry.web_perf.timeline_interaction_record</a>

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

-<a href="telemetry.timeline.tracing_category_filter.html">telemetry.timeline.tracing_category_filter</a>

-<a href="telemetry.timeline.tracing_options.html">telemetry.timeline.tracing_options</a>

-<a href="telemetry.web_perf.metrics.webrtc_rendering_timeline.html">telemetry.web_perf.metrics.webrtc_rendering_timeline</a>

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

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

-<tr bgcolor="#ee77aa">

-<td colspan=3 valign=bottom>

-<big>Classes</big></td></tr>

-<tr><td bgcolor="#ee77aa"><tt>      </tt></td><td> </td>

-<td width="100%"><dl>

-<dt><a href="__builtin__.html#object">__builtin__.object</a>

-</dt><dd>

-<dl>

-<dt><a href="telemetry.web_perf.timeline_based_measurement.html#Options">Options</a>

-</dt><dt><a href="telemetry.web_perf.timeline_based_measurement.html#ResultsWrapperInterface">ResultsWrapperInterface</a>

-</dt></dl>

-</dd>

-<dt><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>)

-</dt><dd>

-<dl>

-<dt><a href="telemetry.web_perf.timeline_based_measurement.html#InvalidInteractions">InvalidInteractions</a>

-</dt></dl>

-</dd>

-<dt><a href="telemetry.web_perf.story_test.html#StoryTest">telemetry.web_perf.story_test.StoryTest</a>(<a href="__builtin__.html#object">__builtin__.object</a>)

-</dt><dd>

-<dl>

-<dt><a href="telemetry.web_perf.timeline_based_measurement.html#TimelineBasedMeasurement">TimelineBasedMeasurement</a>

-</dt></dl>

-</dd>

-</dl>

-

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

-<tr bgcolor="#ffc8d8">

-<td colspan=3 valign=bottom>

-<a name="InvalidInteractions">class InvalidInteractions</a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</td></tr>

-<tr><td bgcolor="#ffc8d8"><tt>   </tt></td><td> </td>

-<td width="100%"><dl><dt>Method resolution order:</dt>

-<dd><a href="telemetry.web_perf.timeline_based_measurement.html#InvalidInteractions">InvalidInteractions</a></dd>

-<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>

-<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>

-<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

-</dl>

-<hr>

-Data descriptors defined here:

-<dl><dt>__weakref__</dt>

-<dd><tt>list of weak references to the object (if defined)</tt></dd>

-</dl>

-<hr>

-Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

-<dl><dt><a name="InvalidInteractions-__init__">__init__</a>(...)</dt><dd><tt>x.<a href="#InvalidInteractions-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl>

-<hr>

-Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

-<dl><dt>__new__ = <built-in method __new__ of type object><dd><tt>T.<a href="#InvalidInteractions-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl>

-<hr>

-Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

-<dl><dt><a name="InvalidInteractions-__delattr__">__delattr__</a>(...)</dt><dd><tt>x.<a href="#InvalidInteractions-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>

-<dl><dt><a name="InvalidInteractions-__getattribute__">__getattribute__</a>(...)</dt><dd><tt>x.<a href="#InvalidInteractions-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>

-<dl><dt><a name="InvalidInteractions-__getitem__">__getitem__</a>(...)</dt><dd><tt>x.<a href="#InvalidInteractions-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>

-<dl><dt><a name="InvalidInteractions-__getslice__">__getslice__</a>(...)</dt><dd><tt>x.<a href="#InvalidInteractions-__getslice__">__getslice__</a>(i, j) <==> x[i:j]

-

-Use of negative indices is not supported.</tt></dd></dl>

-<dl><dt><a name="InvalidInteractions-__reduce__">__reduce__</a>(...)</dt></dl>

-<dl><dt><a name="InvalidInteractions-__repr__">__repr__</a>(...)</dt><dd><tt>x.<a href="#InvalidInteractions-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl>

-<dl><dt><a name="InvalidInteractions-__setattr__">__setattr__</a>(...)</dt><dd><tt>x.<a href="#InvalidInteractions-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>

-<dl><dt><a name="InvalidInteractions-__setstate__">__setstate__</a>(...)</dt></dl>

-<dl><dt><a name="InvalidInteractions-__str__">__str__</a>(...)</dt><dd><tt>x.<a href="#InvalidInteractions-__str__">__str__</a>() <==> str(x)</tt></dd></dl>

-<dl><dt><a name="InvalidInteractions-__unicode__">__unicode__</a>(...)</dt></dl>

-<hr>

-Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

-<dl><dt>__dict__</dt>

-</dl>

-<dl><dt>args</dt>

-</dl>

-<dl><dt>message</dt>

-</dl>

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

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

-<tr bgcolor="#ffc8d8">

-<td colspan=3 valign=bottom>

-<a name="Options">class Options</a>(<a href="__builtin__.html#object">__builtin__.object</a>)</td></tr>

-<tr bgcolor="#ffc8d8"><td rowspan=2><tt>   </tt></td>

-<td colspan=2><tt>A class to be used to configure <a href="#TimelineBasedMeasurement">TimelineBasedMeasurement</a>.

-

-This is created and returned by

-Benchmark.CreateTimelineBasedMeasurementOptions.

-

-By default, all the timeline based metrics in telemetry/web_perf/metrics are

-used (see _GetAllTimelineBasedMetrics above).

-To customize your metric needs, use <a href="#Options-SetTimelineBasedMetrics">SetTimelineBasedMetrics</a>().  </tt></td></tr>

-<tr><td> </td>

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

-<dl><dt><a name="Options-ExtendTraceCategoryFilter">ExtendTraceCategoryFilter</a>(self, filters)</dt></dl>

-<dl><dt><a name="Options-GetTimelineBasedMetrics">GetTimelineBasedMetrics</a>(self)</dt></dl>

-<dl><dt><a name="Options-SetTimelineBasedMetrics">SetTimelineBasedMetrics</a>(self, metrics)</dt></dl>

-<dl><dt><a name="Options-__init__">__init__</a>(self, overhead_level='no-overhead')</dt><dd><tt>As the amount of instrumentation increases, so does the overhead.

-The user of the measurement chooses the overhead level that is appropriate,

-and the tracing is filtered accordingly.

-

-overhead_level: Can either be a custom TracingCategoryFilter <a href="__builtin__.html#object">object</a> or

-    one of NO_OVERHEAD_LEVEL, MINIMAL_OVERHEAD_LEVEL or

-    DEBUG_OVERHEAD_LEVEL.</tt></dd></dl>

-<hr>

-Data descriptors defined here:

-<dl><dt>__dict__</dt>

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

-</dl>

-<dl><dt>__weakref__</dt>

-<dd><tt>list of weak references to the object (if defined)</tt></dd>

-</dl>

-<dl><dt>category_filter</dt>

-</dl>

-<dl><dt>tracing_options</dt>

-</dl>

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

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

-<tr bgcolor="#ffc8d8">

-<td colspan=3 valign=bottom>

-<a name="ResultsWrapperInterface">class ResultsWrapperInterface</a>(<a href="__builtin__.html#object">__builtin__.object</a>)</td></tr>

-<tr bgcolor="#ffc8d8"><td rowspan=2><tt>   </tt></td>

-<td colspan=2><tt># TODO(nednguyen): Get rid of this results wrapper hack after we add interaction

-# record to telemetry value system (crbug.com/453109)  </tt></td></tr>

-<tr><td> </td>

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

-<dl><dt><a name="ResultsWrapperInterface-AddValue">AddValue</a>(self, value)</dt></dl>

-<dl><dt><a name="ResultsWrapperInterface-SetResults">SetResults</a>(self, results)</dt></dl>

-<dl><dt><a name="ResultsWrapperInterface-SetTirLabel">SetTirLabel</a>(self, tir_label)</dt></dl>

-<dl><dt><a name="ResultsWrapperInterface-__init__">__init__</a>(self)</dt></dl>

-<hr>

-Data descriptors defined here:

-<dl><dt>__dict__</dt>

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

-</dl>

-<dl><dt>__weakref__</dt>

-<dd><tt>list of weak references to the object (if defined)</tt></dd>

-</dl>

-<dl><dt>current_page</dt>

-</dl>

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

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

-<tr bgcolor="#ffc8d8">

-<td colspan=3 valign=bottom>

-<a name="TimelineBasedMeasurement">class TimelineBasedMeasurement</a>(<a href="telemetry.web_perf.story_test.html#StoryTest">telemetry.web_perf.story_test.StoryTest</a>)</td></tr>

-<tr bgcolor="#ffc8d8"><td rowspan=2><tt>   </tt></td>

-<td colspan=2><tt>Collects multiple metrics based on their interaction records.

-

-A timeline based measurement shifts the burden of what metrics to collect onto

-the story under test. Instead of the measurement

-having a fixed set of values it collects, the story being tested

-issues (via javascript) an Interaction record into the user timing API that

-describing what is happening at that time, as well as a standardized set

-of flags describing the semantics of the work being done. The

-<a href="#TimelineBasedMeasurement">TimelineBasedMeasurement</a> <a href="__builtin__.html#object">object</a> collects a trace that includes both these

-interaction records, and a user-chosen amount of performance data using

-Telemetry's various timeline-producing APIs, tracing especially.

-

-It then passes the recorded timeline to different TimelineBasedMetrics based

-on those flags. As an example, this allows a single story run to produce

-load timing data, smoothness data, critical jank information and overall cpu

-usage information.

-

-For information on how to mark up a page to work with

-<a href="#TimelineBasedMeasurement">TimelineBasedMeasurement</a>, refer to the

-perf.metrics.timeline_interaction_record module.

-

-Args:

-    options: an instance of timeline_based_measurement.<a href="#Options">Options</a>.

-    results_wrapper: A class that has the __init__ method takes in

-      the page_test_results <a href="__builtin__.html#object">object</a> and the interaction record label. This

-      class follows the <a href="#ResultsWrapperInterface">ResultsWrapperInterface</a>. Note: this class is not

-      supported long term and to be removed when crbug.com/453109 is resolved.  </tt></td></tr>

-<tr><td> </td>

-<td width="100%"><dl><dt>Method resolution order:</dt>

-<dd><a href="telemetry.web_perf.timeline_based_measurement.html#TimelineBasedMeasurement">TimelineBasedMeasurement</a></dd>

-<dd><a href="telemetry.web_perf.story_test.html#StoryTest">telemetry.web_perf.story_test.StoryTest</a></dd>

-<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

-</dl>

-<hr>

-Methods defined here:

-<dl><dt><a name="TimelineBasedMeasurement-DidRunStory">DidRunStory</a>(self, platform)</dt><dd><tt>Clean up after running the story.</tt></dd></dl>

-<dl><dt><a name="TimelineBasedMeasurement-Measure">Measure</a>(self, platform, results)</dt><dd><tt>Collect all possible metrics and added them to results.</tt></dd></dl>

-<dl><dt><a name="TimelineBasedMeasurement-WillRunStory">WillRunStory</a>(self, platform)</dt><dd><tt>Configure and start tracing.</tt></dd></dl>

-<dl><dt><a name="TimelineBasedMeasurement-__init__">__init__</a>(self, options, results_wrapper=None)</dt></dl>

-<hr>

-Data descriptors inherited from <a href="telemetry.web_perf.story_test.html#StoryTest">telemetry.web_perf.story_test.StoryTest</a>:

-<dl><dt>__dict__</dt>

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

-</dl>

-<dl><dt>__weakref__</dt>

-<dd><tt>list of weak references to the object (if defined)</tt></dd>

-</dl>

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

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

-<tr bgcolor="#55aa55">

-<td colspan=3 valign=bottom>

-<big>Data</big></td></tr>

-<tr><td bgcolor="#55aa55"><tt>      </tt></td><td> </td>

-<td width="100%">ALL_OVERHEAD_LEVELS = ['no-overhead', 'minimal-overhead', 'debug-overhead']

-DEBUG_OVERHEAD_LEVEL = 'debug-overhead'

-MINIMAL_OVERHEAD_LEVEL = 'minimal-overhead'

-NO_OVERHEAD_LEVEL = 'no-overhead'</td></tr></table>

-</body></html>