Added in API level 28

StatsLog


class StatsLog
kotlin.Any
   ↳ 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(trainName: String, trainVersionCode: Long, options: Int, state: Int, experimentIds: LongArray)

Logs an event for binary push for module updates.

static Boolean
logEvent(label: Int)

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

static Boolean
logStart(label: Int)

Logs a start event.

static Boolean
logStop(label: Int)

Logs a stop event.

Public methods

logBinaryPushStateChanged

Added in API level 29
static fun logBinaryPushStateChanged(
    trainName: String,
    trainVersionCode: Long,
    options: Int,
    state: Int,
    experimentIds: LongArray
): Boolean

Logs an event for binary push for module updates.
Requires android.Manifest.permission#DUMP and 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 LongArray: experiment ids. This value cannot be null.
Return
Boolean True if the log request was sent to statsd.

logEvent

Added in API level 28
static fun logEvent(label: Int): Boolean

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

Parameters
label Int: developer-chosen label.
Return
Boolean True if the log request was sent to statsd.

logStart

Added in API level 28
static fun logStart(label: Int): Boolean

Logs a start event.

Parameters
label Int: developer-chosen label.
Return
Boolean True if the log request was sent to statsd.

logStop

Added in API level 28
static fun logStop(label: Int): Boolean

Logs a stop event.

Parameters
label Int: developer-chosen label.
Return
Boolean True if the log request was sent to statsd.