IMetricCollector

public interface IMetricCollector
implements IDisableable, ILogSaverListener

com.android.tradefed.device.metric.IMetricCollector

已知的间接子类 AtraceCollector、AtraceRunMetricCollector、BaseDeviceMetricCollector、BluetoothConnectionLatencyCollector、BluetoothConnectionStateCollector、BluetoothHciSnoopLogCollector、BugreportzOnFailureCollector、BugreportzOnTestCaseFailureCollector、ClangCodeCoverageCollector、CodeCoverageCollector、CountTestCasesCollector、DebugHostLogOnFailureCollector、DeviceTraceCollector、FilePullerDeviceMetricCollector、FilePullerLogCollector 以及其他 16 个。 AtraceCollector 一种在测试期间运行 atrace 并收集结果和日志，然后将它们记录到调用中的 IMetricCollector。  AtraceRunMetricCollector 从测试设备收集给定目录下所有测试目录中的轨迹，记录测试目录，对测试目录下的轨迹文件进行后处理，并汇总指标。  BaseDeviceMetricCollector IMetricCollector 的基本实现，允许在 onTestRunStart(DeviceMetricData) 和 onTestRunEnd(DeviceMetricData,Map) 上开始和停止收集。  BluetoothConnectionLatencyCollector 收集器会将预定义的 statsd 时长指标配置推送到设备，并收集每个配置文件的蓝牙连接时长。  BluetoothConnectionStateCollector 此收集器将收集 BluetoothConnectionStateChanged 指标，并记录每个配置的连接状态编号。  BluetoothHciSnoopLogCollector 用于在 DUT 上启用蓝牙 HCI 信息收集日志记录并收集每次测试的日志的收集器。  BugreportzOnFailureCollector 在测试用例失败时收集 bugreportz。  BugreportzOnTestCaseFailureCollector 在运行中的测试用例失败时收集 bugreportz。  ClangCodeCoverageCollector 一个 BaseDeviceMetricCollector，用于从设备中提取 Clang 覆盖率测量数据，并将其记录为测试制品。  CodeCoverageCollector 一个 BaseDeviceMetricCollector，用于从设备中提取 Java 和原生覆盖率测量数据，并将其记录为测试制品。  CountTestCasesCollector 统计并报告给定 IRemoteTest 的测试用例数量。  DebugHostLogOnFailureCollector 在测试用例失败时收集并记录主机端日志的收集器。  DeviceTraceCollector 在测试运行开始时启动 Perfetto 跟踪并在结束时记录跟踪文件的收集器。  FilePullerDeviceMetricCollector 一个 BaseDeviceMetricCollector，用于监听来自设备的指标密钥，并以文件形式从设备中提取这些密钥。  FilePullerLogCollector 设备端报告的文件的记录器。  GcovCodeCoverageCollector 一个 BaseDeviceMetricCollector，用于从设备中提取 gcov 覆盖率测量数据，并将其记录为测试制品。  GcovKernelCodeCoverageCollector 一个 BaseDeviceMetricCollector，用于从 debugfs 和设备中提取 gcov 内核覆盖率测量数据，然后最终将其记录为测试制品。  HostStatsdMetricCollector 一种 IMetricCollector，可使用 statsd 实用程序命令从主机端收集 statsd 指标。  JavaCodeCoverageCollector 一个 BaseDeviceMetricCollector，用于从设备中提取 Java 覆盖率测量数据，并将其记录为测试制品。  LogcatOnFailureCollector 当测试用例或测试运行失败时，将捕获并记录 logcat 的收集器。  LogcatTimingMetricCollector 一种指标收集器，通过使用给定的正则表达式模式从 logcat 行解析事件的开始和结束信号，在一次或多次重复测试期间从 logcat 收集时间信息（例如用户切换时间）。  ModuleLogcatCollector logcat 收集器的版本（但适用于模块）。  ModulePerfettoCollector 当测试模块启动和结束以及设备重新启动时，将启动 Perfetto 轨迹的收集器。  PerfettoFilePullerCollector 一种从设备拉取 Perfetto 轨迹文件的收集器，可以选择性地压缩这些文件，并将其添加到测试日志中。  PerfettoPullerMetricCollector 此类已弃用。 请改用 PerfettoFilePullerCollector 和 ERROR(/PerfettoTracePostProcessor)。  RebootReasonCollector 收集器，用于收集测试运行期间的设备重启情况，并按原因和次数报告这些情况。  RuntimeRestartCollector 收集器，用于收集测试运行期间的运行时重启（系统服务器崩溃）时间戳（如有）。  ScreenRecordOnFailureCollector 在测试用例失败时捕获并记录屏幕录制的收集器。  ScreenshotOnFailureCollector 在测试用例失败时捕获并记录屏幕截图的收集器。  ShowmapPullerMetricCollector FilePullerDeviceMetricCollector 的基本实现，允许从设备拉取 showmap 文件并从中收集指标。  TraceCmdCollector 一个 IMetricCollector，用于在测试期间使用 trace-cmd 收集轨迹，并将其记录到调用中。

