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.

IResourceMetricCollector

public interface IResourceMetricCollector

com.android.tradefed.monitoring.collector.IResourceMetricCollector

Known indirect subclasses

DeviceBatteryResourceMetricCollector, DeviceInternetAccessibilityResourceMetricCollector, DeviceStorageAgeResourceMetricCollector, DeviceWifiResourceMetricCollector

DeviceBatteryResourceMetricCollector	This collector collects device battery metrics.
DeviceInternetAccessibilityResourceMetricCollector	The collector pings google.com to check if the device has internet accessibility or not.
DeviceStorageAgeResourceMetricCollector	Parse storage age from logcat.
DeviceWifiResourceMetricCollector	The collector collects current connected wifi signal strength and link speed metrics.

The interface for user to implement customized resource collectors.

Summary

Public methods
`default long`	`getDeviceMetricizeTimeoutMs()` Gets the device metricize timeout in ms.
`default`	`getDeviceResourceMetrics(DeviceDescriptor descriptor, IDeviceManager deviceManager)` Collects device resource metrics.
`default long`	`getHostMetricizeTimeoutMs()` Gets the host metricize timeout in ms.
`default`	`getHostResourceMetrics()` Collects host resource metrics.

Public methods

getDeviceMetricizeTimeoutMs

public long getDeviceMetricizeTimeoutMs ()

Gets the device metricize timeout in ms.

Returns
`long`

getDeviceResourceMetrics

public  getDeviceResourceMetrics (DeviceDescriptor descriptor, 
                IDeviceManager deviceManager)

Collects device resource metrics. The function must return in getDeviceMetricizeTimeoutMs() ms, otherwise the result will be dropped by the LabResourceDeviceMonitor. Also, please check Thread.currentThread().isInterrupted() before expensive operation and return immediately.

Parameters
`descriptor`	`DeviceDescriptor`: the `DeviceDescriptor` about the metricizing device.
`deviceManager`	`IDeviceManager`: the `IDeviceManager` instance.

Returns
	a `ERROR(/Collection)` of device `Resource`.

getHostMetricizeTimeoutMs

public long getHostMetricizeTimeoutMs ()

Gets the host metricize timeout in ms.

Returns
`long`

getHostResourceMetrics

public  getHostResourceMetrics ()

Collects host resource metrics. The function must return in getHostMetricizeTimeoutMs() ms, otherwise the result will be dropped by the LabResourceDeviceMonitor. Also, please check Thread.currentThread().isInterrupted() before expensive operation and return immediately.

Returns
	a `ERROR(/Collection)` of host `Resource`.