StatsLog

public final class StatsLog
extends Object

java.lang.Object
↳	android.util.StatsLog

StatsLog provides an API for developers to send events to statsd. The events can be used to define custom metrics inside statsd.

Summary

Public methods
`static boolean`	`logBinaryPushStateChanged(String trainName, long trainVersionCode, int options, int state, long[] experimentIds)` Logs an event for binary push for module updates.
`static boolean`	`logEvent(int label)` Logs an event that does not represent a start or stop boundary.
`static boolean`	`logStart(int label)` Logs a start event.
`static boolean`	`logStop(int label)` Logs a stop event.
`static void`	`write(int id, Object... params)` Add a log to the stats log.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

Public methods

logBinaryPushStateChanged

Added in Android Q

public static boolean logBinaryPushStateChanged (String trainName, 
                long trainVersionCode, 
                int options, 
                int state, 
                long[] experimentIds)

Logs an event for binary push for module updates.
Requires Manifest.permission.DUMP and Manifest.permission.PACKAGE_USAGE_STATS

Parameters
`trainName`	`String`: name of install train. This value must never be `null`.
`trainVersionCode`	`long`: version code of the train.
`options`	`int`: optional flags about this install.
`state`	`int`: current install state.
`experimentIds`	`long`: experiment ids. This value must never be `null`.

Returns
`boolean`	True if the log request was sent to statsd.

logEvent

Added in API level 28

public static boolean logEvent (int label)

Logs an event that does not represent a start or stop boundary.

Parameters
`label`	`int`: developer-chosen label.

Returns
`boolean`	True if the log request was sent to statsd.

logStart

Added in API level 28

public static boolean logStart (int label)

Logs a start event.

Parameters
`label`	`int`: developer-chosen label.

Returns
`boolean`	True if the log request was sent to statsd.

logStop

Added in API level 28

public static boolean logStop (int label)

Logs a stop event.

Parameters
`label`	`int`: developer-chosen label.

Returns
`boolean`	True if the log request was sent to statsd.

write

Added in Android Q

public static void write (int id, 
                Object... params)

Add a log to the stats log.

Parameters
`id`	`int`: The id of the atom
`params`	`Object`: The parameters of the atom's message. This value must never be `null`.