IMetricCollector

public interface IMetricCollector
implements IDisableable, ILogSaverListener

com.android.tradefed.device.metric.IMetricCollector

已知的间接子类 AtraceCollector、AtraceCollector、AtraceRunMetricCollector、Atrace 全部 AtraceCollector 用于在测试期间运行 atrace 并收集结果和日志的 IMetricCollector 传递给调用  AtraceRunMetricCollector 从指定目录下的所有测试目录中收集跟踪记录 从测试设备中记录测试目录并后处理跟踪文件 下的测试目录下，然后汇总指标。  BaseDeviceMetricCollector IMetricCollector 的基础实现，支持在以下位置开始和停止收集： onTestRunStart(com.android.tradefed.device.metric.DeviceMetricData)和ERROR(/#onTestRunEnd(com.android.tradefed.device.metric.DeviceMetricData,Map))。  BluetoothConnectionLatencyCollector 收集器会将预定义的 statsd 时长指标配置推送到设备，并收集 每份个人资料的蓝牙连接时长。  BluetoothConnectionStateCollector 此收集器将收集 BluetoothConnectionStateChanged 指标并记录连接状态 每个配置文件对应一个编号  BluetoothHciSnoopLogCollector 收集器用于在 DUT 上启用蓝牙 HCI 信息收集日志记录，并收集每项测试的日志。  BugreportzOnFailureCollector 在测试用例失败时收集 bug 报告。  BugreportzOnTestCaseFailureCollector 当运行中的测试用例失败时收集 bugreportz。  ClangCodeCoverageCollector 一个 BaseDeviceMetricCollector，用于拉取 Clang 测量结果，并将其记录为测试工件。  CountTestCasesCollector 统计并报告给定 IRemoteTest 的测试用例数量。  DebugHostLogOnFailureCollector 收集器，用于在测试用例失败时收集并记录主机端日志。  DeviceTraceCollector 该收集器将在测试运行开始时启动 Perfetto 跟踪记录，并在测试结束时记录跟踪文件。  FilePullerDeviceMetricCollector 一个 BaseDeviceMetricCollector，用于监听来自设备的指标键并拉取 从设备中导入和导出应用  FilePullerLogCollector 设备端报告的文件的记录器。  GcovCodeCoverageCollector 用于拉取 gcov 的 BaseDeviceMetricCollector 测量结果，并将其记录为测试工件。  GcovKernelCodeCoverageCollector 用于拉取 gcov 内核的 BaseDeviceMetricCollector 在 debugfs 和在设备之外进行覆盖率测量，最后将其记录为测试 工件  HostStatsdMetricCollector 一个使用 statsd 实用程序从主机端收集 statsd 指标的 IMetricCollector 命令。  JavaCodeCoverageCollector 用于拉取 Java 的 BaseDeviceMetricCollector 测量结果，并将其记录为测试工件。  LogcatOnFailureCollector 当测试用例失败时，将捕获并记录 logcat 的收集器。  LogcatTimingMetricCollector 一个指标收集器，用于从 logcat 收集时间信息（例如，用户切换时间） 通过使用给定的正则表达式模式来解析 该事件对象。  ModuleLogcatCollector logcat 收集器的版本，但适用于模块。  PerfettoPullerMetricCollector FilePullerDeviceMetricCollector 的基本实现，允许 从设备中提取 Perfetto 文件并从中收集指标。  RebootReasonCollector 收集器，在测试运行期间收集设备重新启动数据，并按原因和计数进行报告。  RuntimeRestartCollector 收集器，用于收集测试期间运行时重启（系统服务器崩溃）的时间戳 若有，则会发生该错误  ScreenshotOnFailureCollector 收集器，用于在测试用例失败时捕获并记录屏幕截图。  ShowmapPullerMetricCollector FilePullerDeviceMetricCollector 的基本实现，允许拉取节目地图 文件，并从设备中收集指标。  TraceCmdCollector 一个 IMetricCollector，用于在测试期间使用 trace-cmd 收集跟踪记录并将其记录到 调用。

---

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

此接口不能用作 ，即使它扩展了 ITestInvocationListener 也是如此。配置检查将拒绝该消息。它必须作为 "metrics_collector"。

收集器不应保留内部状态，因为它们可能会在多个 。如果确实必须使用内部状态，则应通过 init(com.android.tradefed.invoker.IInvocationContext, com.android.tradefed.result.ITestInvocationListener) 对其进行清理。

摘要

公共方法
default boolean	captureModuleLevel() 收集器是否适用于模块级捕获且应为 init。
abstract	getBuildInfos() 返回调用中可用的 build 信息列表。
abstract	getDevices() 返回调用中可用设备的列表。
abstract ITestInvocationListener	getInvocationListener() 返回要转发结果的原始 ITestInvocationListener。
abstract ITestInvocationListener	init(IInvocationContext context, ITestInvocationListener listener) 使用当前上下文和转发结果的位置初始化收集器。
abstract void	onTestAssumptionFailure(DeviceMetricData testData, TestDescription test) 在测试用例失败并假设失败时的回调。
abstract void	onTestEnd(DeviceMetricData testData, currentTestCaseMetrics, TestDescription test) 测试用例结束时进行回调。
abstract void	onTestEnd(DeviceMetricData testData, currentTestCaseMetrics) 测试用例结束时进行回调。
abstract void	onTestFail(DeviceMetricData testData, TestDescription test) 测试用例失败时的回调。
default void	onTestModuleEnded() 允许捕获“模块已结束”事件。
default void	onTestModuleStarted() 允许捕获“模块已启动”事件。
abstract void	onTestRunEnd(DeviceMetricData runData, currentRunMetrics) 测试运行结束时的回调。
abstract void	onTestRunStart(DeviceMetricData runData) 测试运行开始时的回调。
default void	onTestRunStart(DeviceMetricData runData, int testCount) 测试运行开始时的回调。
abstract void	onTestStart(DeviceMetricData testData) 启动测试用例时的回调。

公共方法

获取模块级别

public boolean captureModuleLevel ()

收集器是否适用于模块级捕获且应为 init。

返回
boolean

getBuildInfo

public abstract  getBuildInfos ()

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

返回

getDevices

public abstract  getDevices ()

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

返回

getInvocationListener

public abstract ITestInvocationListener getInvocationListener ()

返回要转发结果的原始 ITestInvocationListener。

返回
ITestInvocationListener

init

public abstract ITestInvocationListener init (IInvocationContext context, 
                ITestInvocationListener listener)

使用当前上下文和转发结果的位置初始化收集器。威尔 每个实例仅调用一次，并且收集器应更新其内部 上下文和监听器。在测试运行期间，系统绝不会在之前调用 Init。

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

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

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

抛出
DeviceNotAvailableException

onTestAssumptionFailure

public abstract void onTestAssumptionFailure (DeviceMetricData testData, 
                TestDescription test)

在测试用例失败并假设失败时的回调。

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

抛出
DeviceNotAvailableException

onTestEnd

public abstract void onTestEnd (DeviceMetricData testData, 
                 currentTestCaseMetrics, 
                TestDescription test)

测试用例结束时进行回调。这时应该进行清理。

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

抛出
DeviceNotAvailableException

onTestEnd

public abstract void onTestEnd (DeviceMetricData testData, 
                 currentTestCaseMetrics)

测试用例结束时进行回调。这时应该进行清理。

参数
testData	DeviceMetricData：用于保存测试用例数据的 DeviceMetricData。将是 与 onTestStart(com.android.tradefed.device.metric.DeviceMetricData) 期间的对象相同。
currentTestCaseMetrics	：传递给 ERROR(/#testEnded(com.android.tradefed.result.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, 
                 currentRunMetrics)

测试运行结束时的回调。这时应该进行清理。

参数
runData	DeviceMetricData：保存运行数据的 DeviceMetricData。将保持不变 该对象与 onTestRunStart(com.android.tradefed.device.metric.DeviceMetricData) 期间相同。
currentRunMetrics	：传递给 ERROR(/#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

onTestStart

public abstract void onTestStart (DeviceMetricData testData)

启动测试用例时的回调。

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

抛出
DeviceNotAvailableException