---

在报告测试结果时，此接口将作为装饰器添加，以便收集匹配的指标。

即使此接口扩展了 ITestInvocationListener，也无法用作 。配置检查会拒绝该配置。必须用作“metrics_collector”。

收集器不应保留内部状态，因为它们可能会在多个位置重复使用。如果确实必须使用内部状态，则应在 init(IInvocationContext,ITestInvocationListener) 上清理该状态。

摘要

公共方法
default boolean	captureModuleLevel() 收集器是否适用于模块级捕获，是否应进行初始化。
default boolean	doesModuleContainFailure() 如果当前模块包含任何测试用例或测试运行失败，则返回 true。
default void	enableDefaultMetricCollection() 允许收集器启用默认指标收集。
default IMetricCollector.MetricCollectionLevel	getAlwaysOnCollectionLevel()
abstract List<IBuildInfo>	getBuildInfos() 返回调用中可用的 build 信息列表。
abstract List<ITestDevice>	getDevices() 返回调用中可用的设备列表。
abstract ITestInvocationListener	getInvocationListener() 返回转发结果的原始 ITestInvocationListener。
default IMetricCollector.MetricCollectionLevel	getOnFailureCollectionLevel()
abstract ITestInvocationListener	init(IInvocationContext context, ITestInvocationListener listener) 使用当前上下文初始化收集器，并指定结果的转发位置。
default boolean	isDefaultMetricCollectionEnabled() 收集器是否正在收集指标（作为默认指标收集的一部分）。
abstract void	onTestAssumptionFailure(DeviceMetricData testData, TestDescription test) 当测试用例因假设失败而失败时的回调。
abstract void	onTestEnd(DeviceMetricData testData, Map<String, MetricMeasurement.Metric> currentTestCaseMetrics, TestDescription test) 测试用例结束时的回调。
abstract void	onTestEnd(DeviceMetricData testData, Map<String, MetricMeasurement.Metric> currentTestCaseMetrics) 测试用例结束时的回调。
abstract void	onTestFail(DeviceMetricData testData, TestDescription test) 测试用例失败时的回调。
default void	onTestModuleEnded() 允许捕获模块结束事件。
default void	onTestModuleStarted() 允许捕获模块启动事件。
abstract void	onTestRunEnd(DeviceMetricData runData, Map<String, MetricMeasurement.Metric> currentRunMetrics) 测试运行结束时的回调。
abstract void	onTestRunStart(DeviceMetricData runData) 测试运行开始时的回调。
default void	onTestRunStart(DeviceMetricData runData, int testCount) 测试运行开始时的回调。
default void	onTestRunStartBlocking() 显式回调，用于在收集器支持的情况下手动启动收集器。
abstract void	onTestStart(DeviceMetricData testData) 测试用例开始时的回调。
default void	setAlwaysOnCollectionLevel(IMetricCollector.MetricCollectionLevel level) 设置收集器应收集日志的级别，无论是否发生故障。
default void	setModuleContainsFailure() 设置模块是否出现任何失败（测试用例、测试运行）。
default void	setOnFailureCollectionLevel(IMetricCollector.MetricCollectionLevel level) 设置收集器在发生故障时应收集日志的级别。

公共方法

captureModuleLevel

public boolean captureModuleLevel ()

收集器是否适用于模块级捕获，是否应进行初始化。

返回
boolean

doesModuleContainFailure

public boolean doesModuleContainFailure ()

如果当前模块包含任何测试用例或测试运行失败，则返回 true。

返回
boolean

enableDefaultMetricCollection

public void enableDefaultMetricCollection ()

允许收集器启用默认指标收集。启用默认指标收集功能后，收集器应仅在指定的收集级别进行收集。

getAlwaysOnCollectionLevel

public IMetricCollector.MetricCollectionLevel getAlwaysOnCollectionLevel ()

返回
IMetricCollector.MetricCollectionLevel

getBuildInfos

public abstract List<IBuildInfo> getBuildInfos ()

返回调用中可用的 build 信息列表。

返回
List<IBuildInfo>

getDevices

public abstract List<ITestDevice> getDevices ()

返回调用中可用的设备列表。

返回
List<ITestDevice>

getInvocationListener

public abstract ITestInvocationListener getInvocationListener ()

返回转发结果的原始 ITestInvocationListener。

返回
ITestInvocationListener

getOnFailureCollectionLevel

public IMetricCollector.MetricCollectionLevel getOnFailureCollectionLevel ()

返回
IMetricCollector.MetricCollectionLevel

init

public abstract ITestInvocationListener init (IInvocationContext context, 
                ITestInvocationListener listener)

使用当前上下文初始化收集器，并指定将结果转发到何处。每个实例只会调用一次，并且收集器应更新其内部上下文和监听器。在测试运行期间，系统绝不会调用 Init，而是在测试运行之前调用。

除非您知道自己在做什么，否则请勿替换。

