Effective in 2026, to align with our trunk stable development model and ensure platform stability for the ecosystem, we will publish source code to AOSP in Q2 and Q4. For building and contributing to AOSP, use android-latest-release. The android-latest-release manifest branch will always reference the most recent release pushed to AOSP. For more information, see Changes to AOSP.

IMetricCollector

public interface IMetricCollector
implements IDisableable, ILogSaverListener

com.android.tradefed.device.metric.IMetricCollector

Known indirect subclasses

AtraceCollector, AtraceRunMetricCollector, BaseDeviceMetricCollector, BluetoothConnectionLatencyCollector, BluetoothConnectionStateCollector, BluetoothHciSnoopLogCollector, BugreportzOnFailureCollector, BugreportzOnTestCaseFailureCollector, ClangCodeCoverageCollector, CodeCoverageCollector, CountTestCasesCollector, DebugHostLogOnFailureCollector, DeviceTraceCollector, FilePullerDeviceMetricCollector, FilePullerLogCollector, and 16 others.

AtraceCollector	A `IMetricCollector` that runs atrace during a test and collects the result and log them to the invocation.
AtraceRunMetricCollector	Collects the traces from all the test directory under the given directory from the test device, log the test directory and post process the trace files under the test directory and aggregate the metrics.
BaseDeviceMetricCollector	Base implementation of `IMetricCollector` that allows to start and stop collection on `onTestRunStart(DeviceMetricData)` and `onTestRunEnd(DeviceMetricData,Map)`.
BluetoothConnectionLatencyCollector	The collector will push a pre-defined statsd duration metric config to devices and collect Bluetooth connection duration for each profile.
BluetoothConnectionStateCollector	This collector will collect BluetoothConnectionStateChanged metrics and record connection state number for each profile.
BluetoothHciSnoopLogCollector	Collector to enable Bluetooth HCI snoop logging on the DUT and to collect the log for each test.
BugreportzOnFailureCollector	Collect a bugreportz when a test case fails.
BugreportzOnTestCaseFailureCollector	Collect a bugreportz when a test case in a run fails.
ClangCodeCoverageCollector	A `BaseDeviceMetricCollector` that will pull Clang coverage measurements off of the device and log them as test artifacts.
CodeCoverageCollector	A `BaseDeviceMetricCollector` that will pull Java and native 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.
DeviceTraceCollector	Collector that will start perfetto trace when a test run starts and log trace file at the end.
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.
GcovKernelCodeCoverageCollector	A `BaseDeviceMetricCollector` that will pull gcov kernel coverage measurements out of debugfs and off of the device and then finally logs them as test artifacts.
HostStatsdMetricCollector	A `IMetricCollector` that collects statsd metrics from host side using statsd utility commands.
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 or test run fails.
LogcatTimingMetricCollector	A metric collector that collects timing information (e.g. user switch time) from logcat during one or multiple repeated tests by using given regex patterns to parse start and end signals of an event from logcat lines.
ModuleLogcatCollector	Version of logcat collector but for module.
ModulePerfettoCollector	Collector that will start perfetto trace when a test module start and end and device reboots.
PerfettoFilePullerCollector	A collector which pulls perfetto trace files from the device, optionally compresses them, and adds them to the test logs.
PerfettoPullerMetricCollector	This class is deprecated. Use `PerfettoFilePullerCollector` and `ERROR(/PerfettoTracePostProcessor)` instead.
RebootReasonCollector	Collector that collects device reboot during the test run and report them by reason and counts.
RuntimeRestartCollector	Collector that collects timestamps of runtime restarts (system server crashes) during the test run, if any.
ScreenRecordOnFailureCollector	Collector that will capture and log a screen recording when a test case fails.
ScreenshotOnFailureCollector	Collector that will capture and log a screenshot when a test case fails.
ShowmapPullerMetricCollector	Base implementation of `FilePullerDeviceMetricCollector` that allows pulling the showmap files from the device and collect the metrics from it.
TraceCmdCollector	A `IMetricCollector` that collects traces during the test using trace-cmd, and logs them to the invocation.

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(IInvocationContext,ITestInvocationListener).

Summary

Public methods
`default boolean`	`captureModuleLevel()` Whether or not the collector is applicable to module level capture and should be init.
`default boolean`	`doesModuleContainFailure()` Returns true if current module contained any test case or test run failures.
`default void`	`enableDefaultMetricCollection()` Allows collectors to enable default metrics collection.
`default IMetricCollector.MetricCollectionLevel`	`getAlwaysOnCollectionLevel()`
`abstract List<IBuildInfo>`	`getBuildInfos()` Returns the list of build information available in the invocation.
`abstract List<ITestDevice>`	`getDevices()` Returns the list of devices available in the invocation.
`abstract ITestInvocationListener`	`getInvocationListener()` Returns the original `ITestInvocationListener` where we are forwarding the results.
`default IMetricCollector.MetricCollectionLevel`	`getOnFailureCollectionLevel()`
`abstract ITestInvocationListener`	`init(IInvocationContext context, ITestInvocationListener listener)` Initialization of the collector with the current context and where to forward results.
`default boolean`	`isDefaultMetricCollectionEnabled()` Whether the collector is collecting metrics as part of default metric collection.
`abstract void`	`onTestAssumptionFailure(DeviceMetricData testData, TestDescription test)` Callback when a test case fails with assumption failure.
`abstract void`	`onTestEnd(DeviceMetricData testData, Map<String, MetricMeasurement.Metric> currentTestCaseMetrics, TestDescription test)` Callback when a test case is ended.
`abstract void`	`onTestEnd(DeviceMetricData testData, Map<String, MetricMeasurement.Metric> currentTestCaseMetrics)` Callback when a test case is ended.
`abstract void`	`onTestFail(DeviceMetricData testData, TestDescription test)` Callback when a test case fails.
`default void`	`onTestModuleEnded()` Allows capturing the module ended event.
`default void`	`onTestModuleStarted()` Allows capturing the module started event.
`abstract void`	`onTestRunEnd(DeviceMetricData runData, Map<String, MetricMeasurement.Metric> currentRunMetrics)` Callback when a test run is ended.
`abstract void`	`onTestRunStart(DeviceMetricData runData)` Callback when a test run is started.
`default void`	`onTestRunStart(DeviceMetricData runData, int testCount)` Callback when a test run is started.
`default void`	`onTestRunStartBlocking()` Explicit callback to start a collector manually if it supports it.
`abstract void`	`onTestStart(DeviceMetricData testData)` Callback when a test case is started.
`default void`	`setAlwaysOnCollectionLevel(IMetricCollector.MetricCollectionLevel level)` Sets the level at which the collector should collect logs regardless of failures.
`default void`	`setModuleContainsFailure()` Sets whether the module had any failures (test case, test run).
`default void`	`setOnFailureCollectionLevel(IMetricCollector.MetricCollectionLevel level)` Sets the level at which the collector should collect logs during failures.

