Added in API level 28
Summary: Methods | Inherited Methods

StatsLog

public final class StatsLog
extends Object


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.

Inherited methods

Public methods

logBinaryPushStateChanged

Added in API level 29 
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 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 
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.