参数
context	IInvocationContext：正在进行的调用的 IInvocationContext。
listener	ITestInvocationListener：用于放置结果的 ITestInvocationListener。

返回
ITestInvocationListener	封装原始监听器的新监听器。

抛出
DeviceNotAvailableException

isDefaultMetricCollectionEnabled

public boolean isDefaultMetricCollectionEnabled ()

收集器是否正在收集指标（作为默认指标收集的一部分）。

返回
boolean

onTestAssumptionFailure

public abstract void onTestAssumptionFailure (DeviceMetricData testData, 
                TestDescription test)

测试用例因假设失败而失败时的回调。

参数
testData	DeviceMetricData：用于保存测试用例数据的 DeviceMetricData。
test	TestDescription：正在进行的测试用例的 TestDescription。

抛出
DeviceNotAvailableException

onTestEnd

public abstract void onTestEnd (DeviceMetricData testData, 
                Map<String, MetricMeasurement.Metric> currentTestCaseMetrics, 
                TestDescription test)

测试用例结束时的回调。此时应执行清理操作。

参数
testData	DeviceMetricData：用于保存测试用例数据的 DeviceMetricData。将与 onTestStart(DeviceMetricData) 期间的对象相同。
currentTestCaseMetrics	Map：传递给 testEnded(TestDescription,Map) 的当前指标映射。
test	TestDescription：正在进行的测试用例的 TestDescription。

抛出
DeviceNotAvailableException

onTestEnd

public abstract void onTestEnd (DeviceMetricData testData, 
                Map<String, MetricMeasurement.Metric> currentTestCaseMetrics)

测试用例结束时的回调。此时应执行清理操作。

参数
testData	DeviceMetricData：用于保存测试用例数据的 DeviceMetricData。将与 onTestStart(DeviceMetricData) 期间的对象相同。
currentTestCaseMetrics	Map：传递给 testEnded(TestDescription,Map) 的当前指标映射。

抛出
DeviceNotAvailableException

onTestFail

public abstract void onTestFail (DeviceMetricData testData, 
                TestDescription test)

测试用例失败时的回调。

参数
testData	DeviceMetricData：用于保存测试用例数据的 DeviceMetricData。
test	TestDescription：正在进行的测试用例的 TestDescription。

抛出
DeviceNotAvailableException

onTestModuleEnded

public void onTestModuleEnded ()

允许捕获模块结束事件。

抛出
	com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

onTestModuleStarted

public void onTestModuleStarted ()

允许捕获模块启动事件。

抛出
	com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

onTestRunEnd

public abstract void onTestRunEnd (DeviceMetricData runData, 
                Map<String, MetricMeasurement.Metric> currentRunMetrics)

测试运行结束时的回调。此时应执行清理操作。

参数
runData	DeviceMetricData：用于保存运行数据的 DeviceMetricData。将与 onTestRunStart(DeviceMetricData) 期间的对象相同。
currentRunMetrics	Map：传递给 testRunEnded(long,Map) 的当前指标映射。

抛出
DeviceNotAvailableException

onTestRunStart

public abstract void onTestRunStart (DeviceMetricData runData)

测试运行开始时的回调。

参数
runData	DeviceMetricData：用于保存运行数据的 DeviceMetricData。

抛出
DeviceNotAvailableException

onTestRunStart

public void onTestRunStart (DeviceMetricData runData, 
                int testCount)

测试运行开始时的回调。

参数
runData	DeviceMetricData：用于保存运行数据的 DeviceMetricData。
testCount	int：相应测试运行中的测试用例数量。

抛出
DeviceNotAvailableException

onTestRunStartBlocking

public void onTestRunStartBlocking ()

显式回调，用于在收集器支持的情况下手动启动收集器。这样可以确保我们不在某些异步测试生命周期中。

抛出
	com.android.tradefed.device.DeviceNotAvailableException
DeviceNotAvailableException

onTestStart

public abstract void onTestStart (DeviceMetricData testData)

测试用例开始时的回调。

参数
testData	DeviceMetricData：用于保存测试用例数据的 DeviceMetricData。

抛出
DeviceNotAvailableException

setAlwaysOnCollectionLevel

public void setAlwaysOnCollectionLevel (IMetricCollector.MetricCollectionLevel level)

设置收集器应收集日志的级别，无论是否发生故障。

如果级别为 NULL，则不会收集任何数据。

参数
level	IMetricCollector.MetricCollectionLevel：将收集日志的MetricCollectionLevel。

setModuleContainsFailure

public void setModuleContainsFailure ()

设置模块是否出现任何失败（测试用例、测试运行）。

setOnFailureCollectionLevel

public void setOnFailureCollectionLevel (IMetricCollector.MetricCollectionLevel level)

设置收集器在发生故障时应收集日志的级别。

如果级别为 NULL，则不会收集任何数据。

参数
level	IMetricCollector.MetricCollectionLevel：将收集日志的MetricCollectionLevel。