blob: 85725172e22afab7fea9976ce9e316c66b5a210c [file] [log] [blame]
Stefan Lafoncdb1a0e2017-09-27 20:24:15 -07001/*
2 * Copyright (C) 2017 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17syntax = "proto2";
Stefan Lafoncdb1a0e2017-09-27 20:24:15 -070018
19package android.os.statsd;
Stefan Lafoncdb1a0e2017-09-27 20:24:15 -070020option java_package = "com.android.os";
Stefan Lafonae2df012017-11-14 09:17:21 -080021option java_outer_classname = "AtomsProto";
Stefan Lafoncdb1a0e2017-09-27 20:24:15 -070022
Yao Chen9c1debe2018-02-19 14:39:19 -080023import "frameworks/base/cmds/statsd/src/atom_field_options.proto";
Bookatzdb026a22018-01-10 19:01:56 -080024import "frameworks/base/core/proto/android/app/enums.proto";
Fan Zhangf837b8e2018-10-23 12:38:30 -070025import "frameworks/base/core/proto/android/app/settings_enums.proto";
Tej Singh33a412b2018-03-16 18:43:59 -070026import "frameworks/base/core/proto/android/app/job/enums.proto";
Tej Singh5d991e12018-03-09 19:48:11 -080027import "frameworks/base/core/proto/android/bluetooth/enums.proto";
Bookatz1a1b0462018-01-12 11:47:03 -080028import "frameworks/base/core/proto/android/os/enums.proto";
Bookatz8bdae8d2018-01-16 11:24:30 -080029import "frameworks/base/core/proto/android/server/enums.proto";
Bookatz48d362e2018-11-06 15:49:08 -080030import "frameworks/base/core/proto/android/server/location/enums.proto";
Yangsteraf9aee72018-10-12 09:26:16 -070031import "frameworks/base/core/proto/android/service/procstats_enum.proto";
32import "frameworks/base/core/proto/android/stats/enums.proto";
Yao Chen8c433862018-10-24 14:09:20 -070033import "frameworks/base/core/proto/android/stats/launcher/launcher.proto";
Tej Singhc477d9c2018-02-05 18:31:39 -080034import "frameworks/base/core/proto/android/telecomm/enums.proto";
Bookatz1a1b0462018-01-12 11:47:03 -080035import "frameworks/base/core/proto/android/telephony/enums.proto";
36import "frameworks/base/core/proto/android/view/enums.proto";
Joe Onorato62c220b2017-11-18 20:32:56 -080037
Yao Chend54f9dd2017-10-17 17:37:48 +000038/**
Stefan Lafonae2df012017-11-14 09:17:21 -080039 * The master atom class. This message defines all of the available
Yao Chend54f9dd2017-10-17 17:37:48 +000040 * raw stats log events from the Android system, also known as "atoms."
41 *
42 * This field contains a single oneof with all of the available messages.
43 * The stats-log-api-gen tool runs as part of the Android build and
44 * generates the android.util.StatsLog class, which contains the constants
45 * and methods that Android uses to log.
46 *
Stefan Lafonae2df012017-11-14 09:17:21 -080047 * This Atom class is not actually built into the Android system.
Yao Chend54f9dd2017-10-17 17:37:48 +000048 * Instead, statsd on Android constructs these messages synthetically,
49 * in the format defined here and in stats_log.proto.
50 */
Stefan Lafonae2df012017-11-14 09:17:21 -080051message Atom {
52 // Pushed atoms start at 2.
David Chenc8a43242017-10-17 16:23:28 -070053 oneof pushed {
Bookatzc1a050a2017-10-10 15:49:28 -070054 // For StatsLog reasons, 1 is illegal and will not work. Must start at 2.
55 BleScanStateChanged ble_scan_state_changed = 2;
Chenjie Yubd1a28f2018-07-17 14:55:19 -070056 ProcessStateChanged process_state_changed = 3;
Bookatzc1a050a2017-10-10 15:49:28 -070057 BleScanResultReceived ble_scan_result_received = 4;
58 SensorStateChanged sensor_state_changed = 5;
Bookatzdb026a22018-01-10 19:01:56 -080059 GpsScanStateChanged gps_scan_state_changed = 6;
Bookatzc1a050a2017-10-10 15:49:28 -070060 SyncStateChanged sync_state_changed = 7;
61 ScheduledJobStateChanged scheduled_job_state_changed = 8;
62 ScreenBrightnessChanged screen_brightness_changed = 9;
Bookatzd6746242017-10-24 18:39:35 -070063 WakelockStateChanged wakelock_state_changed = 10;
Bookatzddccf0a2017-11-28 16:48:14 -080064 LongPartialWakelockStateChanged long_partial_wakelock_state_changed = 11;
65 MobileRadioPowerStateChanged mobile_radio_power_state_changed = 12;
66 WifiRadioPowerStateChanged wifi_radio_power_state_changed = 13;
Chenjie Yubd1a28f2018-07-17 14:55:19 -070067 ActivityManagerSleepStateChanged activity_manager_sleep_state_changed = 14;
68 MemoryFactorStateChanged memory_factor_state_changed = 15;
69 ExcessiveCpuUsageReported excessive_cpu_usage_reported = 16;
70 CachedKillReported cached_kill_reported = 17;
71 ProcessMemoryStatReported process_memory_stat_reported = 18;
Hyunyoung Songc6d6b772018-10-17 13:35:32 -070072 LauncherUIChanged launcher_event = 19;
Bookatzddccf0a2017-11-28 16:48:14 -080073 BatterySaverModeStateChanged battery_saver_mode_state_changed = 20;
74 DeviceIdleModeStateChanged device_idle_mode_state_changed = 21;
75 DeviceIdlingModeStateChanged device_idling_mode_state_changed = 22;
Bookatzc1a050a2017-10-10 15:49:28 -070076 AudioStateChanged audio_state_changed = 23;
Chenjie Yu5caaa9d2018-03-06 15:48:54 -080077 MediaCodecStateChanged media_codec_state_changed = 24;
Bookatzc1a050a2017-10-10 15:49:28 -070078 CameraStateChanged camera_state_changed = 25;
79 FlashlightStateChanged flashlight_state_changed = 26;
80 UidProcessStateChanged uid_process_state_changed = 27;
81 ProcessLifeCycleStateChanged process_life_cycle_state_changed = 28;
82 ScreenStateChanged screen_state_changed = 29;
Bookatz8c6571b2017-10-24 15:04:41 -070083 BatteryLevelChanged battery_level_changed = 30;
84 ChargingStateChanged charging_state_changed = 31;
85 PluggedStateChanged plugged_state_changed = 32;
Bookatza66083f2018-09-20 17:24:00 -070086 InteractiveStateChanged interactive_state_changed = 33;
87 // 34 is available
Bookatz8c6571b2017-10-24 15:04:41 -070088 WakeupAlarmOccurred wakeup_alarm_occurred = 35;
89 KernelWakeupReported kernel_wakeup_reported = 36;
Bookatze5885242017-10-24 20:10:31 -070090 WifiLockStateChanged wifi_lock_state_changed = 37;
91 WifiSignalStrengthChanged wifi_signal_strength_changed = 38;
92 WifiScanStateChanged wifi_scan_state_changed = 39;
93 PhoneSignalStrengthChanged phone_signal_strength_changed = 40;
David Chenc28b2bb2017-10-24 12:52:52 -070094 SettingChanged setting_changed = 41;
David Chenc8a43242017-10-17 16:23:28 -070095 ActivityForegroundStateChanged activity_foreground_state_changed = 42;
David Chen21582962017-11-01 17:32:46 -070096 IsolatedUidChanged isolated_uid_changed = 43;
Hugo Benichi884970e2017-11-14 22:42:46 +090097 PacketWakeupOccurred packet_wakeup_occurred = 44;
Bookatz7948c872018-09-04 12:58:33 -070098 WallClockTimeShifted wall_clock_time_shifted = 45;
Bookatz8fcd09a2017-12-18 13:01:10 -080099 AnomalyDetected anomaly_detected = 46;
David Chen0b5c90c2018-01-25 16:51:49 -0800100 AppBreadcrumbReported app_breadcrumb_reported = 47;
Chenjie Yu5caaa9d2018-03-06 15:48:54 -0800101 AppStartOccurred app_start_occurred = 48;
102 AppStartCanceled app_start_canceled = 49;
103 AppStartFullyDrawn app_start_fully_drawn = 50;
Rajeev Kumar8a9fa052018-01-25 19:03:09 -0800104 LmkKillOccurred lmk_kill_occurred = 51;
Chenjie Yu52cacc62017-12-08 18:11:45 -0800105 PictureInPictureStateChanged picture_in_picture_state_changed = 52;
Tej Singh4503e102018-01-04 14:35:01 -0800106 WifiMulticastLockStateChanged wifi_multicast_lock_state_changed = 53;
Rajeev Kumar8a9fa052018-01-25 19:03:09 -0800107 LmkStateChanged lmk_state_changed = 54;
108 AppStartMemoryStateCaptured app_start_memory_state_captured = 55;
Tej Singh1ea42892018-01-19 09:27:00 -0800109 ShutdownSequenceReported shutdown_sequence_reported = 56;
Tej Singh6483ea42018-01-25 17:45:49 -0800110 BootSequenceReported boot_sequence_reported = 57;
Tej Singhbb8554a2018-01-26 11:59:14 -0800111 DaveyOccurred davey_occurred = 58;
Chenjie Yue8904192017-12-08 19:12:57 -0800112 OverlayStateChanged overlay_state_changed = 59;
Chenjie Yuccfe6452018-01-30 11:33:21 -0800113 ForegroundServiceStateChanged foreground_service_state_changed = 60;
Tej Singhc477d9c2018-02-05 18:31:39 -0800114 CallStateChanged call_state_changed = 61;
Tej Singhdd7bd352018-02-09 19:33:15 -0800115 KeyguardStateChanged keyguard_state_changed = 62;
116 KeyguardBouncerStateChanged keyguard_bouncer_state_changed = 63;
117 KeyguardBouncerPasswordEntered keyguard_bouncer_password_entered = 64;
Chenjie Yu5caaa9d2018-03-06 15:48:54 -0800118 AppDied app_died = 65;
Tej Singha883b372018-02-15 11:30:01 -0800119 ResourceConfigurationChanged resource_configuration_changed = 66;
Tej Singh5d991e12018-03-09 19:48:11 -0800120 BluetoothEnabledStateChanged bluetooth_enabled_state_changed = 67;
121 BluetoothConnectionStateChanged bluetooth_connection_state_changed = 68;
Bookatz48d362e2018-11-06 15:49:08 -0800122 GpsSignalQualityChanged gps_signal_quality_changed = 69;
Andrew Chantb56388b2018-03-22 21:07:33 -0700123 UsbConnectorStateChanged usb_connector_state_changed = 70;
Andrew Chant28d627e2018-02-22 15:17:05 -0800124 SpeakerImpedanceReported speaker_impedance_reported = 71;
125 HardwareFailed hardware_failed = 72;
126 PhysicalDropDetected physical_drop_detected = 73;
127 ChargeCyclesReported charge_cycles_reported = 74;
Tej Singheee317b2018-03-07 19:28:05 -0800128 MobileConnectionStateChanged mobile_connection_state_changed = 75;
129 MobileRadioTechnologyChanged mobile_radio_technology_changed = 76;
Andrew Chantb56388b2018-03-22 21:07:33 -0700130 UsbDeviceAttached usb_device_attached = 77;
Chenjie Yu5caaa9d2018-03-06 15:48:54 -0800131 AppCrashOccurred app_crash_occurred = 78;
132 ANROccurred anr_occurred = 79;
133 WTFOccurred wtf_occurred = 80;
134 LowMemReported low_mem_reported = 81;
Howard Rocb767f62018-06-19 19:58:05 -0700135 GenericAtom generic_atom = 82;
Yangster-mac48b3d622018-08-18 12:38:11 -0700136 KeyValuePairsAtom key_value_pairs_atom = 83;
Bookatza7020bd2018-08-28 16:29:35 -0700137 VibratorStateChanged vibrator_state_changed = 84;
Yangster-mac96353002018-09-05 11:18:55 -0700138 DeferredJobStatsReported deferred_job_stats_reported = 85;
Yangster-mace16189a2018-08-26 12:20:16 -0700139 ThermalThrottlingStateChanged thermal_throttling = 86;
Tej Singhd6d6d772018-09-05 17:41:25 -0700140 FingerprintAcquired fingerprint_acquired = 87;
141 FingerprintAuthenticated fingerprint_authenticated = 88;
142 FingerprintErrorOccurred fingerprint_error_occurred = 89;
Howard Ro688ae182018-09-25 00:09:36 -0700143 Notification notification = 90;
Howard Roa46b6582018-09-18 16:45:02 -0700144 BatteryHealthSnapshot battery_health_snapshot = 91;
145 SlowIo slow_io = 92;
146 BatteryCausedShutdown battery_caused_shutdown = 93;
Yangsteraf9aee72018-10-12 09:26:16 -0700147 PhoneServiceStateChanged phone_service_state_changed = 94;
148 PhoneStateChanged phone_state_changed = 95;
arangelovd5db50e2018-10-12 20:24:39 +0100149 UserRestrictionChanged user_restriction_changed = 96;
Fan Zhang916c13b2018-10-16 22:49:45 -0700150 SettingsUIChanged settings_ui_changed = 97;
Chenjie Yuae9dfac2018-10-25 16:06:56 -0700151 ConnectivityStateChanged connectivity_state_changed = 98;
Yao Chend54f9dd2017-10-17 17:37:48 +0000152 }
David Chenc8a43242017-10-17 16:23:28 -0700153
David Chen6e3e6cb2018-01-03 16:14:06 -0800154 // Pulled events will start at field 10000.
Misha Wagner5a51e002018-10-03 15:04:09 +0100155 // Next: 10038
David Chenc8a43242017-10-17 16:23:28 -0700156 oneof pulled {
David Chen6e3e6cb2018-01-03 16:14:06 -0800157 WifiBytesTransfer wifi_bytes_transfer = 10000;
158 WifiBytesTransferByFgBg wifi_bytes_transfer_by_fg_bg = 10001;
159 MobileBytesTransfer mobile_bytes_transfer = 10002;
160 MobileBytesTransferByFgBg mobile_bytes_transfer_by_fg_bg = 10003;
Chenjie Yu9d7720b2018-01-24 10:34:48 -0800161 BluetoothBytesTransfer bluetooth_bytes_transfer = 10006;
David Chen6e3e6cb2018-01-03 16:14:06 -0800162 KernelWakelock kernel_wakelock = 10004;
Chenjie Yuc8b7f222018-01-11 23:25:57 -0800163 SubsystemSleepState subsystem_sleep_state = 10005;
David Chen6e3e6cb2018-01-03 16:14:06 -0800164 CpuTimePerFreq cpu_time_per_freq = 10008;
165 CpuTimePerUid cpu_time_per_uid = 10009;
166 CpuTimePerUidFreq cpu_time_per_uid_freq = 10010;
Chenjie Yu5caaa9d2018-03-06 15:48:54 -0800167 WifiActivityInfo wifi_activity_info = 10011;
David Chen6e3e6cb2018-01-03 16:14:06 -0800168 ModemActivityInfo modem_activity_info = 10012;
Chenjie Yu9d7720b2018-01-24 10:34:48 -0800169 BluetoothActivityInfo bluetooth_activity_info = 10007;
Rajeev Kumar8a9fa052018-01-25 19:03:09 -0800170 ProcessMemoryState process_memory_state = 10013;
Chenjie Yu9d7720b2018-01-24 10:34:48 -0800171 SystemElapsedRealtime system_elapsed_realtime = 10014;
172 SystemUptime system_uptime = 10015;
Chenjie Yu9da105b2018-01-13 12:41:08 -0800173 CpuActiveTime cpu_active_time = 10016;
174 CpuClusterTime cpu_cluster_time = 10017;
Tej Singh86dc9db2018-09-06 00:39:57 +0000175 DiskSpace disk_space = 10018 [deprecated=true];
Tej Singhbf972d92018-01-10 20:51:13 -0800176 RemainingBatteryCapacity remaining_battery_capacity = 10019;
177 FullBatteryCapacity full_battery_capacity = 10020;
Tej Singh40298312018-02-16 00:15:09 -0800178 Temperature temperature = 10021;
Olivier Gaillard00bfb1b2018-07-10 11:25:09 +0100179 BinderCalls binder_calls = 10022;
Olivier Gaillard9ea238d2018-07-24 10:26:31 +0100180 BinderCallsExceptions binder_calls_exceptions = 10023;
Marcin Oczeretkod8cc8592018-08-22 16:07:36 +0100181 LooperStats looper_stats = 10024;
Tej Singh86dc9db2018-09-06 00:39:57 +0000182 DiskStats disk_stats = 10025;
183 DirectoryUsage directory_usage = 10026;
184 AppSize app_size = 10027;
185 CategorySize category_size = 10028;
Chenjie Yuab530202018-09-26 12:39:20 -0700186 ProcStats proc_stats = 10029;
Bookatz17f0d8a2018-09-13 12:56:32 -0700187 BatteryVoltage battery_voltage = 10030;
Tej Singhd6d6d772018-09-05 17:41:25 -0700188 NumFingerprints num_fingerprints = 10031;
Tej Singhe7726dc2018-09-21 11:42:12 -0700189 DiskIo disk_io = 10032;
Chenjie Yuab530202018-09-26 12:39:20 -0700190 PowerProfile power_profile = 10033;
Chenjie Yub52779e2018-10-05 12:03:36 -0700191 ProcStats proc_stats_pkg_proc = 10034;
Yangster-mac308ea0c2018-10-22 13:10:25 -0700192 ProcessCpuTime process_cpu_time = 10035;
Rafal Slawik08621582018-10-15 14:53:07 +0100193 NativeProcessMemoryState native_process_memory_state = 10036;
Misha Wagner5a51e002018-10-03 15:04:09 +0100194 CpuTimePerThreadFreq cpu_time_per_thread_freq = 10037;
Bookatz92da2832018-11-01 18:10:03 -0700195 OnDevicePowerMeasurement on_device_power_measurement = 10038;
David Chenc8a43242017-10-17 16:23:28 -0700196 }
yroa1fe77c2018-02-26 14:22:54 -0800197
Bookatz76aafcf2018-09-17 16:17:10 -0700198 // DO NOT USE field numbers above 100,000 in AOSP.
199 // Field numbers 100,000 - 199,999 are reserved for non-AOSP (e.g. OEMs) to use.
200 // Field numbers 200,000 and above are reserved for future use; do not use them at all.
Stefan Lafoncdb1a0e2017-09-27 20:24:15 -0700201}
202
Yao Chend54f9dd2017-10-17 17:37:48 +0000203/**
Yangster-mac20877162017-12-22 17:19:39 -0800204 * This proto represents a node of an attribution chain.
205 * Note: All attribution chains are represented as a repeated field of type
206 * AttributionNode. It is understood that in such arrays, the order is that
207 * of calls, that is [A, B, C] if A calls B that calls C.
Yao Chend54f9dd2017-10-17 17:37:48 +0000208 */
Yangster-mac20877162017-12-22 17:19:39 -0800209message AttributionNode {
210 // The uid for a given element in the attribution chain.
Yangster-mac7604aea2017-12-11 22:55:49 -0800211 optional int32 uid = 1;
Yangster-mac7604aea2017-12-11 22:55:49 -0800212
Yangster-mac20877162017-12-22 17:19:39 -0800213 // The (optional) string tag for an element in the attribution chain. If the
214 // element has no tag, it is encoded as an empty string.
215 optional string tag = 2;
Stefan Lafoncdb1a0e2017-09-27 20:24:15 -0700216}
217
Yangster-mac48b3d622018-08-18 12:38:11 -0700218message KeyValuePair {
219 optional int32 key = 1;
220 oneof value {
Howard Ro4078dd42018-09-27 17:41:08 -0700221 int32 value_int = 2;
222 int64 value_long = 3;
223 string value_str = 4;
224 float value_float = 5;
Yangster-mac48b3d622018-08-18 12:38:11 -0700225 }
226}
227
228message KeyValuePairsAtom {
229 optional int32 uid = 1;
230 repeated KeyValuePair pairs = 2;
231}
232
Yao Chend54f9dd2017-10-17 17:37:48 +0000233/*
234 * *****************************************************************************
yrode4ca102017-11-15 22:57:24 -0800235 * Below are all of the individual atoms that are logged by Android via statsd.
Yao Chend54f9dd2017-10-17 17:37:48 +0000236 *
237 * RULES:
238 * - The field ids for each atom must start at 1, and count upwards by 1.
239 * Skipping field ids is not allowed.
240 * - These form an API, so renaming, renumbering or removing fields is
241 * not allowed between android releases. (This is not currently enforced,
242 * but there will be a tool to enforce this restriction).
243 * - The types must be built-in protocol buffer types, namely, no sub-messages
244 * are allowed (yet). The bytes type is also not allowed.
245 * - The CamelCase name of the message type should match the
Stefan Lafonae2df012017-11-14 09:17:21 -0800246 * underscore_separated name as defined in Atom.
Yao Chend54f9dd2017-10-17 17:37:48 +0000247 * - If an atom represents work that can be attributed to an app, there can
Yangster-mac7604aea2017-12-11 22:55:49 -0800248 * be exactly one AttributionChain field. It must be field number 1.
Yao Chend54f9dd2017-10-17 17:37:48 +0000249 * - A field that is a uid should be a string field, tagged with the [xxx]
250 * annotation. The generated code on android will be represented by UIDs,
251 * and those UIDs will be translated in xxx to those strings.
252 *
253 * CONVENTIONS:
Bookatzc1a050a2017-10-10 15:49:28 -0700254 * - Events are past tense. e.g. ScreenStateChanged, not ScreenStateChange.
Yao Chend54f9dd2017-10-17 17:37:48 +0000255 * - If there is a UID, it goes first. Think in an object-oriented fashion.
256 * *****************************************************************************
257 */
Stefan Lafoncdb1a0e2017-09-27 20:24:15 -0700258
Yao Chend54f9dd2017-10-17 17:37:48 +0000259/**
Yangster-mace16189a2018-08-26 12:20:16 -0700260 * Logs when the Thermal service HAL notifies the throttling start/stop events.
261 *
262 * Logged from:
263 * frameworks/base/services/core/java/com/android/server/stats/StatsCompanionService.java
264 */
265message ThermalThrottlingStateChanged {
266 optional android.os.TemperatureTypeEnum sensor_type = 1;
267
268 enum State {
269 UNKNOWN = 0;
270 START = 1;
271 STOP = 2;
272 }
273
274 optional State state = 2;
275
276 optional float temperature = 3;
277}
278
279/**
Yao Chend54f9dd2017-10-17 17:37:48 +0000280 * Logs when the screen state changes.
281 *
282 * Logged from:
283 * frameworks/base/services/core/java/com/android/server/am/BatteryStatsService.java
284 */
285message ScreenStateChanged {
Bookatz1a1b0462018-01-12 11:47:03 -0800286 // New screen state, from frameworks/base/core/proto/android/view/enums.proto.
Yangster-macb6b77c62018-10-12 19:33:24 -0700287 optional android.view.DisplayStateEnum state = 1 [(state_field_option).option = EXCLUSIVE];
Stefan Lafoncdb1a0e2017-09-27 20:24:15 -0700288}
Yao Chend54f9dd2017-10-17 17:37:48 +0000289
290/**
Chenjie Yubd1a28f2018-07-17 14:55:19 -0700291 * Logs that the process state of the uid, as determined by ActivityManager
292 * (i.e. the highest process state of that uid's processes) has changed.
Yao Chend54f9dd2017-10-17 17:37:48 +0000293 *
294 * Logged from:
295 * frameworks/base/services/core/java/com/android/server/am/BatteryStatsService.java
296 */
Bookatzc1a050a2017-10-10 15:49:28 -0700297message UidProcessStateChanged {
Yangster-macb6b77c62018-10-12 19:33:24 -0700298 optional int32 uid = 1 [(state_field_option).option = PRIMARY, (is_uid) = true];
Yao Chend54f9dd2017-10-17 17:37:48 +0000299
Bookatzdb026a22018-01-10 19:01:56 -0800300 // The state, from frameworks/base/core/proto/android/app/enums.proto.
Yangster-macb6b77c62018-10-12 19:33:24 -0700301 optional android.app.ProcessStateEnum state = 2 [(state_field_option).option = EXCLUSIVE];
Yao Chend54f9dd2017-10-17 17:37:48 +0000302}
303
304/**
Chenjie Yubd1a28f2018-07-17 14:55:19 -0700305 * Logs process state change of a process, as per the activity manager.
306 *
307 * Logged from:
308 * frameworks/base/services/core/java/com/android/server/am/ProcessRecord.java
309 */
310message ProcessStateChanged {
311 optional int32 uid = 1;
312 optional string process_name = 2;
313 optional string package_name = 3;
314 // TODO: remove this when validation is done
315 optional int64 version = 5;
316 // The state, from frameworks/base/core/proto/android/app/enums.proto.
317 optional android.app.ProcessStateEnum state = 4;
318}
319
320/**
321 * Logs when ActivityManagerService sleep state is changed.
322 *
323 * Logged from:
324 * frameworks/base/services/core/java/com/android/server/am/ActivityTaskManagerService.java
325 */
326message ActivityManagerSleepStateChanged {
327 // TODO: import frameworks proto
328 enum State {
329 UNKNOWN = 0;
330 ASLEEP = 1;
331 AWAKE = 2;
332 }
Yangster-macb6b77c62018-10-12 19:33:24 -0700333 optional State state = 1 [(state_field_option).option = EXCLUSIVE];
Chenjie Yubd1a28f2018-07-17 14:55:19 -0700334}
335
336/**
337 * Logs when system memory state changes.
338 *
339 * Logged from:
340 * frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
341 */
342message MemoryFactorStateChanged {
343 // TODO: import frameworks proto
344 enum State {
345 MEMORY_UNKNOWN = 0;
346 NORMAL = 1; // normal.
347 MODERATE = 2; // moderate memory pressure.
348 LOW = 3; // low memory.
349 CRITICAL = 4; // critical memory.
350
351 }
Yangster-macb6b77c62018-10-12 19:33:24 -0700352 optional State factor = 1 [(state_field_option).option = EXCLUSIVE];
Chenjie Yubd1a28f2018-07-17 14:55:19 -0700353}
354
355/**
356 * Logs when app is using too much cpu, according to ActivityManagerService.
357 *
358 * Logged from:
359 * frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
360 */
361message ExcessiveCpuUsageReported {
362 optional int32 uid = 1;
363 optional string process_name = 2;
364 optional string package_name = 3;
365 // package version. TODO: remove this when validation is done
366 optional int64 version = 4;
367}
368
369/**
370 * Logs when a cached process is killed, along with its pss.
371 *
372 * Logged from:
373 * frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
374 */
375message CachedKillReported {
376 optional int32 uid = 1;
377 optional string process_name = 2;
378 optional string package_name = 3;
379 // TODO: remove this when validation is done
380 optional int64 version = 5;
381 optional int64 pss = 4;
382}
383
384/**
385 * Logs when memory stats of a process is reported.
386 *
387 * Logged from:
388 * frameworks/base/services/core/java/com/android/server/am/ProcessRecord.java
389 */
390message ProcessMemoryStatReported {
391 optional int32 uid = 1;
392 optional string process_name = 2;
393 optional string package_name = 3;
394 //TODO: remove this when validation is done
395 optional int64 version = 9;
396 optional int64 pss = 4;
397 optional int64 uss = 5;
398 optional int64 rss = 6;
399 enum Type {
400 ADD_PSS_INTERNAL_SINGLE = 0;
401 ADD_PSS_INTERNAL_ALL_MEM = 1;
402 ADD_PSS_INTERNAL_ALL_POLL = 2;
403 ADD_PSS_EXTERNAL = 3;
404 ADD_PSS_EXTERNAL_SLOW = 4;
405 }
406 optional Type type = 7;
407 optional int64 duration = 8;
408}
409
410/**
Bookatzc1a050a2017-10-10 15:49:28 -0700411 * Logs that a process started, finished, crashed, or ANRed.
412 *
413 * Logged from:
414 * frameworks/base/services/core/java/com/android/server/am/BatteryStatsService.java
415 */
416message ProcessLifeCycleStateChanged {
Yao Chenc40a19d2018-03-15 16:48:25 -0700417 optional int32 uid = 1 [(is_uid) = true];
Bookatzc1a050a2017-10-10 15:49:28 -0700418
David Chen0b5c90c2018-01-25 16:51:49 -0800419 // The process name (usually same as the app name).
Chenjie Yu5caaa9d2018-03-06 15:48:54 -0800420 optional string process_name = 2;
Bookatzc1a050a2017-10-10 15:49:28 -0700421
Bookatzddccf0a2017-11-28 16:48:14 -0800422 // What lifecycle state the process changed to.
423 // This enum is specific to atoms.proto.
Chenjie Yu5caaa9d2018-03-06 15:48:54 -0800424 enum State {
425 FINISHED = 0;
426 STARTED = 1;
427 CRASHED = 2;
Bookatzddccf0a2017-11-28 16:48:14 -0800428 }
Chenjie Yu5caaa9d2018-03-06 15:48:54 -0800429 optional State state = 3;
Bookatzc1a050a2017-10-10 15:49:28 -0700430}
431
Bookatzc1a050a2017-10-10 15:49:28 -0700432/**
433 * Logs when the ble scan state changes.
434 *
435 * Logged from:
Bookatz17a879d2018-03-28 15:05:28 -0700436 * packages/apps/Bluetooth/src/com/android/bluetooth/gatt/AppScanStats.java
Bookatzc1a050a2017-10-10 15:49:28 -0700437 */
438message BleScanStateChanged {
Yangster-macafad8c62018-01-05 22:30:49 -0800439 repeated AttributionNode attribution_node = 1;
Bookatzc1a050a2017-10-10 15:49:28 -0700440
441 enum State {
442 OFF = 0;
443 ON = 1;
Bookatze5ec0b42018-03-26 13:34:56 -0700444 // RESET indicates all ble stopped. Used when it (re)starts (e.g. after it crashes).
445 RESET = 2;
Bookatzc1a050a2017-10-10 15:49:28 -0700446 }
447 optional State state = 2;
Bookatzc1a050a2017-10-10 15:49:28 -0700448
Bookatze5ec0b42018-03-26 13:34:56 -0700449 // Does the scan have a filter.
450 optional bool is_filtered = 3;
451 // Whether the scan is a CALLBACK_TYPE_FIRST_MATCH scan. Called 'background' scan internally.
452 optional bool is_first_match = 4;
453 // Whether the scan set to piggy-back off the results of other scans (SCAN_MODE_OPPORTUNISTIC).
454 optional bool is_opportunistic = 5;
Bookatzc1a050a2017-10-10 15:49:28 -0700455}
456
457/**
458 * Logs reporting of a ble scan finding results.
459 *
460 * Logged from:
Bookatzae6738e2018-09-13 11:38:56 -0700461 * packages/apps/Bluetooth/src/com/android/bluetooth/gatt/AppScanStats.java
Bookatzc1a050a2017-10-10 15:49:28 -0700462 */
Bookatzae6738e2018-09-13 11:38:56 -0700463// TODO: Consider also tracking per-scanner-id.
Bookatzc1a050a2017-10-10 15:49:28 -0700464message BleScanResultReceived {
Yangster-macafad8c62018-01-05 22:30:49 -0800465 repeated AttributionNode attribution_node = 1;
Bookatzc1a050a2017-10-10 15:49:28 -0700466
467 // Number of ble scan results returned.
Chenjie Yu5caaa9d2018-03-06 15:48:54 -0800468 optional int32 num_results = 2;
Bookatzc1a050a2017-10-10 15:49:28 -0700469}
470
471/**
472 * Logs when a sensor state changes.
473 *
474 * Logged from:
Bookatz235343d2018-03-26 13:03:50 -0700475 * frameworks/base/services/core/java/com/android/server/am/BatteryStatsService.java
Bookatzc1a050a2017-10-10 15:49:28 -0700476 */
477message SensorStateChanged {
Yangster-macafad8c62018-01-05 22:30:49 -0800478 repeated AttributionNode attribution_node = 1;
Bookatzc1a050a2017-10-10 15:49:28 -0700479
Bookatzc1a050a2017-10-10 15:49:28 -0700480 // The id (int) of the sensor.
481 optional int32 sensor_id = 2;
482
483 enum State {
484 OFF = 0;
485 ON = 1;
486 }
487 optional State state = 3;
488}
489
Bookatzc1a050a2017-10-10 15:49:28 -0700490/**
491 * Logs when GPS state changes.
492 *
493 * Logged from:
494 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
495 */
496message GpsScanStateChanged {
Yangster-macafad8c62018-01-05 22:30:49 -0800497 repeated AttributionNode attribution_node = 1;
Bookatzc1a050a2017-10-10 15:49:28 -0700498
499 enum State {
500 OFF = 0;
501 ON = 1;
502 }
503 optional State state = 2;
504}
505
Bookatz48d362e2018-11-06 15:49:08 -0800506/**
507 * Logs when GPS signal quality.
508 *
509 * Logged from:
510 * /frameworks/base/location/java/com/android/internal/location/gnssmetrics/GnssMetrics.java
511 */
512message GpsSignalQualityChanged {
513 optional android.server.location.GpsSignalQualityEnum level = 1;
514}
515
Bookatzc1a050a2017-10-10 15:49:28 -0700516
517/**
518 * Logs when a sync manager sync state changes.
519 *
520 * Logged from:
Bookatz235343d2018-03-26 13:03:50 -0700521 * frameworks/base/services/core/java/com/android/server/am/BatteryStatsService.java
Bookatzc1a050a2017-10-10 15:49:28 -0700522 */
523message SyncStateChanged {
Yangster-macafad8c62018-01-05 22:30:49 -0800524 repeated AttributionNode attribution_node = 1;
Bookatzc1a050a2017-10-10 15:49:28 -0700525
David Chen0b5c90c2018-01-25 16:51:49 -0800526 // Name of the sync (as named in the app). Can be chosen at run-time.
Chenjie Yu5caaa9d2018-03-06 15:48:54 -0800527 optional string sync_name = 2;
Bookatzc1a050a2017-10-10 15:49:28 -0700528
529 enum State {
530 OFF = 0;
531 ON = 1;
532 }
533 optional State state = 3;
534}
535
Yangster-mac96353002018-09-05 11:18:55 -0700536/*
537 * Deferred job stats.
538 *
539 * Logged from:
540 * frameworks/base/services/core/java/com/android/server/job/JobSchedulerService.java
541*/
542message DeferredJobStatsReported {
543 repeated AttributionNode attribution_node = 1;
544
545 // Number of jobs deferred.
546 optional int32 num_jobs_deferred = 2;
547
548 // Time since the last job runs.
549 optional int64 time_since_last_job_millis = 3;
550}
551
Bookatzc1a050a2017-10-10 15:49:28 -0700552/**
553 * Logs when a job scheduler job state changes.
554 *
555 * Logged from:
Bookatz235343d2018-03-26 13:03:50 -0700556 * frameworks/base/services/core/java/com/android/server/am/BatteryStatsService.java
Bookatzc1a050a2017-10-10 15:49:28 -0700557 */
558message ScheduledJobStateChanged {
Yangster-macafad8c62018-01-05 22:30:49 -0800559 repeated AttributionNode attribution_node = 1;
Bookatzc1a050a2017-10-10 15:49:28 -0700560
561 // Name of the job (as named in the app)
Chenjie Yu5caaa9d2018-03-06 15:48:54 -0800562 optional string job_name = 2;
Bookatzc1a050a2017-10-10 15:49:28 -0700563
564 enum State {
Tej Singhd5747a62018-01-08 20:57:35 -0800565 FINISHED = 0;
566 STARTED = 1;
567 SCHEDULED = 2;
Bookatzc1a050a2017-10-10 15:49:28 -0700568 }
569 optional State state = 3;
570
Tej Singh33a412b2018-03-16 18:43:59 -0700571 // The reason a job has stopped.
572 // This is only applicable when the state is FINISHED.
Bookatz235343d2018-03-26 13:03:50 -0700573 // The default value is STOP_REASON_UNKNOWN.
Tej Singh33a412b2018-03-16 18:43:59 -0700574 optional android.app.job.StopReasonEnum stop_reason = 4;
Bookatzc1a050a2017-10-10 15:49:28 -0700575}
576
577/**
578 * Logs when the audio state changes.
579 *
580 * Logged from:
Bookatz235343d2018-03-26 13:03:50 -0700581 * frameworks/base/services/core/java/com/android/server/am/BatteryStatsService.java
Bookatzc1a050a2017-10-10 15:49:28 -0700582 */
583message AudioStateChanged {
Yangster-macafad8c62018-01-05 22:30:49 -0800584 repeated AttributionNode attribution_node = 1;
Bookatzc1a050a2017-10-10 15:49:28 -0700585
586 enum State {
587 OFF = 0;
588 ON = 1;
Bookatz235343d2018-03-26 13:03:50 -0700589 // RESET indicates all audio stopped. Used when it (re)starts (e.g. after it crashes).
590 RESET = 2;
Bookatzc1a050a2017-10-10 15:49:28 -0700591 }
592 optional State state = 2;
593}
594
595/**
596 * Logs when the video codec state changes.
597 *
598 * Logged from:
Bookatz235343d2018-03-26 13:03:50 -0700599 * frameworks/base/services/core/java/com/android/server/am/BatteryStatsService.java
Bookatzc1a050a2017-10-10 15:49:28 -0700600 */
Chenjie Yu5caaa9d2018-03-06 15:48:54 -0800601message MediaCodecStateChanged {
Yangster-macafad8c62018-01-05 22:30:49 -0800602 repeated AttributionNode attribution_node = 1;
Bookatzc1a050a2017-10-10 15:49:28 -0700603
604 enum State {
605 OFF = 0;
606 ON = 1;
Bookatz235343d2018-03-26 13:03:50 -0700607 // RESET indicates all mediaCodec stopped. Used when it (re)starts (e.g. after it crashes).
608 RESET = 2;
Bookatzc1a050a2017-10-10 15:49:28 -0700609 }
610 optional State state = 2;
611}
612
613/**
614 * Logs when the flashlight state changes.
615 *
616 * Logged from:
Bookatz235343d2018-03-26 13:03:50 -0700617 * frameworks/base/services/core/java/com/android/server/am/BatteryStatsService.java
Bookatzc1a050a2017-10-10 15:49:28 -0700618 */
619message FlashlightStateChanged {
Yangster-macafad8c62018-01-05 22:30:49 -0800620 repeated AttributionNode attribution_node = 1;
Bookatzc1a050a2017-10-10 15:49:28 -0700621
622 enum State {
623 OFF = 0;
624 ON = 1;
Bookatz235343d2018-03-26 13:03:50 -0700625 // RESET indicates all flashlight stopped. Used when it (re)starts (e.g. after it crashes).
626 RESET = 2;
Bookatzc1a050a2017-10-10 15:49:28 -0700627 }
628 optional State state = 2;
629}
630
631/**
632 * Logs when the camera state changes.
633 *
634 * Logged from:
Bookatz235343d2018-03-26 13:03:50 -0700635 * frameworks/base/services/core/java/com/android/server/am/BatteryStatsService.java
Bookatzc1a050a2017-10-10 15:49:28 -0700636 */
637message CameraStateChanged {
Yangster-macafad8c62018-01-05 22:30:49 -0800638 repeated AttributionNode attribution_node = 1;
Bookatzc1a050a2017-10-10 15:49:28 -0700639
640 enum State {
641 OFF = 0;
642 ON = 1;
Bookatz235343d2018-03-26 13:03:50 -0700643 // RESET indicates all camera stopped. Used when it (re)starts (e.g. after it crashes).
644 RESET = 2;
Bookatzc1a050a2017-10-10 15:49:28 -0700645 }
646 optional State state = 2;
647}
648
649/**
650 * Logs that the state of a wakelock (per app and per wakelock name) has changed.
Yao Chend54f9dd2017-10-17 17:37:48 +0000651 *
652 * Logged from:
653 * TODO
654 */
Bookatzd6746242017-10-24 18:39:35 -0700655message WakelockStateChanged {
Yangster-mac20877162017-12-22 17:19:39 -0800656 repeated AttributionNode attribution_node = 1;
Yao Chend54f9dd2017-10-17 17:37:48 +0000657
Bookatz1a1b0462018-01-12 11:47:03 -0800658 // The type (level) of the wakelock; e.g. a partial wakelock or a full wakelock.
659 // From frameworks/base/core/proto/android/os/enums.proto.
Yangster-maca8a30442018-10-13 23:46:34 -0700660 optional android.os.WakeLockLevelEnum type = 2;
Bookatzc1a050a2017-10-10 15:49:28 -0700661
662 // The wakelock tag (Called tag in the Java API, sometimes name elsewhere).
663 optional string tag = 3;
664
665 enum State {
Yangster-maccfdf3a42017-12-06 13:42:38 -0800666 RELEASE = 0;
667 ACQUIRE = 1;
668 CHANGE_RELEASE = 2;
669 CHANGE_ACQUIRE = 3;
Bookatzc1a050a2017-10-10 15:49:28 -0700670 }
671 optional State state = 4;
672}
673
674/**
Bookatzc1a050a2017-10-10 15:49:28 -0700675 * Logs when a partial wakelock is considered 'long' (over 1 min).
676 *
677 * Logged from:
678 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
679 */
680message LongPartialWakelockStateChanged {
Yangster-macafad8c62018-01-05 22:30:49 -0800681 repeated AttributionNode attribution_node = 1;
Bookatzc1a050a2017-10-10 15:49:28 -0700682
Yao Chend54f9dd2017-10-17 17:37:48 +0000683 // The wakelock tag (Called tag in the Java API, sometimes name elsewhere).
684 optional string tag = 2;
685
Bookatzc1a050a2017-10-10 15:49:28 -0700686 // TODO: I have no idea what this is.
687 optional string history_tag = 3;
688
689 enum State {
690 OFF = 0;
691 ON = 1;
692 }
693 optional State state = 4;
Yao Chend54f9dd2017-10-17 17:37:48 +0000694}
695
Bookatzc1a050a2017-10-10 15:49:28 -0700696/**
Bookatza66083f2018-09-20 17:24:00 -0700697 * Logs when the device is interactive, according to the PowerManager Notifier.
698 *
699 * Logged from:
700 * frameworks/base/services/core/java/com/android/server/power/Notifier.java
701 */
702message InteractiveStateChanged {
703 enum State {
704 OFF = 0;
705 ON = 1;
706 }
707 optional State state = 1;
708}
709
710/**
Bookatzc1a050a2017-10-10 15:49:28 -0700711 * Logs Battery Saver state change.
712 *
713 * Logged from:
714 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
715 */
716message BatterySaverModeStateChanged {
717 enum State {
718 OFF = 0;
719 ON = 1;
720 }
721 optional State state = 1;
722}
723
724/**
725 * Logs Doze mode state change.
726 *
727 * Logged from:
Bookatzddccf0a2017-11-28 16:48:14 -0800728 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
Bookatzc1a050a2017-10-10 15:49:28 -0700729 */
730message DeviceIdleModeStateChanged {
Bookatz8bdae8d2018-01-16 11:24:30 -0800731 optional android.server.DeviceIdleModeEnum state = 1;
Bookatzddccf0a2017-11-28 16:48:14 -0800732}
733
734
735/**
736 * Logs state change of Doze mode including maintenance windows.
737 *
738 * Logged from:
739 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
740 */
741message DeviceIdlingModeStateChanged {
Bookatz8bdae8d2018-01-16 11:24:30 -0800742 optional android.server.DeviceIdleModeEnum state = 1;
Bookatzc1a050a2017-10-10 15:49:28 -0700743}
744
745/**
746 * Logs screen brightness level.
747 *
748 * Logged from:
749 * frameworks/base/services/core/java/com/android/server/am/BatteryStatsService.java
750 */
751message ScreenBrightnessChanged {
752 // Screen brightness level. Should be in [-1, 255] according to PowerManager.java.
753 optional int32 level = 1;
Bookatz8c6571b2017-10-24 15:04:41 -0700754}
755
756/**
757 * Logs battery level (percent full, from 0 to 100).
758 *
759 * Logged from:
David Chenc28b2bb2017-10-24 12:52:52 -0700760 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
Bookatz8c6571b2017-10-24 15:04:41 -0700761 */
762message BatteryLevelChanged {
763 // Battery level. Should be in [0, 100].
764 optional int32 battery_level = 1;
765}
766
767/**
768 * Logs change in charging status of the device.
769 *
770 * Logged from:
David Chenc28b2bb2017-10-24 12:52:52 -0700771 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
Bookatz8c6571b2017-10-24 15:04:41 -0700772 */
773message ChargingStateChanged {
Bookatz1a1b0462018-01-12 11:47:03 -0800774 // State of the battery, from frameworks/base/core/proto/android/os/enums.proto.
775 optional android.os.BatteryStatusEnum state = 1;
Bookatz8c6571b2017-10-24 15:04:41 -0700776}
777
778/**
779 * Logs whether the device is plugged in, and what power source it is using.
780 *
781 * Logged from:
David Chenc28b2bb2017-10-24 12:52:52 -0700782 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
Bookatz8c6571b2017-10-24 15:04:41 -0700783 */
784message PluggedStateChanged {
Bookatz1a1b0462018-01-12 11:47:03 -0800785 // Whether the device is plugged in, from frameworks/base/core/proto/android/os/enums.proto.
786 optional android.os.BatteryPluggedStateEnum state = 1;
Bookatz8c6571b2017-10-24 15:04:41 -0700787}
788
Bookatz8c6571b2017-10-24 15:04:41 -0700789/**
790 * Logs when an app's wakeup alarm fires.
791 *
792 * Logged from:
David Chenc28b2bb2017-10-24 12:52:52 -0700793 * frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
Bookatz8c6571b2017-10-24 15:04:41 -0700794 */
795message WakeupAlarmOccurred {
Yangster-macafad8c62018-01-05 22:30:49 -0800796 repeated AttributionNode attribution_node = 1;
Bookatzddccf0a2017-11-28 16:48:14 -0800797
798 // Name of the wakeup alarm.
799 optional string tag = 2;
Bookatzcaf2293e2018-09-23 13:07:43 -0700800
801 // Name of source package (for historical reasons, since BatteryStats tracked it).
802 optional string package_name = 3;
Bookatzddccf0a2017-11-28 16:48:14 -0800803}
804
805/**
806 * Logs when an an app causes the mobile radio to change state.
807 * Changing from LOW to MEDIUM or HIGH can be considered the app waking the mobile radio.
808 *
809 * Logged from:
Bookatz0b028b12018-05-31 16:51:17 -0700810 * frameworks/base/services/core/java/com/android/server/NetworkManagementService.java
Bookatzddccf0a2017-11-28 16:48:14 -0800811 */
812message MobileRadioPowerStateChanged {
Chenjie Yu5caaa9d2018-03-06 15:48:54 -0800813 repeated AttributionNode attribution_node = 1;
Bookatzddccf0a2017-11-28 16:48:14 -0800814
Bookatz1a1b0462018-01-12 11:47:03 -0800815 // Power state, from frameworks/base/core/proto/android/telephony/enums.proto.
816 optional android.telephony.DataConnectionPowerStateEnum state = 2;
Bookatzddccf0a2017-11-28 16:48:14 -0800817}
818
819/**
820 * Logs when an an app causes the wifi radio to change state.
821 * Changing from LOW to MEDIUM or HIGH can be considered the app waking the wifi radio.
822 *
823 * Logged from:
Bookatz0b028b12018-05-31 16:51:17 -0700824 * frameworks/base/services/core/java/com/android/server/NetworkManagementService.java
Bookatzddccf0a2017-11-28 16:48:14 -0800825 */
826message WifiRadioPowerStateChanged {
Chenjie Yu5caaa9d2018-03-06 15:48:54 -0800827 repeated AttributionNode attribution_node = 1;
Bookatzddccf0a2017-11-28 16:48:14 -0800828
Bookatz1a1b0462018-01-12 11:47:03 -0800829 // Power state, from frameworks/base/core/proto/android/telephony/enums.proto.
830 optional android.telephony.DataConnectionPowerStateEnum state = 2;
Bookatz8c6571b2017-10-24 15:04:41 -0700831}
832
833/**
834 * Logs kernel wakeup reasons and aborts.
835 *
836 * Logged from:
Bookatz56585ca2018-09-07 11:38:45 -0700837 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
Bookatz8c6571b2017-10-24 15:04:41 -0700838 */
839message KernelWakeupReported {
840 // Name of the kernel wakeup reason (or abort).
841 optional string wakeup_reason_name = 1;
842
843 // Duration (in microseconds) for the wake-up interrupt to be serviced.
David Chen0b5c90c2018-01-25 16:51:49 -0800844 optional int64 duration_micros = 2;
Bookatze5885242017-10-24 20:10:31 -0700845}
846
847/**
848 * Logs wifi locks held by an app.
849 *
850 * Logged from:
David Chenc28b2bb2017-10-24 12:52:52 -0700851 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
Bookatze5885242017-10-24 20:10:31 -0700852 */
853message WifiLockStateChanged {
Yangster-macafad8c62018-01-05 22:30:49 -0800854 repeated AttributionNode attribution_node = 1;
Bookatze5885242017-10-24 20:10:31 -0700855
856 enum State {
857 OFF = 0;
858 ON = 1;
859 }
860 optional State state = 2;
861}
862
863/**
864 * Logs wifi signal strength changes.
865 *
866 * Logged from:
David Chenc28b2bb2017-10-24 12:52:52 -0700867 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
Bookatze5885242017-10-24 20:10:31 -0700868 */
869message WifiSignalStrengthChanged {
Bookatz1a1b0462018-01-12 11:47:03 -0800870 // Signal strength, from frameworks/base/core/proto/android/telephony/enums.proto.
871 optional android.telephony.SignalStrengthEnum signal_strength = 1;
Bookatze5885242017-10-24 20:10:31 -0700872}
873
874/**
875 * Logs wifi scans performed by an app.
876 *
877 * Logged from:
David Chenc28b2bb2017-10-24 12:52:52 -0700878 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
Bookatze5885242017-10-24 20:10:31 -0700879 */
880message WifiScanStateChanged {
Yangster-macafad8c62018-01-05 22:30:49 -0800881 repeated AttributionNode attribution_node = 1;
Bookatze5885242017-10-24 20:10:31 -0700882
883 enum State {
884 OFF = 0;
885 ON = 1;
886 }
887 optional State state = 2;
888}
889
890/**
Tej Singh4503e102018-01-04 14:35:01 -0800891 * Logs wifi multicast locks held by an app
892 *
893 * Logged from:
894 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
895 */
896message WifiMulticastLockStateChanged {
897 repeated AttributionNode attribution_node = 1;
898
899 enum State {
900 OFF = 0;
901 ON = 1;
902 }
903 optional State state = 2;
904}
905
906/**
Tej Singh1ea42892018-01-19 09:27:00 -0800907 * Logs shutdown reason and duration on next boot.
908 *
909 * Logged from:
910 * frameworks/base/core/java/com/android/server/BootReceiver.java
911 */
912message ShutdownSequenceReported {
913 // True if shutdown is for a reboot. Default: false if we do not know.
914 optional bool reboot = 1;
915
916 // Reason for shutdown. Eg: userrequested. Default: "<EMPTY>".
917 optional string reason = 2;
918
919 // Beginning of shutdown time in ms using wall clock time since unix epoch.
920 // Default: 0 if no start time received.
David Chen0b5c90c2018-01-25 16:51:49 -0800921 optional int64 start_time_millis = 3;
Tej Singh1ea42892018-01-19 09:27:00 -0800922
923 // Duration of shutdown in ms. Default: 0 if no duration received.
David Chen0b5c90c2018-01-25 16:51:49 -0800924 optional int64 duration_millis = 4;
Tej Singh1ea42892018-01-19 09:27:00 -0800925}
926
Tej Singh6483ea42018-01-25 17:45:49 -0800927
928/**
929 * Logs boot reason and duration.
930 *
931 * Logged from:
932 * system/core/bootstat/bootstat.cpp
933 */
934message BootSequenceReported {
935 // Reason for bootloader boot. Eg. reboot. See bootstat.cpp for larger list
936 // Default: "<EMPTY>" if not available.
937 optional string bootloader_reason = 1;
938
939 // Reason for system boot. Eg. bootloader, reboot,userrequested
940 // Default: "<EMPTY>" if not available.
941 optional string system_reason = 2;
942
943 // End of boot time in ms from unix epoch using system wall clock.
David Chen0b5c90c2018-01-25 16:51:49 -0800944 optional int64 end_time_millis = 3;
Tej Singh6483ea42018-01-25 17:45:49 -0800945
946 // Total boot duration in ms.
David Chen0b5c90c2018-01-25 16:51:49 -0800947 optional int64 total_duration_millis = 4;
Tej Singh6483ea42018-01-25 17:45:49 -0800948
949 // Bootloader duration in ms.
David Chen0b5c90c2018-01-25 16:51:49 -0800950 optional int64 bootloader_duration_millis = 5;
Tej Singh6483ea42018-01-25 17:45:49 -0800951
952 // Time since last boot in ms. Default: 0 if not available.
953 optional int64 time_since_last_boot = 6;
954}
955
Tej Singhc477d9c2018-02-05 18:31:39 -0800956
957/**
958 * Logs call state and disconnect cause (if applicable).
959 *
960 * Logged from:
961 * packages/services/Telecomm/src/com/android/server/telecom/Call.java
962 */
963message CallStateChanged {
964 // The state of the call. Eg. DIALING, ACTIVE, ON_HOLD, DISCONNECTED.
965 // From frameworks/base/core/proto/android/telecomm/enums.proto.
966 optional android.telecom.CallStateEnum call_state = 1;
967
968 // The reason the call disconnected. Eg. ERROR, MISSED, REJECTED, BUSY.
969 // This value is only applicable when the call_state is DISCONNECTED, and
970 // should always be UNKNOWN if the call_state is not DISCONNECTED.
971 // From frameworks/base/core/proto/android/telecomm/enums.proto.
972 optional android.telecom.DisconnectCauseEnum disconnect_cause = 2;
973
974 // True if the call is self-managed, which are apps that use the
975 // telecom infrastructure to make their own calls.
976 optional bool self_managed = 3;
977
978 // True if call is external. External calls are calls on connected Wear
979 // devices but show up in Telecom so the user can pull them onto the device.
980 optional bool external_call = 4;
981}
982
Tej Singh1ea42892018-01-19 09:27:00 -0800983/**
Tej Singhdd7bd352018-02-09 19:33:15 -0800984 * Logs keyguard state. The keyguard is the lock screen.
985 *
986 * Logged from:
987 * frameworks/base/packages/SystemUI/src/com/android/systemui/statusbar/phone/StatusBarKeyguardViewManager.java
988 */
989message KeyguardStateChanged {
990 enum State {
991 UNKNOWN = 0;
992 // The keyguard is hidden when the phone is unlocked.
993 HIDDEN = 1;
994 // The keyguard is shown when the phone is locked (screen turns off).
995 SHOWN= 2;
996 // The keyguard is occluded when something is overlaying the keyguard.
997 // Eg. Opening the camera while on the lock screen.
998 OCCLUDED = 3;
999 }
1000 optional State state = 1;
1001}
1002
1003/**
1004 * Logs keyguard bouncer state. The bouncer is a part of the keyguard, and
1005 * prompts the user to enter a password (pattern, pin, etc).
1006 *
1007 * Logged from:
1008 * frameworks/base/packages/SystemUI/src/com/android/systemui/statusbar/phone/KeyguardBouncer.java
1009 */
1010
1011message KeyguardBouncerStateChanged {
1012 enum State {
1013 UNKNOWN = 0;
1014 // Bouncer is hidden, either as a result of successfully entering the
1015 // password, screen timing out, or user going back to lock screen.
1016 HIDDEN = 1;
1017 // This is when the user is being prompted to enter the password.
1018 SHOWN = 2;
1019 }
1020 optional State state = 1;
1021}
1022
1023/**
1024 * Logs the result of entering a password into the keyguard bouncer.
1025 *
1026 * Logged from:
1027 * frameworks/base/packages/SystemUI/src/com/android/keyguard/KeyguardSecurityContainer.java
1028 */
1029message KeyguardBouncerPasswordEntered {
1030 enum BouncerResult {
1031 UNKNOWN = 0;
1032 // The password entered was incorrect.
1033 FAILURE = 1;
1034 // The password entered was correct.
1035 SUCCESS = 2;
1036 }
1037 optional BouncerResult result = 1;
1038}
1039
Tej Singha883b372018-02-15 11:30:01 -08001040/*
1041 * Logs changes to the configuration of the device. The configuration is defined
1042 * in frameworks/base/core/java/android/content/res/Configuration.java
1043 * More documentation is at https://d.android.com/reference/android/content/res/Configuration.html
1044 * Please go there to interpret the possible values each field can be.
1045 *
1046 * Logged from:
1047 * frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
1048 */
1049message ResourceConfigurationChanged {
1050 // Bit mask of color capabilities of the screen.
1051 // Contains information about the color gamut and hdr mode of the screen.
1052 // See: https://d.android.com/reference/android/content/res/Configuration.html#colorMode
Yangster-maca8a30442018-10-13 23:46:34 -07001053 optional int32 color_mode = 1;
Tej Singha883b372018-02-15 11:30:01 -08001054
1055 // The target screen density being rendered to.
1056 // See: https://d.android.com/reference/android/content/res/Configuration.html#densityDpi
Yangster-maca8a30442018-10-13 23:46:34 -07001057 optional int32 density_dpi = 2;
Tej Singha883b372018-02-15 11:30:01 -08001058
1059 // Current user preference for the scaling factor for fonts,
1060 // relative to the base density scaling.
1061 // See: https://d.android.com/reference/android/content/res/Configuration.html#fontScale
Yangster-maca8a30442018-10-13 23:46:34 -07001062 optional float font_scale = 3;
Tej Singha883b372018-02-15 11:30:01 -08001063
1064 // Flag indicating whether the hard keyboard is hidden.
1065 // See: https://d.android.com/reference/android/content/res/Configuration.html#hardKeyboardHidden
Yangster-maca8a30442018-10-13 23:46:34 -07001066 optional int32 hard_keyboard_hidden = 4;
Tej Singha883b372018-02-15 11:30:01 -08001067
1068 // The type of keyboard attached to the device.
1069 // See: https://d.android.com/reference/android/content/res/Configuration.html#keyboard
1070 optional int32 keyboard = 5;
1071
1072 // Flag indicating whether any keyboard is available. Takes soft keyboards into account.
1073 // See: https://d.android.com/reference/android/content/res/Configuration.html#keyboardHidden
Yangster-maca8a30442018-10-13 23:46:34 -07001074 optional int32 keyboard_hidden = 6;
Tej Singha883b372018-02-15 11:30:01 -08001075
1076 // IMSI MCC (Mobile Country Code), corresponding to mcc resource qualifier.
1077 // 0 if undefined.
1078 // See: https://d.android.com/reference/android/content/res/Configuration.html#mcc
1079 optional int32 mcc = 7;
1080
1081 // IMSI MNC (Mobile Network Code), corresponding to mnc resource qualifier.
1082 // 0 if undefined. Note: the actual MNC may be 0, to check for this use the
1083 // MNC_ZERO symbol defined in Configuration.java.
1084 // See: https://d.android.com/reference/android/content/res/Configuration.html#mnc
1085 optional int32 mnc = 8;
1086
1087 // The kind of navigation available on the device.
1088 // See: https://developer.android.com/reference/android/content/res/Configuration.html#navigation
1089 optional int32 navigation = 9;
1090
1091 // Flag indicating whether the navigation is available.
1092 // See: https://d.android.com/reference/android/content/res/Configuration.html#navigationHidden
Yangster-maca8a30442018-10-13 23:46:34 -07001093 optional int32 navigation_hidden = 10;
Tej Singha883b372018-02-15 11:30:01 -08001094
1095 // Overall orientation of the screen.
1096 // See: https://d.android.com/reference/android/content/res/Configuration.html#orientation
1097 optional int32 orientation = 11;
1098
1099 // The current height of the available screen space, in dp units.
1100 // See: https://d.android.com/reference/android/content/res/Configuration.html#screenHeightDp
Yangster-maca8a30442018-10-13 23:46:34 -07001101 optional int32 screen_height_dp = 12;
Tej Singha883b372018-02-15 11:30:01 -08001102
1103 // Bit mask of overall layout of the screen.
1104 // Contains information about screen size, whether the screen is wider/taller
1105 // than normal, whether the screen layout is right-tl-left or left-to-right,
1106 // and whether the screen has a rounded shape.
1107 // See: https://d.android.com/reference/android/content/res/Configuration.html#screenLayout
Yangster-maca8a30442018-10-13 23:46:34 -07001108 optional int32 screen_layout = 13;
Tej Singha883b372018-02-15 11:30:01 -08001109
1110 // Current width of the available screen space, in dp units.
1111 // See: https://d.android.com/reference/android/content/res/Configuration.html#screenWidthDp
Yangster-maca8a30442018-10-13 23:46:34 -07001112 optional int32 screen_width_dp = 14;
Tej Singha883b372018-02-15 11:30:01 -08001113
1114 // The smallest screen size an application will see in normal operation.
1115 // This is the smallest value of both screenWidthDp and screenHeightDp
1116 // in portrait and landscape.
1117 // See: https://d.android.com/reference/android/content/res/Configuration.html#smallestScreenWidthDp
Yangster-maca8a30442018-10-13 23:46:34 -07001118 optional int32 smallest_screen_width_dp = 15;
Tej Singha883b372018-02-15 11:30:01 -08001119
1120 // The type of touch screen attached to the device.
1121 // See: https://d.android.com/reference/android/content/res/Configuration.html#touchscreen
1122 optional int32 touchscreen = 16;
1123
1124 // Bit mask of the ui mode.
1125 // Contains information about the overall ui mode of the device.
1126 // Eg: NORMAL, DESK, CAR, TELEVISION, WATCH, VR_HEADSET
1127 // Also contains information about whether the device is in night mode.
1128 // See: https://d.android.com/reference/android/content/res/Configuration.html#uiMode
Yangster-maca8a30442018-10-13 23:46:34 -07001129 optional int32 ui_mode = 17;
Tej Singha883b372018-02-15 11:30:01 -08001130}
1131
Tej Singheee317b2018-03-07 19:28:05 -08001132
1133/**
1134 * Logs changes in the connection state of the mobile radio.
1135 *
1136 * Logged from:
1137 * frameworks/opt/telephony/src/java/com/android/internal/telephony/dataconnection/DataConnection.java
1138 */
1139message MobileConnectionStateChanged {
1140 // States are from the state machine DataConnection.java.
1141 enum State {
1142 UNKNOWN = 0;
1143 // The connection is inactive, or disconnected.
1144 INACTIVE = 1;
1145 // The connection is being activated, or connecting.
1146 ACTIVATING = 2;
1147 // The connection is active, or connected.
1148 ACTIVE = 3;
1149 // The connection is disconnecting.
1150 DISCONNECTING = 4;
1151 // The connection is disconnecting after creating a connection.
1152 DISCONNECTION_ERROR_CREATING_CONNECTION = 5;
1153 }
1154 optional State state = 1;
1155 // For multi-sim phones, this distinguishes between the sim cards.
1156 optional int32 sim_slot_index = 2;
1157 // Used to identify the connection. Starts at 0 and increments by 1 for
1158 // every new network created. Resets whenever the device reboots.
1159 optional int32 data_connection_id = 3;
1160 // A bitmask for the capabilities of this connection.
1161 // Eg. DEFAULT (internet), MMS, SUPL, DUN, IMS.
1162 // Default value (if we have no information): 0
1163 optional int64 capabilities = 4;
1164 // If this connection has internet.
1165 // This just checks if the DEFAULT bit of capabilities is set.
1166 optional bool has_internet = 5;
1167}
1168
1169/**
1170 * Logs changes in mobile radio technology. eg: LTE, EDGE, CDMA.
1171 *
1172 * Logged from:
1173 * frameworks/opt/telephony/src/java/com/android/internal/telephony/ServiceStateTracker.java
1174 */
1175message MobileRadioTechnologyChanged {
1176 optional android.telephony.NetworkTypeEnum state = 1;
1177 // For multi-sim phones, this distinguishes between the sim cards.
1178 optional int32 sim_slot_index = 2;
1179}
1180
Andrew Chantb56388b2018-03-22 21:07:33 -07001181/**
1182 * Logs the VID and PID of any connected USB devices.
1183 *
1184 * Notes if any Audio, HID (input buttons/mouse/keyboard), or Storage interfaces are present.
1185 *
1186 * Logged by Vendor.
1187 */
1188message UsbDeviceAttached {
1189 optional int32 vid = 1;
1190 optional int32 pid = 2;
1191 optional bool has_audio = 3;
1192 optional bool has_hid = 4;
1193 optional bool has_storage = 5;
1194}
1195
Tej Singheee317b2018-03-07 19:28:05 -08001196
Tej Singhdd7bd352018-02-09 19:33:15 -08001197/**
Tej Singh5d991e12018-03-09 19:48:11 -08001198 * Logs when Bluetooth is enabled and disabled.
1199 *
1200 * Logged from:
1201 * services/core/java/com/android/server/BluetoothManagerService.java
1202 */
1203message BluetoothEnabledStateChanged {
1204 repeated AttributionNode attribution_node = 1;
1205 // Whether or not bluetooth is enabled on the device.
1206 enum State {
1207 UNKNOWN = 0;
1208 ENABLED = 1;
1209 DISABLED = 2;
1210 }
1211 optional State state = 2;
1212 // The reason for being enabled/disabled.
1213 // Eg. Airplane mode, crash, application request.
1214 optional android.bluetooth.EnableDisableReasonEnum reason = 3;
1215 // If the reason is an application request, this will be the package name.
Yangster-maca8a30442018-10-13 23:46:34 -07001216 optional string pkg_name = 4;
Tej Singh5d991e12018-03-09 19:48:11 -08001217}
1218
1219/**
1220 * Logs when a Bluetooth device connects and disconnects.
1221 *
1222 * Logged from:
1223 * packages/apps/Bluetooth/src/com/android/bluetooth/btservice/AdapterProperties.java
1224 */
1225message BluetoothConnectionStateChanged {
1226 // The state of the connection.
1227 // Eg: CONNECTING, CONNECTED, DISCONNECTING, DISCONNECTED.
1228 optional android.bluetooth.ConnectionStateEnum state = 1;
1229 // An identifier that can be used to match connect and disconnect events.
1230 // Currently is last two bytes of a hash of a device level ID and
1231 // the mac address of the bluetooth device that is connected.
1232 optional int32 obfuscated_id = 2;
1233 // The profile that is connected. Eg. GATT, A2DP, HEADSET.
1234 // From android.bluetooth.BluetoothAdapter.java
1235 optional int32 bt_profile = 3;
1236}
1237
1238/**
Andrew Chant28d627e2018-02-22 15:17:05 -08001239 * Logs when something is plugged into or removed from the USB-C connector.
1240 *
1241 * Logged from:
1242 * Vendor USB HAL.
1243 */
1244message UsbConnectorStateChanged {
1245 enum State {
1246 DISCONNECTED = 0;
1247 CONNECTED = 1;
1248 }
1249 optional State state = 1;
1250}
1251
1252/**
1253 * Logs the reported speaker impedance.
1254 *
1255 * Logged from:
1256 * Vendor audio implementation.
1257 */
1258message SpeakerImpedanceReported {
1259 optional int32 speaker_location = 1;
1260 optional int32 impedance = 2;
1261}
1262
1263/**
1264 * Logs the report of a failed hardware.
1265 *
1266 * Logged from:
1267 * Vendor HALs.
1268 *
1269 */
1270message HardwareFailed {
1271 enum HardwareType {
1272 HARDWARE_FAILED_UNKNOWN = 0;
1273 HARDWARE_FAILED_MICROPHONE = 1;
1274 HARDWARE_FAILED_CODEC = 2;
1275 HARDWARE_FAILED_SPEAKER = 3;
1276 HARDWARE_FAILED_FINGERPRINT = 4;
1277 }
1278 optional HardwareType hardware_type = 1;
1279
1280 /* hardware_location allows vendors to differentiate between multiple instances of
1281 * the same hardware_type. The specific locations are vendor defined integers,
1282 * referring to board-specific numbering schemes.
1283 */
1284 optional int32 hardware_location = 2;
1285
1286 /* failure_code is specific to the HardwareType of the failed hardware.
1287 * It should use the enum values defined below.
1288 */
1289 enum MicrophoneFailureCode {
1290 MICROPHONE_FAILURE_COMPLETE = 0;
1291 }
1292 enum CodecFailureCode {
1293 CODEC_FAILURE_COMPLETE = 0;
1294 }
1295 enum SpeakerFailureCode {
1296 SPEAKER_FAILURE_COMPLETE = 0;
1297 SPEAKER_FAILURE_HIGH_Z = 1;
1298 SPEAKER_FAILURE_SHORT = 2;
1299 }
1300 enum FingerprintFailureCode {
1301 FINGERPRINT_FAILURE_COMPLETE = 0;
1302 FINGERPRINT_SENSOR_BROKEN = 1;
1303 FINGERPRINT_TOO_MANY_DEAD_PIXELS = 2;
1304 }
1305 optional int32 failure_code = 3;
1306}
1307
1308/**
1309 * Log an event when the device has been physically dropped.
1310 * Reported from the /vendor partition.
1311 */
1312message PhysicalDropDetected {
1313 // Confidence that the event was actually a drop, 0 -> 100
1314 optional int32 confidence_pctg = 1;
1315 // Peak acceleration of the drop, in 1/1000s of a g.
1316 optional int32 accel_peak_thousandths_g = 2;
Andrew Chantb56388b2018-03-22 21:07:33 -07001317 // Duration of freefall in ms
1318 optional int32 freefall_time_millis = 3;
Andrew Chant28d627e2018-02-22 15:17:05 -08001319}
1320
1321/**
1322 * Log bucketed battery charge cycles.
1323 *
1324 * Each bucket represents cycles of the battery past
1325 * a given charge point. For example, bucket 1 is the
1326 * lowest 1/8th of the battery, and bucket 8 is 100%.
1327 *
1328 * Logged from:
1329 * /sys/class/power_supply/bms/cycle_count, via Vendor.
1330 */
1331message ChargeCyclesReported {
1332 optional int32 cycle_bucket_1 = 1;
1333 optional int32 cycle_bucket_2 = 2;
1334 optional int32 cycle_bucket_3 = 3;
1335 optional int32 cycle_bucket_4 = 4;
1336 optional int32 cycle_bucket_5 = 5;
1337 optional int32 cycle_bucket_6 = 6;
1338 optional int32 cycle_bucket_7 = 7;
1339 optional int32 cycle_bucket_8 = 8;
1340}
1341
1342/**
Howard Roa46b6582018-09-18 16:45:02 -07001343 * Log battery health snapshot.
1344 *
1345 * Resistance, Voltage, Open Circuit Voltage, Temperature, and Charge Level
1346 * are snapshotted periodically over 24hrs.
1347 */
1348message BatteryHealthSnapshot {
1349 enum BatterySnapshotType {
1350 UNKNOWN = 0;
1351 MIN_TEMP = 1; // Snapshot at min batt temp over 24hrs.
1352 MAX_TEMP = 2; // Snapshot at max batt temp over 24hrs.
1353 MIN_RESISTANCE = 3; // Snapshot at min batt resistance over 24hrs.
1354 MAX_RESISTANCE = 4; // Snapshot at max batt resistance over 24hrs.
1355 MIN_VOLTAGE = 5; // Snapshot at min batt voltage over 24hrs.
1356 MAX_VOLTAGE = 6; // Snapshot at max batt voltage over 24hrs.
1357 MIN_CURRENT = 7; // Snapshot at min batt current over 24hrs.
1358 MAX_CURRENT = 8; // Snapshot at max batt current over 24hrs.
1359 MIN_BATT_LEVEL = 9; // Snapshot at min battery level (SoC) over 24hrs.
1360 MAX_BATT_LEVEL = 10; // Snapshot at max battery level (SoC) over 24hrs.
1361 AVG_RESISTANCE = 11; // Snapshot at average battery resistance over 24hrs.
1362 }
1363 optional BatterySnapshotType type = 1;
1364 // Temperature, in 1/10ths of degree C.
Yangster-maca8a30442018-10-13 23:46:34 -07001365 optional int32 temperature_deci_celsius = 2;
Howard Roa46b6582018-09-18 16:45:02 -07001366 // Voltage Battery Voltage, in microVolts.
1367 optional int32 voltage_micro_volt = 3;
1368 // Current Battery current, in microAmps.
1369 optional int32 current_micro_amps = 4;
1370 // OpenCircuitVoltage Battery Open Circuit Voltage, in microVolts.
1371 optional int32 open_circuit_micro_volt = 5;
1372 // Resistance Battery Resistance, in microOhms.
1373 optional int32 resistance_micro_ohm = 6;
1374 // Level Battery Level, as % of full.
1375 optional int32 level_percent = 7;
1376}
1377
1378/**
1379 * Log slow I/O operations on the primary storage.
1380 */
1381message SlowIo {
1382 // Classifications of IO Operations.
1383 enum IoOperation {
1384 UNKNOWN = 0;
1385 READ = 1;
1386 WRITE = 2;
1387 UNMAP = 3;
1388 SYNC = 4;
1389 }
1390 optional IoOperation operation = 1;
1391
1392 // The number of slow IO operations of this type over 24 hours.
1393 optional int32 count = 2;
1394}
1395
1396/**
1397 * Log battery caused shutdown with the last recorded voltage.
1398 */
1399message BatteryCausedShutdown {
1400 // The last recorded battery voltage prior to shutdown.
1401 optional int32 last_recorded_micro_volt = 1;
1402}
1403
1404/**
Tej Singhbb8554a2018-01-26 11:59:14 -08001405 * Logs the duration of a davey (jank of >=700ms) when it occurs
1406 *
1407 * Logged from:
1408 * frameworks/base/libs/hwui/JankTracker.cpp
1409 */
1410message DaveyOccurred {
David Chen77ef6712018-02-23 18:23:42 -08001411 // The UID that logged this atom.
Yao Chenc40a19d2018-03-15 16:48:25 -07001412 optional int32 uid = 1 [(is_uid) = true];
David Chen77ef6712018-02-23 18:23:42 -08001413
Tej Singhbb8554a2018-01-26 11:59:14 -08001414 // Amount of time it took to render the frame. Should be >=700ms.
David Chen77ef6712018-02-23 18:23:42 -08001415 optional int64 jank_duration_millis = 2;
Tej Singhbb8554a2018-01-26 11:59:14 -08001416}
1417
1418/**
Bookatze5885242017-10-24 20:10:31 -07001419 * Logs phone signal strength changes.
1420 *
1421 * Logged from:
David Chenc28b2bb2017-10-24 12:52:52 -07001422 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
Bookatze5885242017-10-24 20:10:31 -07001423 */
1424message PhoneSignalStrengthChanged {
Bookatz1a1b0462018-01-12 11:47:03 -08001425 // Signal strength, from frameworks/base/core/proto/android/telephony/enums.proto.
1426 optional android.telephony.SignalStrengthEnum signal_strength = 1;
David Chenc28b2bb2017-10-24 12:52:52 -07001427}
1428
Yangster4ccebea2018-10-09 17:09:02 -07001429
1430/**
1431 * Logs when the phone state, sim state or signal strength changes
1432 *
1433 * Logged from:
1434 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
1435 */
1436message PhoneServiceStateChanged {
1437 optional android.telephony.ServiceStateEnum state = 1;
1438 optional android.telephony.SimStateEnum sim_state = 2;
1439 optional android.telephony.SignalStrengthEnum signal_strength = 3;
1440}
1441
1442/**
1443 * Logs when the phone becomes on or off.
1444 *
1445 * Logged from:
1446 * frameworks/base/core/java/com/android/internal/os/TelephonyRegistry.java
1447 */
1448message PhoneStateChanged {
1449 enum State {
1450 OFF = 0;
1451 ON = 1;
1452 }
1453 optional State state = 1;
1454}
1455
Hyunyoung Songc6d6b772018-10-17 13:35:32 -07001456message LauncherUIChanged {
Yao Chen8c433862018-10-24 14:09:20 -07001457 optional android.stats.launcher.LauncherAction action = 1;
1458 optional android.stats.launcher.LauncherState src_state = 2;
1459 optional android.stats.launcher.LauncherState dst_state = 3;
1460 optional android.stats.launcher.LauncherExtension extension = 4 [(log_mode) = MODE_BYTES];
Hyunyoung Songc6d6b772018-10-17 13:35:32 -07001461 optional bool is_swipe_up_enabled = 5;
1462}
1463
David Chenc28b2bb2017-10-24 12:52:52 -07001464/**
Fan Zhang916c13b2018-10-16 22:49:45 -07001465 * Logs when Settings UI has changed.
1466 *
1467 * Logged from:
1468 * packages/apps/Settings
1469 */
1470message SettingsUIChanged {
1471 /**
Fan Zhang916c13b2018-10-16 22:49:45 -07001472 * Where this SettingsUIChange event comes from. For example, if
1473 * it's a PAGE_VISIBLE event, where the page is opened from.
1474 */
Fan Zhangf837b8e2018-10-23 12:38:30 -07001475 optional android.app.settings.PageId attribution = 1;
Fan Zhang916c13b2018-10-16 22:49:45 -07001476
1477 /**
1478 * What the UI action is.
1479 */
Fan Zhangf837b8e2018-10-23 12:38:30 -07001480 optional android.app.settings.Action action = 2;
Fan Zhang916c13b2018-10-16 22:49:45 -07001481
1482 /**
1483 * Where the action is happening
1484 */
Fan Zhangf837b8e2018-10-23 12:38:30 -07001485 optional android.app.settings.PageId pageId = 3;
Fan Zhang916c13b2018-10-16 22:49:45 -07001486
1487 /**
1488 * What preference changed in this event.
1489 */
1490 optional string changedPreferenceKey = 4;
1491
1492 /**
1493 * The new value of the changed preference.
1494 */
1495 optional int64 changedPreferenceIntValue = 5;
1496}
1497
1498/**
David Chenc28b2bb2017-10-24 12:52:52 -07001499 * Logs that a setting was updated.
1500 * Logged from:
David Chenbd789912018-03-16 17:19:55 -07001501 * frameworks/base/packages/SettingsProvider/src/com/android/providers/settings/SettingsState.java
David Chenc28b2bb2017-10-24 12:52:52 -07001502 * The tag and is_default allow resetting of settings to default values based on the specified
1503 * tag. See Settings#putString(ContentResolver, String, String, String, boolean) for more details.
1504 */
1505message SettingChanged {
1506 // The name of the setting.
1507 optional string setting = 1;
1508
1509 // The change being imposed on this setting. May represent a number, eg "3".
1510 optional string value = 2;
1511
1512 // The new value of this setting. For most settings, this is same as value. For some settings,
1513 // value is +X or -X where X represents an element in a set. For example, if the previous value
1514 // is A,B,C and value is -B, then new_value is A,C and prev_value is A,B,C.
1515 // The +/- feature is currently only used for location_providers_allowed.
1516 optional string new_value = 3;
1517
1518 // The previous value of this setting.
1519 optional string prev_value = 4;
1520
1521 // The tag used with the is_default for resetting sets of settings. This is generally null.
1522 optional string tag = 5;
1523
Bookatz90867622018-01-31 15:05:57 -08001524 // True if this setting with tag should be resettable.
1525 optional bool is_default = 6;
David Chenc28b2bb2017-10-24 12:52:52 -07001526
David Chenbd789912018-03-16 17:19:55 -07001527 // The associated user (for multi-user feature). Defined in android/os/UserHandle.java
David Chenc28b2bb2017-10-24 12:52:52 -07001528 optional int32 user = 7;
David Chenbd789912018-03-16 17:19:55 -07001529
1530 enum ChangeReason {
1531 UPDATED = 1; // Updated can be an insertion or an update.
1532 DELETED = 2;
1533 }
1534 optional ChangeReason reason = 8;
David Chenc28b2bb2017-10-24 12:52:52 -07001535}
Chenjie Yub3dda412017-10-24 13:41:59 -07001536
Chenjie Yu05013b32017-11-21 10:21:41 -08001537/**
Chenjie Yu3d4f6042017-10-27 15:39:34 -07001538 * Logs activity going to foreground or background
1539 *
1540 * Logged from:
1541 * frameworks/base/services/core/java/com/android/server/am/ActivityRecord.java
1542 */
1543message ActivityForegroundStateChanged {
Yao Chenc40a19d2018-03-15 16:48:25 -07001544 optional int32 uid = 1 [(is_uid) = true];
Yangster-mac20877162017-12-22 17:19:39 -08001545 optional string pkg_name = 2;
1546 optional string class_name = 3;
1547
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001548 enum State {
1549 BACKGROUND = 0;
1550 FOREGROUND = 1;
Chenjie Yu3d4f6042017-10-27 15:39:34 -07001551 }
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001552 optional State state = 4;
Chenjie Yu3d4f6042017-10-27 15:39:34 -07001553}
David Chenc8a43242017-10-17 16:23:28 -07001554
1555/**
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001556 * Logs when an app crashes.
David Chen9e3808c2017-11-20 17:25:34 -08001557 * Logged from:
1558 * frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
1559 */
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001560message AppCrashOccurred {
Yao Chenc40a19d2018-03-15 16:48:25 -07001561 optional int32 uid = 1 [(is_uid) = true];
David Chen9e3808c2017-11-20 17:25:34 -08001562
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001563 optional string event_type = 2;
David Chen9e3808c2017-11-20 17:25:34 -08001564
1565 // The name of the process.
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001566 // system_server if it is not by an app
David Chen9e3808c2017-11-20 17:25:34 -08001567 optional string process_name = 3;
1568
1569 // The pid if available. -1 means not available.
David Chen6e3e6cb2018-01-03 16:14:06 -08001570 optional sint32 pid = 4;
Chenjie Yuf17bf622018-04-02 14:22:19 -07001571
1572 optional string package_name = 5;
1573
1574 enum InstantApp {
1575 UNAVAILABLE = 0;
1576 FALSE = 1;
1577 TRUE = 2;
1578 }
1579 optional InstantApp is_instant_app = 6;
1580
1581 enum ForegroundState {
1582 UNKNOWN = 0;
1583 BACKGROUND = 1;
1584 FOREGROUND = 2;
1585 }
1586 optional ForegroundState foreground_state = 7;
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001587}
David Chen9e3808c2017-11-20 17:25:34 -08001588
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001589/**
1590 * Logs when a WTF (What a Terrible Failure) happened.
1591 * Logged from:
1592 * frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
1593 */
1594message WTFOccurred {
1595 optional int32 uid = 1 [(is_uid) = true];
David Chen9e3808c2017-11-20 17:25:34 -08001596
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001597 optional string tag = 2;
David Chen9e3808c2017-11-20 17:25:34 -08001598
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001599 // The name of the process.
1600 // system_server if it is not by an app
1601 optional string process_name = 3;
David Chen6e3e6cb2018-01-03 16:14:06 -08001602
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001603 // The pid if available. -1 means not available.
1604 optional sint32 pid = 4;
1605}
1606
1607/**
1608 * Logs when system server reports low memory.
1609 * Logged from:
1610 * frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
1611 */
1612message LowMemReported {
1613}
1614
1615/**
1616 * Logs when an app ANR (App Not Responding) occurs.
1617 * Logged from:
1618 * frameworks/base/services/core/java/com/android/server/am/AppErrors.java
1619 */
1620message ANROccurred {
1621 optional int32 uid = 1 [(is_uid) = true];
1622
1623 optional string process_name = 2;
1624
1625 optional string short_component_name = 3;
1626
1627 optional string reason = 4;
Chenjie Yuf17bf622018-04-02 14:22:19 -07001628
1629 enum InstantApp {
1630 UNAVAILABLE = 0;
1631 FALSE = 1;
1632 TRUE = 2;
1633 }
1634 optional InstantApp is_instant_app = 5;
1635
1636 enum ForegroundState {
1637 UNKNOWN = 0;
1638 BACKGROUND = 1;
1639 FOREGROUND = 2;
1640 }
1641 optional ForegroundState foreground_state = 6;
David Chen9e3808c2017-11-20 17:25:34 -08001642}
1643
Bookatza7020bd2018-08-28 16:29:35 -07001644/**
1645 * Logs when the vibrator state changes.
1646 * Logged from:
1647 * frameworks/base/services/core/java/com/android/server/VibratorService.java
1648 */
1649message VibratorStateChanged {
1650 repeated AttributionNode attribution_node = 1;
1651
1652 enum State {
1653 OFF = 0;
1654 ON = 1;
1655 }
1656 optional State state = 2;
1657
1658 // Duration (in milliseconds) requested to keep the vibrator on.
1659 // Only applicable for State == ON.
1660 optional int64 duration_millis = 3;
1661}
1662
David Chen0a368b22017-12-06 16:28:16 -08001663/*
1664 * Allows other apps to push events into statsd.
1665 * Logged from:
1666 * frameworks/base/core/java/android/util/StatsLog.java
1667 */
David Chen0b5c90c2018-01-25 16:51:49 -08001668message AppBreadcrumbReported {
David Chen0a368b22017-12-06 16:28:16 -08001669 // The uid of the application that sent this custom atom.
Yao Chenc40a19d2018-03-15 16:48:25 -07001670 optional int32 uid = 1 [(is_uid) = true];
David Chen0a368b22017-12-06 16:28:16 -08001671
1672 // An arbitrary label chosen by the developer. For Android P, the label should be in [0, 16).
1673 optional int32 label = 2;
1674
1675 // Allows applications to easily use a custom event as start/stop boundaries (ie, define custom
1676 // predicates for the metrics).
1677 enum State {
1678 UNKNOWN = 0;
1679 UNSPECIFIED = 1; // For events that are known to not represent START/STOP.
1680 STOP = 2;
1681 START = 3;
1682 }
1683 optional State state = 3;
1684}
1685
David Chen9e3808c2017-11-20 17:25:34 -08001686/**
Bookatz7948c872018-09-04 12:58:33 -07001687 * Logs the wall-clock time when a significant wall-clock time shift occurs.
1688 * For example, this could be due to the user manually changing the time.
1689 *
1690 * Logged from:
1691 * frameworks/base/services/core/java/com/android/server/AlarmManagerService.java
1692 */
1693message WallClockTimeShifted {
1694 // New wall-clock time in milliseconds, according to System.currentTimeMillis().
1695 optional int64 wall_clock_timestamp_millis = 1;
1696}
1697
1698/**
Bookatz8fcd09a2017-12-18 13:01:10 -08001699 * Logs when statsd detects an anomaly.
1700 *
1701 * Logged from:
1702 * frameworks/base/cmds/statsd/src/anomaly/AnomalyTracker.cpp
1703 */
1704message AnomalyDetected {
1705 // Uid that owns the config whose anomaly detection alert fired.
Yao Chenc40a19d2018-03-15 16:48:25 -07001706 optional int32 config_uid = 1 [(is_uid) = true];
Bookatz8fcd09a2017-12-18 13:01:10 -08001707
Yangster-mac94e197c2018-01-02 16:03:03 -08001708 // Id of the config whose anomaly detection alert fired.
1709 optional int64 config_id = 2;
Bookatz8fcd09a2017-12-18 13:01:10 -08001710
Yangster-mac94e197c2018-01-02 16:03:03 -08001711 // Id of the alert (i.e. name of the anomaly that was detected).
1712 optional int64 alert_id = 3;
Bookatz8fcd09a2017-12-18 13:01:10 -08001713}
1714
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001715message AppStartOccurred {
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001716 // The uid if available. -1 means not available.
Yao Chenc40a19d2018-03-15 16:48:25 -07001717 optional int32 uid = 1 [(is_uid) = true];
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001718
1719 // The app package name.
1720 optional string pkg_name = 2;
1721
1722 enum TransitionType {
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001723 UNKNOWN = 0;
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001724 WARM = 1;
1725 HOT = 2;
1726 COLD = 3;
1727 }
1728 // The transition type.
1729 optional TransitionType type = 3;
1730
1731 // The activity name.
1732 optional string activity_name = 4;
1733
1734 // The name of the calling app. Empty if not set.
1735 optional string calling_pkg_name = 5;
1736
1737 // Whether the app is an instant app.
1738 optional bool is_instant_app = 6;
1739
1740 // Device uptime when activity started.
David Chen0b5c90c2018-01-25 16:51:49 -08001741 optional int64 activity_start_millis = 7;
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001742
Bookatz80d11a02018-01-16 10:46:35 -08001743 optional android.app.AppTransitionReasonEnum reason = 8;
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001744
David Chen0b5c90c2018-01-25 16:51:49 -08001745 optional int32 transition_delay_millis = 9;
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001746 // -1 if not set.
David Chen0b5c90c2018-01-25 16:51:49 -08001747 optional int32 starting_window_delay_millis = 10;
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001748 // -1 if not set.
David Chen0b5c90c2018-01-25 16:51:49 -08001749 optional int32 bind_application_delay_millis = 11;
1750 optional int32 windows_drawn_delay_millis = 12;
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001751
1752 // Empty if not set.
1753 optional string launch_token = 13;
1754
Calin Juravle759fbda2018-02-20 19:52:30 +00001755 // The compiler filter used when when the package was optimized.
Calin Juravlea86783b2018-03-21 14:25:59 -07001756 optional int32 package_optimization_compilation_filter = 14;
Calin Juravle759fbda2018-02-20 19:52:30 +00001757
1758 // The reason why the package was optimized.
Calin Juravlea86783b2018-03-21 14:25:59 -07001759 optional int32 package_optimization_compilation_reason = 15;
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001760}
1761
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001762message AppStartCanceled {
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001763 // The uid if available. -1 means not available.
Yao Chenc40a19d2018-03-15 16:48:25 -07001764 optional int32 uid = 1 [(is_uid) = true];
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001765
1766 // The app package name.
1767 optional string pkg_name = 2;
1768
1769 enum TransitionType {
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001770 UNKNOWN = 0;
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001771 WARM = 1;
1772 HOT = 2;
1773 COLD = 3;
1774 }
1775 // The transition type.
1776 optional TransitionType type = 3;
1777
1778 // The activity name.
1779 optional string activity_name = 4;
1780}
1781
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001782message AppStartFullyDrawn {
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001783 // The uid if available. -1 means not available.
Yao Chenc40a19d2018-03-15 16:48:25 -07001784 optional int32 uid = 1 [(is_uid) = true];
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001785
1786 // The app package name.
1787 optional string pkg_name = 2;
1788
1789 enum TransitionType {
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001790 UNKNOWN = 0;
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001791 WITH_BUNDLE = 1;
1792 WITHOUT_BUNDLE = 2;
1793 }
1794 // The transition type.
1795 optional TransitionType type = 3;
1796
1797 // The activity name.
1798 optional string activity_name = 4;
1799
1800 optional bool transition_process_running = 5;
1801
1802 // App startup time (until call to Activity#reportFullyDrawn()).
David Chen0b5c90c2018-01-25 16:51:49 -08001803 optional int64 app_startup_time_millis = 6;
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001804}
1805
Bookatz8fcd09a2017-12-18 13:01:10 -08001806/**
Chenjie Yu52cacc62017-12-08 18:11:45 -08001807 * Logs a picture-in-picture action
1808 * Logged from:
1809 * frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
1810 * frameworks/base/services/core/java/com/android/server/am/ActivityStackSupervisor.java
1811 * frameworks/base/packages/SystemUI/src/com/android/systemui/pip/phone/PipTouchHandler.java
1812 */
1813message PictureInPictureStateChanged {
Chenjie Yuae9fdf042018-02-15 10:19:32 -08001814 // -1 if it is not available
Yao Chenc40a19d2018-03-15 16:48:25 -07001815 optional int32 uid = 1 [(is_uid) = true];
Chenjie Yu52cacc62017-12-08 18:11:45 -08001816
Chenjie Yuae9fdf042018-02-15 10:19:32 -08001817 optional string short_name = 2;
Chenjie Yu52cacc62017-12-08 18:11:45 -08001818
Chenjie Yu52cacc62017-12-08 18:11:45 -08001819 enum State {
1820 ENTERED = 1;
1821 EXPANDED_TO_FULL_SCREEN = 2;
1822 MINIMIZED = 3;
1823 DISMISSED = 4;
1824 }
Chenjie Yuae9fdf042018-02-15 10:19:32 -08001825 optional State state = 3;
Chenjie Yu52cacc62017-12-08 18:11:45 -08001826}
1827
1828/**
Chenjie Yue8904192017-12-08 19:12:57 -08001829 * Logs overlay action
1830 * Logged from:
1831 * services/core/java/com/android/server/wm/Session.java
1832 */
1833message OverlayStateChanged {
Yao Chenc40a19d2018-03-15 16:48:25 -07001834 optional int32 uid = 1 [(is_uid) = true];
Chenjie Yue8904192017-12-08 19:12:57 -08001835
1836 optional string package_name = 2;
1837
1838 optional bool using_alert_window = 3;
1839
1840 enum State {
1841 ENTERED = 1;
1842 EXITED = 2;
1843 }
1844 optional State state = 4;
1845}
1846
Chenjie Yuccfe6452018-01-30 11:33:21 -08001847/*
1848 * Logs foreground service starts and stops.
1849 * Note that this is not when a service starts or stops, but when it is
1850 * considered foreground.
1851 * Logged from
1852 * //frameworks/base/services/core/java/com/android/server/am/ActiveServices.java
1853 */
1854message ForegroundServiceStateChanged {
Yao Chenc40a19d2018-03-15 16:48:25 -07001855 optional int32 uid = 1 [(is_uid) = true];
Chenjie Yuccfe6452018-01-30 11:33:21 -08001856 // package_name + "/" + class_name
1857 optional string short_name = 2;
1858
1859 enum State {
1860 ENTER = 1;
1861 EXIT = 2;
1862 }
1863 optional State state = 3;
1864}
1865
Chenjie Yue8904192017-12-08 19:12:57 -08001866/**
Chenjie Yubbcbc602018-02-05 16:51:52 -08001867 * Logs creation or removal of an isolated uid. Isolated uid's are temporary uid's to sandbox risky
1868 * behavior in its own uid. However, the metrics of these isolated uid's almost always should be
1869 * attributed back to the parent (host) uid. One example is Chrome.
1870 *
1871 * Logged from:
1872 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
1873 */
1874message IsolatedUidChanged {
1875 // The host UID. Generally, we should attribute metrics from the isolated uid to the host uid.
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001876 // NOTE: DO NOT annotate uid field in this atom. This atom is specially handled in statsd.
Bookatz3c648862018-05-25 13:32:43 -07001877 // This field is ignored when event == REMOVED.
Chenjie Yubbcbc602018-02-05 16:51:52 -08001878 optional int32 parent_uid = 1;
1879
1880 optional int32 isolated_uid = 2;
1881
1882 // We expect an isolated uid to be removed before if it's used for another parent uid.
1883 enum Event {
1884 REMOVED = 0;
1885 CREATED = 1;
1886 }
1887 optional Event event = 3;
1888}
1889
1890/*
1891 * Logs the reception of an incoming network packet causing the main system to wake up for
1892 * processing that packet. These events are notified by the kernel via Netlink NFLOG to Netd
1893 * and processed by WakeupController.cpp.
1894 */
1895message PacketWakeupOccurred {
1896 // The uid owning the socket into which the packet was delivered, or -1 if the packet was
1897 // delivered nowhere.
Yao Chenc40a19d2018-03-15 16:48:25 -07001898 optional int32 uid = 1 [(is_uid) = true];
Chenjie Yubbcbc602018-02-05 16:51:52 -08001899 // The interface name on which the packet was received.
1900 optional string iface = 2;
1901 // The ethertype value of the packet.
1902 optional int32 ethertype = 3;
1903 // String representation of the destination MAC address of the packet.
1904 optional string destination_hardware_address = 4;
1905 // String representation of the source address of the packet if this was an IP packet.
1906 optional string source_ip = 5;
1907 // String representation of the destination address of the packet if this was an IP packet.
1908 optional string destination_ip = 6;
1909 // The value of the protocol field if this was an IPv4 packet or the value of the Next Header
1910 // field if this was an IPv6 packet. The range of possible values is the same for both IP
1911 // families.
1912 optional int32 ip_next_header = 7;
1913 // The source port if this was a TCP or UDP packet.
1914 optional int32 source_port = 8;
1915 // The destination port if this was a TCP or UDP packet.
1916 optional int32 destination_port = 9;
1917}
1918
1919/*
1920 * Logs the memory stats for an app on startup.
1921 * Logged from:
1922 * frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
1923 */
1924message AppStartMemoryStateCaptured {
1925 // The uid if available. -1 means not available.
Yao Chenc40a19d2018-03-15 16:48:25 -07001926 optional int32 uid = 1 [(is_uid) = true];
Chenjie Yubbcbc602018-02-05 16:51:52 -08001927
1928 // The process name.
1929 optional string process_name = 2;
1930
1931 // The activity name.
1932 optional string activity_name = 3;
1933
1934 // # of page-faults
Yangster-maca8a30442018-10-13 23:46:34 -07001935 optional int64 page_fault = 4;
Chenjie Yubbcbc602018-02-05 16:51:52 -08001936
1937 // # of major page-faults
Yangster-maca8a30442018-10-13 23:46:34 -07001938 optional int64 page_major_fault = 5;
Chenjie Yubbcbc602018-02-05 16:51:52 -08001939
1940 // RSS
1941 optional int64 rss_in_bytes = 6;
1942
1943 // CACHE
1944 optional int64 cache_in_bytes = 7;
1945
1946 // SWAP
1947 optional int64 swap_in_bytes = 8;
1948}
1949
1950/*
1951 * Logs the change in Low Memory Killer Daemon (LMKD) state which is used as start/stop boundaries
1952 * for LMK event.
1953 * Logged from:
1954 * system/core/lmkd/lmkd.c
1955 */
1956message LmkStateChanged {
1957 enum State {
1958 UNKNOWN = 0;
1959 START = 1;
1960 STOP = 2;
1961 }
1962 optional State state = 1;
1963}
1964
1965/*
1966 * Logs the event when Low Memory Killer Daemon (LMKD) kills a process to reduce memory pressure.
1967 * Logged from:
1968 * system/core/lmkd/lmkd.c
1969 */
1970message LmkKillOccurred {
1971 // The uid if available. -1 means not available.
Yao Chenc40a19d2018-03-15 16:48:25 -07001972 optional int32 uid = 1 [(is_uid) = true];
Chenjie Yubbcbc602018-02-05 16:51:52 -08001973
1974 // The process name.
1975 optional string process_name = 2;
1976
1977 // oom adj score.
Yangster-maca8a30442018-10-13 23:46:34 -07001978 optional int32 oom_adj_score = 3;
Chenjie Yubbcbc602018-02-05 16:51:52 -08001979
1980 // # of page-faults
Yangster-maca8a30442018-10-13 23:46:34 -07001981 optional int64 page_fault = 4;
Chenjie Yubbcbc602018-02-05 16:51:52 -08001982
1983 // # of major page-faults
Yangster-maca8a30442018-10-13 23:46:34 -07001984 optional int64 page_major_fault = 5;
Chenjie Yubbcbc602018-02-05 16:51:52 -08001985
1986 // RSS
1987 optional int64 rss_in_bytes = 6;
1988
1989 // CACHE
1990 optional int64 cache_in_bytes = 7;
1991
1992 // SWAP
1993 optional int64 swap_in_bytes = 8;
1994}
1995
Rajeev Kumar51b54602018-03-01 12:18:26 -08001996/*
1997 * Logs when the ActivityManagerService detects that an app died.
1998 *
1999 * Logged from:
2000 * frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
2001 */
2002message AppDied {
2003 // timestamp(elapsedRealtime) of record creation
Yangster-macb6b77c62018-10-12 19:33:24 -07002004 optional uint64 timestamp_millis = 1 [(state_field_option).option = EXCLUSIVE];
Rajeev Kumar51b54602018-03-01 12:18:26 -08002005}
2006
Howard Ro21a039c2018-08-06 14:55:47 -07002007/**
2008 * An atom for generic metrics logging. Available from Android Q.
2009 */
2010message GenericAtom {
2011 // The uid of the application that sent this custom atom.
2012 optional int32 uid = 1 [(is_uid) = true];
2013
2014 // An event_id indicates the type of event.
Howard Ro9a862de2018-10-11 16:03:33 -07002015 optional android.stats.EventType event_id = 2;
Howard Ro21a039c2018-08-06 14:55:47 -07002016}
2017
Tej Singhd6d6d772018-09-05 17:41:25 -07002018/**
2019 * Logs when a fingerprint acquire event occurs.
2020 *
2021 * Logged from:
2022 * frameworks/base/services/core/java/com/android/server/biometrics/fingerprint/FingerprintService.java
2023 */
2024message FingerprintAcquired {
2025 // The associated user. Eg: 0 for owners, 10+ for others.
2026 // Defined in android/os/UserHandle.java
2027 optional int32 user = 1;
2028 // If this acquire is for a crypto fingerprint.
2029 // e.g. Secure purchases, unlock password storage.
2030 optional bool is_crypto = 2;
2031}
2032
2033/**
2034 * Logs when a fingerprint authentication event occurs.
2035 *
2036 * Logged from:
2037 * frameworks/base/services/core/java/com/android/server/biometrics/fingerprint/FingerprintService.java
2038 */
2039message FingerprintAuthenticated {
2040 // The associated user. Eg: 0 for owners, 10+ for others.
2041 // Defined in android/os/UserHandle.java
2042 optional int32 user = 1;
2043 // If this authentication is for a crypto fingerprint.
2044 // e.g. Secure purchases, unlock password storage.
2045 optional bool is_crypto = 2;
2046 // Whether or not this authentication was successful.
2047 optional bool is_authenticated = 3;
2048}
2049
2050/**
2051 * Logs when a fingerprint error occurs.
2052 *
2053 * Logged from:
2054 * frameworks/base/services/core/java/com/android/server/biometrics/fingerprint/FingerprintService.java
2055 */
2056message FingerprintErrorOccurred {
2057 // The associated user. Eg: 0 for owners, 10+ for others.
2058 // Defined in android/os/UserHandle.java
2059 optional int32 user = 1;
2060 // If this error is for a crypto fingerprint.
2061 // e.g. Secure purchases, unlock password storage.
2062 optional bool is_crypto = 2;
2063
2064 enum Error {
2065 UNKNOWN = 0;
2066 LOCKOUT = 1;
2067 PERMANENT_LOCKOUT = 2;
2068 }
2069 // The type of error.
2070 optional Error error = 3;
2071}
Howard Ro688ae182018-09-25 00:09:36 -07002072
2073message Notification {
2074
2075 // Type of notification event.
2076 enum Type {
2077 TYPE_UNKNOWN = 0;
2078 // Notification became visible to the user.
2079 TYPE_OPEN = 1;
2080 // Notification became hidden.
2081 TYPE_CLOSE = 2;
2082 // Notification switched to detail mode.
2083 TYPE_DETAIL = 3;
2084 // Notification was clicked.
2085 TYPE_ACTION = 4;
2086 // Notification was dismissed.
2087 TYPE_DISMISS = 5;
2088 // Notification switched to summary mode. The enum value of 14 is to
2089 // match that of metrics_constants.
2090 TYPE_COLLAPSE = 14;
2091 }
2092 optional Type type = 1;
2093
2094 // Package name associated with the notification.
2095 optional string package_name = 2;
2096
2097 // Tag associated with notification.
2098 optional string tag = 3;
2099
2100 // Application-supplied ID associated with the notification.
2101 optional int32 id = 4;
2102
2103 // Index of notification in the notification panel.
2104 optional int32 shade_index = 5;
2105
2106 // The number of notifications in the notification panel.
2107 optional int32 shade_count = 6;
2108
2109 // Importance for the notification.
2110 optional int32 importance = 7;
2111
2112 // ID for the notification channel.
Howard Ro183c2bd2018-10-18 13:52:10 -07002113 optional string channel_id = 8;
Howard Ro688ae182018-09-25 00:09:36 -07002114
2115 // Importance for the notification channel.
2116 optional int32 channel_importance = 9;
2117
Howard Ro183c2bd2018-10-18 13:52:10 -07002118 // Application-supplied ID associated with the notifications group.
2119 optional string group_id = 10;
2120
Howard Ro688ae182018-09-25 00:09:36 -07002121 // Whether notification was a group summary.
Howard Ro183c2bd2018-10-18 13:52:10 -07002122 optional bool group_summary = 11;
Howard Ro688ae182018-09-25 00:09:36 -07002123
Howard Ro183c2bd2018-10-18 13:52:10 -07002124 // Reason for dismissal of a notification. This field is only meaningful for
2125 // TYPE_DISMISS events.
2126 optional int32 dismiss_reason = 12;
Howard Ro688ae182018-09-25 00:09:36 -07002127
Howard Ro183c2bd2018-10-18 13:52:10 -07002128 // The first post time of notification, stable across updates.
2129 optional int64 creation_millis = 13;
Howard Ro688ae182018-09-25 00:09:36 -07002130
Howard Ro183c2bd2018-10-18 13:52:10 -07002131 // The most recent interruption time, or the creation time if no updates.
2132 // Differs from update_millis because updates are filtered based on whether
2133 // they actually interrupted the user.
2134 optional int64 interruption_millis = 14;
Howard Ro688ae182018-09-25 00:09:36 -07002135
Howard Ro183c2bd2018-10-18 13:52:10 -07002136 // The most recent update time, or the creation time if no updates.
2137 optional int64 update_millis = 15;
2138
2139 // The most recent visibility event.
2140 optional int64 visible_millis = 16;
Howard Ro688ae182018-09-25 00:09:36 -07002141}
2142
Chenjie Yuae9dfac2018-10-25 16:06:56 -07002143/*
2144 * Logs when a connection becomes available and lost.
2145 * Logged in StatsCompanionService.java
2146 */
2147message ConnectivityStateChanged {
2148 // Id of the network.
2149 optional int32 net_id = 1;
2150
2151 enum State {
2152 UNKNOWN = 0;
2153 CONNECTED = 1;
2154 DISCONNECTED = 2;
2155 }
2156 // Connected state of a network.
2157 optional State state = 2;
2158}
Howard Ro688ae182018-09-25 00:09:36 -07002159
Chenjie Yubbcbc602018-02-05 16:51:52 -08002160//////////////////////////////////////////////////////////////////////
2161// Pulled atoms below this line //
2162//////////////////////////////////////////////////////////////////////
2163
2164/**
David Chenc8a43242017-10-17 16:23:28 -07002165 * Pulls bytes transferred via wifi (Sum of foreground and background usage).
2166 *
2167 * Pulled from:
2168 * StatsCompanionService (using BatteryStats to get which interfaces are wifi)
2169 */
Chenjie Yu31d14d72017-12-12 17:54:33 -08002170message WifiBytesTransfer {
Yao Chenc40a19d2018-03-15 16:48:25 -07002171 optional int32 uid = 1 [(is_uid) = true];
David Chenc8a43242017-10-17 16:23:28 -07002172
2173 optional int64 rx_bytes = 2;
2174
2175 optional int64 rx_packets = 3;
2176
2177 optional int64 tx_bytes = 4;
2178
2179 optional int64 tx_packets = 5;
2180}
2181
2182/**
2183 * Pulls bytes transferred via wifi (separated by foreground and background usage).
2184 *
2185 * Pulled from:
2186 * StatsCompanionService (using BatteryStats to get which interfaces are wifi)
2187 */
Chenjie Yu31d14d72017-12-12 17:54:33 -08002188message WifiBytesTransferByFgBg {
Yao Chenc40a19d2018-03-15 16:48:25 -07002189 optional int32 uid = 1 [(is_uid) = true];
David Chenc8a43242017-10-17 16:23:28 -07002190
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08002191 // 1 denotes foreground and 0 denotes background. This is called Set in NetworkStats.
2192 optional bool is_foreground = 2;
David Chenc8a43242017-10-17 16:23:28 -07002193
2194 optional int64 rx_bytes = 3;
2195
2196 optional int64 rx_packets = 4;
2197
2198 optional int64 tx_bytes = 5;
2199
2200 optional int64 tx_packets = 6;
2201}
2202
2203/**
2204 * Pulls bytes transferred via mobile networks (Sum of foreground and background usage).
2205 *
2206 * Pulled from:
2207 * StatsCompanionService (using BatteryStats to get which interfaces are mobile data)
2208 */
Chenjie Yu31d14d72017-12-12 17:54:33 -08002209message MobileBytesTransfer {
Yao Chenc40a19d2018-03-15 16:48:25 -07002210 optional int32 uid = 1 [(is_uid) = true];
David Chenc8a43242017-10-17 16:23:28 -07002211
2212 optional int64 rx_bytes = 2;
2213
2214 optional int64 rx_packets = 3;
2215
2216 optional int64 tx_bytes = 4;
2217
2218 optional int64 tx_packets = 5;
2219}
2220
2221/**
2222 * Pulls bytes transferred via mobile networks (separated by foreground and background usage).
2223 *
2224 * Pulled from:
2225 * StatsCompanionService (using BatteryStats to get which interfaces are mobile data)
2226 */
Chenjie Yu31d14d72017-12-12 17:54:33 -08002227message MobileBytesTransferByFgBg {
Yao Chenc40a19d2018-03-15 16:48:25 -07002228 optional int32 uid = 1 [(is_uid) = true];
David Chenc8a43242017-10-17 16:23:28 -07002229
Yao Chenc40a19d2018-03-15 16:48:25 -07002230 // 1 denotes foreground and 0 denotes background. This is called Set in
2231 // NetworkStats.
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08002232 optional bool is_foreground = 2;
David Chenc8a43242017-10-17 16:23:28 -07002233
2234 optional int64 rx_bytes = 3;
2235
2236 optional int64 rx_packets = 4;
2237
2238 optional int64 tx_bytes = 5;
2239
2240 optional int64 tx_packets = 6;
2241}
2242
2243/**
Chenjie Yu9d7720b2018-01-24 10:34:48 -08002244 * Pulls bytes transferred via bluetooth. It is pulled from Bluetooth controller.
2245 *
2246 * Pulled from:
2247 * StatsCompanionService
2248 */
2249message BluetoothBytesTransfer {
Yao Chenc40a19d2018-03-15 16:48:25 -07002250 optional int32 uid = 1 [(is_uid) = true];
Chenjie Yu9d7720b2018-01-24 10:34:48 -08002251
2252 optional int64 rx_bytes = 2;
2253
2254 optional int64 tx_bytes = 3;
2255}
2256
2257/**
David Chenc8a43242017-10-17 16:23:28 -07002258 * Pulls the kernel wakelock durations. This atom is adapted from
2259 * android/internal/os/KernelWakelockStats.java
2260 *
2261 * Pulled from:
2262 * StatsCompanionService using KernelWakelockReader.
2263 */
Chenjie Yu31d14d72017-12-12 17:54:33 -08002264message KernelWakelock {
David Chenc8a43242017-10-17 16:23:28 -07002265 optional string name = 1;
2266
2267 optional int32 count = 2;
2268
2269 optional int32 version = 3;
2270
Yangster-maca8a30442018-10-13 23:46:34 -07002271 optional int64 time_micros = 4;
David Chenc8a43242017-10-17 16:23:28 -07002272}
Chenjie Yu5305e1d2017-10-31 13:49:36 -07002273
Chenjie Yu05013b32017-11-21 10:21:41 -08002274/**
Chenjie Yuc8b7f222018-01-11 23:25:57 -08002275 * Pulls low power state information. This includes platform and subsystem sleep state information,
2276 * PowerStatePlatformSleepState, PowerStateVoter or PowerStateSubsystemSleepState as defined in
Chenjie Yu5305e1d2017-10-31 13:49:36 -07002277 * hardware/interfaces/power/1.0/types.hal
Chenjie Yu5305e1d2017-10-31 13:49:36 -07002278 * hardware/interfaces/power/1.1/types.hal
2279 */
Chenjie Yu31d14d72017-12-12 17:54:33 -08002280message SubsystemSleepState {
Chenjie Yubbcbc602018-02-05 16:51:52 -08002281 // Subsystem name
2282 optional string subsystem_name = 1;
2283 // For PlatformLowPowerStats (hal 1.0), this is the voter name, which could be empty.
2284 // For SubsystemLowPowerStats (hal 1.1), this is the sleep state name.
2285 optional string subname = 2;
Chenjie Yuc8b7f222018-01-11 23:25:57 -08002286 // The number of times it entered, or voted for entering the sleep state
Chenjie Yubbcbc602018-02-05 16:51:52 -08002287 optional uint64 count = 3;
Chenjie Yuc8b7f222018-01-11 23:25:57 -08002288 // The length of time spent in, or spent voting for, the sleep state
David Chen0b5c90c2018-01-25 16:51:49 -08002289 optional uint64 time_millis = 4;
David Chen21582962017-11-01 17:32:46 -07002290}
Chenjie Yu7f8def92017-11-03 09:33:15 -07002291
Chenjie Yu05013b32017-11-21 10:21:41 -08002292/**
Bookatz92da2832018-11-01 18:10:03 -07002293 * Pulls on-device power measurement information.
2294 * Data defined by hardware/interfaces/power/stats/1.0/types.hal.
2295 * Pulled from:
2296 * frameworks/base/cmds/statsd/src/external/PowerStatsPuller.cpp
2297 */
2298message OnDevicePowerMeasurement {
2299 // Name of the subsystem (to which the rail belongs).
2300 optional string subsystem_name = 1;
2301
2302 // Rail name. The rail lies within the subsystem.
2303 optional string rail_name = 2;
2304
2305 // Time (in ms since boot) at which the rail energy value was measured.
2306 // This may differ slightly from the time that statsd logs this information.
2307 optional uint64 measurement_timestamp_millis = 3;
2308
2309 // Accumulated energy used via the rail since device boot in uWs.
2310 optional uint64 energy_microwatt_secs = 4;
2311}
2312
2313/**
Chenjie Yu7f8def92017-11-03 09:33:15 -07002314 * Pulls Cpu time per frequency.
Chenjie Yu1ee9b742018-01-10 16:02:57 -08002315 * Pulls the time the cpu spend on the frequency index. Frequency index
2316 * starts from highest to lowest. The value should be monotonically
2317 * increasing since boot. However, if there is a cpu
2318 * hotplug event, the value would be reset as well.
Chenjie Yu7f8def92017-11-03 09:33:15 -07002319 */
Chenjie Yu31d14d72017-12-12 17:54:33 -08002320message CpuTimePerFreq {
Chenjie Yu7f8def92017-11-03 09:33:15 -07002321 optional uint32 cluster = 1;
2322 optional uint32 freq_index = 2;
David Chen0b5c90c2018-01-25 16:51:49 -08002323 optional uint64 time_millis = 3;
Chenjie Yu7f8def92017-11-03 09:33:15 -07002324}
Chenjie Yue33bc3b2017-11-06 17:56:44 -08002325
Chenjie Yu05013b32017-11-21 10:21:41 -08002326/**
Chenjie Yue33bc3b2017-11-06 17:56:44 -08002327 * Pulls Cpu Time Per Uid.
2328 * Note that isolated process uid time should be attributed to host uids.
2329 */
Chenjie Yu31d14d72017-12-12 17:54:33 -08002330message CpuTimePerUid {
Yao Chenc40a19d2018-03-15 16:48:25 -07002331 optional int32 uid = 1 [(is_uid) = true];
David Chen0b5c90c2018-01-25 16:51:49 -08002332 optional uint64 user_time_millis = 2;
2333 optional uint64 sys_time_millis = 3;
Chenjie Yue33bc3b2017-11-06 17:56:44 -08002334}
2335
2336/**
2337 * Pulls Cpu Time Per Uid per frequency.
2338 * Note that isolated process uid time should be attributed to host uids.
2339 * For each uid, we order the time by descending frequencies.
2340 */
Chenjie Yu31d14d72017-12-12 17:54:33 -08002341message CpuTimePerUidFreq {
Yao Chenc40a19d2018-03-15 16:48:25 -07002342 optional int32 uid = 1 [(is_uid) = true];
Chenjie Yuec676612018-03-07 09:19:17 -08002343 optional uint32 freq_index = 2;
David Chen0b5c90c2018-01-25 16:51:49 -08002344 optional uint64 time_millis = 3;
Chenjie Yue33bc3b2017-11-06 17:56:44 -08002345}
Hugo Benichi884970e2017-11-14 22:42:46 +09002346
Chenjie Yu05013b32017-11-21 10:21:41 -08002347/**
2348 * Pulls Wifi Controller Activity Energy Info
2349 */
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08002350message WifiActivityInfo {
Chenjie Yu05013b32017-11-21 10:21:41 -08002351 // timestamp(wall clock) of record creation
David Chen0b5c90c2018-01-25 16:51:49 -08002352 optional uint64 timestamp_millis = 1;
Chenjie Yu05013b32017-11-21 10:21:41 -08002353 // stack reported state
2354 // TODO: replace this with proto enum
2355 optional int32 stack_state = 2;
Yangster-maca8a30442018-10-13 23:46:34 -07002356 // tx time in millis
David Chen0b5c90c2018-01-25 16:51:49 -08002357 optional uint64 controller_tx_time_millis = 3;
Yangster-maca8a30442018-10-13 23:46:34 -07002358 // rx time in millis
David Chen0b5c90c2018-01-25 16:51:49 -08002359 optional uint64 controller_rx_time_millis = 4;
Yangster-maca8a30442018-10-13 23:46:34 -07002360 // idle time in millis
David Chen0b5c90c2018-01-25 16:51:49 -08002361 optional uint64 controller_idle_time_millis = 5;
Chenjie Yu05013b32017-11-21 10:21:41 -08002362 // product of current(mA), voltage(V) and time(ms)
2363 optional uint64 controller_energy_used = 6;
2364}
2365
2366/**
2367 * Pulls Modem Activity Energy Info
2368 */
Chenjie Yu31d14d72017-12-12 17:54:33 -08002369message ModemActivityInfo {
Chenjie Yu05013b32017-11-21 10:21:41 -08002370 // timestamp(wall clock) of record creation
David Chen0b5c90c2018-01-25 16:51:49 -08002371 optional uint64 timestamp_millis = 1;
Yangster-maca8a30442018-10-13 23:46:34 -07002372 // sleep time in millis.
David Chen0b5c90c2018-01-25 16:51:49 -08002373 optional uint64 sleep_time_millis = 2;
Yangster-maca8a30442018-10-13 23:46:34 -07002374 // idle time in millis
David Chen0b5c90c2018-01-25 16:51:49 -08002375 optional uint64 controller_idle_time_millis = 3;
Chenjie Yu05013b32017-11-21 10:21:41 -08002376 /**
2377 * Tx power index
2378 * index 0 = tx_power < 0dBm
2379 * index 1 = 0dBm < tx_power < 5dBm
2380 * index 2 = 5dBm < tx_power < 15dBm
2381 * index 3 = 15dBm < tx_power < 20dBm
2382 * index 4 = tx_power > 20dBm
2383 */
2384 // tx time in ms at power level 0
David Chen0b5c90c2018-01-25 16:51:49 -08002385 optional uint64 controller_tx_time_pl0_millis = 4;
Chenjie Yu05013b32017-11-21 10:21:41 -08002386 // tx time in ms at power level 1
David Chen0b5c90c2018-01-25 16:51:49 -08002387 optional uint64 controller_tx_time_pl1_millis = 5;
Chenjie Yu05013b32017-11-21 10:21:41 -08002388 // tx time in ms at power level 2
David Chen0b5c90c2018-01-25 16:51:49 -08002389 optional uint64 controller_tx_time_pl2_millis = 6;
Chenjie Yu05013b32017-11-21 10:21:41 -08002390 // tx time in ms at power level 3
David Chen0b5c90c2018-01-25 16:51:49 -08002391 optional uint64 controller_tx_time_pl3_millis = 7;
Chenjie Yu05013b32017-11-21 10:21:41 -08002392 // tx time in ms at power level 4
David Chen0b5c90c2018-01-25 16:51:49 -08002393 optional uint64 controller_tx_time_pl4_millis = 8;
Chenjie Yu05013b32017-11-21 10:21:41 -08002394 // rx time in ms at power level 5
David Chen0b5c90c2018-01-25 16:51:49 -08002395 optional uint64 controller_rx_time_millis = 9;
Chenjie Yu05013b32017-11-21 10:21:41 -08002396 // product of current(mA), voltage(V) and time(ms)
2397 optional uint64 energy_used = 10;
Joe Onorato62c220b2017-11-18 20:32:56 -08002398}
Rajeev Kumar508a9bf2018-01-18 15:49:11 -08002399
Chenjie Yu9d7720b2018-01-24 10:34:48 -08002400/**
2401 * Pulls Bluetooth Activity Energy Info
2402 * Note: BluetoothBytesTransfer is pulled at the same time from the controller.
2403 */
2404message BluetoothActivityInfo {
2405 // timestamp(wall clock) of record creation
David Chen0b5c90c2018-01-25 16:51:49 -08002406 optional uint64 timestamp_millis = 1;
Chenjie Yu9d7720b2018-01-24 10:34:48 -08002407 // bluetooth stack state
2408 optional int32 bluetooth_stack_state = 2;
Yangster-maca8a30442018-10-13 23:46:34 -07002409 // tx time in millis
David Chen0b5c90c2018-01-25 16:51:49 -08002410 optional uint64 controller_tx_time_millis = 3;
Yangster-maca8a30442018-10-13 23:46:34 -07002411 // rx time in millis
David Chen0b5c90c2018-01-25 16:51:49 -08002412 optional uint64 controller_rx_time_millis = 4;
Yangster-maca8a30442018-10-13 23:46:34 -07002413 // idle time in millis
David Chen0b5c90c2018-01-25 16:51:49 -08002414 optional uint64 controller_idle_time_millis = 5;
Chenjie Yu9d7720b2018-01-24 10:34:48 -08002415 // product of current(mA), voltage(V) and time(ms)
2416 optional uint64 energy_used = 6;
2417}
2418
Rajeev Kumar508a9bf2018-01-18 15:49:11 -08002419/*
Rajeev Kumar8a9fa052018-01-25 19:03:09 -08002420 * Logs the memory stats for a process.
2421 */
2422message ProcessMemoryState {
2423 // The uid if available. -1 means not available.
Yao Chenc40a19d2018-03-15 16:48:25 -07002424 optional int32 uid = 1 [(is_uid) = true];
Rajeev Kumar8a9fa052018-01-25 19:03:09 -08002425
2426 // The process name.
2427 optional string process_name = 2;
2428
2429 // oom adj score.
Yangster-maca8a30442018-10-13 23:46:34 -07002430 optional int32 oom_adj_score = 3;
Rajeev Kumar8a9fa052018-01-25 19:03:09 -08002431
2432 // # of page-faults
Yangster-maca8a30442018-10-13 23:46:34 -07002433 optional int64 page_fault = 4;
Rajeev Kumar8a9fa052018-01-25 19:03:09 -08002434
2435 // # of major page-faults
Yangster-maca8a30442018-10-13 23:46:34 -07002436 optional int64 page_major_fault = 5;
Rajeev Kumar8a9fa052018-01-25 19:03:09 -08002437
Rajeev Kumar90235992018-01-29 11:06:48 -08002438 // RSS
2439 optional int64 rss_in_bytes = 6;
2440
2441 // CACHE
2442 optional int64 cache_in_bytes = 7;
2443
2444 // SWAP
2445 optional int64 swap_in_bytes = 8;
Rafal Slawikaaf60892018-09-12 13:04:30 +01002446
2447 // RSS high watermark.
2448 // Peak RSS usage of the process. Value is read from the VmHWM field in /proc/PID/status or
2449 // from memory.max_usage_in_bytes under /dev/memcg if the device uses per-app memory cgroups.
2450 optional int64 rss_high_watermark_in_bytes = 9;
Rafal Slawik272a8162018-11-01 15:12:28 +00002451
2452 // Elapsed real time when the process started.
2453 // Value is read from /proc/PID/stat, field 22. 0 if read from per-app memory cgroups.
2454 optional int64 start_time_nanos = 10;
Rajeev Kumar8a9fa052018-01-25 19:03:09 -08002455}
2456
2457/*
Rafal Slawik08621582018-10-15 14:53:07 +01002458 * Logs the memory stats for a native process (from procfs).
2459 */
2460message NativeProcessMemoryState {
Rafal Slawikbf67d072018-10-23 11:07:54 +01002461 // The uid if available. -1 means not available.
2462 optional int32 uid = 1 [(is_uid) = true];
Rafal Slawik08621582018-10-15 14:53:07 +01002463
Rafal Slawikbf67d072018-10-23 11:07:54 +01002464 // The process name.
2465 optional string process_name = 2;
Rafal Slawik08621582018-10-15 14:53:07 +01002466
Rafal Slawikbf67d072018-10-23 11:07:54 +01002467 // # of page-faults
2468 optional int64 page_fault = 3;
Rafal Slawik08621582018-10-15 14:53:07 +01002469
Rafal Slawikbf67d072018-10-23 11:07:54 +01002470 // # of major page-faults
2471 optional int64 page_major_fault = 4;
Rafal Slawik08621582018-10-15 14:53:07 +01002472
Rafal Slawikbf67d072018-10-23 11:07:54 +01002473 // RSS
2474 optional int64 rss_in_bytes = 5;
Rafal Slawik08621582018-10-15 14:53:07 +01002475
Rafal Slawikbf67d072018-10-23 11:07:54 +01002476 // RSS high watermark.
2477 // Peak RSS usage of the process. Value is read from the VmHWM field in /proc/PID/status.
2478 optional int64 rss_high_watermark_in_bytes = 6;
2479
2480 // Elapsed real time when the process started.
2481 // Value is read from /proc/PID/stat, field 22.
2482 optional int64 start_time_nanos = 7;
Rafal Slawik08621582018-10-15 14:53:07 +01002483}
2484
2485/*
Chenjie Yu9d7720b2018-01-24 10:34:48 -08002486 * Elapsed real time from SystemClock.
Chenjie Yu9da105b2018-01-13 12:41:08 -08002487 */
Chenjie Yu9d7720b2018-01-24 10:34:48 -08002488message SystemElapsedRealtime {
David Chen0b5c90c2018-01-25 16:51:49 -08002489 optional uint64 time_millis = 1;
Chenjie Yu9da105b2018-01-13 12:41:08 -08002490}
2491
2492/*
Chenjie Yu9d7720b2018-01-24 10:34:48 -08002493 * Up time from SystemClock.
Chenjie Yu9da105b2018-01-13 12:41:08 -08002494 */
Chenjie Yu9d7720b2018-01-24 10:34:48 -08002495message SystemUptime {
2496 // Milliseconds since the system was booted.
2497 // This clock stops when the system enters deep sleep (CPU off, display dark, device waiting
2498 // for external input).
2499 // It is not affected by clock scaling, idle, or other power saving mechanisms.
David Chen0b5c90c2018-01-25 16:51:49 -08002500 optional uint64 uptime_millis = 1;
Chenjie Yu9da105b2018-01-13 12:41:08 -08002501}
2502
2503/*
2504 * Reads from /proc/uid_concurrent_active_time which has the format:
2505 * active: X (X is # cores)
2506 * [uid0]: [time-0] [time-1] [time-2] ... (# entries = # cores)
2507 * [uid1]: [time-0] [time-1] [time-2] ... ...
2508 * ...
2509 * Time-N means the CPU time a UID spent running concurrently with N other processes.
2510 * The file contains a monotonically increasing count of time for a single boot.
2511 */
2512message CpuActiveTime {
Yao Chenc40a19d2018-03-15 16:48:25 -07002513 optional int32 uid = 1 [(is_uid) = true];
Chenjie Yuec676612018-03-07 09:19:17 -08002514 optional uint64 time_millis = 2;
Chenjie Yu9da105b2018-01-13 12:41:08 -08002515}
2516
2517/**
2518 * Reads from /proc/uid_concurrent_policy_time which has the format:
2519 * policy0: X policy4: Y (there are X cores on policy0, Y cores on policy4)
2520 * [uid0]: [time-0-0] [time-0-1] ... [time-1-0] [time-1-1] ...
2521 * [uid1]: [time-0-0] [time-0-1] ... [time-1-0] [time-1-1] ...
2522 * ...
2523 * Time-X-Y means the time a UID spent on clusterX running concurrently with Y other processes.
2524 * The file contains a monotonically increasing count of time for a single boot.
2525 */
2526message CpuClusterTime {
Yao Chenc40a19d2018-03-15 16:48:25 -07002527 optional int32 uid = 1 [(is_uid) = true];
Chenjie Yuec676612018-03-07 09:19:17 -08002528 optional int32 cluster_index = 2;
David Chen0b5c90c2018-01-25 16:51:49 -08002529 optional uint64 time_millis = 3;
Chenjie Yu937d7422018-01-10 16:37:53 -08002530}
2531
2532/*
2533 * Pulls free disk space, for data, system partition and temporary directory.
2534 */
2535message DiskSpace {
2536 // available bytes in data partition
2537 optional uint64 data_available_bytes = 1;
2538 // available bytes in system partition
2539 optional uint64 system_available_bytes = 2;
2540 // available bytes in download cache or temp directories
2541 optional uint64 temp_available_bytes = 3;
2542}
Tej Singhbf972d92018-01-10 20:51:13 -08002543
2544/**
2545 * Pulls battery coulomb counter, which is the remaining battery charge in uAh.
Tej Singh40298312018-02-16 00:15:09 -08002546 * Pulled from:
2547 * frameworks/base/cmds/statsd/src/external/ResourceHealthManagerPuller.cpp
Tej Singhbf972d92018-01-10 20:51:13 -08002548 */
2549message RemainingBatteryCapacity {
Yangster-maca8a30442018-10-13 23:46:34 -07002550 optional int32 charge_micro_ampere_hour = 1;
Tej Singhbf972d92018-01-10 20:51:13 -08002551}
2552
2553/**
2554 * Pulls battery capacity, which is the battery capacity when full in uAh.
Tej Singh40298312018-02-16 00:15:09 -08002555 * Pulled from:
2556 * frameworks/base/cmds/statsd/src/external/ResourceHealthManagerPuller.cpp
Tej Singhbf972d92018-01-10 20:51:13 -08002557 */
2558message FullBatteryCapacity {
Yangster-maca8a30442018-10-13 23:46:34 -07002559 optional int32 capacity_micro_ampere_hour = 1;
Tej Singh40298312018-02-16 00:15:09 -08002560}
2561
2562/**
Bookatz17f0d8a2018-09-13 12:56:32 -07002563 * Pulls battery voltage.
2564 * Pulled from:
2565 * frameworks/base/cmds/statsd/src/external/ResourceHealthManagerPuller.cpp
2566 */
2567message BatteryVoltage {
2568 // The voltage of the battery, in millivolts.
Yangster-maca8a30442018-10-13 23:46:34 -07002569 optional int32 voltage_millivolt = 1;
Bookatz17f0d8a2018-09-13 12:56:32 -07002570}
2571
2572/**
Tej Singhd89137e2018-03-26 14:51:40 -07002573 * Pulls the temperature of various parts of the device.
2574 * The units are tenths of a degree Celsius. Eg: 30.3C is reported as 303.
Tej Singh40298312018-02-16 00:15:09 -08002575 *
2576 * Pulled from:
2577 * frameworks/base/cmds/statsd/src/external/ResourceThermalManagerPuller.cpp
2578 */
2579message Temperature {
2580 // The type of temperature being reported. Eg. CPU, GPU, SKIN, BATTERY.
2581 optional android.os.TemperatureTypeEnum sensor_location = 1;
2582
2583 // The name of the temperature source. Eg. CPU0
2584 optional string sensor_name = 2;
2585
Tej Singhd89137e2018-03-26 14:51:40 -07002586 // Temperature in tenths of a degree C.
Yangster-maca8a30442018-10-13 23:46:34 -07002587 optional int32 temperature_deci_celsius = 3;
yroa1fe77c2018-02-26 14:22:54 -08002588}
Olivier Gaillard00bfb1b2018-07-10 11:25:09 +01002589
2590/**
2591 * Pulls the statistics of calls to Binder.
2592 *
Olivier Gaillardd25f7a82018-09-12 14:28:48 +01002593 * Binder stats will be reset every time the data is pulled. It means it can only be pulled by one
2594 * config on the device.
Olivier Gaillard9ea238d2018-07-24 10:26:31 +01002595 *
Olivier Gaillard720ec5b2018-10-30 17:32:56 +00002596 * Next tag: 15
Olivier Gaillard00bfb1b2018-07-10 11:25:09 +01002597 */
2598message BinderCalls {
Olivier Gaillard720ec5b2018-10-30 17:32:56 +00002599 // UID of the process responsible for the binder transaction. It will be set if the process
2600 // executing the binder transaction attribute the transaction to another uid using
2601 // Binder.setThreadWorkSource().
2602 //
2603 // If not set, the value will be -1.
Olivier Gaillard9ea238d2018-07-24 10:26:31 +01002604 optional int32 uid = 1 [(is_uid) = true];
Olivier Gaillard720ec5b2018-10-30 17:32:56 +00002605 // UID of the process executing the binder transaction.
2606 optional int32 direct_caller_uid = 14;
Olivier Gaillard9ea238d2018-07-24 10:26:31 +01002607 // Fully qualified class name of the API call.
2608 //
2609 // This is a system server class name.
2610 //
2611 // TODO(gaillard): figure out if binder call stats includes data from isolated uids, if a uid
2612 // gets recycled and we have isolated uids, we might attribute the data incorrectly.
2613 // TODO(gaillard): there is a high dimensions cardinality, figure out if we should drop the less
2614 // commonly used APIs.
2615 optional string service_class_name = 2;
2616 // Method name of the API call. It can also be a transaction code if we cannot
2617 // resolve it to a name. See Binder#getTransactionName.
2618 //
2619 // This is a system server method name.
2620 optional string service_method_name = 3;
2621 // Total number of API calls.
2622 optional int64 call_count = 4;
2623 // True if the screen was interactive PowerManager#isInteractive at the end of the call.
2624 optional bool screen_interactive = 13;
2625 // Total number of API calls we have data recorded for. If we collected data for all the calls,
2626 // call_count will be equal to recorded_call_count.
2627 //
2628 // If recorded_call_count is different than call_count, it means data collection has been
2629 // sampled. All the fields below will be sampled in this case.
2630 optional int64 recorded_call_count = 12;
2631 // Number of exceptions thrown by the API.
2632 optional int64 recorded_exception_count = 5;
2633 // Total latency of all API calls.
2634 // Average can be computed using total_latency_micros / recorded_call_count.
2635 optional int64 recorded_total_latency_micros = 6;
2636 // Maximum latency of one API call.
2637 optional int64 recorded_max_latency_micros = 7;
2638 // Total CPU usage of all API calls.
2639 // Average can be computed using total_cpu_micros / recorded_call_count.
2640 // Total can be computed using total_cpu_micros / recorded_call_count * call_count.
2641 optional int64 recorded_total_cpu_micros = 8;
2642 // Maximum CPU usage of one API call.
2643 optional int64 recorded_max_cpu_micros = 9;
2644 // Maximum parcel reply size of one API call.
2645 optional int64 recorded_max_reply_size_bytes = 10;
2646 // Maximum parcel request size of one API call.
2647 optional int64 recorded_max_request_size_bytes = 11;
2648}
2649
2650/**
2651 * Pulls the statistics of exceptions during calls to Binder.
2652 *
2653 * Binder stats are cumulative from boot unless somebody reset the data using
2654 * > adb shell dumpsys binder_calls_stats --reset
2655 */
2656message BinderCallsExceptions {
2657 // Exception class name, e.g. java.lang.IllegalArgumentException.
2658 //
2659 // This is an exception class name thrown by the system server.
2660 optional string exception_class_name = 1;
2661 // Total number of exceptions.
2662 optional int64 exception_count = 2;
Olivier Gaillard00bfb1b2018-07-10 11:25:09 +01002663}
Marcin Oczeretkod8cc8592018-08-22 16:07:36 +01002664
Marcin Oczeretko3e6494e2018-09-10 18:06:52 +01002665/**
2666 * Pulls the statistics of message dispatching on HandlerThreads.
2667 *
2668 * Looper stats will be reset every time the data is pulled. It means it can only be pulled by one
2669 * config on the device.
2670 *
2671 * Next tag: 11
2672 */
Marcin Oczeretkod8cc8592018-08-22 16:07:36 +01002673message LooperStats {
Marcin Oczeretkoec758722018-09-12 12:53:47 +01002674 // The uid that made a call to the System Server and caused the message to be enqueued.
Marcin Oczeretkod8cc8592018-08-22 16:07:36 +01002675 optional int32 uid = 1 [(is_uid) = true];
2676
2677 // Fully qualified class name of the handler target class.
2678 //
2679 // This field does not contain PII. This is a system server class name.
2680 optional string handler_class_name = 2;
2681
2682 // The name of the thread that runs the Looper.
2683 //
2684 // This field does not contain PII. This is a system server thread name.
2685 optional string looper_thread_name = 3;
2686
2687 // The name of the dispatched message.
2688 //
2689 // This field does not contain PII. This is a system server constant or class
2690 // name.
2691 optional string message_name = 4;
2692
2693 // Total number of successfully dispatched messages.
2694 optional int64 message_count = 5;
2695
2696 // Total number of messages that failed dispatching.
2697 optional int64 exception_count = 6;
2698
2699 // Total number of processed messages we have data recorded for. If we
2700 // collected data for all the messages, message_count will be equal to
2701 // recorded_message_count.
2702 //
2703 // If recorded_message_count is different than message_count, it means data
Marcin Oczeretkoc06331a2018-10-02 13:00:38 +01002704 // collection has been sampled. The fields below will be sampled in this case.
Marcin Oczeretkod8cc8592018-08-22 16:07:36 +01002705 optional int64 recorded_message_count = 7;
2706
2707 // Total latency of all processed messages.
2708 // Average can be computed using recorded_total_latency_micros /
2709 // recorded_message_count.
2710 optional int64 recorded_total_latency_micros = 8;
2711
2712 // Total CPU usage of all processed message.
2713 // Average can be computed using recorded_total_cpu_micros /
2714 // recorded_message_count. Total can be computed using
Marcin Oczeretko3e6494e2018-09-10 18:06:52 +01002715 // recorded_total_cpu_micros / recorded_message_count * message_count.
Marcin Oczeretkod8cc8592018-08-22 16:07:36 +01002716 optional int64 recorded_total_cpu_micros = 9;
Marcin Oczeretko3e6494e2018-09-10 18:06:52 +01002717
2718 // True if the screen was interactive PowerManager#isInteractive at the end of the call.
2719 optional bool screen_interactive = 10;
Marcin Oczeretkoc06331a2018-10-02 13:00:38 +01002720
2721 // Max recorded CPU usage of all processed messages.
2722 optional int64 recorded_max_cpu_micros = 11;
2723
2724 // Max recorded latency of all processed messages.
2725 optional int64 recorded_max_latency_micros = 12;
2726
2727 // Total number of messages we tracked the dispatching delay for. If we
2728 // collected data for all the messages, message_count will be equal to
2729 // recorded_delay_message_count.
2730 //
2731 // If recorded_delay_message_count is different than message_count, it means data
2732 // collection has been sampled or/and not all messages specified the target dispatch time.
2733 // The fields below will be sampled in this case.
2734 optional int64 recorded_delay_message_count = 13;
2735
2736 // Total dispatching delay of all processed messages.
2737 // Calculated as a difference between the target dispatching time (Message.when)
2738 // and the actual dispatching time.
2739 // Average can be computed using recorded_total_delay_millis / recorded_delay_message_count.
2740 optional int64 recorded_total_delay_millis = 14;
2741
2742 // Max dispatching delay of all processed messages.
2743 // Calculated as a difference between the target dispatching time (Message.when)
2744 // and the actual dispatching time.
2745 optional int64 recorded_max_delay_millis = 15;
Marcin Oczeretkod8cc8592018-08-22 16:07:36 +01002746}
Tej Singh86dc9db2018-09-06 00:39:57 +00002747
2748/**
2749 * Pulls disk information, such as write speed and latency.
2750 */
2751message DiskStats {
2752 // Time taken to open, write 512B to, and close a file.
2753 // -1 if error performing the check.
2754 optional int64 data_write_latency_millis = 1;
2755
2756 optional bool file_based_encryption = 2;
2757
2758 // Recent disk write speed in kB/s.
2759 // -1 if error querying storageed.
2760 // 0 if data is unavailable.
2761 optional int32 recent_disk_write_speed = 3;
2762}
2763
2764
2765/**
2766 * Free and total bytes of the Data, Cache, and System partition.
2767 */
2768message DirectoryUsage {
2769 enum Directory {
2770 UNKNOWN = 0;
2771 DATA = 1;
2772 CACHE = 2;
2773 SYSTEM = 3;
2774 }
2775 optional Directory directory = 1;
2776 optional int64 free_bytes = 2;
2777 optional int64 total_bytes = 3;
2778}
2779
2780
2781/**
2782 * Size of an application: apk size, data size, and cache size.
2783 * Reads from a cached file produced daily by DiskStatsLoggingService.java.
2784 * Information is only reported for apps with the primary user (user 0).
2785 * Sizes are aggregated by package name.
2786 */
2787message AppSize {
2788 // Including uids will involve modifying diskstats logic.
2789 optional string package_name = 1;
2790 // App size in bytes. -1 if unavailable.
2791 optional int64 app_size_bytes = 2;
2792 // App data size in bytes. -1 if unavailable.
2793 optional int64 app_data_size_bytes = 3;
2794 // App cache size in bytes. -1 if unavailable.
2795 optional int64 app_cache_size_bytes = 4;
2796 // Time that the cache file was produced.
2797 // Uses System.currentTimeMillis(), which is wall clock time.
2798 optional int64 cache_time_millis = 5;
2799}
2800
2801
2802/**
2803 * Size of a particular category. Eg: photos, videos.
2804 * Reads from a cached file produced daily by DiskStatsLoggingService.java.
2805 */
2806message CategorySize {
2807 enum Category {
2808 UNKNOWN = 0;
2809 APP_SIZE = 1;
2810 APP_DATA_SIZE = 2;
2811 APP_CACHE_SIZE = 3;
2812 PHOTOS = 4;
2813 VIDEOS = 5;
2814 AUDIO = 6;
2815 DOWNLOADS = 7;
2816 SYSTEM = 8;
2817 OTHER = 9;
2818 }
2819 optional Category category = 1;
2820 // Category size in bytes.
2821 optional int64 size_bytes = 2;
2822 // Time that the cache file was produced.
2823 // Uses System.currentTimeMillis(), which is wall clock time.
2824 optional int64 cache_time_millis = 3;
2825}
Tej Singhd6d6d772018-09-05 17:41:25 -07002826
2827/**
Tej Singhe7726dc2018-09-21 11:42:12 -07002828 * Pulls per uid I/O stats. The stats are cumulative since boot.
2829 *
2830 * Read/write bytes are I/O events from a storage device
2831 * Read/write chars are data requested by read/write syscalls, and can be
2832 * satisfied by caching.
2833 *
2834 * Pulled from StatsCompanionService, which reads proc/uid_io/stats.
2835 */
2836message DiskIo {
2837 optional int32 uid = 1 [(is_uid) = true];
2838 optional int64 fg_chars_read = 2;
2839 optional int64 fg_chars_write = 3;
2840 optional int64 fg_bytes_read = 4;
2841 optional int64 fg_bytes_write = 5;
2842 optional int64 bg_chars_read = 6;
2843 optional int64 bg_chars_write = 7;
2844 optional int64 bg_bytes_read = 8;
2845 optional int64 bg_bytes_write = 9;
2846 optional int64 fg_fsync = 10;
2847 optional int64 bg_fsync= 11;
2848}
2849
2850
2851/**
Tej Singhd6d6d772018-09-05 17:41:25 -07002852 * Pulls the number of fingerprints for each user.
2853 *
2854 * Pulled from StatsCompanionService, which queries FingerprintManager.
2855 */
2856message NumFingerprints {
2857 // The associated user. Eg: 0 for owners, 10+ for others.
2858 // Defined in android/os/UserHandle.java
2859 optional int32 user = 1;
2860 // Number of fingerprints registered to that user.
2861 optional int32 num_fingerprints = 2;
2862}
Chenjie Yu12e5e672018-09-14 15:54:59 -07002863
Yangsteraf9aee72018-10-12 09:26:16 -07002864message AggStats {
2865 optional int64 min = 1;
2866
2867 optional int64 average = 2;
2868
2869 optional int64 max = 3;
2870}
2871
2872message ProcessStatsStateProto {
2873 optional android.service.procstats.ScreenState screen_state = 1;
2874
2875 optional android.service.procstats.MemoryState memory_state = 2;
2876
2877 // this enum list is from frameworks/base/core/java/com/android/internal/app/procstats/ProcessStats.java
2878 // and not frameworks/base/core/java/android/app/ActivityManager.java
2879 optional android.service.procstats.ProcessState process_state = 3;
2880
2881 // Millisecond uptime duration spent in this state
Yangster-maca8a30442018-10-13 23:46:34 -07002882 optional int64 duration_millis = 4;
Yangsteraf9aee72018-10-12 09:26:16 -07002883
2884 // Millisecond elapsed realtime duration spent in this state
Yangster-maca8a30442018-10-13 23:46:34 -07002885 optional int64 realtime_duration_millis = 9;
Yangsteraf9aee72018-10-12 09:26:16 -07002886
2887 // # of samples taken
2888 optional int32 sample_size = 5;
2889
2890 // PSS is memory reserved for this process
2891 optional AggStats pss = 6;
2892
2893 // USS is memory shared between processes, divided evenly for accounting
2894 optional AggStats uss = 7;
2895
2896 // RSS is memory resident for this process
2897 optional AggStats rss = 8;
2898}
2899
2900// Next Tag: 7
2901message ProcessStatsProto {
2902 // Name of process.
2903 optional string process = 1;
2904
2905 // Uid of the process.
2906 optional int32 uid = 2;
2907
2908 // Information about how often kills occurred
2909 message Kill {
2910 // Count of excessive CPU kills
2911 optional int32 cpu = 1;
2912
2913 // Count of kills when cached
2914 optional int32 cached = 2;
2915
2916 // PSS stats during cached kill
2917 optional AggStats cached_pss = 3;
2918 }
2919 optional Kill kill = 3;
2920
2921 // Time and memory spent in various states.
2922 repeated ProcessStatsStateProto states = 5;
2923
2924 // Total time process has been running... screen_state, memory_state, and process_state
2925 // will not be set.
2926 optional ProcessStatsStateProto total_running_state = 6;
2927}
2928
2929message PackageServiceOperationStatsProto {
2930 // Operate enum: Started, Foreground, Bound, Executing
2931 optional android.service.procstats.ServiceOperationState operation = 1;
2932
2933 // Number of times the service was in this operation.
2934 optional int32 count = 2;
2935
2936 // Information about a state the service can be in.
2937 message StateStats {
2938 // Screen state enum.
2939 optional android.service.procstats.ScreenState screen_state = 1;
2940 // Memory state enum.
2941 optional android.service.procstats.MemoryState memory_state = 2;
2942
2943 // duration in milliseconds.
Yangster-maca8a30442018-10-13 23:46:34 -07002944 optional int64 duration_millis = 3;
Yangsteraf9aee72018-10-12 09:26:16 -07002945 // Millisecond elapsed realtime duration spent in this state
Yangster-maca8a30442018-10-13 23:46:34 -07002946 optional int64 realtime_duration_millis = 4;
Yangsteraf9aee72018-10-12 09:26:16 -07002947 }
2948 repeated StateStats state_stats = 3;
2949}
2950
2951message PackageServiceStatsProto {
2952 // Name of service component.
2953 optional string service_name = 1;
2954
2955 // The operation stats.
2956 // The package_name, package_uid, package_version, service_name will not be set to save space.
2957 repeated PackageServiceOperationStatsProto operation_stats = 2;
2958}
2959
2960message PackageAssociationSourceProcessStatsProto {
2961 // Uid of the process.
2962 optional int32 process_uid = 1;
2963 // Process name.
2964 optional string process_name = 2;
2965
2966 // Total count of the times this association appeared.
2967 optional int32 total_count = 3;
2968
2969 // Millisecond uptime total duration this association was around.
Yangster-maca8a30442018-10-13 23:46:34 -07002970 optional int64 total_duration_millis = 4;
Yangsteraf9aee72018-10-12 09:26:16 -07002971
2972 // Total count of the times this association became actively impacting its target process.
2973 optional int32 active_count = 5;
2974
2975 // Information on one source in this association.
2976 message StateStats {
2977 // Process state enum.
2978 optional android.service.procstats.ProcessState process_state = 1;
2979 // Millisecond uptime duration spent in this state
Yangster-maca8a30442018-10-13 23:46:34 -07002980 optional int64 duration_millis = 2;
Yangsteraf9aee72018-10-12 09:26:16 -07002981 // Millisecond elapsed realtime duration spent in this state
Yangster-maca8a30442018-10-13 23:46:34 -07002982 optional int64 realtime_duration_mmillis = 3;
Yangsteraf9aee72018-10-12 09:26:16 -07002983 }
2984 repeated StateStats active_state_stats = 6;
2985}
2986
2987message PackageAssociationProcessStatsProto {
2988 // Name of the target component.
2989 optional string component_name = 1;
2990 // Information on one source in this association.
2991 repeated PackageAssociationSourceProcessStatsProto sources = 2;
2992}
2993
2994
2995message ProcessStatsPackageProto {
2996 // Name of package.
2997 optional string package = 1;
2998
2999 // Uid of the package.
3000 optional int32 uid = 2;
3001
3002 // Version of the package.
3003 optional int64 version = 3;
3004
3005 // Stats for each process running with the package loaded in to it.
3006 repeated ProcessStatsProto process_stats = 4;
3007
3008 // Stats for each of the package's services.
3009 repeated PackageServiceStatsProto service_stats = 5;
3010
3011 // Stats for each association with the package.
3012 repeated PackageAssociationProcessStatsProto association_stats = 6;
3013}
3014
3015message ProcessStatsSectionProto {
3016 // Elapsed realtime at start of report.
Yangster-maca8a30442018-10-13 23:46:34 -07003017 optional int64 start_realtime_millis = 1;
Yangsteraf9aee72018-10-12 09:26:16 -07003018
3019 // Elapsed realtime at end of report.
Yangster-maca8a30442018-10-13 23:46:34 -07003020 optional int64 end_realtime_millis = 2;
Yangsteraf9aee72018-10-12 09:26:16 -07003021
3022 // CPU uptime at start of report.
Yangster-maca8a30442018-10-13 23:46:34 -07003023 optional int64 start_uptime_millis = 3;
Yangsteraf9aee72018-10-12 09:26:16 -07003024
3025 // CPU uptime at end of report.
Yangster-maca8a30442018-10-13 23:46:34 -07003026 optional int64 end_uptime_millis = 4;
Yangsteraf9aee72018-10-12 09:26:16 -07003027
3028 // System runtime library. e.g. "libdvm.so", "libart.so".
3029 optional string runtime = 5;
3030
3031 // whether kernel reports swapped pss.
3032 optional bool has_swapped_pss = 6;
3033
3034 // Data completeness. e.g. "complete", "partial", shutdown", or "sysprops".
3035 enum Status {
3036 STATUS_UNKNOWN = 0;
3037 STATUS_COMPLETE = 1;
3038 STATUS_PARTIAL = 2;
3039 STATUS_SHUTDOWN = 3;
3040 STATUS_SYSPROPS = 4;
3041 }
3042 repeated Status status = 7;
3043
3044 // Stats for each process.
3045 repeated ProcessStatsProto process_stats = 8;
3046
3047 // Stats for each package.
3048 repeated ProcessStatsPackageProto package_stats = 9;
3049}
3050
Chenjie Yu12e5e672018-09-14 15:54:59 -07003051/**
3052 * Pulled from ProcessStatsService.java
3053 */
3054message ProcStats {
Yangsteraf9aee72018-10-12 09:26:16 -07003055 optional ProcessStatsSectionProto proc_stats_section = 1;
3056}
3057
3058message PowerProfileProto {
3059 optional double cpu_suspend = 1;
3060
3061 optional double cpu_idle = 2;
3062
3063 optional double cpu_active = 3;
3064
3065 message CpuCluster {
3066 optional int32 id = 1;
3067 optional double cluster_power = 2;
3068 optional int32 cores = 3;
3069 repeated int64 speed = 4;
3070 repeated double core_power = 5;
3071 }
3072
3073 repeated CpuCluster cpu_cluster = 40;
3074
3075 optional double wifi_scan = 4;
3076
3077 optional double wifi_on = 5;
3078
3079 optional double wifi_active = 6;
3080
3081 optional double wifi_controller_idle = 7;
3082
3083 optional double wifi_controller_rx = 8;
3084
3085 optional double wifi_controller_tx = 9;
3086
3087 repeated double wifi_controller_tx_levels = 10;
3088
3089 optional double wifi_controller_operating_voltage = 11;
3090
3091 optional double bluetooth_controller_idle = 12;
3092
3093 optional double bluetooth_controller_rx = 13;
3094
3095 optional double bluetooth_controller_tx = 14;
3096
3097 optional double bluetooth_controller_operating_voltage = 15;
3098
3099 optional double modem_controller_sleep = 16;
3100
3101 optional double modem_controller_idle = 17;
3102
3103 optional double modem_controller_rx = 18;
3104
3105 repeated double modem_controller_tx = 19;
3106
3107 optional double modem_controller_operating_voltage = 20;
3108
3109 optional double gps_on = 21;
3110
3111 repeated double gps_signal_quality_based = 22;
3112
3113 optional double gps_operating_voltage = 23;
3114
3115 optional double bluetooth_on = 24;
3116
3117 optional double bluetooth_active = 25;
3118
3119 optional double bluetooth_at_cmd = 26;
3120
3121 optional double ambient_display = 27;
3122
3123 optional double screen_on = 28;
3124
3125 optional double radio_on = 29;
3126
3127 optional double radio_scanning = 30;
3128
3129 optional double radio_active = 31;
3130
3131 optional double screen_full = 32;
3132
3133 optional double audio = 33;
3134
3135 optional double video = 34;
3136
3137 optional double flashlight = 35;
3138
3139 optional double memory = 36;
3140
3141 optional double camera = 37;
3142
3143 optional double wifi_batched_scan = 38;
3144
3145 optional double battery_capacity = 39;
Chenjie Yu12e5e672018-09-14 15:54:59 -07003146}
Chenjie Yuab530202018-09-26 12:39:20 -07003147
3148/**
3149 * power_profile.xml and other constants for power model calculations.
3150 * Pulled from PowerProfile.java
3151 */
3152message PowerProfile {
Yangsteraf9aee72018-10-12 09:26:16 -07003153 optional PowerProfileProto power_profile = 1;
Howard Ro9a862de2018-10-11 16:03:33 -07003154}
Chenjie Yub35b5f72018-10-13 23:25:11 -07003155
3156/**
arangelovd5db50e2018-10-12 20:24:39 +01003157 * Logs when a user restriction was added or removed.
3158 *
3159 * Logged from:
3160 * frameworks/base/services/devicepolicy/java/com/android/server/devicepolicy/DevicePolicyManagerService.java
3161 */
3162message UserRestrictionChanged {
3163 // The raw string of the user restriction as defined in UserManager.
3164 // Allowed values are defined in UserRestrictionsUtils#USER_RESTRICTIONS.
3165 optional string restriction = 1;
3166 // Whether the restriction is enabled or disabled.
3167 optional bool enabled = 2;
Howard Ro183c2bd2018-10-18 13:52:10 -07003168}
Yangster-mac308ea0c2018-10-22 13:10:25 -07003169
3170/**
3171 * Pulls process user time and system time. Puller takes a snapshot of all pids
3172 * in the system and returns cpu stats for those that are working at the time.
3173 * Dead pids will be dropped. Kernel processes are excluded.
3174 * Min cool-down is 5 sec.
3175 */
3176message ProcessCpuTime {
3177 optional int32 uid = 1 [(is_uid) = true];
3178
3179 optional string process_name = 2;
3180 // Process cpu time in user space, cumulative from boot/process start
3181 optional int64 user_time_millis = 3;
3182 // Process cpu time in system space, cumulative from boot/process start
3183 optional int64 system_time_millis = 4;
Rafal Slawikbf67d072018-10-23 11:07:54 +01003184}
Misha Wagner5a51e002018-10-03 15:04:09 +01003185
3186/**
3187 * Pulls the CPU usage for each thread.
3188 *
3189 * Read from /proc/$PID/task/$TID/time_in_state files.
3190 *
3191 * TODO(mishaw): This is an experimental atom. Issues with big/little CPU frequencies, and
3192 * time_in_state files not being present on some phones, have not been addressed. These should be
3193 * considered before a public release.
3194 */
3195message CpuTimePerThreadFreq {
3196 // UID that owns the process.
3197 optional int32 uid = 1 [(is_uid) = true];
3198 // ID of the process.
3199 optional uint32 process_id = 2;
3200 // ID of the thread.
3201 optional uint32 thread_id = 3;
3202 // Name of the process taken from `/proc/$PID/cmdline`.
3203 optional string process_name = 4;
3204 // Name of the thread taken from `/proc/$PID/task/$TID/comm`
3205 optional string thread_name = 5;
3206 // What frequency the CPU was running at, in KHz
3207 optional uint32 frequency_khz = 6;
3208 // Time spent in frequency in milliseconds, since thread start.
3209 optional uint32 time_millis = 7;
3210}