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.

LogcatOnFailureCollector

public class LogcatOnFailureCollector
extends BaseDeviceMetricCollector

java.lang.Object
↳	com.android.tradefed.device.metric.BaseDeviceMetricCollector
	↳	com.android.tradefed.device.metric.LogcatOnFailureCollector

Known direct subclasses

ModuleLogcatCollector

ModuleLogcatCollector Version of logcat collector but for module.

Collector that will capture and log a logcat when a test case fails.

Summary

Public constructors
`LogcatOnFailureCollector()`

Public methods
`void`	`onTestFail(DeviceMetricData testData, TestDescription test)` Callback when a test case fails.
`void`	`onTestRunEnd(DeviceMetricData runData, currentRunMetrics)` Callback when a test run is ended.
`void`	`onTestRunFailed(DeviceMetricData testData, FailureDescription failure)` Callback for testRunFailed events
`void`	`onTestRunStart(DeviceMetricData runData)` Callback when a test run is started.
`void`	`onTestStart(DeviceMetricData testData)` Callback when a test case is started.

Protected methods
`void`	`collectAndLog(String testName, int size)`

Public constructors

LogcatOnFailureCollector

public LogcatOnFailureCollector ()

Public methods

onTestFail

public 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`

onTestRunEnd

public 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 `ERROR(/#testRunEnded(long,Map))`.

onTestRunFailed

public void onTestRunFailed (DeviceMetricData testData, 
                FailureDescription failure)

Callback for testRunFailed events

Throws
`DeviceNotAvailableException`

onTestRunStart

public void onTestRunStart (DeviceMetricData runData)

Callback when a test run is started.

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

onTestStart

public void onTestStart (DeviceMetricData testData)

Callback when a test case is started.

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

Protected methods

collectAndLog

protected void collectAndLog (String testName, 
                int size)

Parameters
`testName`	`String`
`size`	`int`

Throws
`DeviceNotAvailableException`