Starting March 27, 2025, we recommend using android-latest-release instead of aosp-main to build and contribute to AOSP. For more information, see Changes to AOSP.

IMetricCollector

public interface IMetricCollector
implements ILogSaverListener, IDisableable

com.android.tradefed.device.metric.IMetricCollector

Known indirect subclasses

BaseDeviceMetricCollector, BugreportzOnFailureCollector, ClangCodeCoverageCollector, CountTestCasesCollector, DebugHostLogOnFailureCollector, FilePullerDeviceMetricCollector, FilePullerLogCollector, GcovCodeCoverageCollector, JavaCodeCoverageCollector, LogcatOnFailureCollector, ScreenshotOnFailureCollector

BaseDeviceMetricCollector	Base implementation of `IMetricCollector` that allows to start and stop collection on `onTestRunStart(com.android.tradefed.device.metric.DeviceMetricData)` and `ERROR(/#onTestRunEnd(com.android.tradefed.device.metric.DeviceMetricData,Map))`.
BugreportzOnFailureCollector	Collect a bugreportz when a test case fails.
ClangCodeCoverageCollector	A `BaseDeviceMetricCollector` that will pull Clang coverage measurements off of the device and log them as test artifacts.
CountTestCasesCollector	Count and report the number of test cases for a given `IRemoteTest`.
DebugHostLogOnFailureCollector	Collector that will gather and log the host-side logs when a test case failure occurs.
FilePullerDeviceMetricCollector	A `BaseDeviceMetricCollector` that listen for metrics key coming from the device and pull them as a file from the device.
FilePullerLogCollector	Logger of the file reported by the device-side.
GcovCodeCoverageCollector	A `BaseDeviceMetricCollector` that will pull gcov coverage measurements off of the device and log them as test artifacts.
JavaCodeCoverageCollector	A `BaseDeviceMetricCollector` that will pull Java coverage measurements off of the device and log them as test artifacts.
LogcatOnFailureCollector	Collector that will capture and log a logcat when a test case fails.
ScreenshotOnFailureCollector	Collector that will capture and log a screenshot when a test case fails.

This interface will be added as a decorator when reporting tests results in order to collect matching metrics.

This interface cannot be used as a even it extends ITestInvocationListener. The configuration checking will reject it. It must be used as a "metrics_collector".

Collectors are not expected to keep an internal state as they may be re-used in several places. If an internal state really must be used, then it should be cleaned on init(com.android.tradefed.invoker.IInvocationContext, com.android.tradefed.result.ITestInvocationListener).

Summary

Public methods
`abstract`	`getBuildInfos()` Returns the list of build information available in the invocation.
`abstract`	`getDevices()` Returns the list of devices available in the invocation.
`abstract ITestInvocationListener`	`getInvocationListener()` Returns the original `ITestInvocationListener` where we are forwarding the results.
`abstract ITestInvocationListener`	`init(IInvocationContext context, ITestInvocationListener listener)` Initialization of the collector with the current context and where to forward results.
`abstract void`	`onTestAssumptionFailure(DeviceMetricData testData, TestDescription test)` Callback when a test case fails with assumption failure.
`abstract void`	`onTestEnd(DeviceMetricData testData, currentTestCaseMetrics)` Callback when a test case is ended.
`abstract void`	`onTestEnd(DeviceMetricData testData, currentTestCaseMetrics, TestDescription test)` Callback when a test case is ended.
`abstract void`	`onTestFail(DeviceMetricData testData, TestDescription test)` Callback when a test case fails.
`abstract void`	`onTestRunEnd(DeviceMetricData runData, currentRunMetrics)` Callback when a test run is ended.
`abstract void`	`onTestRunStart(DeviceMetricData runData)` Callback when a test run is started.
`abstract void`	`onTestStart(DeviceMetricData testData)` Callback when a test case is started.

Public methods

getBuildInfos

public abstract  getBuildInfos ()

Returns the list of build information available in the invocation.

Returns

getDevices

public abstract  getDevices ()

Returns the list of devices available in the invocation.

Returns

getInvocationListener

public abstract ITestInvocationListener getInvocationListener ()

Returns the original ITestInvocationListener where we are forwarding the results.

Returns
`ITestInvocationListener`

init

public abstract ITestInvocationListener init (IInvocationContext context, 
                ITestInvocationListener listener)

Initialization of the collector with the current context and where to forward results. Will only be called once per instance, and the collector is expected to update its internal context and listener. Init will never be called during a test run always before.

Do not override unless you know what you are doing.

Parameters
`context`	`IInvocationContext`: the `IInvocationContext` for the invocation in progress.
`listener`	`ITestInvocationListener`: the `ITestInvocationListener` where to put results.

Returns
`ITestInvocationListener`	the new listener wrapping the original one.

onTestAssumptionFailure

public abstract void onTestAssumptionFailure (DeviceMetricData testData, 
                TestDescription test)

Callback when a test case fails with assumption failure.

Parameters
`testData`	`DeviceMetricData`: the `DeviceMetricData` holding the data for the test case.
`test`	`TestDescription`: the `TestDescription` of the test case in progress.

onTestEnd

public abstract void onTestEnd (DeviceMetricData testData, 
                 currentTestCaseMetrics)

Callback when a test case is ended. This should be the time for clean up.

Parameters
`testData`	`DeviceMetricData`: the `DeviceMetricData` holding the data for the test case. Will be the same object as during `onTestStart(com.android.tradefed.device.metric.DeviceMetricData)`.
`currentTestCaseMetrics`	: the current map of metrics passed to `ITestLifeCycleReceiver.testEnded(com.android.tradefed.result.TestDescription, Map)`.

onTestEnd

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

Callback when a test case is ended. This should be the time for clean up.

Parameters
`testData`	`DeviceMetricData`: the `DeviceMetricData` holding the data for the test case. Will be the same object as during `onTestStart(com.android.tradefed.device.metric.DeviceMetricData)`.
`currentTestCaseMetrics`	: the current map of metrics passed to `ITestLifeCycleReceiver.testEnded(com.android.tradefed.result.TestDescription, Map)`.
`test`	`TestDescription`: the `TestDescription` of the test case in progress.

onTestFail

public abstract void onTestFail (DeviceMetricData testData, 
                TestDescription test)

Callback when a test case fails.

Parameters
`testData`	`DeviceMetricData`: the `DeviceMetricData` holding the data for the test case.
`test`	`TestDescription`: the `TestDescription` of the test case in progress.

onTestRunEnd

public abstract void onTestRunEnd (DeviceMetricData runData, 
                 currentRunMetrics)

Callback when a test run is ended. This should be the time for clean up.

Parameters
`runData`	`DeviceMetricData`: the `DeviceMetricData` holding the data for the run. Will be the same object as during `onTestRunStart(com.android.tradefed.device.metric.DeviceMetricData)`.
`currentRunMetrics`	: the current map of metrics passed to `ITestLifeCycleReceiver.testRunEnded(long, Map)`.

onTestRunStart

public abstract void onTestRunStart (DeviceMetricData runData)

Callback when a test run is started.

Parameters
`runData`	`DeviceMetricData`: the `DeviceMetricData` holding the data for the run.

onTestStart

public abstract void onTestStart (DeviceMetricData testData)

Callback when a test case is started.

Parameters
`testData`	`DeviceMetricData`: the `DeviceMetricData` holding the data for the test case.