HealthStats Class

Definition

[Android.Runtime.Register("android/os/health/HealthStats", ApiSince=24, DoNotGenerateAcw=true)]
public class HealthStats : Java.Lang.Object

[<Android.Runtime.Register("android/os/health/HealthStats", ApiSince=24, DoNotGenerateAcw=true)>]
type HealthStats = class
    inherit Object

Inheritance

Object

Object

HealthStats

Attributes

RegisterAttribute

Remarks

A HealthStats object contains system health data about an application.

<b>Data Types</b><br> Each of the keys references data in one of five data types:

A <b>measurement</b> metric contains a single long value. That value may be a count, a time, or some other type of value. The unit for a measurement (COUNT, MS, etc) will always be in the name of the constant for the key to retrieve it. For example, the android.os.health.UidHealthStats#MEASUREMENT_WIFI_TX_MS UidHealthStats.MEASUREMENT_WIFI_TX_MS value is the number of milliseconds (ms) that were spent transmitting on wifi by an application. The android.os.health.UidHealthStats#MEASUREMENT_MOBILE_RX_PACKETS UidHealthStats.MEASUREMENT_MOBILE_RX_PACKETS measurement is the number of packets received on behalf of an application. The android.os.health.UidHealthStats#MEASUREMENT_TOUCH_USER_ACTIVITY_COUNT UidHealthStats.MEASUREMENT_TOUCH_USER_ACTIVITY_COUNT measurement is the number of times the user touched the screen, causing the screen to stay awake.

A <b>timer</b> metric contains an int count and a long time, measured in milliseconds. Timers track how many times a resource was used, and the total duration for that usage. For example, the android.os.health.UidHealthStats#TIMER_FLASHLIGHT timer tracks how many times the application turned on the flashlight, and for how many milliseconds total it kept it on.

A <b>measurement map</b> metric is a mapping of java.lang.String names to java.lang.Long values. The names typically are application provided names. For example, the android.os.health.PackageHealthStats#MEASUREMENTS_WAKEUP_ALARMS_COUNT PackageHealthStats.MEASUREMENTS_WAKEUP_ALARMS_COUNT measurement map is a mapping of the tag provided to the android.app.AlarmManager when the alarm is scheduled.

A <b>timer map</b> metric is a mapping of java.lang.String names to android.os.health.TimerStat objects. The names are typically application provided names. For example, the android.os.health.UidHealthStats#TIMERS_WAKELOCKS_PARTIAL UidHealthStats.TIMERS_WAKELOCKS_PARTIAL is a mapping of tag provided to the android.os.PowerManager when the wakelock is created to the number of times and for how long each wakelock was active.

Lastly, a <b>health stats</b> metric is a mapping of java.lang.String names to a recursive android.os.health.HealthStats object containing more detailed information. For example, the android.os.health.UidHealthStats#STATS_PACKAGES UidHealthStats.STATS_PACKAGES metric is a mapping of the package names for each of the APKs sharing a uid to the information recorded for that apk. The returned HealthStats objects will each be associated with a different set of constants. For the HealthStats returned for UidHealthStats.STATS_PACKAGES, the keys come from the android.os.health.PackageHealthStats class.

The keys that are available are subject to change, depending on what a particular device or software version is capable of recording. Applications must handle the absence of data without crashing.

Java documentation for android.os.health.HealthStats.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Constructors

Properties

Methods

Explicit Interface Implementations

Extension Methods

Applies to