Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Methods](https://developer.android.com/reference/android/util/StatsLog#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/util/StatsLog#inhmethods)
# StatsLog
*** ** * ** ***
`
public
final
class
StatsLog
`
`
extends https://developer.android.com/reference/java/lang/Object
`
`
`
|---|---|
| [java.lang.Object](https://developer.android.com/reference/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` | ` https://developer.android.com/reference/android/util/StatsLog#logBinaryPushStateChanged(java.lang.String,%20long,%20int,%20int,%20long[])(https://developer.android.com/reference/java/lang/String trainName, long trainVersionCode, int options, int state, long[] experimentIds) ` Logs an event for binary push for module updates. |
| ` static boolean` | ` https://developer.android.com/reference/android/util/StatsLog#logEvent(int)(int label) ` Logs an event that does not represent a start or stop boundary. |
| ` static boolean` | ` https://developer.android.com/reference/android/util/StatsLog#logStart(int)(int label) ` Logs a start event. |
| ` static boolean` | ` https://developer.android.com/reference/android/util/StatsLog#logStop(int)(int label) ` Logs a stop event. |
| ### Inherited methods |
|---|---|
| From class ` https://developer.android.com/reference/java/lang/Object ` |---|---| | ` https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/java/lang/Object#clone()() ` Creates and returns a copy of this object. | | ` boolean` | ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` https://developer.android.com/reference/java/lang/Object#finalize()() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final https://developer.android.com/reference/java/lang/Class` | ` https://developer.android.com/reference/java/lang/Object#getClass()() ` Returns the runtime class of this `Object`. | | ` int` | ` https://developer.android.com/reference/java/lang/Object#hashCode()() ` Returns a hash code value for the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notify()() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notifyAll()() ` Wakes up all threads that are waiting on this object's monitor. | | ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/Object#toString()() ` Returns a string representation of the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait()() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||
## Public methods
### logBinaryPushStateChanged
Added in [API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static boolean logBinaryPushStateChanged (String trainName,
long trainVersionCode,
int options,
int state,
long[] experimentIds)
```
Logs an event for binary push for module updates.
Requires `https://developer.android.com/reference/android/Manifest.permission#DUMP` and `https://developer.android.com/reference/android/Manifest.permission#PACKAGE_USAGE_STATS`
| Parameters ||
|---|---|
| `trainName` | `String`: name of install train. This value cannot be `null`.
|
| `trainVersionCode` | `long`: version code of the train.
|
| `options` | `int`: optional flags about this install. The last 3 bits indicate options: 0x01: FLAG_REQUIRE_STAGING 0x02: FLAG_ROLLBACK_ENABLED 0x04: FLAG_REQUIRE_LOW_LATENCY_MONITOR
|
| `state` | `int`: current install state. Defined as State enums in BinaryPushStateChanged atom in frameworks/proto_logging/stats/atoms.proto
|
| `experimentIds` | `long`: experiment ids. This value cannot be `null`.
|
| Returns ||
|---|---|
| `boolean` | True if the log request was sent to statsd.
|
### logEvent
Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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.
|