com.facebook.battery.metrics.wakelock

Class WakeLockMetricsCollector

java.lang.Object

com.facebook.battery.metrics.api.SystemMetricsCollector<WakeLockMetrics>

com.facebook.battery.metrics.wakelock.WakeLockMetricsCollector

@ThreadSafe
public class WakeLockMetricsCollector
extends SystemMetricsCollector<WakeLockMetrics>

Records information about currently active wakelocks, including attribution by tag.

Snapshots can be attributed (at the cost of extra memory) or unattributed, in which case the collector will only record total wakelock time instead.

This must be instrumented by hand as well, with - PowerManager#newWakeLock(int, String) -> newWakeLock(PowerManager.WakeLock, int, String) - PowerManager.WakeLock#acquire(), PowerManager.WakeLock#acquire(long) -> acquire(PowerManager.WakeLock, long) - PowerManager.WakeLock#release(), PowerManager.WakeLock#release() -> release(PowerManager.WakeLock, int) - PowerManager.WakeLock#setReferenceCounted(boolean) -> setReferenceCounted(PowerManager.WakeLock, boolean)

Constructor Summary

Constructors

Constructor and Description
WakeLockMetricsCollector()

Method Summary

Modifier and Type	Method and Description
void	acquire(PowerManager.WakeLock wakelock, long timeout)
WakeLockMetrics	createMetrics() Creates an empty instance of the corresponding system metrics.
boolean	getSnapshot(WakeLockMetrics snapshot) Note that access to snapshot instances is not synchronized and must be taken care of by the caller requesting getSnapshot.
void	newWakeLock(PowerManager.WakeLock wakelock, int levelAndFlags, java.lang.String tag)
void	release(PowerManager.WakeLock wakelock, int flags)
void	setReferenceCounted(PowerManager.WakeLock wakelock, boolean value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WakeLockMetricsCollector

public WakeLockMetricsCollector()

Method Detail

newWakeLock

public void newWakeLock(PowerManager.WakeLock wakelock,
                        int levelAndFlags,
                        java.lang.String tag)

acquire

public void acquire(PowerManager.WakeLock wakelock,
                    long timeout)

release

public void release(PowerManager.WakeLock wakelock,
                    int flags)

setReferenceCounted

public void setReferenceCounted(PowerManager.WakeLock wakelock,
                                boolean value)

getSnapshot

public boolean getSnapshot(WakeLockMetrics snapshot)

Description copied from class: SystemMetricsCollector

Note that access to snapshot instances is not synchronized and must be taken care of by the caller requesting getSnapshot.

Specified by:

getSnapshot in class SystemMetricsCollector<WakeLockMetrics>

Parameters:

snapshot - snapshot on which the data will be written

Returns:

true if the snapshot has been updated with valid data.

createMetrics

public WakeLockMetrics createMetrics()

Description copied from class: SystemMetricsCollector

Creates an empty instance of the corresponding system metrics.

Explicitly having this function available reduces a significant amount of boilerplate

Specified by:

createMetrics in class SystemMetricsCollector<WakeLockMetrics>

Returns:

New System Metrics object