Public methods

captureModuleLevel

public boolean captureModuleLevel ()

Whether or not the collector is applicable to module level capture and should be init.

Returns
`boolean`

doesModuleContainFailure

public boolean doesModuleContainFailure ()

Returns true if current module contained any test case or test run failures.

Returns
`boolean`

enableDefaultMetricCollection

public void enableDefaultMetricCollection ()

Allows collectors to enable default metrics collection. When default metric collection is enabled, the collector should only collect at the specified collection level.

getAlwaysOnCollectionLevel

public IMetricCollector.MetricCollectionLevel getAlwaysOnCollectionLevel ()

Returns
`IMetricCollector.MetricCollectionLevel`

getBuildInfos

public abstract List<IBuildInfo> getBuildInfos ()

Returns the list of build information available in the invocation.

Returns
`List<IBuildInfo>`

getDevices

public abstract List<ITestDevice> getDevices ()

Returns the list of devices available in the invocation.

Returns
`List<ITestDevice>`

getInvocationListener

public abstract ITestInvocationListener getInvocationListener ()

Returns the original ITestInvocationListener where we are forwarding the results.

Returns
`ITestInvocationListener`

getOnFailureCollectionLevel

public IMetricCollector.MetricCollectionLevel getOnFailureCollectionLevel ()

Returns
`IMetricCollector.MetricCollectionLevel`

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.

Throws
`DeviceNotAvailableException`

isDefaultMetricCollectionEnabled

public boolean isDefaultMetricCollectionEnabled ()

Whether the collector is collecting metrics as part of default metric collection.

Returns
`boolean`

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.

Throws
`DeviceNotAvailableException`

onTestEnd

public abstract void onTestEnd (DeviceMetricData testData, 
                Map<String, MetricMeasurement.Metric> 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(DeviceMetricData)`.
`currentTestCaseMetrics`	`Map`: the current map of metrics passed to `testEnded(TestDescription,Map)`.
`test`	`TestDescription`: the `TestDescription` of the test case in progress.

Throws
`DeviceNotAvailableException`

onTestEnd

public abstract void onTestEnd (DeviceMetricData testData, 
                Map<String, MetricMeasurement.Metric> 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(DeviceMetricData)`.
`currentTestCaseMetrics`	`Map`: the current map of metrics passed to `testEnded(TestDescription,Map)`.

Throws
`DeviceNotAvailableException`

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.

Throws
`DeviceNotAvailableException`

onTestModuleEnded

public void onTestModuleEnded ()

Allows capturing the module ended event.

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

onTestModuleStarted

public void onTestModuleStarted ()

Allows capturing the module started event.

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

onTestRunEnd

public abstract void onTestRunEnd (DeviceMetricData runData, 
                Map<String, MetricMeasurement.Metric> 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(DeviceMetricData)`.
`currentRunMetrics`	`Map`: the current map of metrics passed to `testRunEnded(long,Map)`.

Throws
`DeviceNotAvailableException`

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.

Throws
`DeviceNotAvailableException`

onTestRunStart

public void onTestRunStart (DeviceMetricData runData, 
                int testCount)

Callback when a test run is started.

Parameters
`runData`	`DeviceMetricData`: the `DeviceMetricData` holding the data for the run.
`testCount`	`int`: the number of test cases in this test run.

Throws
`DeviceNotAvailableException`

onTestRunStartBlocking

public void onTestRunStartBlocking ()

Explicit callback to start a collector manually if it supports it. This allows to ensure we are out of some test lifecycle which are asynchronous.

Throws
	com.android.tradefed.device.DeviceNotAvailableException
`DeviceNotAvailableException`

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.

Throws
`DeviceNotAvailableException`

setAlwaysOnCollectionLevel

public void setAlwaysOnCollectionLevel (IMetricCollector.MetricCollectionLevel level)

Sets the level at which the collector should collect logs regardless of failures.

NULL level will result in no collection.

Parameters
`level`	`IMetricCollector.MetricCollectionLevel`: `MetricCollectionLevel` at which the logs will be collected.

setModuleContainsFailure

public void setModuleContainsFailure ()

Sets whether the module had any failures (test case, test run).

setOnFailureCollectionLevel

public void setOnFailureCollectionLevel (IMetricCollector.MetricCollectionLevel level)

Sets the level at which the collector should collect logs during failures.

NULL level will result in no collection.

Parameters
`level`	`IMetricCollector.MetricCollectionLevel`: `MetricCollectionLevel` at which the logs will be collected.