| | |
- __builtin__.object
-
- Options
- ResultsWrapperInterface
- exceptions.Exception(exceptions.BaseException)
-
- InvalidInteractions
- telemetry.web_perf.story_test.StoryTest(__builtin__.object)
-
- TimelineBasedMeasurement
class Options(__builtin__.object) |
| |
A class to be used to configure TimelineBasedMeasurement.
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 SetTimelineBasedMetrics().
|
| |
Methods defined here:
- ExtendTraceCategoryFilter(self, filters)
- GetTimelineBasedMetrics(self)
- SetTimelineBasedMetrics(self, metrics)
- __init__(self, overhead_level='no-overhead')
- 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 object or
one of NO_OVERHEAD_LEVEL, MINIMAL_OVERHEAD_LEVEL or
DEBUG_OVERHEAD_LEVEL.
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
- category_filter
- tracing_options
|
class ResultsWrapperInterface(__builtin__.object) |
| |
# TODO(nednguyen): Get rid of this results wrapper hack after we add interaction
# record to telemetry value system (crbug.com/453109)
|
| |
Methods defined here:
- AddValue(self, value)
- SetResults(self, results)
- SetTirLabel(self, tir_label)
- __init__(self)
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
- current_page
|
class TimelineBasedMeasurement(telemetry.web_perf.story_test.StoryTest) |
| |
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
TimelineBasedMeasurement object 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
TimelineBasedMeasurement, refer to the
perf.metrics.timeline_interaction_record module.
Args:
options: an instance of timeline_based_measurement.Options.
results_wrapper: A class that has the __init__ method takes in
the page_test_results object and the interaction record label. This
class follows the ResultsWrapperInterface. Note: this class is not
supported long term and to be removed when crbug.com/453109 is resolved.
|
| |
- Method resolution order:
- TimelineBasedMeasurement
- telemetry.web_perf.story_test.StoryTest
- __builtin__.object
Methods defined here:
- DidRunStory(self, platform)
- Clean up after running the story.
- Measure(self, platform, results)
- Collect all possible metrics and added them to results.
- WillRunStory(self, platform)
- Configure and start tracing.
- __init__(self, options, results_wrapper=None)
Data descriptors inherited from telemetry.web_perf.story_test.StoryTest:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
| |