42 lines
1.4 KiB
Python
42 lines
1.4 KiB
Python
|
# Copyright 2013 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.
|
||
|
|
|
||
|
|
class Metric(object):
|
||
|
|
"""Base class for all the metrics that are used by telemetry measurements.
|
||
|
|
|
||
|
|
The Metric class represents a way of measuring something. Metrics are
|
||
|
|
helper classes used by PageMeasurements. Each PageMeasurement may use
|
||
|
|
multiple metrics; each metric should be focussed on collecting data
|
||
|
|
about one thing.
|
||
|
|
"""
|
||
|
|
|
||
|
|
def CustomizeBrowserOptions(self, options):
|
||
|
|
"""Add browser options that are required by this metric.
|
||
|
|
|
||
|
|
Some metrics do not have any special browser options that need
|
||
|
|
to be added, and they do not need to override this method; by
|
||
|
|
default, no browser options are added.
|
||
|
|
|
||
|
|
To add options here, call options.AppendExtraBrowserArg(arg).
|
||
|
|
"""
|
||
|
|
pass
|
||
|
|
|
||
|
|
def Start(self, page, tab):
|
||
|
|
"""Start collecting data for this metric."""
|
||
|
|
raise NotImplementedError()
|
||
|
|
|
||
|
|
def Stop(self, page, tab):
|
||
|
|
"""Stop collecting data for this metric (if applicable)."""
|
||
|
|
raise NotImplementedError()
|
||
|
|
|
||
|
|
def AddResults(self, tab, results):
|
||
|
|
"""Add the data collected into the results object for a measurement.
|
||
|
|
|
||
|
|
Metrics may implement AddResults to provide a common way to add results
|
||
|
|
to the PageMeasurementResults in PageMeasurement.AddMeasurement --
|
||
|
|
results should be added with results.Add(trace_name, unit, value).
|
||
|
|
"""
|
||
|
|
raise NotImplementedError()
|
||
|
|
|