blob: 1189e827f409e91d42d7c5849fbd37a98ea7265f [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";
Yangsteraf9aee72018-10-12 09:26:16 -070030import "frameworks/base/core/proto/android/service/procstats_enum.proto";
31import "frameworks/base/core/proto/android/stats/enums.proto";
Yao Chen8c433862018-10-24 14:09:20 -070032import "frameworks/base/core/proto/android/stats/launcher/launcher.proto";
Tej Singhc477d9c2018-02-05 18:31:39 -080033import "frameworks/base/core/proto/android/telecomm/enums.proto";
Bookatz1a1b0462018-01-12 11:47:03 -080034import "frameworks/base/core/proto/android/telephony/enums.proto";
35import "frameworks/base/core/proto/android/view/enums.proto";
Joe Onorato62c220b2017-11-18 20:32:56 -080036
Yao Chend54f9dd2017-10-17 17:37:48 +000037/**
Stefan Lafonae2df012017-11-14 09:17:21 -080038 * The master atom class. This message defines all of the available
Yao Chend54f9dd2017-10-17 17:37:48 +000039 * raw stats log events from the Android system, also known as "atoms."
40 *
41 * This field contains a single oneof with all of the available messages.
42 * The stats-log-api-gen tool runs as part of the Android build and
43 * generates the android.util.StatsLog class, which contains the constants
44 * and methods that Android uses to log.
45 *
Stefan Lafonae2df012017-11-14 09:17:21 -080046 * This Atom class is not actually built into the Android system.
Yao Chend54f9dd2017-10-17 17:37:48 +000047 * Instead, statsd on Android constructs these messages synthetically,
48 * in the format defined here and in stats_log.proto.
49 */
Stefan Lafonae2df012017-11-14 09:17:21 -080050message Atom {
51 // Pushed atoms start at 2.
David Chenc8a43242017-10-17 16:23:28 -070052 oneof pushed {
Bookatzc1a050a2017-10-10 15:49:28 -070053 // For StatsLog reasons, 1 is illegal and will not work. Must start at 2.
54 BleScanStateChanged ble_scan_state_changed = 2;
Chenjie Yubd1a28f2018-07-17 14:55:19 -070055 ProcessStateChanged process_state_changed = 3;
Bookatzc1a050a2017-10-10 15:49:28 -070056 BleScanResultReceived ble_scan_result_received = 4;
57 SensorStateChanged sensor_state_changed = 5;
Bookatzdb026a22018-01-10 19:01:56 -080058 GpsScanStateChanged gps_scan_state_changed = 6;
Bookatzc1a050a2017-10-10 15:49:28 -070059 SyncStateChanged sync_state_changed = 7;
60 ScheduledJobStateChanged scheduled_job_state_changed = 8;
61 ScreenBrightnessChanged screen_brightness_changed = 9;
Bookatzd6746242017-10-24 18:39:35 -070062 WakelockStateChanged wakelock_state_changed = 10;
Bookatzddccf0a2017-11-28 16:48:14 -080063 LongPartialWakelockStateChanged long_partial_wakelock_state_changed = 11;
64 MobileRadioPowerStateChanged mobile_radio_power_state_changed = 12;
65 WifiRadioPowerStateChanged wifi_radio_power_state_changed = 13;
Chenjie Yubd1a28f2018-07-17 14:55:19 -070066 ActivityManagerSleepStateChanged activity_manager_sleep_state_changed = 14;
67 MemoryFactorStateChanged memory_factor_state_changed = 15;
68 ExcessiveCpuUsageReported excessive_cpu_usage_reported = 16;
69 CachedKillReported cached_kill_reported = 17;
70 ProcessMemoryStatReported process_memory_stat_reported = 18;
Hyunyoung Songc6d6b772018-10-17 13:35:32 -070071 LauncherUIChanged launcher_event = 19;
Bookatzddccf0a2017-11-28 16:48:14 -080072 BatterySaverModeStateChanged battery_saver_mode_state_changed = 20;
73 DeviceIdleModeStateChanged device_idle_mode_state_changed = 21;
74 DeviceIdlingModeStateChanged device_idling_mode_state_changed = 22;
Bookatzc1a050a2017-10-10 15:49:28 -070075 AudioStateChanged audio_state_changed = 23;
Chenjie Yu5caaa9d2018-03-06 15:48:54 -080076 MediaCodecStateChanged media_codec_state_changed = 24;
Bookatzc1a050a2017-10-10 15:49:28 -070077 CameraStateChanged camera_state_changed = 25;
78 FlashlightStateChanged flashlight_state_changed = 26;
79 UidProcessStateChanged uid_process_state_changed = 27;
80 ProcessLifeCycleStateChanged process_life_cycle_state_changed = 28;
81 ScreenStateChanged screen_state_changed = 29;
Bookatz8c6571b2017-10-24 15:04:41 -070082 BatteryLevelChanged battery_level_changed = 30;
83 ChargingStateChanged charging_state_changed = 31;
84 PluggedStateChanged plugged_state_changed = 32;
Bookatza66083f2018-09-20 17:24:00 -070085 InteractiveStateChanged interactive_state_changed = 33;
86 // 34 is available
Bookatz8c6571b2017-10-24 15:04:41 -070087 WakeupAlarmOccurred wakeup_alarm_occurred = 35;
88 KernelWakeupReported kernel_wakeup_reported = 36;
Bookatze5885242017-10-24 20:10:31 -070089 WifiLockStateChanged wifi_lock_state_changed = 37;
90 WifiSignalStrengthChanged wifi_signal_strength_changed = 38;
91 WifiScanStateChanged wifi_scan_state_changed = 39;
92 PhoneSignalStrengthChanged phone_signal_strength_changed = 40;
David Chenc28b2bb2017-10-24 12:52:52 -070093 SettingChanged setting_changed = 41;
David Chenc8a43242017-10-17 16:23:28 -070094 ActivityForegroundStateChanged activity_foreground_state_changed = 42;
David Chen21582962017-11-01 17:32:46 -070095 IsolatedUidChanged isolated_uid_changed = 43;
Hugo Benichi884970e2017-11-14 22:42:46 +090096 PacketWakeupOccurred packet_wakeup_occurred = 44;
Bookatz7948c872018-09-04 12:58:33 -070097 WallClockTimeShifted wall_clock_time_shifted = 45;
Bookatz8fcd09a2017-12-18 13:01:10 -080098 AnomalyDetected anomaly_detected = 46;
David Chen0b5c90c2018-01-25 16:51:49 -080099 AppBreadcrumbReported app_breadcrumb_reported = 47;
Chenjie Yu5caaa9d2018-03-06 15:48:54 -0800100 AppStartOccurred app_start_occurred = 48;
101 AppStartCanceled app_start_canceled = 49;
102 AppStartFullyDrawn app_start_fully_drawn = 50;
Rajeev Kumar8a9fa052018-01-25 19:03:09 -0800103 LmkKillOccurred lmk_kill_occurred = 51;
Chenjie Yu52cacc62017-12-08 18:11:45 -0800104 PictureInPictureStateChanged picture_in_picture_state_changed = 52;
Tej Singh4503e102018-01-04 14:35:01 -0800105 WifiMulticastLockStateChanged wifi_multicast_lock_state_changed = 53;
Rajeev Kumar8a9fa052018-01-25 19:03:09 -0800106 LmkStateChanged lmk_state_changed = 54;
107 AppStartMemoryStateCaptured app_start_memory_state_captured = 55;
Tej Singh1ea42892018-01-19 09:27:00 -0800108 ShutdownSequenceReported shutdown_sequence_reported = 56;
Tej Singh6483ea42018-01-25 17:45:49 -0800109 BootSequenceReported boot_sequence_reported = 57;
Tej Singhbb8554a2018-01-26 11:59:14 -0800110 DaveyOccurred davey_occurred = 58;
Chenjie Yue8904192017-12-08 19:12:57 -0800111 OverlayStateChanged overlay_state_changed = 59;
Chenjie Yuccfe6452018-01-30 11:33:21 -0800112 ForegroundServiceStateChanged foreground_service_state_changed = 60;
Tej Singhc477d9c2018-02-05 18:31:39 -0800113 CallStateChanged call_state_changed = 61;
Tej Singhdd7bd352018-02-09 19:33:15 -0800114 KeyguardStateChanged keyguard_state_changed = 62;
115 KeyguardBouncerStateChanged keyguard_bouncer_state_changed = 63;
116 KeyguardBouncerPasswordEntered keyguard_bouncer_password_entered = 64;
Chenjie Yu5caaa9d2018-03-06 15:48:54 -0800117 AppDied app_died = 65;
Tej Singha883b372018-02-15 11:30:01 -0800118 ResourceConfigurationChanged resource_configuration_changed = 66;
Tej Singh5d991e12018-03-09 19:48:11 -0800119 BluetoothEnabledStateChanged bluetooth_enabled_state_changed = 67;
120 BluetoothConnectionStateChanged bluetooth_connection_state_changed = 68;
Tej Singh02200f92018-04-02 19:37:59 -0700121 // 69 is blank but need not be.
Andrew Chantb56388b2018-03-22 21:07:33 -0700122 UsbConnectorStateChanged usb_connector_state_changed = 70;
Andrew Chant28d627e2018-02-22 15:17:05 -0800123 SpeakerImpedanceReported speaker_impedance_reported = 71;
124 HardwareFailed hardware_failed = 72;
125 PhysicalDropDetected physical_drop_detected = 73;
126 ChargeCyclesReported charge_cycles_reported = 74;
Tej Singheee317b2018-03-07 19:28:05 -0800127 MobileConnectionStateChanged mobile_connection_state_changed = 75;
128 MobileRadioTechnologyChanged mobile_radio_technology_changed = 76;
Andrew Chantb56388b2018-03-22 21:07:33 -0700129 UsbDeviceAttached usb_device_attached = 77;
Chenjie Yu5caaa9d2018-03-06 15:48:54 -0800130 AppCrashOccurred app_crash_occurred = 78;
131 ANROccurred anr_occurred = 79;
132 WTFOccurred wtf_occurred = 80;
133 LowMemReported low_mem_reported = 81;
Howard Rocb767f62018-06-19 19:58:05 -0700134 GenericAtom generic_atom = 82;
Yangster-mac48b3d622018-08-18 12:38:11 -0700135 KeyValuePairsAtom key_value_pairs_atom = 83;
Bookatza7020bd2018-08-28 16:29:35 -0700136 VibratorStateChanged vibrator_state_changed = 84;
Yangster-mac96353002018-09-05 11:18:55 -0700137 DeferredJobStatsReported deferred_job_stats_reported = 85;
Yangster-mace16189a2018-08-26 12:20:16 -0700138 ThermalThrottlingStateChanged thermal_throttling = 86;
Tej Singhd6d6d772018-09-05 17:41:25 -0700139 FingerprintAcquired fingerprint_acquired = 87;
140 FingerprintAuthenticated fingerprint_authenticated = 88;
141 FingerprintErrorOccurred fingerprint_error_occurred = 89;
Howard Ro688ae182018-09-25 00:09:36 -0700142 Notification notification = 90;
Howard Roa46b6582018-09-18 16:45:02 -0700143 BatteryHealthSnapshot battery_health_snapshot = 91;
144 SlowIo slow_io = 92;
145 BatteryCausedShutdown battery_caused_shutdown = 93;
Yangsteraf9aee72018-10-12 09:26:16 -0700146 PhoneServiceStateChanged phone_service_state_changed = 94;
147 PhoneStateChanged phone_state_changed = 95;
arangelovd5db50e2018-10-12 20:24:39 +0100148 UserRestrictionChanged user_restriction_changed = 96;
Fan Zhang916c13b2018-10-16 22:49:45 -0700149 SettingsUIChanged settings_ui_changed = 97;
Chenjie Yuae9dfac2018-10-25 16:06:56 -0700150 ConnectivityStateChanged connectivity_state_changed = 98;
Yao Chend54f9dd2017-10-17 17:37:48 +0000151 }
David Chenc8a43242017-10-17 16:23:28 -0700152
David Chen6e3e6cb2018-01-03 16:14:06 -0800153 // Pulled events will start at field 10000.
Misha Wagner5a51e002018-10-03 15:04:09 +0100154 // Next: 10038
David Chenc8a43242017-10-17 16:23:28 -0700155 oneof pulled {
David Chen6e3e6cb2018-01-03 16:14:06 -0800156 WifiBytesTransfer wifi_bytes_transfer = 10000;
157 WifiBytesTransferByFgBg wifi_bytes_transfer_by_fg_bg = 10001;
158 MobileBytesTransfer mobile_bytes_transfer = 10002;
159 MobileBytesTransferByFgBg mobile_bytes_transfer_by_fg_bg = 10003;
Chenjie Yu9d7720b2018-01-24 10:34:48 -0800160 BluetoothBytesTransfer bluetooth_bytes_transfer = 10006;
David Chen6e3e6cb2018-01-03 16:14:06 -0800161 KernelWakelock kernel_wakelock = 10004;
Chenjie Yuc8b7f222018-01-11 23:25:57 -0800162 SubsystemSleepState subsystem_sleep_state = 10005;
David Chen6e3e6cb2018-01-03 16:14:06 -0800163 CpuTimePerFreq cpu_time_per_freq = 10008;
164 CpuTimePerUid cpu_time_per_uid = 10009;
165 CpuTimePerUidFreq cpu_time_per_uid_freq = 10010;
Chenjie Yu5caaa9d2018-03-06 15:48:54 -0800166 WifiActivityInfo wifi_activity_info = 10011;
David Chen6e3e6cb2018-01-03 16:14:06 -0800167 ModemActivityInfo modem_activity_info = 10012;
Chenjie Yu9d7720b2018-01-24 10:34:48 -0800168 BluetoothActivityInfo bluetooth_activity_info = 10007;
Rajeev Kumar8a9fa052018-01-25 19:03:09 -0800169 ProcessMemoryState process_memory_state = 10013;
Chenjie Yu9d7720b2018-01-24 10:34:48 -0800170 SystemElapsedRealtime system_elapsed_realtime = 10014;
171 SystemUptime system_uptime = 10015;
Chenjie Yu9da105b2018-01-13 12:41:08 -0800172 CpuActiveTime cpu_active_time = 10016;
173 CpuClusterTime cpu_cluster_time = 10017;
Tej Singh86dc9db2018-09-06 00:39:57 +0000174 DiskSpace disk_space = 10018 [deprecated=true];
Tej Singhbf972d92018-01-10 20:51:13 -0800175 RemainingBatteryCapacity remaining_battery_capacity = 10019;
176 FullBatteryCapacity full_battery_capacity = 10020;
Tej Singh40298312018-02-16 00:15:09 -0800177 Temperature temperature = 10021;
Olivier Gaillard00bfb1b2018-07-10 11:25:09 +0100178 BinderCalls binder_calls = 10022;
Olivier Gaillard9ea238d2018-07-24 10:26:31 +0100179 BinderCallsExceptions binder_calls_exceptions = 10023;
Marcin Oczeretkod8cc8592018-08-22 16:07:36 +0100180 LooperStats looper_stats = 10024;
Tej Singh86dc9db2018-09-06 00:39:57 +0000181 DiskStats disk_stats = 10025;
182 DirectoryUsage directory_usage = 10026;
183 AppSize app_size = 10027;
184 CategorySize category_size = 10028;
Chenjie Yuab530202018-09-26 12:39:20 -0700185 ProcStats proc_stats = 10029;
Bookatz17f0d8a2018-09-13 12:56:32 -0700186 BatteryVoltage battery_voltage = 10030;
Tej Singhd6d6d772018-09-05 17:41:25 -0700187 NumFingerprints num_fingerprints = 10031;
Tej Singhe7726dc2018-09-21 11:42:12 -0700188 DiskIo disk_io = 10032;
Chenjie Yuab530202018-09-26 12:39:20 -0700189 PowerProfile power_profile = 10033;
Chenjie Yub52779e2018-10-05 12:03:36 -0700190 ProcStats proc_stats_pkg_proc = 10034;
Yangster-mac308ea0c2018-10-22 13:10:25 -0700191 ProcessCpuTime process_cpu_time = 10035;
Rafal Slawik08621582018-10-15 14:53:07 +0100192 NativeProcessMemoryState native_process_memory_state = 10036;
Misha Wagner5a51e002018-10-03 15:04:09 +0100193 CpuTimePerThreadFreq cpu_time_per_thread_freq = 10037;
Bookatz92da2832018-11-01 18:10:03 -0700194 OnDevicePowerMeasurement on_device_power_measurement = 10038;
David Chenc8a43242017-10-17 16:23:28 -0700195 }
yroa1fe77c2018-02-26 14:22:54 -0800196
Bookatz76aafcf2018-09-17 16:17:10 -0700197 // DO NOT USE field numbers above 100,000 in AOSP.
198 // Field numbers 100,000 - 199,999 are reserved for non-AOSP (e.g. OEMs) to use.
199 // Field numbers 200,000 and above are reserved for future use; do not use them at all.
Stefan Lafoncdb1a0e2017-09-27 20:24:15 -0700200}
201
Yao Chend54f9dd2017-10-17 17:37:48 +0000202/**
Yangster-mac20877162017-12-22 17:19:39 -0800203 * This proto represents a node of an attribution chain.
204 * Note: All attribution chains are represented as a repeated field of type
205 * AttributionNode. It is understood that in such arrays, the order is that
206 * of calls, that is [A, B, C] if A calls B that calls C.
Yao Chend54f9dd2017-10-17 17:37:48 +0000207 */
Yangster-mac20877162017-12-22 17:19:39 -0800208message AttributionNode {
209 // The uid for a given element in the attribution chain.
Yangster-mac7604aea2017-12-11 22:55:49 -0800210 optional int32 uid = 1;
Yangster-mac7604aea2017-12-11 22:55:49 -0800211
Yangster-mac20877162017-12-22 17:19:39 -0800212 // The (optional) string tag for an element in the attribution chain. If the
213 // element has no tag, it is encoded as an empty string.
214 optional string tag = 2;
Stefan Lafoncdb1a0e2017-09-27 20:24:15 -0700215}
216
Yangster-mac48b3d622018-08-18 12:38:11 -0700217message KeyValuePair {
218 optional int32 key = 1;
219 oneof value {
Howard Ro4078dd42018-09-27 17:41:08 -0700220 int32 value_int = 2;
221 int64 value_long = 3;
222 string value_str = 4;
223 float value_float = 5;
Yangster-mac48b3d622018-08-18 12:38:11 -0700224 }
225}
226
227message KeyValuePairsAtom {
228 optional int32 uid = 1;
229 repeated KeyValuePair pairs = 2;
230}
231
Yao Chend54f9dd2017-10-17 17:37:48 +0000232/*
233 * *****************************************************************************
yrode4ca102017-11-15 22:57:24 -0800234 * Below are all of the individual atoms that are logged by Android via statsd.
Yao Chend54f9dd2017-10-17 17:37:48 +0000235 *
236 * RULES:
237 * - The field ids for each atom must start at 1, and count upwards by 1.
238 * Skipping field ids is not allowed.
239 * - These form an API, so renaming, renumbering or removing fields is
240 * not allowed between android releases. (This is not currently enforced,
241 * but there will be a tool to enforce this restriction).
242 * - The types must be built-in protocol buffer types, namely, no sub-messages
243 * are allowed (yet). The bytes type is also not allowed.
244 * - The CamelCase name of the message type should match the
Stefan Lafonae2df012017-11-14 09:17:21 -0800245 * underscore_separated name as defined in Atom.
Yao Chend54f9dd2017-10-17 17:37:48 +0000246 * - If an atom represents work that can be attributed to an app, there can
Yangster-mac7604aea2017-12-11 22:55:49 -0800247 * be exactly one AttributionChain field. It must be field number 1.
Yao Chend54f9dd2017-10-17 17:37:48 +0000248 * - A field that is a uid should be a string field, tagged with the [xxx]
249 * annotation. The generated code on android will be represented by UIDs,
250 * and those UIDs will be translated in xxx to those strings.
251 *
252 * CONVENTIONS:
Bookatzc1a050a2017-10-10 15:49:28 -0700253 * - Events are past tense. e.g. ScreenStateChanged, not ScreenStateChange.
Yao Chend54f9dd2017-10-17 17:37:48 +0000254 * - If there is a UID, it goes first. Think in an object-oriented fashion.
255 * *****************************************************************************
256 */
Stefan Lafoncdb1a0e2017-09-27 20:24:15 -0700257
Yao Chend54f9dd2017-10-17 17:37:48 +0000258/**
Yangster-mace16189a2018-08-26 12:20:16 -0700259 * Logs when the Thermal service HAL notifies the throttling start/stop events.
260 *
261 * Logged from:
262 * frameworks/base/services/core/java/com/android/server/stats/StatsCompanionService.java
263 */
264message ThermalThrottlingStateChanged {
265 optional android.os.TemperatureTypeEnum sensor_type = 1;
266
267 enum State {
268 UNKNOWN = 0;
269 START = 1;
270 STOP = 2;
271 }
272
273 optional State state = 2;
274
275 optional float temperature = 3;
276}
277
278/**
Yao Chend54f9dd2017-10-17 17:37:48 +0000279 * Logs when the screen state changes.
280 *
281 * Logged from:
282 * frameworks/base/services/core/java/com/android/server/am/BatteryStatsService.java
283 */
284message ScreenStateChanged {
Bookatz1a1b0462018-01-12 11:47:03 -0800285 // New screen state, from frameworks/base/core/proto/android/view/enums.proto.
Yangster-macb6b77c62018-10-12 19:33:24 -0700286 optional android.view.DisplayStateEnum state = 1 [(state_field_option).option = EXCLUSIVE];
Stefan Lafoncdb1a0e2017-09-27 20:24:15 -0700287}
Yao Chend54f9dd2017-10-17 17:37:48 +0000288
289/**
Chenjie Yubd1a28f2018-07-17 14:55:19 -0700290 * Logs that the process state of the uid, as determined by ActivityManager
291 * (i.e. the highest process state of that uid's processes) has changed.
Yao Chend54f9dd2017-10-17 17:37:48 +0000292 *
293 * Logged from:
294 * frameworks/base/services/core/java/com/android/server/am/BatteryStatsService.java
295 */
Bookatzc1a050a2017-10-10 15:49:28 -0700296message UidProcessStateChanged {
Yangster-macb6b77c62018-10-12 19:33:24 -0700297 optional int32 uid = 1 [(state_field_option).option = PRIMARY, (is_uid) = true];
Yao Chend54f9dd2017-10-17 17:37:48 +0000298
Bookatzdb026a22018-01-10 19:01:56 -0800299 // The state, from frameworks/base/core/proto/android/app/enums.proto.
Yangster-macb6b77c62018-10-12 19:33:24 -0700300 optional android.app.ProcessStateEnum state = 2 [(state_field_option).option = EXCLUSIVE];
Yao Chend54f9dd2017-10-17 17:37:48 +0000301}
302
303/**
Chenjie Yubd1a28f2018-07-17 14:55:19 -0700304 * Logs process state change of a process, as per the activity manager.
305 *
306 * Logged from:
307 * frameworks/base/services/core/java/com/android/server/am/ProcessRecord.java
308 */
309message ProcessStateChanged {
310 optional int32 uid = 1;
311 optional string process_name = 2;
312 optional string package_name = 3;
313 // TODO: remove this when validation is done
314 optional int64 version = 5;
315 // The state, from frameworks/base/core/proto/android/app/enums.proto.
316 optional android.app.ProcessStateEnum state = 4;
317}
318
319/**
320 * Logs when ActivityManagerService sleep state is changed.
321 *
322 * Logged from:
323 * frameworks/base/services/core/java/com/android/server/am/ActivityTaskManagerService.java
324 */
325message ActivityManagerSleepStateChanged {
326 // TODO: import frameworks proto
327 enum State {
328 UNKNOWN = 0;
329 ASLEEP = 1;
330 AWAKE = 2;
331 }
Yangster-macb6b77c62018-10-12 19:33:24 -0700332 optional State state = 1 [(state_field_option).option = EXCLUSIVE];
Chenjie Yubd1a28f2018-07-17 14:55:19 -0700333}
334
335/**
336 * Logs when system memory state changes.
337 *
338 * Logged from:
339 * frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
340 */
341message MemoryFactorStateChanged {
342 // TODO: import frameworks proto
343 enum State {
344 MEMORY_UNKNOWN = 0;
345 NORMAL = 1; // normal.
346 MODERATE = 2; // moderate memory pressure.
347 LOW = 3; // low memory.
348 CRITICAL = 4; // critical memory.
349
350 }
Yangster-macb6b77c62018-10-12 19:33:24 -0700351 optional State factor = 1 [(state_field_option).option = EXCLUSIVE];
Chenjie Yubd1a28f2018-07-17 14:55:19 -0700352}
353
354/**
355 * Logs when app is using too much cpu, according to ActivityManagerService.
356 *
357 * Logged from:
358 * frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
359 */
360message ExcessiveCpuUsageReported {
361 optional int32 uid = 1;
362 optional string process_name = 2;
363 optional string package_name = 3;
364 // package version. TODO: remove this when validation is done
365 optional int64 version = 4;
366}
367
368/**
369 * Logs when a cached process is killed, along with its pss.
370 *
371 * Logged from:
372 * frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
373 */
374message CachedKillReported {
375 optional int32 uid = 1;
376 optional string process_name = 2;
377 optional string package_name = 3;
378 // TODO: remove this when validation is done
379 optional int64 version = 5;
380 optional int64 pss = 4;
381}
382
383/**
384 * Logs when memory stats of a process is reported.
385 *
386 * Logged from:
387 * frameworks/base/services/core/java/com/android/server/am/ProcessRecord.java
388 */
389message ProcessMemoryStatReported {
390 optional int32 uid = 1;
391 optional string process_name = 2;
392 optional string package_name = 3;
393 //TODO: remove this when validation is done
394 optional int64 version = 9;
395 optional int64 pss = 4;
396 optional int64 uss = 5;
397 optional int64 rss = 6;
398 enum Type {
399 ADD_PSS_INTERNAL_SINGLE = 0;
400 ADD_PSS_INTERNAL_ALL_MEM = 1;
401 ADD_PSS_INTERNAL_ALL_POLL = 2;
402 ADD_PSS_EXTERNAL = 3;
403 ADD_PSS_EXTERNAL_SLOW = 4;
404 }
405 optional Type type = 7;
406 optional int64 duration = 8;
407}
408
409/**
Bookatzc1a050a2017-10-10 15:49:28 -0700410 * Logs that a process started, finished, crashed, or ANRed.
411 *
412 * Logged from:
413 * frameworks/base/services/core/java/com/android/server/am/BatteryStatsService.java
414 */
415message ProcessLifeCycleStateChanged {
Yao Chenc40a19d2018-03-15 16:48:25 -0700416 optional int32 uid = 1 [(is_uid) = true];
Bookatzc1a050a2017-10-10 15:49:28 -0700417
David Chen0b5c90c2018-01-25 16:51:49 -0800418 // The process name (usually same as the app name).
Chenjie Yu5caaa9d2018-03-06 15:48:54 -0800419 optional string process_name = 2;
Bookatzc1a050a2017-10-10 15:49:28 -0700420
Bookatzddccf0a2017-11-28 16:48:14 -0800421 // What lifecycle state the process changed to.
422 // This enum is specific to atoms.proto.
Chenjie Yu5caaa9d2018-03-06 15:48:54 -0800423 enum State {
424 FINISHED = 0;
425 STARTED = 1;
426 CRASHED = 2;
Bookatzddccf0a2017-11-28 16:48:14 -0800427 }
Chenjie Yu5caaa9d2018-03-06 15:48:54 -0800428 optional State state = 3;
Bookatzc1a050a2017-10-10 15:49:28 -0700429}
430
Bookatzc1a050a2017-10-10 15:49:28 -0700431/**
432 * Logs when the ble scan state changes.
433 *
434 * Logged from:
Bookatz17a879d2018-03-28 15:05:28 -0700435 * packages/apps/Bluetooth/src/com/android/bluetooth/gatt/AppScanStats.java
Bookatzc1a050a2017-10-10 15:49:28 -0700436 */
437message BleScanStateChanged {
Yangster-macafad8c62018-01-05 22:30:49 -0800438 repeated AttributionNode attribution_node = 1;
Bookatzc1a050a2017-10-10 15:49:28 -0700439
440 enum State {
441 OFF = 0;
442 ON = 1;
Bookatze5ec0b42018-03-26 13:34:56 -0700443 // RESET indicates all ble stopped. Used when it (re)starts (e.g. after it crashes).
444 RESET = 2;
Bookatzc1a050a2017-10-10 15:49:28 -0700445 }
446 optional State state = 2;
Bookatzc1a050a2017-10-10 15:49:28 -0700447
Bookatze5ec0b42018-03-26 13:34:56 -0700448 // Does the scan have a filter.
449 optional bool is_filtered = 3;
450 // Whether the scan is a CALLBACK_TYPE_FIRST_MATCH scan. Called 'background' scan internally.
451 optional bool is_first_match = 4;
452 // Whether the scan set to piggy-back off the results of other scans (SCAN_MODE_OPPORTUNISTIC).
453 optional bool is_opportunistic = 5;
Bookatzc1a050a2017-10-10 15:49:28 -0700454}
455
456/**
457 * Logs reporting of a ble scan finding results.
458 *
459 * Logged from:
Bookatzae6738e2018-09-13 11:38:56 -0700460 * packages/apps/Bluetooth/src/com/android/bluetooth/gatt/AppScanStats.java
Bookatzc1a050a2017-10-10 15:49:28 -0700461 */
Bookatzae6738e2018-09-13 11:38:56 -0700462// TODO: Consider also tracking per-scanner-id.
Bookatzc1a050a2017-10-10 15:49:28 -0700463message BleScanResultReceived {
Yangster-macafad8c62018-01-05 22:30:49 -0800464 repeated AttributionNode attribution_node = 1;
Bookatzc1a050a2017-10-10 15:49:28 -0700465
466 // Number of ble scan results returned.
Chenjie Yu5caaa9d2018-03-06 15:48:54 -0800467 optional int32 num_results = 2;
Bookatzc1a050a2017-10-10 15:49:28 -0700468}
469
470/**
471 * Logs when a sensor state changes.
472 *
473 * Logged from:
Bookatz235343d2018-03-26 13:03:50 -0700474 * frameworks/base/services/core/java/com/android/server/am/BatteryStatsService.java
Bookatzc1a050a2017-10-10 15:49:28 -0700475 */
476message SensorStateChanged {
Yangster-macafad8c62018-01-05 22:30:49 -0800477 repeated AttributionNode attribution_node = 1;
Bookatzc1a050a2017-10-10 15:49:28 -0700478
Bookatzc1a050a2017-10-10 15:49:28 -0700479 // The id (int) of the sensor.
480 optional int32 sensor_id = 2;
481
482 enum State {
483 OFF = 0;
484 ON = 1;
485 }
486 optional State state = 3;
487}
488
489
490/**
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
506
507/**
508 * Logs when a sync manager sync state changes.
509 *
510 * Logged from:
Bookatz235343d2018-03-26 13:03:50 -0700511 * frameworks/base/services/core/java/com/android/server/am/BatteryStatsService.java
Bookatzc1a050a2017-10-10 15:49:28 -0700512 */
513message SyncStateChanged {
Yangster-macafad8c62018-01-05 22:30:49 -0800514 repeated AttributionNode attribution_node = 1;
Bookatzc1a050a2017-10-10 15:49:28 -0700515
David Chen0b5c90c2018-01-25 16:51:49 -0800516 // Name of the sync (as named in the app). Can be chosen at run-time.
Chenjie Yu5caaa9d2018-03-06 15:48:54 -0800517 optional string sync_name = 2;
Bookatzc1a050a2017-10-10 15:49:28 -0700518
519 enum State {
520 OFF = 0;
521 ON = 1;
522 }
523 optional State state = 3;
524}
525
Yangster-mac96353002018-09-05 11:18:55 -0700526/*
527 * Deferred job stats.
528 *
529 * Logged from:
530 * frameworks/base/services/core/java/com/android/server/job/JobSchedulerService.java
531*/
532message DeferredJobStatsReported {
533 repeated AttributionNode attribution_node = 1;
534
535 // Number of jobs deferred.
536 optional int32 num_jobs_deferred = 2;
537
538 // Time since the last job runs.
539 optional int64 time_since_last_job_millis = 3;
540}
541
Bookatzc1a050a2017-10-10 15:49:28 -0700542/**
543 * Logs when a job scheduler job state changes.
544 *
545 * Logged from:
Bookatz235343d2018-03-26 13:03:50 -0700546 * frameworks/base/services/core/java/com/android/server/am/BatteryStatsService.java
Bookatzc1a050a2017-10-10 15:49:28 -0700547 */
548message ScheduledJobStateChanged {
Yangster-macafad8c62018-01-05 22:30:49 -0800549 repeated AttributionNode attribution_node = 1;
Bookatzc1a050a2017-10-10 15:49:28 -0700550
551 // Name of the job (as named in the app)
Chenjie Yu5caaa9d2018-03-06 15:48:54 -0800552 optional string job_name = 2;
Bookatzc1a050a2017-10-10 15:49:28 -0700553
554 enum State {
Tej Singhd5747a62018-01-08 20:57:35 -0800555 FINISHED = 0;
556 STARTED = 1;
557 SCHEDULED = 2;
Bookatzc1a050a2017-10-10 15:49:28 -0700558 }
559 optional State state = 3;
560
Tej Singh33a412b2018-03-16 18:43:59 -0700561 // The reason a job has stopped.
562 // This is only applicable when the state is FINISHED.
Bookatz235343d2018-03-26 13:03:50 -0700563 // The default value is STOP_REASON_UNKNOWN.
Tej Singh33a412b2018-03-16 18:43:59 -0700564 optional android.app.job.StopReasonEnum stop_reason = 4;
Bookatzc1a050a2017-10-10 15:49:28 -0700565}
566
567/**
568 * Logs when the audio state changes.
569 *
570 * Logged from:
Bookatz235343d2018-03-26 13:03:50 -0700571 * frameworks/base/services/core/java/com/android/server/am/BatteryStatsService.java
Bookatzc1a050a2017-10-10 15:49:28 -0700572 */
573message AudioStateChanged {
Yangster-macafad8c62018-01-05 22:30:49 -0800574 repeated AttributionNode attribution_node = 1;
Bookatzc1a050a2017-10-10 15:49:28 -0700575
576 enum State {
577 OFF = 0;
578 ON = 1;
Bookatz235343d2018-03-26 13:03:50 -0700579 // RESET indicates all audio stopped. Used when it (re)starts (e.g. after it crashes).
580 RESET = 2;
Bookatzc1a050a2017-10-10 15:49:28 -0700581 }
582 optional State state = 2;
583}
584
585/**
586 * Logs when the video codec state changes.
587 *
588 * Logged from:
Bookatz235343d2018-03-26 13:03:50 -0700589 * frameworks/base/services/core/java/com/android/server/am/BatteryStatsService.java
Bookatzc1a050a2017-10-10 15:49:28 -0700590 */
Chenjie Yu5caaa9d2018-03-06 15:48:54 -0800591message MediaCodecStateChanged {
Yangster-macafad8c62018-01-05 22:30:49 -0800592 repeated AttributionNode attribution_node = 1;
Bookatzc1a050a2017-10-10 15:49:28 -0700593
594 enum State {
595 OFF = 0;
596 ON = 1;
Bookatz235343d2018-03-26 13:03:50 -0700597 // RESET indicates all mediaCodec stopped. Used when it (re)starts (e.g. after it crashes).
598 RESET = 2;
Bookatzc1a050a2017-10-10 15:49:28 -0700599 }
600 optional State state = 2;
601}
602
603/**
604 * Logs when the flashlight state changes.
605 *
606 * Logged from:
Bookatz235343d2018-03-26 13:03:50 -0700607 * frameworks/base/services/core/java/com/android/server/am/BatteryStatsService.java
Bookatzc1a050a2017-10-10 15:49:28 -0700608 */
609message FlashlightStateChanged {
Yangster-macafad8c62018-01-05 22:30:49 -0800610 repeated AttributionNode attribution_node = 1;
Bookatzc1a050a2017-10-10 15:49:28 -0700611
612 enum State {
613 OFF = 0;
614 ON = 1;
Bookatz235343d2018-03-26 13:03:50 -0700615 // RESET indicates all flashlight stopped. Used when it (re)starts (e.g. after it crashes).
616 RESET = 2;
Bookatzc1a050a2017-10-10 15:49:28 -0700617 }
618 optional State state = 2;
619}
620
621/**
622 * Logs when the camera state changes.
623 *
624 * Logged from:
Bookatz235343d2018-03-26 13:03:50 -0700625 * frameworks/base/services/core/java/com/android/server/am/BatteryStatsService.java
Bookatzc1a050a2017-10-10 15:49:28 -0700626 */
627message CameraStateChanged {
Yangster-macafad8c62018-01-05 22:30:49 -0800628 repeated AttributionNode attribution_node = 1;
Bookatzc1a050a2017-10-10 15:49:28 -0700629
630 enum State {
631 OFF = 0;
632 ON = 1;
Bookatz235343d2018-03-26 13:03:50 -0700633 // RESET indicates all camera stopped. Used when it (re)starts (e.g. after it crashes).
634 RESET = 2;
Bookatzc1a050a2017-10-10 15:49:28 -0700635 }
636 optional State state = 2;
637}
638
639/**
640 * Logs that the state of a wakelock (per app and per wakelock name) has changed.
Yao Chend54f9dd2017-10-17 17:37:48 +0000641 *
642 * Logged from:
643 * TODO
644 */
Bookatzd6746242017-10-24 18:39:35 -0700645message WakelockStateChanged {
Yangster-mac20877162017-12-22 17:19:39 -0800646 repeated AttributionNode attribution_node = 1;
Yao Chend54f9dd2017-10-17 17:37:48 +0000647
Bookatz1a1b0462018-01-12 11:47:03 -0800648 // The type (level) of the wakelock; e.g. a partial wakelock or a full wakelock.
649 // From frameworks/base/core/proto/android/os/enums.proto.
Yangster-maca8a30442018-10-13 23:46:34 -0700650 optional android.os.WakeLockLevelEnum type = 2;
Bookatzc1a050a2017-10-10 15:49:28 -0700651
652 // The wakelock tag (Called tag in the Java API, sometimes name elsewhere).
653 optional string tag = 3;
654
655 enum State {
Yangster-maccfdf3a42017-12-06 13:42:38 -0800656 RELEASE = 0;
657 ACQUIRE = 1;
658 CHANGE_RELEASE = 2;
659 CHANGE_ACQUIRE = 3;
Bookatzc1a050a2017-10-10 15:49:28 -0700660 }
661 optional State state = 4;
662}
663
664/**
Bookatzc1a050a2017-10-10 15:49:28 -0700665 * Logs when a partial wakelock is considered 'long' (over 1 min).
666 *
667 * Logged from:
668 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
669 */
670message LongPartialWakelockStateChanged {
Yangster-macafad8c62018-01-05 22:30:49 -0800671 repeated AttributionNode attribution_node = 1;
Bookatzc1a050a2017-10-10 15:49:28 -0700672
Yao Chend54f9dd2017-10-17 17:37:48 +0000673 // The wakelock tag (Called tag in the Java API, sometimes name elsewhere).
674 optional string tag = 2;
675
Bookatzc1a050a2017-10-10 15:49:28 -0700676 // TODO: I have no idea what this is.
677 optional string history_tag = 3;
678
679 enum State {
680 OFF = 0;
681 ON = 1;
682 }
683 optional State state = 4;
Yao Chend54f9dd2017-10-17 17:37:48 +0000684}
685
Bookatzc1a050a2017-10-10 15:49:28 -0700686/**
Bookatza66083f2018-09-20 17:24:00 -0700687 * Logs when the device is interactive, according to the PowerManager Notifier.
688 *
689 * Logged from:
690 * frameworks/base/services/core/java/com/android/server/power/Notifier.java
691 */
692message InteractiveStateChanged {
693 enum State {
694 OFF = 0;
695 ON = 1;
696 }
697 optional State state = 1;
698}
699
700/**
Bookatzc1a050a2017-10-10 15:49:28 -0700701 * Logs Battery Saver state change.
702 *
703 * Logged from:
704 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
705 */
706message BatterySaverModeStateChanged {
707 enum State {
708 OFF = 0;
709 ON = 1;
710 }
711 optional State state = 1;
712}
713
714/**
715 * Logs Doze mode state change.
716 *
717 * Logged from:
Bookatzddccf0a2017-11-28 16:48:14 -0800718 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
Bookatzc1a050a2017-10-10 15:49:28 -0700719 */
720message DeviceIdleModeStateChanged {
Bookatz8bdae8d2018-01-16 11:24:30 -0800721 optional android.server.DeviceIdleModeEnum state = 1;
Bookatzddccf0a2017-11-28 16:48:14 -0800722}
723
724
725/**
726 * Logs state change of Doze mode including maintenance windows.
727 *
728 * Logged from:
729 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
730 */
731message DeviceIdlingModeStateChanged {
Bookatz8bdae8d2018-01-16 11:24:30 -0800732 optional android.server.DeviceIdleModeEnum state = 1;
Bookatzc1a050a2017-10-10 15:49:28 -0700733}
734
735/**
736 * Logs screen brightness level.
737 *
738 * Logged from:
739 * frameworks/base/services/core/java/com/android/server/am/BatteryStatsService.java
740 */
741message ScreenBrightnessChanged {
742 // Screen brightness level. Should be in [-1, 255] according to PowerManager.java.
743 optional int32 level = 1;
Bookatz8c6571b2017-10-24 15:04:41 -0700744}
745
746/**
747 * Logs battery level (percent full, from 0 to 100).
748 *
749 * Logged from:
David Chenc28b2bb2017-10-24 12:52:52 -0700750 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
Bookatz8c6571b2017-10-24 15:04:41 -0700751 */
752message BatteryLevelChanged {
753 // Battery level. Should be in [0, 100].
754 optional int32 battery_level = 1;
755}
756
757/**
758 * Logs change in charging status of the device.
759 *
760 * Logged from:
David Chenc28b2bb2017-10-24 12:52:52 -0700761 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
Bookatz8c6571b2017-10-24 15:04:41 -0700762 */
763message ChargingStateChanged {
Bookatz1a1b0462018-01-12 11:47:03 -0800764 // State of the battery, from frameworks/base/core/proto/android/os/enums.proto.
765 optional android.os.BatteryStatusEnum state = 1;
Bookatz8c6571b2017-10-24 15:04:41 -0700766}
767
768/**
769 * Logs whether the device is plugged in, and what power source it is using.
770 *
771 * Logged from:
David Chenc28b2bb2017-10-24 12:52:52 -0700772 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
Bookatz8c6571b2017-10-24 15:04:41 -0700773 */
774message PluggedStateChanged {
Bookatz1a1b0462018-01-12 11:47:03 -0800775 // Whether the device is plugged in, from frameworks/base/core/proto/android/os/enums.proto.
776 optional android.os.BatteryPluggedStateEnum state = 1;
Bookatz8c6571b2017-10-24 15:04:41 -0700777}
778
Bookatz8c6571b2017-10-24 15:04:41 -0700779/**
780 * Logs when an app's wakeup alarm fires.
781 *
782 * Logged from:
David Chenc28b2bb2017-10-24 12:52:52 -0700783 * frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
Bookatz8c6571b2017-10-24 15:04:41 -0700784 */
785message WakeupAlarmOccurred {
Yangster-macafad8c62018-01-05 22:30:49 -0800786 repeated AttributionNode attribution_node = 1;
Bookatzddccf0a2017-11-28 16:48:14 -0800787
788 // Name of the wakeup alarm.
789 optional string tag = 2;
Bookatzcaf2293e2018-09-23 13:07:43 -0700790
791 // Name of source package (for historical reasons, since BatteryStats tracked it).
792 optional string package_name = 3;
Bookatzddccf0a2017-11-28 16:48:14 -0800793}
794
795/**
796 * Logs when an an app causes the mobile radio to change state.
797 * Changing from LOW to MEDIUM or HIGH can be considered the app waking the mobile radio.
798 *
799 * Logged from:
Bookatz0b028b12018-05-31 16:51:17 -0700800 * frameworks/base/services/core/java/com/android/server/NetworkManagementService.java
Bookatzddccf0a2017-11-28 16:48:14 -0800801 */
802message MobileRadioPowerStateChanged {
Chenjie Yu5caaa9d2018-03-06 15:48:54 -0800803 repeated AttributionNode attribution_node = 1;
Bookatzddccf0a2017-11-28 16:48:14 -0800804
Bookatz1a1b0462018-01-12 11:47:03 -0800805 // Power state, from frameworks/base/core/proto/android/telephony/enums.proto.
806 optional android.telephony.DataConnectionPowerStateEnum state = 2;
Bookatzddccf0a2017-11-28 16:48:14 -0800807}
808
809/**
810 * Logs when an an app causes the wifi radio to change state.
811 * Changing from LOW to MEDIUM or HIGH can be considered the app waking the wifi radio.
812 *
813 * Logged from:
Bookatz0b028b12018-05-31 16:51:17 -0700814 * frameworks/base/services/core/java/com/android/server/NetworkManagementService.java
Bookatzddccf0a2017-11-28 16:48:14 -0800815 */
816message WifiRadioPowerStateChanged {
Chenjie Yu5caaa9d2018-03-06 15:48:54 -0800817 repeated AttributionNode attribution_node = 1;
Bookatzddccf0a2017-11-28 16:48:14 -0800818
Bookatz1a1b0462018-01-12 11:47:03 -0800819 // Power state, from frameworks/base/core/proto/android/telephony/enums.proto.
820 optional android.telephony.DataConnectionPowerStateEnum state = 2;
Bookatz8c6571b2017-10-24 15:04:41 -0700821}
822
823/**
824 * Logs kernel wakeup reasons and aborts.
825 *
826 * Logged from:
Bookatz56585ca2018-09-07 11:38:45 -0700827 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
Bookatz8c6571b2017-10-24 15:04:41 -0700828 */
829message KernelWakeupReported {
830 // Name of the kernel wakeup reason (or abort).
831 optional string wakeup_reason_name = 1;
832
833 // Duration (in microseconds) for the wake-up interrupt to be serviced.
David Chen0b5c90c2018-01-25 16:51:49 -0800834 optional int64 duration_micros = 2;
Bookatze5885242017-10-24 20:10:31 -0700835}
836
837/**
838 * Logs wifi locks held by an app.
839 *
840 * Logged from:
David Chenc28b2bb2017-10-24 12:52:52 -0700841 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
Bookatze5885242017-10-24 20:10:31 -0700842 */
843message WifiLockStateChanged {
Yangster-macafad8c62018-01-05 22:30:49 -0800844 repeated AttributionNode attribution_node = 1;
Bookatze5885242017-10-24 20:10:31 -0700845
846 enum State {
847 OFF = 0;
848 ON = 1;
849 }
850 optional State state = 2;
851}
852
853/**
854 * Logs wifi signal strength changes.
855 *
856 * Logged from:
David Chenc28b2bb2017-10-24 12:52:52 -0700857 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
Bookatze5885242017-10-24 20:10:31 -0700858 */
859message WifiSignalStrengthChanged {
Bookatz1a1b0462018-01-12 11:47:03 -0800860 // Signal strength, from frameworks/base/core/proto/android/telephony/enums.proto.
861 optional android.telephony.SignalStrengthEnum signal_strength = 1;
Bookatze5885242017-10-24 20:10:31 -0700862}
863
864/**
865 * Logs wifi scans performed by an app.
866 *
867 * Logged from:
David Chenc28b2bb2017-10-24 12:52:52 -0700868 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
Bookatze5885242017-10-24 20:10:31 -0700869 */
870message WifiScanStateChanged {
Yangster-macafad8c62018-01-05 22:30:49 -0800871 repeated AttributionNode attribution_node = 1;
Bookatze5885242017-10-24 20:10:31 -0700872
873 enum State {
874 OFF = 0;
875 ON = 1;
876 }
877 optional State state = 2;
878}
879
880/**
Tej Singh4503e102018-01-04 14:35:01 -0800881 * Logs wifi multicast locks held by an app
882 *
883 * Logged from:
884 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
885 */
886message WifiMulticastLockStateChanged {
887 repeated AttributionNode attribution_node = 1;
888
889 enum State {
890 OFF = 0;
891 ON = 1;
892 }
893 optional State state = 2;
894}
895
896/**
Tej Singh1ea42892018-01-19 09:27:00 -0800897 * Logs shutdown reason and duration on next boot.
898 *
899 * Logged from:
900 * frameworks/base/core/java/com/android/server/BootReceiver.java
901 */
902message ShutdownSequenceReported {
903 // True if shutdown is for a reboot. Default: false if we do not know.
904 optional bool reboot = 1;
905
906 // Reason for shutdown. Eg: userrequested. Default: "<EMPTY>".
907 optional string reason = 2;
908
909 // Beginning of shutdown time in ms using wall clock time since unix epoch.
910 // Default: 0 if no start time received.
David Chen0b5c90c2018-01-25 16:51:49 -0800911 optional int64 start_time_millis = 3;
Tej Singh1ea42892018-01-19 09:27:00 -0800912
913 // Duration of shutdown in ms. Default: 0 if no duration received.
David Chen0b5c90c2018-01-25 16:51:49 -0800914 optional int64 duration_millis = 4;
Tej Singh1ea42892018-01-19 09:27:00 -0800915}
916
Tej Singh6483ea42018-01-25 17:45:49 -0800917
918/**
919 * Logs boot reason and duration.
920 *
921 * Logged from:
922 * system/core/bootstat/bootstat.cpp
923 */
924message BootSequenceReported {
925 // Reason for bootloader boot. Eg. reboot. See bootstat.cpp for larger list
926 // Default: "<EMPTY>" if not available.
927 optional string bootloader_reason = 1;
928
929 // Reason for system boot. Eg. bootloader, reboot,userrequested
930 // Default: "<EMPTY>" if not available.
931 optional string system_reason = 2;
932
933 // End of boot time in ms from unix epoch using system wall clock.
David Chen0b5c90c2018-01-25 16:51:49 -0800934 optional int64 end_time_millis = 3;
Tej Singh6483ea42018-01-25 17:45:49 -0800935
936 // Total boot duration in ms.
David Chen0b5c90c2018-01-25 16:51:49 -0800937 optional int64 total_duration_millis = 4;
Tej Singh6483ea42018-01-25 17:45:49 -0800938
939 // Bootloader duration in ms.
David Chen0b5c90c2018-01-25 16:51:49 -0800940 optional int64 bootloader_duration_millis = 5;
Tej Singh6483ea42018-01-25 17:45:49 -0800941
942 // Time since last boot in ms. Default: 0 if not available.
943 optional int64 time_since_last_boot = 6;
944}
945
Tej Singhc477d9c2018-02-05 18:31:39 -0800946
947/**
948 * Logs call state and disconnect cause (if applicable).
949 *
950 * Logged from:
951 * packages/services/Telecomm/src/com/android/server/telecom/Call.java
952 */
953message CallStateChanged {
954 // The state of the call. Eg. DIALING, ACTIVE, ON_HOLD, DISCONNECTED.
955 // From frameworks/base/core/proto/android/telecomm/enums.proto.
956 optional android.telecom.CallStateEnum call_state = 1;
957
958 // The reason the call disconnected. Eg. ERROR, MISSED, REJECTED, BUSY.
959 // This value is only applicable when the call_state is DISCONNECTED, and
960 // should always be UNKNOWN if the call_state is not DISCONNECTED.
961 // From frameworks/base/core/proto/android/telecomm/enums.proto.
962 optional android.telecom.DisconnectCauseEnum disconnect_cause = 2;
963
964 // True if the call is self-managed, which are apps that use the
965 // telecom infrastructure to make their own calls.
966 optional bool self_managed = 3;
967
968 // True if call is external. External calls are calls on connected Wear
969 // devices but show up in Telecom so the user can pull them onto the device.
970 optional bool external_call = 4;
971}
972
Tej Singh1ea42892018-01-19 09:27:00 -0800973/**
Tej Singhdd7bd352018-02-09 19:33:15 -0800974 * Logs keyguard state. The keyguard is the lock screen.
975 *
976 * Logged from:
977 * frameworks/base/packages/SystemUI/src/com/android/systemui/statusbar/phone/StatusBarKeyguardViewManager.java
978 */
979message KeyguardStateChanged {
980 enum State {
981 UNKNOWN = 0;
982 // The keyguard is hidden when the phone is unlocked.
983 HIDDEN = 1;
984 // The keyguard is shown when the phone is locked (screen turns off).
985 SHOWN= 2;
986 // The keyguard is occluded when something is overlaying the keyguard.
987 // Eg. Opening the camera while on the lock screen.
988 OCCLUDED = 3;
989 }
990 optional State state = 1;
991}
992
993/**
994 * Logs keyguard bouncer state. The bouncer is a part of the keyguard, and
995 * prompts the user to enter a password (pattern, pin, etc).
996 *
997 * Logged from:
998 * frameworks/base/packages/SystemUI/src/com/android/systemui/statusbar/phone/KeyguardBouncer.java
999 */
1000
1001message KeyguardBouncerStateChanged {
1002 enum State {
1003 UNKNOWN = 0;
1004 // Bouncer is hidden, either as a result of successfully entering the
1005 // password, screen timing out, or user going back to lock screen.
1006 HIDDEN = 1;
1007 // This is when the user is being prompted to enter the password.
1008 SHOWN = 2;
1009 }
1010 optional State state = 1;
1011}
1012
1013/**
1014 * Logs the result of entering a password into the keyguard bouncer.
1015 *
1016 * Logged from:
1017 * frameworks/base/packages/SystemUI/src/com/android/keyguard/KeyguardSecurityContainer.java
1018 */
1019message KeyguardBouncerPasswordEntered {
1020 enum BouncerResult {
1021 UNKNOWN = 0;
1022 // The password entered was incorrect.
1023 FAILURE = 1;
1024 // The password entered was correct.
1025 SUCCESS = 2;
1026 }
1027 optional BouncerResult result = 1;
1028}
1029
Tej Singha883b372018-02-15 11:30:01 -08001030/*
1031 * Logs changes to the configuration of the device. The configuration is defined
1032 * in frameworks/base/core/java/android/content/res/Configuration.java
1033 * More documentation is at https://d.android.com/reference/android/content/res/Configuration.html
1034 * Please go there to interpret the possible values each field can be.
1035 *
1036 * Logged from:
1037 * frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
1038 */
1039message ResourceConfigurationChanged {
1040 // Bit mask of color capabilities of the screen.
1041 // Contains information about the color gamut and hdr mode of the screen.
1042 // See: https://d.android.com/reference/android/content/res/Configuration.html#colorMode
Yangster-maca8a30442018-10-13 23:46:34 -07001043 optional int32 color_mode = 1;
Tej Singha883b372018-02-15 11:30:01 -08001044
1045 // The target screen density being rendered to.
1046 // See: https://d.android.com/reference/android/content/res/Configuration.html#densityDpi
Yangster-maca8a30442018-10-13 23:46:34 -07001047 optional int32 density_dpi = 2;
Tej Singha883b372018-02-15 11:30:01 -08001048
1049 // Current user preference for the scaling factor for fonts,
1050 // relative to the base density scaling.
1051 // See: https://d.android.com/reference/android/content/res/Configuration.html#fontScale
Yangster-maca8a30442018-10-13 23:46:34 -07001052 optional float font_scale = 3;
Tej Singha883b372018-02-15 11:30:01 -08001053
1054 // Flag indicating whether the hard keyboard is hidden.
1055 // See: https://d.android.com/reference/android/content/res/Configuration.html#hardKeyboardHidden
Yangster-maca8a30442018-10-13 23:46:34 -07001056 optional int32 hard_keyboard_hidden = 4;
Tej Singha883b372018-02-15 11:30:01 -08001057
1058 // The type of keyboard attached to the device.
1059 // See: https://d.android.com/reference/android/content/res/Configuration.html#keyboard
1060 optional int32 keyboard = 5;
1061
1062 // Flag indicating whether any keyboard is available. Takes soft keyboards into account.
1063 // See: https://d.android.com/reference/android/content/res/Configuration.html#keyboardHidden
Yangster-maca8a30442018-10-13 23:46:34 -07001064 optional int32 keyboard_hidden = 6;
Tej Singha883b372018-02-15 11:30:01 -08001065
1066 // IMSI MCC (Mobile Country Code), corresponding to mcc resource qualifier.
1067 // 0 if undefined.
1068 // See: https://d.android.com/reference/android/content/res/Configuration.html#mcc
1069 optional int32 mcc = 7;
1070
1071 // IMSI MNC (Mobile Network Code), corresponding to mnc resource qualifier.
1072 // 0 if undefined. Note: the actual MNC may be 0, to check for this use the
1073 // MNC_ZERO symbol defined in Configuration.java.
1074 // See: https://d.android.com/reference/android/content/res/Configuration.html#mnc
1075 optional int32 mnc = 8;
1076
1077 // The kind of navigation available on the device.
1078 // See: https://developer.android.com/reference/android/content/res/Configuration.html#navigation
1079 optional int32 navigation = 9;
1080
1081 // Flag indicating whether the navigation is available.
1082 // See: https://d.android.com/reference/android/content/res/Configuration.html#navigationHidden
Yangster-maca8a30442018-10-13 23:46:34 -07001083 optional int32 navigation_hidden = 10;
Tej Singha883b372018-02-15 11:30:01 -08001084
1085 // Overall orientation of the screen.
1086 // See: https://d.android.com/reference/android/content/res/Configuration.html#orientation
1087 optional int32 orientation = 11;
1088
1089 // The current height of the available screen space, in dp units.
1090 // See: https://d.android.com/reference/android/content/res/Configuration.html#screenHeightDp
Yangster-maca8a30442018-10-13 23:46:34 -07001091 optional int32 screen_height_dp = 12;
Tej Singha883b372018-02-15 11:30:01 -08001092
1093 // Bit mask of overall layout of the screen.
1094 // Contains information about screen size, whether the screen is wider/taller
1095 // than normal, whether the screen layout is right-tl-left or left-to-right,
1096 // and whether the screen has a rounded shape.
1097 // See: https://d.android.com/reference/android/content/res/Configuration.html#screenLayout
Yangster-maca8a30442018-10-13 23:46:34 -07001098 optional int32 screen_layout = 13;
Tej Singha883b372018-02-15 11:30:01 -08001099
1100 // Current width of the available screen space, in dp units.
1101 // See: https://d.android.com/reference/android/content/res/Configuration.html#screenWidthDp
Yangster-maca8a30442018-10-13 23:46:34 -07001102 optional int32 screen_width_dp = 14;
Tej Singha883b372018-02-15 11:30:01 -08001103
1104 // The smallest screen size an application will see in normal operation.
1105 // This is the smallest value of both screenWidthDp and screenHeightDp
1106 // in portrait and landscape.
1107 // See: https://d.android.com/reference/android/content/res/Configuration.html#smallestScreenWidthDp
Yangster-maca8a30442018-10-13 23:46:34 -07001108 optional int32 smallest_screen_width_dp = 15;
Tej Singha883b372018-02-15 11:30:01 -08001109
1110 // The type of touch screen attached to the device.
1111 // See: https://d.android.com/reference/android/content/res/Configuration.html#touchscreen
1112 optional int32 touchscreen = 16;
1113
1114 // Bit mask of the ui mode.
1115 // Contains information about the overall ui mode of the device.
1116 // Eg: NORMAL, DESK, CAR, TELEVISION, WATCH, VR_HEADSET
1117 // Also contains information about whether the device is in night mode.
1118 // See: https://d.android.com/reference/android/content/res/Configuration.html#uiMode
Yangster-maca8a30442018-10-13 23:46:34 -07001119 optional int32 ui_mode = 17;
Tej Singha883b372018-02-15 11:30:01 -08001120}
1121
Tej Singheee317b2018-03-07 19:28:05 -08001122
1123/**
1124 * Logs changes in the connection state of the mobile radio.
1125 *
1126 * Logged from:
1127 * frameworks/opt/telephony/src/java/com/android/internal/telephony/dataconnection/DataConnection.java
1128 */
1129message MobileConnectionStateChanged {
1130 // States are from the state machine DataConnection.java.
1131 enum State {
1132 UNKNOWN = 0;
1133 // The connection is inactive, or disconnected.
1134 INACTIVE = 1;
1135 // The connection is being activated, or connecting.
1136 ACTIVATING = 2;
1137 // The connection is active, or connected.
1138 ACTIVE = 3;
1139 // The connection is disconnecting.
1140 DISCONNECTING = 4;
1141 // The connection is disconnecting after creating a connection.
1142 DISCONNECTION_ERROR_CREATING_CONNECTION = 5;
1143 }
1144 optional State state = 1;
1145 // For multi-sim phones, this distinguishes between the sim cards.
1146 optional int32 sim_slot_index = 2;
1147 // Used to identify the connection. Starts at 0 and increments by 1 for
1148 // every new network created. Resets whenever the device reboots.
1149 optional int32 data_connection_id = 3;
1150 // A bitmask for the capabilities of this connection.
1151 // Eg. DEFAULT (internet), MMS, SUPL, DUN, IMS.
1152 // Default value (if we have no information): 0
1153 optional int64 capabilities = 4;
1154 // If this connection has internet.
1155 // This just checks if the DEFAULT bit of capabilities is set.
1156 optional bool has_internet = 5;
1157}
1158
1159/**
1160 * Logs changes in mobile radio technology. eg: LTE, EDGE, CDMA.
1161 *
1162 * Logged from:
1163 * frameworks/opt/telephony/src/java/com/android/internal/telephony/ServiceStateTracker.java
1164 */
1165message MobileRadioTechnologyChanged {
1166 optional android.telephony.NetworkTypeEnum state = 1;
1167 // For multi-sim phones, this distinguishes between the sim cards.
1168 optional int32 sim_slot_index = 2;
1169}
1170
Andrew Chantb56388b2018-03-22 21:07:33 -07001171/**
1172 * Logs the VID and PID of any connected USB devices.
1173 *
1174 * Notes if any Audio, HID (input buttons/mouse/keyboard), or Storage interfaces are present.
1175 *
1176 * Logged by Vendor.
1177 */
1178message UsbDeviceAttached {
1179 optional int32 vid = 1;
1180 optional int32 pid = 2;
1181 optional bool has_audio = 3;
1182 optional bool has_hid = 4;
1183 optional bool has_storage = 5;
1184}
1185
Tej Singheee317b2018-03-07 19:28:05 -08001186
Tej Singhdd7bd352018-02-09 19:33:15 -08001187/**
Tej Singh5d991e12018-03-09 19:48:11 -08001188 * Logs when Bluetooth is enabled and disabled.
1189 *
1190 * Logged from:
1191 * services/core/java/com/android/server/BluetoothManagerService.java
1192 */
1193message BluetoothEnabledStateChanged {
1194 repeated AttributionNode attribution_node = 1;
1195 // Whether or not bluetooth is enabled on the device.
1196 enum State {
1197 UNKNOWN = 0;
1198 ENABLED = 1;
1199 DISABLED = 2;
1200 }
1201 optional State state = 2;
1202 // The reason for being enabled/disabled.
1203 // Eg. Airplane mode, crash, application request.
1204 optional android.bluetooth.EnableDisableReasonEnum reason = 3;
1205 // If the reason is an application request, this will be the package name.
Yangster-maca8a30442018-10-13 23:46:34 -07001206 optional string pkg_name = 4;
Tej Singh5d991e12018-03-09 19:48:11 -08001207}
1208
1209/**
1210 * Logs when a Bluetooth device connects and disconnects.
1211 *
1212 * Logged from:
1213 * packages/apps/Bluetooth/src/com/android/bluetooth/btservice/AdapterProperties.java
1214 */
1215message BluetoothConnectionStateChanged {
1216 // The state of the connection.
1217 // Eg: CONNECTING, CONNECTED, DISCONNECTING, DISCONNECTED.
1218 optional android.bluetooth.ConnectionStateEnum state = 1;
1219 // An identifier that can be used to match connect and disconnect events.
1220 // Currently is last two bytes of a hash of a device level ID and
1221 // the mac address of the bluetooth device that is connected.
1222 optional int32 obfuscated_id = 2;
1223 // The profile that is connected. Eg. GATT, A2DP, HEADSET.
1224 // From android.bluetooth.BluetoothAdapter.java
1225 optional int32 bt_profile = 3;
1226}
1227
1228/**
Andrew Chant28d627e2018-02-22 15:17:05 -08001229 * Logs when something is plugged into or removed from the USB-C connector.
1230 *
1231 * Logged from:
1232 * Vendor USB HAL.
1233 */
1234message UsbConnectorStateChanged {
1235 enum State {
1236 DISCONNECTED = 0;
1237 CONNECTED = 1;
1238 }
1239 optional State state = 1;
1240}
1241
1242/**
1243 * Logs the reported speaker impedance.
1244 *
1245 * Logged from:
1246 * Vendor audio implementation.
1247 */
1248message SpeakerImpedanceReported {
1249 optional int32 speaker_location = 1;
1250 optional int32 impedance = 2;
1251}
1252
1253/**
1254 * Logs the report of a failed hardware.
1255 *
1256 * Logged from:
1257 * Vendor HALs.
1258 *
1259 */
1260message HardwareFailed {
1261 enum HardwareType {
1262 HARDWARE_FAILED_UNKNOWN = 0;
1263 HARDWARE_FAILED_MICROPHONE = 1;
1264 HARDWARE_FAILED_CODEC = 2;
1265 HARDWARE_FAILED_SPEAKER = 3;
1266 HARDWARE_FAILED_FINGERPRINT = 4;
1267 }
1268 optional HardwareType hardware_type = 1;
1269
1270 /* hardware_location allows vendors to differentiate between multiple instances of
1271 * the same hardware_type. The specific locations are vendor defined integers,
1272 * referring to board-specific numbering schemes.
1273 */
1274 optional int32 hardware_location = 2;
1275
1276 /* failure_code is specific to the HardwareType of the failed hardware.
1277 * It should use the enum values defined below.
1278 */
1279 enum MicrophoneFailureCode {
1280 MICROPHONE_FAILURE_COMPLETE = 0;
1281 }
1282 enum CodecFailureCode {
1283 CODEC_FAILURE_COMPLETE = 0;
1284 }
1285 enum SpeakerFailureCode {
1286 SPEAKER_FAILURE_COMPLETE = 0;
1287 SPEAKER_FAILURE_HIGH_Z = 1;
1288 SPEAKER_FAILURE_SHORT = 2;
1289 }
1290 enum FingerprintFailureCode {
1291 FINGERPRINT_FAILURE_COMPLETE = 0;
1292 FINGERPRINT_SENSOR_BROKEN = 1;
1293 FINGERPRINT_TOO_MANY_DEAD_PIXELS = 2;
1294 }
1295 optional int32 failure_code = 3;
1296}
1297
1298/**
1299 * Log an event when the device has been physically dropped.
1300 * Reported from the /vendor partition.
1301 */
1302message PhysicalDropDetected {
1303 // Confidence that the event was actually a drop, 0 -> 100
1304 optional int32 confidence_pctg = 1;
1305 // Peak acceleration of the drop, in 1/1000s of a g.
1306 optional int32 accel_peak_thousandths_g = 2;
Andrew Chantb56388b2018-03-22 21:07:33 -07001307 // Duration of freefall in ms
1308 optional int32 freefall_time_millis = 3;
Andrew Chant28d627e2018-02-22 15:17:05 -08001309}
1310
1311/**
1312 * Log bucketed battery charge cycles.
1313 *
1314 * Each bucket represents cycles of the battery past
1315 * a given charge point. For example, bucket 1 is the
1316 * lowest 1/8th of the battery, and bucket 8 is 100%.
1317 *
1318 * Logged from:
1319 * /sys/class/power_supply/bms/cycle_count, via Vendor.
1320 */
1321message ChargeCyclesReported {
1322 optional int32 cycle_bucket_1 = 1;
1323 optional int32 cycle_bucket_2 = 2;
1324 optional int32 cycle_bucket_3 = 3;
1325 optional int32 cycle_bucket_4 = 4;
1326 optional int32 cycle_bucket_5 = 5;
1327 optional int32 cycle_bucket_6 = 6;
1328 optional int32 cycle_bucket_7 = 7;
1329 optional int32 cycle_bucket_8 = 8;
1330}
1331
1332/**
Howard Roa46b6582018-09-18 16:45:02 -07001333 * Log battery health snapshot.
1334 *
1335 * Resistance, Voltage, Open Circuit Voltage, Temperature, and Charge Level
1336 * are snapshotted periodically over 24hrs.
1337 */
1338message BatteryHealthSnapshot {
1339 enum BatterySnapshotType {
1340 UNKNOWN = 0;
1341 MIN_TEMP = 1; // Snapshot at min batt temp over 24hrs.
1342 MAX_TEMP = 2; // Snapshot at max batt temp over 24hrs.
1343 MIN_RESISTANCE = 3; // Snapshot at min batt resistance over 24hrs.
1344 MAX_RESISTANCE = 4; // Snapshot at max batt resistance over 24hrs.
1345 MIN_VOLTAGE = 5; // Snapshot at min batt voltage over 24hrs.
1346 MAX_VOLTAGE = 6; // Snapshot at max batt voltage over 24hrs.
1347 MIN_CURRENT = 7; // Snapshot at min batt current over 24hrs.
1348 MAX_CURRENT = 8; // Snapshot at max batt current over 24hrs.
1349 MIN_BATT_LEVEL = 9; // Snapshot at min battery level (SoC) over 24hrs.
1350 MAX_BATT_LEVEL = 10; // Snapshot at max battery level (SoC) over 24hrs.
1351 AVG_RESISTANCE = 11; // Snapshot at average battery resistance over 24hrs.
1352 }
1353 optional BatterySnapshotType type = 1;
1354 // Temperature, in 1/10ths of degree C.
Yangster-maca8a30442018-10-13 23:46:34 -07001355 optional int32 temperature_deci_celsius = 2;
Howard Roa46b6582018-09-18 16:45:02 -07001356 // Voltage Battery Voltage, in microVolts.
1357 optional int32 voltage_micro_volt = 3;
1358 // Current Battery current, in microAmps.
1359 optional int32 current_micro_amps = 4;
1360 // OpenCircuitVoltage Battery Open Circuit Voltage, in microVolts.
1361 optional int32 open_circuit_micro_volt = 5;
1362 // Resistance Battery Resistance, in microOhms.
1363 optional int32 resistance_micro_ohm = 6;
1364 // Level Battery Level, as % of full.
1365 optional int32 level_percent = 7;
1366}
1367
1368/**
1369 * Log slow I/O operations on the primary storage.
1370 */
1371message SlowIo {
1372 // Classifications of IO Operations.
1373 enum IoOperation {
1374 UNKNOWN = 0;
1375 READ = 1;
1376 WRITE = 2;
1377 UNMAP = 3;
1378 SYNC = 4;
1379 }
1380 optional IoOperation operation = 1;
1381
1382 // The number of slow IO operations of this type over 24 hours.
1383 optional int32 count = 2;
1384}
1385
1386/**
1387 * Log battery caused shutdown with the last recorded voltage.
1388 */
1389message BatteryCausedShutdown {
1390 // The last recorded battery voltage prior to shutdown.
1391 optional int32 last_recorded_micro_volt = 1;
1392}
1393
1394/**
Tej Singhbb8554a2018-01-26 11:59:14 -08001395 * Logs the duration of a davey (jank of >=700ms) when it occurs
1396 *
1397 * Logged from:
1398 * frameworks/base/libs/hwui/JankTracker.cpp
1399 */
1400message DaveyOccurred {
David Chen77ef6712018-02-23 18:23:42 -08001401 // The UID that logged this atom.
Yao Chenc40a19d2018-03-15 16:48:25 -07001402 optional int32 uid = 1 [(is_uid) = true];
David Chen77ef6712018-02-23 18:23:42 -08001403
Tej Singhbb8554a2018-01-26 11:59:14 -08001404 // Amount of time it took to render the frame. Should be >=700ms.
David Chen77ef6712018-02-23 18:23:42 -08001405 optional int64 jank_duration_millis = 2;
Tej Singhbb8554a2018-01-26 11:59:14 -08001406}
1407
1408/**
Bookatze5885242017-10-24 20:10:31 -07001409 * Logs phone signal strength changes.
1410 *
1411 * Logged from:
David Chenc28b2bb2017-10-24 12:52:52 -07001412 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
Bookatze5885242017-10-24 20:10:31 -07001413 */
1414message PhoneSignalStrengthChanged {
Bookatz1a1b0462018-01-12 11:47:03 -08001415 // Signal strength, from frameworks/base/core/proto/android/telephony/enums.proto.
1416 optional android.telephony.SignalStrengthEnum signal_strength = 1;
David Chenc28b2bb2017-10-24 12:52:52 -07001417}
1418
Yangster4ccebea2018-10-09 17:09:02 -07001419
1420/**
1421 * Logs when the phone state, sim state or signal strength changes
1422 *
1423 * Logged from:
1424 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
1425 */
1426message PhoneServiceStateChanged {
1427 optional android.telephony.ServiceStateEnum state = 1;
1428 optional android.telephony.SimStateEnum sim_state = 2;
1429 optional android.telephony.SignalStrengthEnum signal_strength = 3;
1430}
1431
1432/**
1433 * Logs when the phone becomes on or off.
1434 *
1435 * Logged from:
1436 * frameworks/base/core/java/com/android/internal/os/TelephonyRegistry.java
1437 */
1438message PhoneStateChanged {
1439 enum State {
1440 OFF = 0;
1441 ON = 1;
1442 }
1443 optional State state = 1;
1444}
1445
Hyunyoung Songc6d6b772018-10-17 13:35:32 -07001446message LauncherUIChanged {
Yao Chen8c433862018-10-24 14:09:20 -07001447 optional android.stats.launcher.LauncherAction action = 1;
1448 optional android.stats.launcher.LauncherState src_state = 2;
1449 optional android.stats.launcher.LauncherState dst_state = 3;
1450 optional android.stats.launcher.LauncherExtension extension = 4 [(log_mode) = MODE_BYTES];
Hyunyoung Songc6d6b772018-10-17 13:35:32 -07001451 optional bool is_swipe_up_enabled = 5;
1452}
1453
David Chenc28b2bb2017-10-24 12:52:52 -07001454/**
Fan Zhang916c13b2018-10-16 22:49:45 -07001455 * Logs when Settings UI has changed.
1456 *
1457 * Logged from:
1458 * packages/apps/Settings
1459 */
1460message SettingsUIChanged {
1461 /**
Fan Zhang916c13b2018-10-16 22:49:45 -07001462 * Where this SettingsUIChange event comes from. For example, if
1463 * it's a PAGE_VISIBLE event, where the page is opened from.
1464 */
Fan Zhangf837b8e2018-10-23 12:38:30 -07001465 optional android.app.settings.PageId attribution = 1;
Fan Zhang916c13b2018-10-16 22:49:45 -07001466
1467 /**
1468 * What the UI action is.
1469 */
Fan Zhangf837b8e2018-10-23 12:38:30 -07001470 optional android.app.settings.Action action = 2;
Fan Zhang916c13b2018-10-16 22:49:45 -07001471
1472 /**
1473 * Where the action is happening
1474 */
Fan Zhangf837b8e2018-10-23 12:38:30 -07001475 optional android.app.settings.PageId pageId = 3;
Fan Zhang916c13b2018-10-16 22:49:45 -07001476
1477 /**
1478 * What preference changed in this event.
1479 */
1480 optional string changedPreferenceKey = 4;
1481
1482 /**
1483 * The new value of the changed preference.
1484 */
1485 optional int64 changedPreferenceIntValue = 5;
1486}
1487
1488/**
David Chenc28b2bb2017-10-24 12:52:52 -07001489 * Logs that a setting was updated.
1490 * Logged from:
David Chenbd789912018-03-16 17:19:55 -07001491 * frameworks/base/packages/SettingsProvider/src/com/android/providers/settings/SettingsState.java
David Chenc28b2bb2017-10-24 12:52:52 -07001492 * The tag and is_default allow resetting of settings to default values based on the specified
1493 * tag. See Settings#putString(ContentResolver, String, String, String, boolean) for more details.
1494 */
1495message SettingChanged {
1496 // The name of the setting.
1497 optional string setting = 1;
1498
1499 // The change being imposed on this setting. May represent a number, eg "3".
1500 optional string value = 2;
1501
1502 // The new value of this setting. For most settings, this is same as value. For some settings,
1503 // value is +X or -X where X represents an element in a set. For example, if the previous value
1504 // is A,B,C and value is -B, then new_value is A,C and prev_value is A,B,C.
1505 // The +/- feature is currently only used for location_providers_allowed.
1506 optional string new_value = 3;
1507
1508 // The previous value of this setting.
1509 optional string prev_value = 4;
1510
1511 // The tag used with the is_default for resetting sets of settings. This is generally null.
1512 optional string tag = 5;
1513
Bookatz90867622018-01-31 15:05:57 -08001514 // True if this setting with tag should be resettable.
1515 optional bool is_default = 6;
David Chenc28b2bb2017-10-24 12:52:52 -07001516
David Chenbd789912018-03-16 17:19:55 -07001517 // The associated user (for multi-user feature). Defined in android/os/UserHandle.java
David Chenc28b2bb2017-10-24 12:52:52 -07001518 optional int32 user = 7;
David Chenbd789912018-03-16 17:19:55 -07001519
1520 enum ChangeReason {
1521 UPDATED = 1; // Updated can be an insertion or an update.
1522 DELETED = 2;
1523 }
1524 optional ChangeReason reason = 8;
David Chenc28b2bb2017-10-24 12:52:52 -07001525}
Chenjie Yub3dda412017-10-24 13:41:59 -07001526
Chenjie Yu05013b32017-11-21 10:21:41 -08001527/**
Chenjie Yu3d4f6042017-10-27 15:39:34 -07001528 * Logs activity going to foreground or background
1529 *
1530 * Logged from:
1531 * frameworks/base/services/core/java/com/android/server/am/ActivityRecord.java
1532 */
1533message ActivityForegroundStateChanged {
Yao Chenc40a19d2018-03-15 16:48:25 -07001534 optional int32 uid = 1 [(is_uid) = true];
Yangster-mac20877162017-12-22 17:19:39 -08001535 optional string pkg_name = 2;
1536 optional string class_name = 3;
1537
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001538 enum State {
1539 BACKGROUND = 0;
1540 FOREGROUND = 1;
Chenjie Yu3d4f6042017-10-27 15:39:34 -07001541 }
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001542 optional State state = 4;
Chenjie Yu3d4f6042017-10-27 15:39:34 -07001543}
David Chenc8a43242017-10-17 16:23:28 -07001544
1545/**
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001546 * Logs when an app crashes.
David Chen9e3808c2017-11-20 17:25:34 -08001547 * Logged from:
1548 * frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
1549 */
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001550message AppCrashOccurred {
Yao Chenc40a19d2018-03-15 16:48:25 -07001551 optional int32 uid = 1 [(is_uid) = true];
David Chen9e3808c2017-11-20 17:25:34 -08001552
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001553 optional string event_type = 2;
David Chen9e3808c2017-11-20 17:25:34 -08001554
1555 // The name of the process.
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001556 // system_server if it is not by an app
David Chen9e3808c2017-11-20 17:25:34 -08001557 optional string process_name = 3;
1558
1559 // The pid if available. -1 means not available.
David Chen6e3e6cb2018-01-03 16:14:06 -08001560 optional sint32 pid = 4;
Chenjie Yuf17bf622018-04-02 14:22:19 -07001561
1562 optional string package_name = 5;
1563
1564 enum InstantApp {
1565 UNAVAILABLE = 0;
1566 FALSE = 1;
1567 TRUE = 2;
1568 }
1569 optional InstantApp is_instant_app = 6;
1570
1571 enum ForegroundState {
1572 UNKNOWN = 0;
1573 BACKGROUND = 1;
1574 FOREGROUND = 2;
1575 }
1576 optional ForegroundState foreground_state = 7;
Yang Lu732d6382018-11-05 07:53:12 -08001577
1578 optional android.server.ErrorSource error_source = 8;
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001579}
David Chen9e3808c2017-11-20 17:25:34 -08001580
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001581/**
1582 * Logs when a WTF (What a Terrible Failure) happened.
1583 * Logged from:
1584 * frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
1585 */
1586message WTFOccurred {
1587 optional int32 uid = 1 [(is_uid) = true];
David Chen9e3808c2017-11-20 17:25:34 -08001588
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001589 optional string tag = 2;
David Chen9e3808c2017-11-20 17:25:34 -08001590
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001591 // The name of the process.
1592 // system_server if it is not by an app
1593 optional string process_name = 3;
David Chen6e3e6cb2018-01-03 16:14:06 -08001594
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001595 // The pid if available. -1 means not available.
1596 optional sint32 pid = 4;
Yang Lu732d6382018-11-05 07:53:12 -08001597
1598 optional android.server.ErrorSource error_source = 5;
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001599}
1600
1601/**
1602 * Logs when system server reports low memory.
1603 * Logged from:
1604 * frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
1605 */
1606message LowMemReported {
1607}
1608
1609/**
1610 * Logs when an app ANR (App Not Responding) occurs.
1611 * Logged from:
1612 * frameworks/base/services/core/java/com/android/server/am/AppErrors.java
1613 */
1614message ANROccurred {
1615 optional int32 uid = 1 [(is_uid) = true];
1616
1617 optional string process_name = 2;
1618
1619 optional string short_component_name = 3;
1620
1621 optional string reason = 4;
Chenjie Yuf17bf622018-04-02 14:22:19 -07001622
1623 enum InstantApp {
1624 UNAVAILABLE = 0;
1625 FALSE = 1;
1626 TRUE = 2;
1627 }
1628 optional InstantApp is_instant_app = 5;
1629
1630 enum ForegroundState {
1631 UNKNOWN = 0;
1632 BACKGROUND = 1;
1633 FOREGROUND = 2;
1634 }
1635 optional ForegroundState foreground_state = 6;
Yang Lu732d6382018-11-05 07:53:12 -08001636
1637 optional android.server.ErrorSource error_source = 7;
1638
1639 optional string package_name = 8;
David Chen9e3808c2017-11-20 17:25:34 -08001640}
1641
Bookatza7020bd2018-08-28 16:29:35 -07001642/**
1643 * Logs when the vibrator state changes.
1644 * Logged from:
1645 * frameworks/base/services/core/java/com/android/server/VibratorService.java
1646 */
1647message VibratorStateChanged {
1648 repeated AttributionNode attribution_node = 1;
1649
1650 enum State {
1651 OFF = 0;
1652 ON = 1;
1653 }
1654 optional State state = 2;
1655
1656 // Duration (in milliseconds) requested to keep the vibrator on.
1657 // Only applicable for State == ON.
1658 optional int64 duration_millis = 3;
1659}
1660
David Chen0a368b22017-12-06 16:28:16 -08001661/*
1662 * Allows other apps to push events into statsd.
1663 * Logged from:
1664 * frameworks/base/core/java/android/util/StatsLog.java
1665 */
David Chen0b5c90c2018-01-25 16:51:49 -08001666message AppBreadcrumbReported {
David Chen0a368b22017-12-06 16:28:16 -08001667 // The uid of the application that sent this custom atom.
Yao Chenc40a19d2018-03-15 16:48:25 -07001668 optional int32 uid = 1 [(is_uid) = true];
David Chen0a368b22017-12-06 16:28:16 -08001669
1670 // An arbitrary label chosen by the developer. For Android P, the label should be in [0, 16).
1671 optional int32 label = 2;
1672
1673 // Allows applications to easily use a custom event as start/stop boundaries (ie, define custom
1674 // predicates for the metrics).
1675 enum State {
1676 UNKNOWN = 0;
1677 UNSPECIFIED = 1; // For events that are known to not represent START/STOP.
1678 STOP = 2;
1679 START = 3;
1680 }
1681 optional State state = 3;
1682}
1683
David Chen9e3808c2017-11-20 17:25:34 -08001684/**
Bookatz7948c872018-09-04 12:58:33 -07001685 * Logs the wall-clock time when a significant wall-clock time shift occurs.
1686 * For example, this could be due to the user manually changing the time.
1687 *
1688 * Logged from:
1689 * frameworks/base/services/core/java/com/android/server/AlarmManagerService.java
1690 */
1691message WallClockTimeShifted {
1692 // New wall-clock time in milliseconds, according to System.currentTimeMillis().
1693 optional int64 wall_clock_timestamp_millis = 1;
1694}
1695
1696/**
Bookatz8fcd09a2017-12-18 13:01:10 -08001697 * Logs when statsd detects an anomaly.
1698 *
1699 * Logged from:
1700 * frameworks/base/cmds/statsd/src/anomaly/AnomalyTracker.cpp
1701 */
1702message AnomalyDetected {
1703 // Uid that owns the config whose anomaly detection alert fired.
Yao Chenc40a19d2018-03-15 16:48:25 -07001704 optional int32 config_uid = 1 [(is_uid) = true];
Bookatz8fcd09a2017-12-18 13:01:10 -08001705
Yangster-mac94e197c2018-01-02 16:03:03 -08001706 // Id of the config whose anomaly detection alert fired.
1707 optional int64 config_id = 2;
Bookatz8fcd09a2017-12-18 13:01:10 -08001708
Yangster-mac94e197c2018-01-02 16:03:03 -08001709 // Id of the alert (i.e. name of the anomaly that was detected).
1710 optional int64 alert_id = 3;
Bookatz8fcd09a2017-12-18 13:01:10 -08001711}
1712
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001713message AppStartOccurred {
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001714 // The uid if available. -1 means not available.
Yao Chenc40a19d2018-03-15 16:48:25 -07001715 optional int32 uid = 1 [(is_uid) = true];
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001716
1717 // The app package name.
1718 optional string pkg_name = 2;
1719
1720 enum TransitionType {
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001721 UNKNOWN = 0;
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001722 WARM = 1;
1723 HOT = 2;
1724 COLD = 3;
1725 }
1726 // The transition type.
1727 optional TransitionType type = 3;
1728
1729 // The activity name.
1730 optional string activity_name = 4;
1731
1732 // The name of the calling app. Empty if not set.
1733 optional string calling_pkg_name = 5;
1734
1735 // Whether the app is an instant app.
1736 optional bool is_instant_app = 6;
1737
1738 // Device uptime when activity started.
David Chen0b5c90c2018-01-25 16:51:49 -08001739 optional int64 activity_start_millis = 7;
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001740
Bookatz80d11a02018-01-16 10:46:35 -08001741 optional android.app.AppTransitionReasonEnum reason = 8;
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001742
David Chen0b5c90c2018-01-25 16:51:49 -08001743 optional int32 transition_delay_millis = 9;
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001744 // -1 if not set.
David Chen0b5c90c2018-01-25 16:51:49 -08001745 optional int32 starting_window_delay_millis = 10;
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001746 // -1 if not set.
David Chen0b5c90c2018-01-25 16:51:49 -08001747 optional int32 bind_application_delay_millis = 11;
1748 optional int32 windows_drawn_delay_millis = 12;
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001749
1750 // Empty if not set.
1751 optional string launch_token = 13;
1752
Calin Juravle759fbda2018-02-20 19:52:30 +00001753 // The compiler filter used when when the package was optimized.
Calin Juravlea86783b2018-03-21 14:25:59 -07001754 optional int32 package_optimization_compilation_filter = 14;
Calin Juravle759fbda2018-02-20 19:52:30 +00001755
1756 // The reason why the package was optimized.
Calin Juravlea86783b2018-03-21 14:25:59 -07001757 optional int32 package_optimization_compilation_reason = 15;
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001758}
1759
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001760message AppStartCanceled {
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001761 // The uid if available. -1 means not available.
Yao Chenc40a19d2018-03-15 16:48:25 -07001762 optional int32 uid = 1 [(is_uid) = true];
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001763
1764 // The app package name.
1765 optional string pkg_name = 2;
1766
1767 enum TransitionType {
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001768 UNKNOWN = 0;
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001769 WARM = 1;
1770 HOT = 2;
1771 COLD = 3;
1772 }
1773 // The transition type.
1774 optional TransitionType type = 3;
1775
1776 // The activity name.
1777 optional string activity_name = 4;
1778}
1779
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001780message AppStartFullyDrawn {
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001781 // The uid if available. -1 means not available.
Yao Chenc40a19d2018-03-15 16:48:25 -07001782 optional int32 uid = 1 [(is_uid) = true];
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001783
1784 // The app package name.
1785 optional string pkg_name = 2;
1786
1787 enum TransitionType {
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001788 UNKNOWN = 0;
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001789 WITH_BUNDLE = 1;
1790 WITHOUT_BUNDLE = 2;
1791 }
1792 // The transition type.
1793 optional TransitionType type = 3;
1794
1795 // The activity name.
1796 optional string activity_name = 4;
1797
1798 optional bool transition_process_running = 5;
1799
1800 // App startup time (until call to Activity#reportFullyDrawn()).
David Chen0b5c90c2018-01-25 16:51:49 -08001801 optional int64 app_startup_time_millis = 6;
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001802}
1803
Bookatz8fcd09a2017-12-18 13:01:10 -08001804/**
Chenjie Yu52cacc62017-12-08 18:11:45 -08001805 * Logs a picture-in-picture action
1806 * Logged from:
1807 * frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
1808 * frameworks/base/services/core/java/com/android/server/am/ActivityStackSupervisor.java
1809 * frameworks/base/packages/SystemUI/src/com/android/systemui/pip/phone/PipTouchHandler.java
1810 */
1811message PictureInPictureStateChanged {
Chenjie Yuae9fdf042018-02-15 10:19:32 -08001812 // -1 if it is not available
Yao Chenc40a19d2018-03-15 16:48:25 -07001813 optional int32 uid = 1 [(is_uid) = true];
Chenjie Yu52cacc62017-12-08 18:11:45 -08001814
Chenjie Yuae9fdf042018-02-15 10:19:32 -08001815 optional string short_name = 2;
Chenjie Yu52cacc62017-12-08 18:11:45 -08001816
Chenjie Yu52cacc62017-12-08 18:11:45 -08001817 enum State {
1818 ENTERED = 1;
1819 EXPANDED_TO_FULL_SCREEN = 2;
1820 MINIMIZED = 3;
1821 DISMISSED = 4;
1822 }
Chenjie Yuae9fdf042018-02-15 10:19:32 -08001823 optional State state = 3;
Chenjie Yu52cacc62017-12-08 18:11:45 -08001824}
1825
1826/**
Chenjie Yue8904192017-12-08 19:12:57 -08001827 * Logs overlay action
1828 * Logged from:
1829 * services/core/java/com/android/server/wm/Session.java
1830 */
1831message OverlayStateChanged {
Yao Chenc40a19d2018-03-15 16:48:25 -07001832 optional int32 uid = 1 [(is_uid) = true];
Chenjie Yue8904192017-12-08 19:12:57 -08001833
1834 optional string package_name = 2;
1835
1836 optional bool using_alert_window = 3;
1837
1838 enum State {
1839 ENTERED = 1;
1840 EXITED = 2;
1841 }
1842 optional State state = 4;
1843}
1844
Chenjie Yuccfe6452018-01-30 11:33:21 -08001845/*
1846 * Logs foreground service starts and stops.
1847 * Note that this is not when a service starts or stops, but when it is
1848 * considered foreground.
1849 * Logged from
1850 * //frameworks/base/services/core/java/com/android/server/am/ActiveServices.java
1851 */
1852message ForegroundServiceStateChanged {
Yao Chenc40a19d2018-03-15 16:48:25 -07001853 optional int32 uid = 1 [(is_uid) = true];
Chenjie Yuccfe6452018-01-30 11:33:21 -08001854 // package_name + "/" + class_name
1855 optional string short_name = 2;
1856
1857 enum State {
1858 ENTER = 1;
1859 EXIT = 2;
1860 }
1861 optional State state = 3;
1862}
1863
Chenjie Yue8904192017-12-08 19:12:57 -08001864/**
Chenjie Yubbcbc602018-02-05 16:51:52 -08001865 * Logs creation or removal of an isolated uid. Isolated uid's are temporary uid's to sandbox risky
1866 * behavior in its own uid. However, the metrics of these isolated uid's almost always should be
1867 * attributed back to the parent (host) uid. One example is Chrome.
1868 *
1869 * Logged from:
1870 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
1871 */
1872message IsolatedUidChanged {
1873 // The host UID. Generally, we should attribute metrics from the isolated uid to the host uid.
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001874 // NOTE: DO NOT annotate uid field in this atom. This atom is specially handled in statsd.
Bookatz3c648862018-05-25 13:32:43 -07001875 // This field is ignored when event == REMOVED.
Chenjie Yubbcbc602018-02-05 16:51:52 -08001876 optional int32 parent_uid = 1;
1877
1878 optional int32 isolated_uid = 2;
1879
1880 // We expect an isolated uid to be removed before if it's used for another parent uid.
1881 enum Event {
1882 REMOVED = 0;
1883 CREATED = 1;
1884 }
1885 optional Event event = 3;
1886}
1887
1888/*
1889 * Logs the reception of an incoming network packet causing the main system to wake up for
1890 * processing that packet. These events are notified by the kernel via Netlink NFLOG to Netd
1891 * and processed by WakeupController.cpp.
1892 */
1893message PacketWakeupOccurred {
1894 // The uid owning the socket into which the packet was delivered, or -1 if the packet was
1895 // delivered nowhere.
Yao Chenc40a19d2018-03-15 16:48:25 -07001896 optional int32 uid = 1 [(is_uid) = true];
Chenjie Yubbcbc602018-02-05 16:51:52 -08001897 // The interface name on which the packet was received.
1898 optional string iface = 2;
1899 // The ethertype value of the packet.
1900 optional int32 ethertype = 3;
1901 // String representation of the destination MAC address of the packet.
1902 optional string destination_hardware_address = 4;
1903 // String representation of the source address of the packet if this was an IP packet.
1904 optional string source_ip = 5;
1905 // String representation of the destination address of the packet if this was an IP packet.
1906 optional string destination_ip = 6;
1907 // The value of the protocol field if this was an IPv4 packet or the value of the Next Header
1908 // field if this was an IPv6 packet. The range of possible values is the same for both IP
1909 // families.
1910 optional int32 ip_next_header = 7;
1911 // The source port if this was a TCP or UDP packet.
1912 optional int32 source_port = 8;
1913 // The destination port if this was a TCP or UDP packet.
1914 optional int32 destination_port = 9;
1915}
1916
1917/*
1918 * Logs the memory stats for an app on startup.
1919 * Logged from:
1920 * frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
1921 */
1922message AppStartMemoryStateCaptured {
1923 // The uid if available. -1 means not available.
Yao Chenc40a19d2018-03-15 16:48:25 -07001924 optional int32 uid = 1 [(is_uid) = true];
Chenjie Yubbcbc602018-02-05 16:51:52 -08001925
1926 // The process name.
1927 optional string process_name = 2;
1928
1929 // The activity name.
1930 optional string activity_name = 3;
1931
1932 // # of page-faults
Yangster-maca8a30442018-10-13 23:46:34 -07001933 optional int64 page_fault = 4;
Chenjie Yubbcbc602018-02-05 16:51:52 -08001934
1935 // # of major page-faults
Yangster-maca8a30442018-10-13 23:46:34 -07001936 optional int64 page_major_fault = 5;
Chenjie Yubbcbc602018-02-05 16:51:52 -08001937
1938 // RSS
1939 optional int64 rss_in_bytes = 6;
1940
1941 // CACHE
1942 optional int64 cache_in_bytes = 7;
1943
1944 // SWAP
1945 optional int64 swap_in_bytes = 8;
1946}
1947
1948/*
1949 * Logs the change in Low Memory Killer Daemon (LMKD) state which is used as start/stop boundaries
1950 * for LMK event.
1951 * Logged from:
1952 * system/core/lmkd/lmkd.c
1953 */
1954message LmkStateChanged {
1955 enum State {
1956 UNKNOWN = 0;
1957 START = 1;
1958 STOP = 2;
1959 }
1960 optional State state = 1;
1961}
1962
1963/*
1964 * Logs the event when Low Memory Killer Daemon (LMKD) kills a process to reduce memory pressure.
1965 * Logged from:
1966 * system/core/lmkd/lmkd.c
1967 */
1968message LmkKillOccurred {
1969 // The uid if available. -1 means not available.
Yao Chenc40a19d2018-03-15 16:48:25 -07001970 optional int32 uid = 1 [(is_uid) = true];
Chenjie Yubbcbc602018-02-05 16:51:52 -08001971
1972 // The process name.
1973 optional string process_name = 2;
1974
1975 // oom adj score.
Yangster-maca8a30442018-10-13 23:46:34 -07001976 optional int32 oom_adj_score = 3;
Chenjie Yubbcbc602018-02-05 16:51:52 -08001977
1978 // # of page-faults
Yangster-maca8a30442018-10-13 23:46:34 -07001979 optional int64 page_fault = 4;
Chenjie Yubbcbc602018-02-05 16:51:52 -08001980
1981 // # of major page-faults
Yangster-maca8a30442018-10-13 23:46:34 -07001982 optional int64 page_major_fault = 5;
Chenjie Yubbcbc602018-02-05 16:51:52 -08001983
1984 // RSS
1985 optional int64 rss_in_bytes = 6;
1986
1987 // CACHE
1988 optional int64 cache_in_bytes = 7;
1989
1990 // SWAP
1991 optional int64 swap_in_bytes = 8;
1992}
1993
Rajeev Kumar51b54602018-03-01 12:18:26 -08001994/*
1995 * Logs when the ActivityManagerService detects that an app died.
1996 *
1997 * Logged from:
1998 * frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
1999 */
2000message AppDied {
2001 // timestamp(elapsedRealtime) of record creation
Yangster-macb6b77c62018-10-12 19:33:24 -07002002 optional uint64 timestamp_millis = 1 [(state_field_option).option = EXCLUSIVE];
Rajeev Kumar51b54602018-03-01 12:18:26 -08002003}
2004
Howard Ro21a039c2018-08-06 14:55:47 -07002005/**
2006 * An atom for generic metrics logging. Available from Android Q.
2007 */
2008message GenericAtom {
2009 // The uid of the application that sent this custom atom.
2010 optional int32 uid = 1 [(is_uid) = true];
2011
2012 // An event_id indicates the type of event.
Howard Ro9a862de2018-10-11 16:03:33 -07002013 optional android.stats.EventType event_id = 2;
Howard Ro21a039c2018-08-06 14:55:47 -07002014}
2015
Tej Singhd6d6d772018-09-05 17:41:25 -07002016/**
2017 * Logs when a fingerprint acquire event occurs.
2018 *
2019 * Logged from:
2020 * frameworks/base/services/core/java/com/android/server/biometrics/fingerprint/FingerprintService.java
2021 */
2022message FingerprintAcquired {
2023 // The associated user. Eg: 0 for owners, 10+ for others.
2024 // Defined in android/os/UserHandle.java
2025 optional int32 user = 1;
2026 // If this acquire is for a crypto fingerprint.
2027 // e.g. Secure purchases, unlock password storage.
2028 optional bool is_crypto = 2;
2029}
2030
2031/**
2032 * Logs when a fingerprint authentication event occurs.
2033 *
2034 * Logged from:
2035 * frameworks/base/services/core/java/com/android/server/biometrics/fingerprint/FingerprintService.java
2036 */
2037message FingerprintAuthenticated {
2038 // The associated user. Eg: 0 for owners, 10+ for others.
2039 // Defined in android/os/UserHandle.java
2040 optional int32 user = 1;
2041 // If this authentication is for a crypto fingerprint.
2042 // e.g. Secure purchases, unlock password storage.
2043 optional bool is_crypto = 2;
2044 // Whether or not this authentication was successful.
2045 optional bool is_authenticated = 3;
2046}
2047
2048/**
2049 * Logs when a fingerprint error occurs.
2050 *
2051 * Logged from:
2052 * frameworks/base/services/core/java/com/android/server/biometrics/fingerprint/FingerprintService.java
2053 */
2054message FingerprintErrorOccurred {
2055 // The associated user. Eg: 0 for owners, 10+ for others.
2056 // Defined in android/os/UserHandle.java
2057 optional int32 user = 1;
2058 // If this error is for a crypto fingerprint.
2059 // e.g. Secure purchases, unlock password storage.
2060 optional bool is_crypto = 2;
2061
2062 enum Error {
2063 UNKNOWN = 0;
2064 LOCKOUT = 1;
2065 PERMANENT_LOCKOUT = 2;
2066 }
2067 // The type of error.
2068 optional Error error = 3;
2069}
Howard Ro688ae182018-09-25 00:09:36 -07002070
2071message Notification {
2072
2073 // Type of notification event.
2074 enum Type {
2075 TYPE_UNKNOWN = 0;
2076 // Notification became visible to the user.
2077 TYPE_OPEN = 1;
2078 // Notification became hidden.
2079 TYPE_CLOSE = 2;
2080 // Notification switched to detail mode.
2081 TYPE_DETAIL = 3;
2082 // Notification was clicked.
2083 TYPE_ACTION = 4;
2084 // Notification was dismissed.
2085 TYPE_DISMISS = 5;
2086 // Notification switched to summary mode. The enum value of 14 is to
2087 // match that of metrics_constants.
2088 TYPE_COLLAPSE = 14;
2089 }
2090 optional Type type = 1;
2091
2092 // Package name associated with the notification.
2093 optional string package_name = 2;
2094
2095 // Tag associated with notification.
2096 optional string tag = 3;
2097
2098 // Application-supplied ID associated with the notification.
2099 optional int32 id = 4;
2100
2101 // Index of notification in the notification panel.
2102 optional int32 shade_index = 5;
2103
2104 // The number of notifications in the notification panel.
2105 optional int32 shade_count = 6;
2106
2107 // Importance for the notification.
2108 optional int32 importance = 7;
2109
2110 // ID for the notification channel.
Howard Ro183c2bd2018-10-18 13:52:10 -07002111 optional string channel_id = 8;
Howard Ro688ae182018-09-25 00:09:36 -07002112
2113 // Importance for the notification channel.
2114 optional int32 channel_importance = 9;
2115
Howard Ro183c2bd2018-10-18 13:52:10 -07002116 // Application-supplied ID associated with the notifications group.
2117 optional string group_id = 10;
2118
Howard Ro688ae182018-09-25 00:09:36 -07002119 // Whether notification was a group summary.
Howard Ro183c2bd2018-10-18 13:52:10 -07002120 optional bool group_summary = 11;
Howard Ro688ae182018-09-25 00:09:36 -07002121
Howard Ro183c2bd2018-10-18 13:52:10 -07002122 // Reason for dismissal of a notification. This field is only meaningful for
2123 // TYPE_DISMISS events.
2124 optional int32 dismiss_reason = 12;
Howard Ro688ae182018-09-25 00:09:36 -07002125
Howard Ro183c2bd2018-10-18 13:52:10 -07002126 // The first post time of notification, stable across updates.
2127 optional int64 creation_millis = 13;
Howard Ro688ae182018-09-25 00:09:36 -07002128
Howard Ro183c2bd2018-10-18 13:52:10 -07002129 // The most recent interruption time, or the creation time if no updates.
2130 // Differs from update_millis because updates are filtered based on whether
2131 // they actually interrupted the user.
2132 optional int64 interruption_millis = 14;
Howard Ro688ae182018-09-25 00:09:36 -07002133
Howard Ro183c2bd2018-10-18 13:52:10 -07002134 // The most recent update time, or the creation time if no updates.
2135 optional int64 update_millis = 15;
2136
2137 // The most recent visibility event.
2138 optional int64 visible_millis = 16;
Howard Ro688ae182018-09-25 00:09:36 -07002139}
2140
Chenjie Yuae9dfac2018-10-25 16:06:56 -07002141/*
2142 * Logs when a connection becomes available and lost.
2143 * Logged in StatsCompanionService.java
2144 */
2145message ConnectivityStateChanged {
2146 // Id of the network.
2147 optional int32 net_id = 1;
2148
2149 enum State {
2150 UNKNOWN = 0;
2151 CONNECTED = 1;
2152 DISCONNECTED = 2;
2153 }
2154 // Connected state of a network.
2155 optional State state = 2;
2156}
Howard Ro688ae182018-09-25 00:09:36 -07002157
Chenjie Yubbcbc602018-02-05 16:51:52 -08002158//////////////////////////////////////////////////////////////////////
2159// Pulled atoms below this line //
2160//////////////////////////////////////////////////////////////////////
2161
2162/**
David Chenc8a43242017-10-17 16:23:28 -07002163 * Pulls bytes transferred via wifi (Sum of foreground and background usage).
2164 *
2165 * Pulled from:
2166 * StatsCompanionService (using BatteryStats to get which interfaces are wifi)
2167 */
Chenjie Yu31d14d72017-12-12 17:54:33 -08002168message WifiBytesTransfer {
Yao Chenc40a19d2018-03-15 16:48:25 -07002169 optional int32 uid = 1 [(is_uid) = true];
David Chenc8a43242017-10-17 16:23:28 -07002170
2171 optional int64 rx_bytes = 2;
2172
2173 optional int64 rx_packets = 3;
2174
2175 optional int64 tx_bytes = 4;
2176
2177 optional int64 tx_packets = 5;
2178}
2179
2180/**
2181 * Pulls bytes transferred via wifi (separated by foreground and background usage).
2182 *
2183 * Pulled from:
2184 * StatsCompanionService (using BatteryStats to get which interfaces are wifi)
2185 */
Chenjie Yu31d14d72017-12-12 17:54:33 -08002186message WifiBytesTransferByFgBg {
Yao Chenc40a19d2018-03-15 16:48:25 -07002187 optional int32 uid = 1 [(is_uid) = true];
David Chenc8a43242017-10-17 16:23:28 -07002188
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08002189 // 1 denotes foreground and 0 denotes background. This is called Set in NetworkStats.
2190 optional bool is_foreground = 2;
David Chenc8a43242017-10-17 16:23:28 -07002191
2192 optional int64 rx_bytes = 3;
2193
2194 optional int64 rx_packets = 4;
2195
2196 optional int64 tx_bytes = 5;
2197
2198 optional int64 tx_packets = 6;
2199}
2200
2201/**
2202 * Pulls bytes transferred via mobile networks (Sum of foreground and background usage).
2203 *
2204 * Pulled from:
2205 * StatsCompanionService (using BatteryStats to get which interfaces are mobile data)
2206 */
Chenjie Yu31d14d72017-12-12 17:54:33 -08002207message MobileBytesTransfer {
Yao Chenc40a19d2018-03-15 16:48:25 -07002208 optional int32 uid = 1 [(is_uid) = true];
David Chenc8a43242017-10-17 16:23:28 -07002209
2210 optional int64 rx_bytes = 2;
2211
2212 optional int64 rx_packets = 3;
2213
2214 optional int64 tx_bytes = 4;
2215
2216 optional int64 tx_packets = 5;
2217}
2218
2219/**
2220 * Pulls bytes transferred via mobile networks (separated by foreground and background usage).
2221 *
2222 * Pulled from:
2223 * StatsCompanionService (using BatteryStats to get which interfaces are mobile data)
2224 */
Chenjie Yu31d14d72017-12-12 17:54:33 -08002225message MobileBytesTransferByFgBg {
Yao Chenc40a19d2018-03-15 16:48:25 -07002226 optional int32 uid = 1 [(is_uid) = true];
David Chenc8a43242017-10-17 16:23:28 -07002227
Yao Chenc40a19d2018-03-15 16:48:25 -07002228 // 1 denotes foreground and 0 denotes background. This is called Set in
2229 // NetworkStats.
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08002230 optional bool is_foreground = 2;
David Chenc8a43242017-10-17 16:23:28 -07002231
2232 optional int64 rx_bytes = 3;
2233
2234 optional int64 rx_packets = 4;
2235
2236 optional int64 tx_bytes = 5;
2237
2238 optional int64 tx_packets = 6;
2239}
2240
2241/**
Chenjie Yu9d7720b2018-01-24 10:34:48 -08002242 * Pulls bytes transferred via bluetooth. It is pulled from Bluetooth controller.
2243 *
2244 * Pulled from:
2245 * StatsCompanionService
2246 */
2247message BluetoothBytesTransfer {
Yao Chenc40a19d2018-03-15 16:48:25 -07002248 optional int32 uid = 1 [(is_uid) = true];
Chenjie Yu9d7720b2018-01-24 10:34:48 -08002249
2250 optional int64 rx_bytes = 2;
2251
2252 optional int64 tx_bytes = 3;
2253}
2254
2255/**
David Chenc8a43242017-10-17 16:23:28 -07002256 * Pulls the kernel wakelock durations. This atom is adapted from
2257 * android/internal/os/KernelWakelockStats.java
2258 *
2259 * Pulled from:
2260 * StatsCompanionService using KernelWakelockReader.
2261 */
Chenjie Yu31d14d72017-12-12 17:54:33 -08002262message KernelWakelock {
David Chenc8a43242017-10-17 16:23:28 -07002263 optional string name = 1;
2264
2265 optional int32 count = 2;
2266
2267 optional int32 version = 3;
2268
Yangster-maca8a30442018-10-13 23:46:34 -07002269 optional int64 time_micros = 4;
David Chenc8a43242017-10-17 16:23:28 -07002270}
Chenjie Yu5305e1d2017-10-31 13:49:36 -07002271
Chenjie Yu05013b32017-11-21 10:21:41 -08002272/**
Chenjie Yuc8b7f222018-01-11 23:25:57 -08002273 * Pulls low power state information. This includes platform and subsystem sleep state information,
2274 * PowerStatePlatformSleepState, PowerStateVoter or PowerStateSubsystemSleepState as defined in
Chenjie Yu5305e1d2017-10-31 13:49:36 -07002275 * hardware/interfaces/power/1.0/types.hal
Chenjie Yu5305e1d2017-10-31 13:49:36 -07002276 * hardware/interfaces/power/1.1/types.hal
2277 */
Chenjie Yu31d14d72017-12-12 17:54:33 -08002278message SubsystemSleepState {
Chenjie Yubbcbc602018-02-05 16:51:52 -08002279 // Subsystem name
2280 optional string subsystem_name = 1;
2281 // For PlatformLowPowerStats (hal 1.0), this is the voter name, which could be empty.
2282 // For SubsystemLowPowerStats (hal 1.1), this is the sleep state name.
2283 optional string subname = 2;
Chenjie Yuc8b7f222018-01-11 23:25:57 -08002284 // The number of times it entered, or voted for entering the sleep state
Chenjie Yubbcbc602018-02-05 16:51:52 -08002285 optional uint64 count = 3;
Chenjie Yuc8b7f222018-01-11 23:25:57 -08002286 // The length of time spent in, or spent voting for, the sleep state
David Chen0b5c90c2018-01-25 16:51:49 -08002287 optional uint64 time_millis = 4;
David Chen21582962017-11-01 17:32:46 -07002288}
Chenjie Yu7f8def92017-11-03 09:33:15 -07002289
Chenjie Yu05013b32017-11-21 10:21:41 -08002290/**
Bookatz92da2832018-11-01 18:10:03 -07002291 * Pulls on-device power measurement information.
2292 * Data defined by hardware/interfaces/power/stats/1.0/types.hal.
2293 * Pulled from:
2294 * frameworks/base/cmds/statsd/src/external/PowerStatsPuller.cpp
2295 */
2296message OnDevicePowerMeasurement {
2297 // Name of the subsystem (to which the rail belongs).
2298 optional string subsystem_name = 1;
2299
2300 // Rail name. The rail lies within the subsystem.
2301 optional string rail_name = 2;
2302
2303 // Time (in ms since boot) at which the rail energy value was measured.
2304 // This may differ slightly from the time that statsd logs this information.
2305 optional uint64 measurement_timestamp_millis = 3;
2306
2307 // Accumulated energy used via the rail since device boot in uWs.
2308 optional uint64 energy_microwatt_secs = 4;
2309}
2310
2311/**
Chenjie Yu7f8def92017-11-03 09:33:15 -07002312 * Pulls Cpu time per frequency.
Chenjie Yu1ee9b742018-01-10 16:02:57 -08002313 * Pulls the time the cpu spend on the frequency index. Frequency index
2314 * starts from highest to lowest. The value should be monotonically
2315 * increasing since boot. However, if there is a cpu
2316 * hotplug event, the value would be reset as well.
Chenjie Yu7f8def92017-11-03 09:33:15 -07002317 */
Chenjie Yu31d14d72017-12-12 17:54:33 -08002318message CpuTimePerFreq {
Chenjie Yu7f8def92017-11-03 09:33:15 -07002319 optional uint32 cluster = 1;
2320 optional uint32 freq_index = 2;
David Chen0b5c90c2018-01-25 16:51:49 -08002321 optional uint64 time_millis = 3;
Chenjie Yu7f8def92017-11-03 09:33:15 -07002322}
Chenjie Yue33bc3b2017-11-06 17:56:44 -08002323
Chenjie Yu05013b32017-11-21 10:21:41 -08002324/**
Chenjie Yue33bc3b2017-11-06 17:56:44 -08002325 * Pulls Cpu Time Per Uid.
2326 * Note that isolated process uid time should be attributed to host uids.
2327 */
Chenjie Yu31d14d72017-12-12 17:54:33 -08002328message CpuTimePerUid {
Yao Chenc40a19d2018-03-15 16:48:25 -07002329 optional int32 uid = 1 [(is_uid) = true];
David Chen0b5c90c2018-01-25 16:51:49 -08002330 optional uint64 user_time_millis = 2;
2331 optional uint64 sys_time_millis = 3;
Chenjie Yue33bc3b2017-11-06 17:56:44 -08002332}
2333
2334/**
2335 * Pulls Cpu Time Per Uid per frequency.
2336 * Note that isolated process uid time should be attributed to host uids.
2337 * For each uid, we order the time by descending frequencies.
2338 */
Chenjie Yu31d14d72017-12-12 17:54:33 -08002339message CpuTimePerUidFreq {
Yao Chenc40a19d2018-03-15 16:48:25 -07002340 optional int32 uid = 1 [(is_uid) = true];
Chenjie Yuec676612018-03-07 09:19:17 -08002341 optional uint32 freq_index = 2;
David Chen0b5c90c2018-01-25 16:51:49 -08002342 optional uint64 time_millis = 3;
Chenjie Yue33bc3b2017-11-06 17:56:44 -08002343}
Hugo Benichi884970e2017-11-14 22:42:46 +09002344
Chenjie Yu05013b32017-11-21 10:21:41 -08002345/**
2346 * Pulls Wifi Controller Activity Energy Info
2347 */
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08002348message WifiActivityInfo {
Chenjie Yu05013b32017-11-21 10:21:41 -08002349 // timestamp(wall clock) of record creation
David Chen0b5c90c2018-01-25 16:51:49 -08002350 optional uint64 timestamp_millis = 1;
Chenjie Yu05013b32017-11-21 10:21:41 -08002351 // stack reported state
2352 // TODO: replace this with proto enum
2353 optional int32 stack_state = 2;
Yangster-maca8a30442018-10-13 23:46:34 -07002354 // tx time in millis
David Chen0b5c90c2018-01-25 16:51:49 -08002355 optional uint64 controller_tx_time_millis = 3;
Yangster-maca8a30442018-10-13 23:46:34 -07002356 // rx time in millis
David Chen0b5c90c2018-01-25 16:51:49 -08002357 optional uint64 controller_rx_time_millis = 4;
Yangster-maca8a30442018-10-13 23:46:34 -07002358 // idle time in millis
David Chen0b5c90c2018-01-25 16:51:49 -08002359 optional uint64 controller_idle_time_millis = 5;
Chenjie Yu05013b32017-11-21 10:21:41 -08002360 // product of current(mA), voltage(V) and time(ms)
2361 optional uint64 controller_energy_used = 6;
2362}
2363
2364/**
2365 * Pulls Modem Activity Energy Info
2366 */
Chenjie Yu31d14d72017-12-12 17:54:33 -08002367message ModemActivityInfo {
Chenjie Yu05013b32017-11-21 10:21:41 -08002368 // timestamp(wall clock) of record creation
David Chen0b5c90c2018-01-25 16:51:49 -08002369 optional uint64 timestamp_millis = 1;
Yangster-maca8a30442018-10-13 23:46:34 -07002370 // sleep time in millis.
David Chen0b5c90c2018-01-25 16:51:49 -08002371 optional uint64 sleep_time_millis = 2;
Yangster-maca8a30442018-10-13 23:46:34 -07002372 // idle time in millis
David Chen0b5c90c2018-01-25 16:51:49 -08002373 optional uint64 controller_idle_time_millis = 3;
Chenjie Yu05013b32017-11-21 10:21:41 -08002374 /**
2375 * Tx power index
2376 * index 0 = tx_power < 0dBm
2377 * index 1 = 0dBm < tx_power < 5dBm
2378 * index 2 = 5dBm < tx_power < 15dBm
2379 * index 3 = 15dBm < tx_power < 20dBm
2380 * index 4 = tx_power > 20dBm
2381 */
2382 // tx time in ms at power level 0
David Chen0b5c90c2018-01-25 16:51:49 -08002383 optional uint64 controller_tx_time_pl0_millis = 4;
Chenjie Yu05013b32017-11-21 10:21:41 -08002384 // tx time in ms at power level 1
David Chen0b5c90c2018-01-25 16:51:49 -08002385 optional uint64 controller_tx_time_pl1_millis = 5;
Chenjie Yu05013b32017-11-21 10:21:41 -08002386 // tx time in ms at power level 2
David Chen0b5c90c2018-01-25 16:51:49 -08002387 optional uint64 controller_tx_time_pl2_millis = 6;
Chenjie Yu05013b32017-11-21 10:21:41 -08002388 // tx time in ms at power level 3
David Chen0b5c90c2018-01-25 16:51:49 -08002389 optional uint64 controller_tx_time_pl3_millis = 7;
Chenjie Yu05013b32017-11-21 10:21:41 -08002390 // tx time in ms at power level 4
David Chen0b5c90c2018-01-25 16:51:49 -08002391 optional uint64 controller_tx_time_pl4_millis = 8;
Chenjie Yu05013b32017-11-21 10:21:41 -08002392 // rx time in ms at power level 5
David Chen0b5c90c2018-01-25 16:51:49 -08002393 optional uint64 controller_rx_time_millis = 9;
Chenjie Yu05013b32017-11-21 10:21:41 -08002394 // product of current(mA), voltage(V) and time(ms)
2395 optional uint64 energy_used = 10;
Joe Onorato62c220b2017-11-18 20:32:56 -08002396}
Rajeev Kumar508a9bf2018-01-18 15:49:11 -08002397
Chenjie Yu9d7720b2018-01-24 10:34:48 -08002398/**
2399 * Pulls Bluetooth Activity Energy Info
2400 * Note: BluetoothBytesTransfer is pulled at the same time from the controller.
2401 */
2402message BluetoothActivityInfo {
2403 // timestamp(wall clock) of record creation
David Chen0b5c90c2018-01-25 16:51:49 -08002404 optional uint64 timestamp_millis = 1;
Chenjie Yu9d7720b2018-01-24 10:34:48 -08002405 // bluetooth stack state
2406 optional int32 bluetooth_stack_state = 2;
Yangster-maca8a30442018-10-13 23:46:34 -07002407 // tx time in millis
David Chen0b5c90c2018-01-25 16:51:49 -08002408 optional uint64 controller_tx_time_millis = 3;
Yangster-maca8a30442018-10-13 23:46:34 -07002409 // rx time in millis
David Chen0b5c90c2018-01-25 16:51:49 -08002410 optional uint64 controller_rx_time_millis = 4;
Yangster-maca8a30442018-10-13 23:46:34 -07002411 // idle time in millis
David Chen0b5c90c2018-01-25 16:51:49 -08002412 optional uint64 controller_idle_time_millis = 5;
Chenjie Yu9d7720b2018-01-24 10:34:48 -08002413 // product of current(mA), voltage(V) and time(ms)
2414 optional uint64 energy_used = 6;
2415}
2416
Rajeev Kumar508a9bf2018-01-18 15:49:11 -08002417/*
Rajeev Kumar8a9fa052018-01-25 19:03:09 -08002418 * Logs the memory stats for a process.
2419 */
2420message ProcessMemoryState {
2421 // The uid if available. -1 means not available.
Yao Chenc40a19d2018-03-15 16:48:25 -07002422 optional int32 uid = 1 [(is_uid) = true];
Rajeev Kumar8a9fa052018-01-25 19:03:09 -08002423
2424 // The process name.
2425 optional string process_name = 2;
2426
2427 // oom adj score.
Yangster-maca8a30442018-10-13 23:46:34 -07002428 optional int32 oom_adj_score = 3;
Rajeev Kumar8a9fa052018-01-25 19:03:09 -08002429
2430 // # of page-faults
Yangster-maca8a30442018-10-13 23:46:34 -07002431 optional int64 page_fault = 4;
Rajeev Kumar8a9fa052018-01-25 19:03:09 -08002432
2433 // # of major page-faults
Yangster-maca8a30442018-10-13 23:46:34 -07002434 optional int64 page_major_fault = 5;
Rajeev Kumar8a9fa052018-01-25 19:03:09 -08002435
Rajeev Kumar90235992018-01-29 11:06:48 -08002436 // RSS
2437 optional int64 rss_in_bytes = 6;
2438
2439 // CACHE
2440 optional int64 cache_in_bytes = 7;
2441
2442 // SWAP
2443 optional int64 swap_in_bytes = 8;
Rafal Slawikaaf60892018-09-12 13:04:30 +01002444
2445 // RSS high watermark.
2446 // Peak RSS usage of the process. Value is read from the VmHWM field in /proc/PID/status or
2447 // from memory.max_usage_in_bytes under /dev/memcg if the device uses per-app memory cgroups.
2448 optional int64 rss_high_watermark_in_bytes = 9;
Rafal Slawik272a8162018-11-01 15:12:28 +00002449
2450 // Elapsed real time when the process started.
2451 // Value is read from /proc/PID/stat, field 22. 0 if read from per-app memory cgroups.
2452 optional int64 start_time_nanos = 10;
Rajeev Kumar8a9fa052018-01-25 19:03:09 -08002453}
2454
2455/*
Rafal Slawik08621582018-10-15 14:53:07 +01002456 * Logs the memory stats for a native process (from procfs).
2457 */
2458message NativeProcessMemoryState {
Rafal Slawikbf67d072018-10-23 11:07:54 +01002459 // The uid if available. -1 means not available.
2460 optional int32 uid = 1 [(is_uid) = true];
Rafal Slawik08621582018-10-15 14:53:07 +01002461
Rafal Slawikbf67d072018-10-23 11:07:54 +01002462 // The process name.
2463 optional string process_name = 2;
Rafal Slawik08621582018-10-15 14:53:07 +01002464
Rafal Slawikbf67d072018-10-23 11:07:54 +01002465 // # of page-faults
2466 optional int64 page_fault = 3;
Rafal Slawik08621582018-10-15 14:53:07 +01002467
Rafal Slawikbf67d072018-10-23 11:07:54 +01002468 // # of major page-faults
2469 optional int64 page_major_fault = 4;
Rafal Slawik08621582018-10-15 14:53:07 +01002470
Rafal Slawikbf67d072018-10-23 11:07:54 +01002471 // RSS
2472 optional int64 rss_in_bytes = 5;
Rafal Slawik08621582018-10-15 14:53:07 +01002473
Rafal Slawikbf67d072018-10-23 11:07:54 +01002474 // RSS high watermark.
2475 // Peak RSS usage of the process. Value is read from the VmHWM field in /proc/PID/status.
2476 optional int64 rss_high_watermark_in_bytes = 6;
2477
2478 // Elapsed real time when the process started.
2479 // Value is read from /proc/PID/stat, field 22.
2480 optional int64 start_time_nanos = 7;
Rafal Slawik08621582018-10-15 14:53:07 +01002481}
2482
2483/*
Chenjie Yu9d7720b2018-01-24 10:34:48 -08002484 * Elapsed real time from SystemClock.
Chenjie Yu9da105b2018-01-13 12:41:08 -08002485 */
Chenjie Yu9d7720b2018-01-24 10:34:48 -08002486message SystemElapsedRealtime {
David Chen0b5c90c2018-01-25 16:51:49 -08002487 optional uint64 time_millis = 1;
Chenjie Yu9da105b2018-01-13 12:41:08 -08002488}
2489
2490/*
Chenjie Yu9d7720b2018-01-24 10:34:48 -08002491 * Up time from SystemClock.
Chenjie Yu9da105b2018-01-13 12:41:08 -08002492 */
Chenjie Yu9d7720b2018-01-24 10:34:48 -08002493message SystemUptime {
2494 // Milliseconds since the system was booted.
2495 // This clock stops when the system enters deep sleep (CPU off, display dark, device waiting
2496 // for external input).
2497 // It is not affected by clock scaling, idle, or other power saving mechanisms.
David Chen0b5c90c2018-01-25 16:51:49 -08002498 optional uint64 uptime_millis = 1;
Chenjie Yu9da105b2018-01-13 12:41:08 -08002499}
2500
2501/*
2502 * Reads from /proc/uid_concurrent_active_time which has the format:
2503 * active: X (X is # cores)
2504 * [uid0]: [time-0] [time-1] [time-2] ... (# entries = # cores)
2505 * [uid1]: [time-0] [time-1] [time-2] ... ...
2506 * ...
2507 * Time-N means the CPU time a UID spent running concurrently with N other processes.
2508 * The file contains a monotonically increasing count of time for a single boot.
2509 */
2510message CpuActiveTime {
Yao Chenc40a19d2018-03-15 16:48:25 -07002511 optional int32 uid = 1 [(is_uid) = true];
Chenjie Yuec676612018-03-07 09:19:17 -08002512 optional uint64 time_millis = 2;
Chenjie Yu9da105b2018-01-13 12:41:08 -08002513}
2514
2515/**
2516 * Reads from /proc/uid_concurrent_policy_time which has the format:
2517 * policy0: X policy4: Y (there are X cores on policy0, Y cores on policy4)
2518 * [uid0]: [time-0-0] [time-0-1] ... [time-1-0] [time-1-1] ...
2519 * [uid1]: [time-0-0] [time-0-1] ... [time-1-0] [time-1-1] ...
2520 * ...
2521 * Time-X-Y means the time a UID spent on clusterX running concurrently with Y other processes.
2522 * The file contains a monotonically increasing count of time for a single boot.
2523 */
2524message CpuClusterTime {
Yao Chenc40a19d2018-03-15 16:48:25 -07002525 optional int32 uid = 1 [(is_uid) = true];
Chenjie Yuec676612018-03-07 09:19:17 -08002526 optional int32 cluster_index = 2;
David Chen0b5c90c2018-01-25 16:51:49 -08002527 optional uint64 time_millis = 3;
Chenjie Yu937d7422018-01-10 16:37:53 -08002528}
2529
2530/*
2531 * Pulls free disk space, for data, system partition and temporary directory.
2532 */
2533message DiskSpace {
2534 // available bytes in data partition
2535 optional uint64 data_available_bytes = 1;
2536 // available bytes in system partition
2537 optional uint64 system_available_bytes = 2;
2538 // available bytes in download cache or temp directories
2539 optional uint64 temp_available_bytes = 3;
2540}
Tej Singhbf972d92018-01-10 20:51:13 -08002541
2542/**
2543 * Pulls battery coulomb counter, which is the remaining battery charge in uAh.
Tej Singh40298312018-02-16 00:15:09 -08002544 * Pulled from:
2545 * frameworks/base/cmds/statsd/src/external/ResourceHealthManagerPuller.cpp
Tej Singhbf972d92018-01-10 20:51:13 -08002546 */
2547message RemainingBatteryCapacity {
Yangster-maca8a30442018-10-13 23:46:34 -07002548 optional int32 charge_micro_ampere_hour = 1;
Tej Singhbf972d92018-01-10 20:51:13 -08002549}
2550
2551/**
2552 * Pulls battery capacity, which is the battery capacity when full in uAh.
Tej Singh40298312018-02-16 00:15:09 -08002553 * Pulled from:
2554 * frameworks/base/cmds/statsd/src/external/ResourceHealthManagerPuller.cpp
Tej Singhbf972d92018-01-10 20:51:13 -08002555 */
2556message FullBatteryCapacity {
Yangster-maca8a30442018-10-13 23:46:34 -07002557 optional int32 capacity_micro_ampere_hour = 1;
Tej Singh40298312018-02-16 00:15:09 -08002558}
2559
2560/**
Bookatz17f0d8a2018-09-13 12:56:32 -07002561 * Pulls battery voltage.
2562 * Pulled from:
2563 * frameworks/base/cmds/statsd/src/external/ResourceHealthManagerPuller.cpp
2564 */
2565message BatteryVoltage {
2566 // The voltage of the battery, in millivolts.
Yangster-maca8a30442018-10-13 23:46:34 -07002567 optional int32 voltage_millivolt = 1;
Bookatz17f0d8a2018-09-13 12:56:32 -07002568}
2569
2570/**
Tej Singhd89137e2018-03-26 14:51:40 -07002571 * Pulls the temperature of various parts of the device.
2572 * The units are tenths of a degree Celsius. Eg: 30.3C is reported as 303.
Tej Singh40298312018-02-16 00:15:09 -08002573 *
2574 * Pulled from:
2575 * frameworks/base/cmds/statsd/src/external/ResourceThermalManagerPuller.cpp
2576 */
2577message Temperature {
2578 // The type of temperature being reported. Eg. CPU, GPU, SKIN, BATTERY.
2579 optional android.os.TemperatureTypeEnum sensor_location = 1;
2580
2581 // The name of the temperature source. Eg. CPU0
2582 optional string sensor_name = 2;
2583
Tej Singhd89137e2018-03-26 14:51:40 -07002584 // Temperature in tenths of a degree C.
Yangster-maca8a30442018-10-13 23:46:34 -07002585 optional int32 temperature_deci_celsius = 3;
yroa1fe77c2018-02-26 14:22:54 -08002586}
Olivier Gaillard00bfb1b2018-07-10 11:25:09 +01002587
2588/**
2589 * Pulls the statistics of calls to Binder.
2590 *
Olivier Gaillardd25f7a82018-09-12 14:28:48 +01002591 * Binder stats will be reset every time the data is pulled. It means it can only be pulled by one
2592 * config on the device.
Olivier Gaillard9ea238d2018-07-24 10:26:31 +01002593 *
Olivier Gaillard720ec5b2018-10-30 17:32:56 +00002594 * Next tag: 15
Olivier Gaillard00bfb1b2018-07-10 11:25:09 +01002595 */
2596message BinderCalls {
Olivier Gaillard720ec5b2018-10-30 17:32:56 +00002597 // UID of the process responsible for the binder transaction. It will be set if the process
2598 // executing the binder transaction attribute the transaction to another uid using
2599 // Binder.setThreadWorkSource().
2600 //
2601 // If not set, the value will be -1.
Olivier Gaillard9ea238d2018-07-24 10:26:31 +01002602 optional int32 uid = 1 [(is_uid) = true];
Olivier Gaillard720ec5b2018-10-30 17:32:56 +00002603 // UID of the process executing the binder transaction.
2604 optional int32 direct_caller_uid = 14;
Olivier Gaillard9ea238d2018-07-24 10:26:31 +01002605 // Fully qualified class name of the API call.
2606 //
2607 // This is a system server class name.
2608 //
2609 // TODO(gaillard): figure out if binder call stats includes data from isolated uids, if a uid
2610 // gets recycled and we have isolated uids, we might attribute the data incorrectly.
2611 // TODO(gaillard): there is a high dimensions cardinality, figure out if we should drop the less
2612 // commonly used APIs.
2613 optional string service_class_name = 2;
2614 // Method name of the API call. It can also be a transaction code if we cannot
2615 // resolve it to a name. See Binder#getTransactionName.
2616 //
2617 // This is a system server method name.
2618 optional string service_method_name = 3;
2619 // Total number of API calls.
2620 optional int64 call_count = 4;
2621 // True if the screen was interactive PowerManager#isInteractive at the end of the call.
2622 optional bool screen_interactive = 13;
2623 // Total number of API calls we have data recorded for. If we collected data for all the calls,
2624 // call_count will be equal to recorded_call_count.
2625 //
2626 // If recorded_call_count is different than call_count, it means data collection has been
2627 // sampled. All the fields below will be sampled in this case.
2628 optional int64 recorded_call_count = 12;
2629 // Number of exceptions thrown by the API.
2630 optional int64 recorded_exception_count = 5;
2631 // Total latency of all API calls.
2632 // Average can be computed using total_latency_micros / recorded_call_count.
2633 optional int64 recorded_total_latency_micros = 6;
2634 // Maximum latency of one API call.
2635 optional int64 recorded_max_latency_micros = 7;
2636 // Total CPU usage of all API calls.
2637 // Average can be computed using total_cpu_micros / recorded_call_count.
2638 // Total can be computed using total_cpu_micros / recorded_call_count * call_count.
2639 optional int64 recorded_total_cpu_micros = 8;
2640 // Maximum CPU usage of one API call.
2641 optional int64 recorded_max_cpu_micros = 9;
2642 // Maximum parcel reply size of one API call.
2643 optional int64 recorded_max_reply_size_bytes = 10;
2644 // Maximum parcel request size of one API call.
2645 optional int64 recorded_max_request_size_bytes = 11;
2646}
2647
2648/**
2649 * Pulls the statistics of exceptions during calls to Binder.
2650 *
2651 * Binder stats are cumulative from boot unless somebody reset the data using
2652 * > adb shell dumpsys binder_calls_stats --reset
2653 */
2654message BinderCallsExceptions {
2655 // Exception class name, e.g. java.lang.IllegalArgumentException.
2656 //
2657 // This is an exception class name thrown by the system server.
2658 optional string exception_class_name = 1;
2659 // Total number of exceptions.
2660 optional int64 exception_count = 2;
Olivier Gaillard00bfb1b2018-07-10 11:25:09 +01002661}
Marcin Oczeretkod8cc8592018-08-22 16:07:36 +01002662
Marcin Oczeretko3e6494e2018-09-10 18:06:52 +01002663/**
2664 * Pulls the statistics of message dispatching on HandlerThreads.
2665 *
2666 * Looper stats will be reset every time the data is pulled. It means it can only be pulled by one
2667 * config on the device.
2668 *
2669 * Next tag: 11
2670 */
Marcin Oczeretkod8cc8592018-08-22 16:07:36 +01002671message LooperStats {
Marcin Oczeretkoec758722018-09-12 12:53:47 +01002672 // The uid that made a call to the System Server and caused the message to be enqueued.
Marcin Oczeretkod8cc8592018-08-22 16:07:36 +01002673 optional int32 uid = 1 [(is_uid) = true];
2674
2675 // Fully qualified class name of the handler target class.
2676 //
2677 // This field does not contain PII. This is a system server class name.
2678 optional string handler_class_name = 2;
2679
2680 // The name of the thread that runs the Looper.
2681 //
2682 // This field does not contain PII. This is a system server thread name.
2683 optional string looper_thread_name = 3;
2684
2685 // The name of the dispatched message.
2686 //
2687 // This field does not contain PII. This is a system server constant or class
2688 // name.
2689 optional string message_name = 4;
2690
2691 // Total number of successfully dispatched messages.
2692 optional int64 message_count = 5;
2693
2694 // Total number of messages that failed dispatching.
2695 optional int64 exception_count = 6;
2696
2697 // Total number of processed messages we have data recorded for. If we
2698 // collected data for all the messages, message_count will be equal to
2699 // recorded_message_count.
2700 //
2701 // If recorded_message_count is different than message_count, it means data
Marcin Oczeretkoc06331a2018-10-02 13:00:38 +01002702 // collection has been sampled. The fields below will be sampled in this case.
Marcin Oczeretkod8cc8592018-08-22 16:07:36 +01002703 optional int64 recorded_message_count = 7;
2704
2705 // Total latency of all processed messages.
2706 // Average can be computed using recorded_total_latency_micros /
2707 // recorded_message_count.
2708 optional int64 recorded_total_latency_micros = 8;
2709
2710 // Total CPU usage of all processed message.
2711 // Average can be computed using recorded_total_cpu_micros /
2712 // recorded_message_count. Total can be computed using
Marcin Oczeretko3e6494e2018-09-10 18:06:52 +01002713 // recorded_total_cpu_micros / recorded_message_count * message_count.
Marcin Oczeretkod8cc8592018-08-22 16:07:36 +01002714 optional int64 recorded_total_cpu_micros = 9;
Marcin Oczeretko3e6494e2018-09-10 18:06:52 +01002715
2716 // True if the screen was interactive PowerManager#isInteractive at the end of the call.
2717 optional bool screen_interactive = 10;
Marcin Oczeretkoc06331a2018-10-02 13:00:38 +01002718
2719 // Max recorded CPU usage of all processed messages.
2720 optional int64 recorded_max_cpu_micros = 11;
2721
2722 // Max recorded latency of all processed messages.
2723 optional int64 recorded_max_latency_micros = 12;
2724
2725 // Total number of messages we tracked the dispatching delay for. If we
2726 // collected data for all the messages, message_count will be equal to
2727 // recorded_delay_message_count.
2728 //
2729 // If recorded_delay_message_count is different than message_count, it means data
2730 // collection has been sampled or/and not all messages specified the target dispatch time.
2731 // The fields below will be sampled in this case.
2732 optional int64 recorded_delay_message_count = 13;
2733
2734 // Total dispatching delay of all processed messages.
2735 // Calculated as a difference between the target dispatching time (Message.when)
2736 // and the actual dispatching time.
2737 // Average can be computed using recorded_total_delay_millis / recorded_delay_message_count.
2738 optional int64 recorded_total_delay_millis = 14;
2739
2740 // Max dispatching delay of all processed messages.
2741 // Calculated as a difference between the target dispatching time (Message.when)
2742 // and the actual dispatching time.
2743 optional int64 recorded_max_delay_millis = 15;
Marcin Oczeretkod8cc8592018-08-22 16:07:36 +01002744}
Tej Singh86dc9db2018-09-06 00:39:57 +00002745
2746/**
2747 * Pulls disk information, such as write speed and latency.
2748 */
2749message DiskStats {
2750 // Time taken to open, write 512B to, and close a file.
2751 // -1 if error performing the check.
2752 optional int64 data_write_latency_millis = 1;
2753
2754 optional bool file_based_encryption = 2;
2755
2756 // Recent disk write speed in kB/s.
2757 // -1 if error querying storageed.
2758 // 0 if data is unavailable.
2759 optional int32 recent_disk_write_speed = 3;
2760}
2761
2762
2763/**
2764 * Free and total bytes of the Data, Cache, and System partition.
2765 */
2766message DirectoryUsage {
2767 enum Directory {
2768 UNKNOWN = 0;
2769 DATA = 1;
2770 CACHE = 2;
2771 SYSTEM = 3;
2772 }
2773 optional Directory directory = 1;
2774 optional int64 free_bytes = 2;
2775 optional int64 total_bytes = 3;
2776}
2777
2778
2779/**
2780 * Size of an application: apk size, data size, and cache size.
2781 * Reads from a cached file produced daily by DiskStatsLoggingService.java.
2782 * Information is only reported for apps with the primary user (user 0).
2783 * Sizes are aggregated by package name.
2784 */
2785message AppSize {
2786 // Including uids will involve modifying diskstats logic.
2787 optional string package_name = 1;
2788 // App size in bytes. -1 if unavailable.
2789 optional int64 app_size_bytes = 2;
2790 // App data size in bytes. -1 if unavailable.
2791 optional int64 app_data_size_bytes = 3;
2792 // App cache size in bytes. -1 if unavailable.
2793 optional int64 app_cache_size_bytes = 4;
2794 // Time that the cache file was produced.
2795 // Uses System.currentTimeMillis(), which is wall clock time.
2796 optional int64 cache_time_millis = 5;
2797}
2798
2799
2800/**
2801 * Size of a particular category. Eg: photos, videos.
2802 * Reads from a cached file produced daily by DiskStatsLoggingService.java.
2803 */
2804message CategorySize {
2805 enum Category {
2806 UNKNOWN = 0;
2807 APP_SIZE = 1;
2808 APP_DATA_SIZE = 2;
2809 APP_CACHE_SIZE = 3;
2810 PHOTOS = 4;
2811 VIDEOS = 5;
2812 AUDIO = 6;
2813 DOWNLOADS = 7;
2814 SYSTEM = 8;
2815 OTHER = 9;
2816 }
2817 optional Category category = 1;
2818 // Category size in bytes.
2819 optional int64 size_bytes = 2;
2820 // Time that the cache file was produced.
2821 // Uses System.currentTimeMillis(), which is wall clock time.
2822 optional int64 cache_time_millis = 3;
2823}
Tej Singhd6d6d772018-09-05 17:41:25 -07002824
2825/**
Tej Singhe7726dc2018-09-21 11:42:12 -07002826 * Pulls per uid I/O stats. The stats are cumulative since boot.
2827 *
2828 * Read/write bytes are I/O events from a storage device
2829 * Read/write chars are data requested by read/write syscalls, and can be
2830 * satisfied by caching.
2831 *
2832 * Pulled from StatsCompanionService, which reads proc/uid_io/stats.
2833 */
2834message DiskIo {
2835 optional int32 uid = 1 [(is_uid) = true];
2836 optional int64 fg_chars_read = 2;
2837 optional int64 fg_chars_write = 3;
2838 optional int64 fg_bytes_read = 4;
2839 optional int64 fg_bytes_write = 5;
2840 optional int64 bg_chars_read = 6;
2841 optional int64 bg_chars_write = 7;
2842 optional int64 bg_bytes_read = 8;
2843 optional int64 bg_bytes_write = 9;
2844 optional int64 fg_fsync = 10;
2845 optional int64 bg_fsync= 11;
2846}
2847
2848
2849/**
Tej Singhd6d6d772018-09-05 17:41:25 -07002850 * Pulls the number of fingerprints for each user.
2851 *
2852 * Pulled from StatsCompanionService, which queries FingerprintManager.
2853 */
2854message NumFingerprints {
2855 // The associated user. Eg: 0 for owners, 10+ for others.
2856 // Defined in android/os/UserHandle.java
2857 optional int32 user = 1;
2858 // Number of fingerprints registered to that user.
2859 optional int32 num_fingerprints = 2;
2860}
Chenjie Yu12e5e672018-09-14 15:54:59 -07002861
Yangsteraf9aee72018-10-12 09:26:16 -07002862message AggStats {
2863 optional int64 min = 1;
2864
2865 optional int64 average = 2;
2866
2867 optional int64 max = 3;
2868}
2869
2870message ProcessStatsStateProto {
2871 optional android.service.procstats.ScreenState screen_state = 1;
2872
2873 optional android.service.procstats.MemoryState memory_state = 2;
2874
2875 // this enum list is from frameworks/base/core/java/com/android/internal/app/procstats/ProcessStats.java
2876 // and not frameworks/base/core/java/android/app/ActivityManager.java
2877 optional android.service.procstats.ProcessState process_state = 3;
2878
2879 // Millisecond uptime duration spent in this state
Yangster-maca8a30442018-10-13 23:46:34 -07002880 optional int64 duration_millis = 4;
Yangsteraf9aee72018-10-12 09:26:16 -07002881
2882 // Millisecond elapsed realtime duration spent in this state
Yangster-maca8a30442018-10-13 23:46:34 -07002883 optional int64 realtime_duration_millis = 9;
Yangsteraf9aee72018-10-12 09:26:16 -07002884
2885 // # of samples taken
2886 optional int32 sample_size = 5;
2887
2888 // PSS is memory reserved for this process
2889 optional AggStats pss = 6;
2890
2891 // USS is memory shared between processes, divided evenly for accounting
2892 optional AggStats uss = 7;
2893
2894 // RSS is memory resident for this process
2895 optional AggStats rss = 8;
2896}
2897
2898// Next Tag: 7
2899message ProcessStatsProto {
2900 // Name of process.
2901 optional string process = 1;
2902
2903 // Uid of the process.
2904 optional int32 uid = 2;
2905
2906 // Information about how often kills occurred
2907 message Kill {
2908 // Count of excessive CPU kills
2909 optional int32 cpu = 1;
2910
2911 // Count of kills when cached
2912 optional int32 cached = 2;
2913
2914 // PSS stats during cached kill
2915 optional AggStats cached_pss = 3;
2916 }
2917 optional Kill kill = 3;
2918
2919 // Time and memory spent in various states.
2920 repeated ProcessStatsStateProto states = 5;
2921
2922 // Total time process has been running... screen_state, memory_state, and process_state
2923 // will not be set.
2924 optional ProcessStatsStateProto total_running_state = 6;
2925}
2926
2927message PackageServiceOperationStatsProto {
2928 // Operate enum: Started, Foreground, Bound, Executing
2929 optional android.service.procstats.ServiceOperationState operation = 1;
2930
2931 // Number of times the service was in this operation.
2932 optional int32 count = 2;
2933
2934 // Information about a state the service can be in.
2935 message StateStats {
2936 // Screen state enum.
2937 optional android.service.procstats.ScreenState screen_state = 1;
2938 // Memory state enum.
2939 optional android.service.procstats.MemoryState memory_state = 2;
2940
2941 // duration in milliseconds.
Yangster-maca8a30442018-10-13 23:46:34 -07002942 optional int64 duration_millis = 3;
Yangsteraf9aee72018-10-12 09:26:16 -07002943 // Millisecond elapsed realtime duration spent in this state
Yangster-maca8a30442018-10-13 23:46:34 -07002944 optional int64 realtime_duration_millis = 4;
Yangsteraf9aee72018-10-12 09:26:16 -07002945 }
2946 repeated StateStats state_stats = 3;
2947}
2948
2949message PackageServiceStatsProto {
2950 // Name of service component.
2951 optional string service_name = 1;
2952
2953 // The operation stats.
2954 // The package_name, package_uid, package_version, service_name will not be set to save space.
2955 repeated PackageServiceOperationStatsProto operation_stats = 2;
2956}
2957
2958message PackageAssociationSourceProcessStatsProto {
2959 // Uid of the process.
2960 optional int32 process_uid = 1;
2961 // Process name.
2962 optional string process_name = 2;
2963
2964 // Total count of the times this association appeared.
2965 optional int32 total_count = 3;
2966
2967 // Millisecond uptime total duration this association was around.
Yangster-maca8a30442018-10-13 23:46:34 -07002968 optional int64 total_duration_millis = 4;
Yangsteraf9aee72018-10-12 09:26:16 -07002969
2970 // Total count of the times this association became actively impacting its target process.
2971 optional int32 active_count = 5;
2972
2973 // Information on one source in this association.
2974 message StateStats {
2975 // Process state enum.
2976 optional android.service.procstats.ProcessState process_state = 1;
2977 // Millisecond uptime duration spent in this state
Yangster-maca8a30442018-10-13 23:46:34 -07002978 optional int64 duration_millis = 2;
Yangsteraf9aee72018-10-12 09:26:16 -07002979 // Millisecond elapsed realtime duration spent in this state
Yangster-maca8a30442018-10-13 23:46:34 -07002980 optional int64 realtime_duration_mmillis = 3;
Yangsteraf9aee72018-10-12 09:26:16 -07002981 }
2982 repeated StateStats active_state_stats = 6;
2983}
2984
2985message PackageAssociationProcessStatsProto {
2986 // Name of the target component.
2987 optional string component_name = 1;
2988 // Information on one source in this association.
2989 repeated PackageAssociationSourceProcessStatsProto sources = 2;
2990}
2991
2992
2993message ProcessStatsPackageProto {
2994 // Name of package.
2995 optional string package = 1;
2996
2997 // Uid of the package.
2998 optional int32 uid = 2;
2999
3000 // Version of the package.
3001 optional int64 version = 3;
3002
3003 // Stats for each process running with the package loaded in to it.
3004 repeated ProcessStatsProto process_stats = 4;
3005
3006 // Stats for each of the package's services.
3007 repeated PackageServiceStatsProto service_stats = 5;
3008
3009 // Stats for each association with the package.
3010 repeated PackageAssociationProcessStatsProto association_stats = 6;
3011}
3012
3013message ProcessStatsSectionProto {
3014 // Elapsed realtime at start of report.
Yangster-maca8a30442018-10-13 23:46:34 -07003015 optional int64 start_realtime_millis = 1;
Yangsteraf9aee72018-10-12 09:26:16 -07003016
3017 // Elapsed realtime at end of report.
Yangster-maca8a30442018-10-13 23:46:34 -07003018 optional int64 end_realtime_millis = 2;
Yangsteraf9aee72018-10-12 09:26:16 -07003019
3020 // CPU uptime at start of report.
Yangster-maca8a30442018-10-13 23:46:34 -07003021 optional int64 start_uptime_millis = 3;
Yangsteraf9aee72018-10-12 09:26:16 -07003022
3023 // CPU uptime at end of report.
Yangster-maca8a30442018-10-13 23:46:34 -07003024 optional int64 end_uptime_millis = 4;
Yangsteraf9aee72018-10-12 09:26:16 -07003025
3026 // System runtime library. e.g. "libdvm.so", "libart.so".
3027 optional string runtime = 5;
3028
3029 // whether kernel reports swapped pss.
3030 optional bool has_swapped_pss = 6;
3031
3032 // Data completeness. e.g. "complete", "partial", shutdown", or "sysprops".
3033 enum Status {
3034 STATUS_UNKNOWN = 0;
3035 STATUS_COMPLETE = 1;
3036 STATUS_PARTIAL = 2;
3037 STATUS_SHUTDOWN = 3;
3038 STATUS_SYSPROPS = 4;
3039 }
3040 repeated Status status = 7;
3041
3042 // Stats for each process.
3043 repeated ProcessStatsProto process_stats = 8;
3044
3045 // Stats for each package.
3046 repeated ProcessStatsPackageProto package_stats = 9;
3047}
3048
Chenjie Yu12e5e672018-09-14 15:54:59 -07003049/**
3050 * Pulled from ProcessStatsService.java
3051 */
3052message ProcStats {
Yangsteraf9aee72018-10-12 09:26:16 -07003053 optional ProcessStatsSectionProto proc_stats_section = 1;
3054}
3055
3056message PowerProfileProto {
3057 optional double cpu_suspend = 1;
3058
3059 optional double cpu_idle = 2;
3060
3061 optional double cpu_active = 3;
3062
3063 message CpuCluster {
3064 optional int32 id = 1;
3065 optional double cluster_power = 2;
3066 optional int32 cores = 3;
3067 repeated int64 speed = 4;
3068 repeated double core_power = 5;
3069 }
3070
3071 repeated CpuCluster cpu_cluster = 40;
3072
3073 optional double wifi_scan = 4;
3074
3075 optional double wifi_on = 5;
3076
3077 optional double wifi_active = 6;
3078
3079 optional double wifi_controller_idle = 7;
3080
3081 optional double wifi_controller_rx = 8;
3082
3083 optional double wifi_controller_tx = 9;
3084
3085 repeated double wifi_controller_tx_levels = 10;
3086
3087 optional double wifi_controller_operating_voltage = 11;
3088
3089 optional double bluetooth_controller_idle = 12;
3090
3091 optional double bluetooth_controller_rx = 13;
3092
3093 optional double bluetooth_controller_tx = 14;
3094
3095 optional double bluetooth_controller_operating_voltage = 15;
3096
3097 optional double modem_controller_sleep = 16;
3098
3099 optional double modem_controller_idle = 17;
3100
3101 optional double modem_controller_rx = 18;
3102
3103 repeated double modem_controller_tx = 19;
3104
3105 optional double modem_controller_operating_voltage = 20;
3106
3107 optional double gps_on = 21;
3108
3109 repeated double gps_signal_quality_based = 22;
3110
3111 optional double gps_operating_voltage = 23;
3112
3113 optional double bluetooth_on = 24;
3114
3115 optional double bluetooth_active = 25;
3116
3117 optional double bluetooth_at_cmd = 26;
3118
3119 optional double ambient_display = 27;
3120
3121 optional double screen_on = 28;
3122
3123 optional double radio_on = 29;
3124
3125 optional double radio_scanning = 30;
3126
3127 optional double radio_active = 31;
3128
3129 optional double screen_full = 32;
3130
3131 optional double audio = 33;
3132
3133 optional double video = 34;
3134
3135 optional double flashlight = 35;
3136
3137 optional double memory = 36;
3138
3139 optional double camera = 37;
3140
3141 optional double wifi_batched_scan = 38;
3142
3143 optional double battery_capacity = 39;
Chenjie Yu12e5e672018-09-14 15:54:59 -07003144}
Chenjie Yuab530202018-09-26 12:39:20 -07003145
3146/**
3147 * power_profile.xml and other constants for power model calculations.
3148 * Pulled from PowerProfile.java
3149 */
3150message PowerProfile {
Yangsteraf9aee72018-10-12 09:26:16 -07003151 optional PowerProfileProto power_profile = 1;
Howard Ro9a862de2018-10-11 16:03:33 -07003152}
Chenjie Yub35b5f72018-10-13 23:25:11 -07003153
3154/**
arangelovd5db50e2018-10-12 20:24:39 +01003155 * Logs when a user restriction was added or removed.
3156 *
3157 * Logged from:
3158 * frameworks/base/services/devicepolicy/java/com/android/server/devicepolicy/DevicePolicyManagerService.java
3159 */
3160message UserRestrictionChanged {
3161 // The raw string of the user restriction as defined in UserManager.
3162 // Allowed values are defined in UserRestrictionsUtils#USER_RESTRICTIONS.
3163 optional string restriction = 1;
3164 // Whether the restriction is enabled or disabled.
3165 optional bool enabled = 2;
Howard Ro183c2bd2018-10-18 13:52:10 -07003166}
Yangster-mac308ea0c2018-10-22 13:10:25 -07003167
3168/**
3169 * Pulls process user time and system time. Puller takes a snapshot of all pids
3170 * in the system and returns cpu stats for those that are working at the time.
3171 * Dead pids will be dropped. Kernel processes are excluded.
3172 * Min cool-down is 5 sec.
3173 */
3174message ProcessCpuTime {
3175 optional int32 uid = 1 [(is_uid) = true];
3176
3177 optional string process_name = 2;
3178 // Process cpu time in user space, cumulative from boot/process start
3179 optional int64 user_time_millis = 3;
3180 // Process cpu time in system space, cumulative from boot/process start
3181 optional int64 system_time_millis = 4;
Rafal Slawikbf67d072018-10-23 11:07:54 +01003182}
Misha Wagner5a51e002018-10-03 15:04:09 +01003183
3184/**
3185 * Pulls the CPU usage for each thread.
3186 *
3187 * Read from /proc/$PID/task/$TID/time_in_state files.
3188 *
3189 * TODO(mishaw): This is an experimental atom. Issues with big/little CPU frequencies, and
3190 * time_in_state files not being present on some phones, have not been addressed. These should be
3191 * considered before a public release.
3192 */
3193message CpuTimePerThreadFreq {
3194 // UID that owns the process.
3195 optional int32 uid = 1 [(is_uid) = true];
3196 // ID of the process.
3197 optional uint32 process_id = 2;
3198 // ID of the thread.
3199 optional uint32 thread_id = 3;
3200 // Name of the process taken from `/proc/$PID/cmdline`.
3201 optional string process_name = 4;
3202 // Name of the thread taken from `/proc/$PID/task/$TID/comm`
3203 optional string thread_name = 5;
3204 // What frequency the CPU was running at, in KHz
3205 optional uint32 frequency_khz = 6;
3206 // Time spent in frequency in milliseconds, since thread start.
3207 optional uint32 time_millis = 7;
3208}