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.

PerfettoPullerMetricCollector

public class PerfettoPullerMetricCollector
extends FilePullerDeviceMetricCollector

java.lang.Object
↳	com.android.tradefed.device.metric.BaseDeviceMetricCollector
	↳	com.android.tradefed.device.metric.FilePullerDeviceMetricCollector
		↳	com.android.tradefed.device.metric.PerfettoPullerMetricCollector

Base implementation of FilePullerDeviceMetricCollector that allows pulling the perfetto files from the device and collect the metrics from it. Also used for converting the raw trace file into perfetto metric file.

Summary

Public constructors
`PerfettoPullerMetricCollector()`

Public methods
`void`	`processMetricDirectory(String key, File metricDirectory, DeviceMetricData runData)` Implementation of the method should allow to log the directory, parse it for metrics to be put in `DeviceMetricData`.
`void`	`processMetricFile(String key, File metricFile, DeviceMetricData data)` Process the perfetto trace file for the additional metrics and add it to final metrics.

Protected methods
`File`	`retrieveFile(ITestDevice device, String remoteFilePath, int userId)` Pull the file from the specified path in the device.

Public constructors

PerfettoPullerMetricCollector

public PerfettoPullerMetricCollector ()

Public methods

processMetricDirectory

public void processMetricDirectory (String key, 
                File metricDirectory, 
                DeviceMetricData runData)

Implementation of the method should allow to log the directory, parse it for metrics to be put in DeviceMetricData.

Parameters
`key`	`String`: the option key associated to the directory that was pulled.
`metricDirectory`	`File`: the `ERROR(/File)` pulled from the device matching the option key.
`runData`	`DeviceMetricData`: the `DeviceMetricData` where metrics can be stored.

processMetricFile

public void processMetricFile (String key, 
                File metricFile, 
                DeviceMetricData data)

Process the perfetto trace file for the additional metrics and add it to final metrics. Decompress the perfetto file for processing if the compression was enabled.

Parameters
`key`	`String`: the option key associated to the file that was pulled from the device.
`metricFile`	`File`: the `ERROR(/File)` pulled from the device matching the option key.
`data`	`DeviceMetricData`: where metrics will be stored.

Protected methods

retrieveFile

protected File retrieveFile (ITestDevice device, 
                String remoteFilePath, 
                int userId)

Pull the file from the specified path in the device. Pull the compressed content of the perfetto file if the compress perfetto option is enabled.

Parameters
`device`	`ITestDevice`: which has the file.
`remoteFilePath`	`String`: location in the device.
`userId`	`int`: the user id to pull from

Returns
`File`	compressed or decompressed version of perfetto file based on mCompressPerfetto option is set or not.

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