blob: 9c2720cb8b78c6f849f541ef67caa8650a2b8e0a [file] [log] [blame]
Stefan Lafoncdb1a0e2017-09-27 20:24:15 -07001/*
2 * Copyright (C) 2017 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17syntax = "proto2";
Stefan Lafoncdb1a0e2017-09-27 20:24:15 -070018
19package android.os.statsd;
Stefan Lafoncdb1a0e2017-09-27 20:24:15 -070020option java_package = "com.android.os";
Stefan Lafonae2df012017-11-14 09:17:21 -080021option java_outer_classname = "AtomsProto";
Stefan Lafoncdb1a0e2017-09-27 20:24:15 -070022
Yao Chen9c1debe2018-02-19 14:39:19 -080023import "frameworks/base/cmds/statsd/src/atom_field_options.proto";
Bookatzdb026a22018-01-10 19:01:56 -080024import "frameworks/base/core/proto/android/app/enums.proto";
Fan Zhangf837b8e2018-10-23 12:38:30 -070025import "frameworks/base/core/proto/android/app/settings_enums.proto";
Tej Singh33a412b2018-03-16 18:43:59 -070026import "frameworks/base/core/proto/android/app/job/enums.proto";
Tej Singh5d991e12018-03-09 19:48:11 -080027import "frameworks/base/core/proto/android/bluetooth/enums.proto";
Bookatz1a1b0462018-01-12 11:47:03 -080028import "frameworks/base/core/proto/android/os/enums.proto";
Bookatz8bdae8d2018-01-16 11:24:30 -080029import "frameworks/base/core/proto/android/server/enums.proto";
Bookatz48d362e2018-11-06 15:49:08 -080030import "frameworks/base/core/proto/android/server/location/enums.proto";
Yangsteraf9aee72018-10-12 09:26:16 -070031import "frameworks/base/core/proto/android/service/procstats_enum.proto";
32import "frameworks/base/core/proto/android/stats/enums.proto";
shawnlinea5b66b2018-11-13 15:05:29 +080033import "frameworks/base/core/proto/android/stats/docsui/docsui_enums.proto";
Yao Chen8c433862018-10-24 14:09:20 -070034import "frameworks/base/core/proto/android/stats/launcher/launcher.proto";
Tej Singhc477d9c2018-02-05 18:31:39 -080035import "frameworks/base/core/proto/android/telecomm/enums.proto";
Bookatz1a1b0462018-01-12 11:47:03 -080036import "frameworks/base/core/proto/android/telephony/enums.proto";
37import "frameworks/base/core/proto/android/view/enums.proto";
arangelov4e994062018-11-13 16:12:38 +000038import "frameworks/base/core/proto/android/stats/devicepolicy/device_policy_enums.proto";
39import "frameworks/base/core/proto/android/stats/devicepolicy/device_policy.proto";
Joe Onorato62c220b2017-11-18 20:32:56 -080040
Yao Chend54f9dd2017-10-17 17:37:48 +000041/**
Stefan Lafonae2df012017-11-14 09:17:21 -080042 * The master atom class. This message defines all of the available
Yao Chend54f9dd2017-10-17 17:37:48 +000043 * raw stats log events from the Android system, also known as "atoms."
44 *
45 * This field contains a single oneof with all of the available messages.
46 * The stats-log-api-gen tool runs as part of the Android build and
47 * generates the android.util.StatsLog class, which contains the constants
48 * and methods that Android uses to log.
49 *
Stefan Lafonae2df012017-11-14 09:17:21 -080050 * This Atom class is not actually built into the Android system.
Yao Chend54f9dd2017-10-17 17:37:48 +000051 * Instead, statsd on Android constructs these messages synthetically,
52 * in the format defined here and in stats_log.proto.
53 */
Stefan Lafonae2df012017-11-14 09:17:21 -080054message Atom {
55 // Pushed atoms start at 2.
David Chenc8a43242017-10-17 16:23:28 -070056 oneof pushed {
Bookatzc1a050a2017-10-10 15:49:28 -070057 // For StatsLog reasons, 1 is illegal and will not work. Must start at 2.
58 BleScanStateChanged ble_scan_state_changed = 2;
Chenjie Yubd1a28f2018-07-17 14:55:19 -070059 ProcessStateChanged process_state_changed = 3;
Bookatzc1a050a2017-10-10 15:49:28 -070060 BleScanResultReceived ble_scan_result_received = 4;
61 SensorStateChanged sensor_state_changed = 5;
Bookatzdb026a22018-01-10 19:01:56 -080062 GpsScanStateChanged gps_scan_state_changed = 6;
Bookatzc1a050a2017-10-10 15:49:28 -070063 SyncStateChanged sync_state_changed = 7;
64 ScheduledJobStateChanged scheduled_job_state_changed = 8;
65 ScreenBrightnessChanged screen_brightness_changed = 9;
Bookatzd6746242017-10-24 18:39:35 -070066 WakelockStateChanged wakelock_state_changed = 10;
Bookatzddccf0a2017-11-28 16:48:14 -080067 LongPartialWakelockStateChanged long_partial_wakelock_state_changed = 11;
68 MobileRadioPowerStateChanged mobile_radio_power_state_changed = 12;
69 WifiRadioPowerStateChanged wifi_radio_power_state_changed = 13;
Chenjie Yubd1a28f2018-07-17 14:55:19 -070070 ActivityManagerSleepStateChanged activity_manager_sleep_state_changed = 14;
71 MemoryFactorStateChanged memory_factor_state_changed = 15;
72 ExcessiveCpuUsageReported excessive_cpu_usage_reported = 16;
73 CachedKillReported cached_kill_reported = 17;
74 ProcessMemoryStatReported process_memory_stat_reported = 18;
Hyunyoung Songc6d6b772018-10-17 13:35:32 -070075 LauncherUIChanged launcher_event = 19;
Bookatzddccf0a2017-11-28 16:48:14 -080076 BatterySaverModeStateChanged battery_saver_mode_state_changed = 20;
77 DeviceIdleModeStateChanged device_idle_mode_state_changed = 21;
78 DeviceIdlingModeStateChanged device_idling_mode_state_changed = 22;
Bookatzc1a050a2017-10-10 15:49:28 -070079 AudioStateChanged audio_state_changed = 23;
Chenjie Yu5caaa9d2018-03-06 15:48:54 -080080 MediaCodecStateChanged media_codec_state_changed = 24;
Bookatzc1a050a2017-10-10 15:49:28 -070081 CameraStateChanged camera_state_changed = 25;
82 FlashlightStateChanged flashlight_state_changed = 26;
83 UidProcessStateChanged uid_process_state_changed = 27;
84 ProcessLifeCycleStateChanged process_life_cycle_state_changed = 28;
85 ScreenStateChanged screen_state_changed = 29;
Bookatz8c6571b2017-10-24 15:04:41 -070086 BatteryLevelChanged battery_level_changed = 30;
87 ChargingStateChanged charging_state_changed = 31;
88 PluggedStateChanged plugged_state_changed = 32;
Bookatza66083f2018-09-20 17:24:00 -070089 InteractiveStateChanged interactive_state_changed = 33;
90 // 34 is available
Bookatz8c6571b2017-10-24 15:04:41 -070091 WakeupAlarmOccurred wakeup_alarm_occurred = 35;
92 KernelWakeupReported kernel_wakeup_reported = 36;
Bookatze5885242017-10-24 20:10:31 -070093 WifiLockStateChanged wifi_lock_state_changed = 37;
94 WifiSignalStrengthChanged wifi_signal_strength_changed = 38;
95 WifiScanStateChanged wifi_scan_state_changed = 39;
96 PhoneSignalStrengthChanged phone_signal_strength_changed = 40;
David Chenc28b2bb2017-10-24 12:52:52 -070097 SettingChanged setting_changed = 41;
David Chenc8a43242017-10-17 16:23:28 -070098 ActivityForegroundStateChanged activity_foreground_state_changed = 42;
David Chen21582962017-11-01 17:32:46 -070099 IsolatedUidChanged isolated_uid_changed = 43;
Hugo Benichi884970e2017-11-14 22:42:46 +0900100 PacketWakeupOccurred packet_wakeup_occurred = 44;
Bookatz7948c872018-09-04 12:58:33 -0700101 WallClockTimeShifted wall_clock_time_shifted = 45;
Bookatz8fcd09a2017-12-18 13:01:10 -0800102 AnomalyDetected anomaly_detected = 46;
David Chen0b5c90c2018-01-25 16:51:49 -0800103 AppBreadcrumbReported app_breadcrumb_reported = 47;
Chenjie Yu5caaa9d2018-03-06 15:48:54 -0800104 AppStartOccurred app_start_occurred = 48;
105 AppStartCanceled app_start_canceled = 49;
106 AppStartFullyDrawn app_start_fully_drawn = 50;
Rajeev Kumar8a9fa052018-01-25 19:03:09 -0800107 LmkKillOccurred lmk_kill_occurred = 51;
Chenjie Yu52cacc62017-12-08 18:11:45 -0800108 PictureInPictureStateChanged picture_in_picture_state_changed = 52;
Tej Singh4503e102018-01-04 14:35:01 -0800109 WifiMulticastLockStateChanged wifi_multicast_lock_state_changed = 53;
Rajeev Kumar8a9fa052018-01-25 19:03:09 -0800110 LmkStateChanged lmk_state_changed = 54;
111 AppStartMemoryStateCaptured app_start_memory_state_captured = 55;
Tej Singh1ea42892018-01-19 09:27:00 -0800112 ShutdownSequenceReported shutdown_sequence_reported = 56;
Tej Singh6483ea42018-01-25 17:45:49 -0800113 BootSequenceReported boot_sequence_reported = 57;
Tej Singhbb8554a2018-01-26 11:59:14 -0800114 DaveyOccurred davey_occurred = 58;
Chenjie Yue8904192017-12-08 19:12:57 -0800115 OverlayStateChanged overlay_state_changed = 59;
Chenjie Yuccfe6452018-01-30 11:33:21 -0800116 ForegroundServiceStateChanged foreground_service_state_changed = 60;
Tej Singhc477d9c2018-02-05 18:31:39 -0800117 CallStateChanged call_state_changed = 61;
Tej Singhdd7bd352018-02-09 19:33:15 -0800118 KeyguardStateChanged keyguard_state_changed = 62;
119 KeyguardBouncerStateChanged keyguard_bouncer_state_changed = 63;
120 KeyguardBouncerPasswordEntered keyguard_bouncer_password_entered = 64;
Chenjie Yu5caaa9d2018-03-06 15:48:54 -0800121 AppDied app_died = 65;
Tej Singha883b372018-02-15 11:30:01 -0800122 ResourceConfigurationChanged resource_configuration_changed = 66;
Tej Singh5d991e12018-03-09 19:48:11 -0800123 BluetoothEnabledStateChanged bluetooth_enabled_state_changed = 67;
124 BluetoothConnectionStateChanged bluetooth_connection_state_changed = 68;
Bookatz48d362e2018-11-06 15:49:08 -0800125 GpsSignalQualityChanged gps_signal_quality_changed = 69;
Andrew Chantb56388b2018-03-22 21:07:33 -0700126 UsbConnectorStateChanged usb_connector_state_changed = 70;
Andrew Chant28d627e2018-02-22 15:17:05 -0800127 SpeakerImpedanceReported speaker_impedance_reported = 71;
128 HardwareFailed hardware_failed = 72;
129 PhysicalDropDetected physical_drop_detected = 73;
130 ChargeCyclesReported charge_cycles_reported = 74;
Tej Singheee317b2018-03-07 19:28:05 -0800131 MobileConnectionStateChanged mobile_connection_state_changed = 75;
132 MobileRadioTechnologyChanged mobile_radio_technology_changed = 76;
Andrew Chantb56388b2018-03-22 21:07:33 -0700133 UsbDeviceAttached usb_device_attached = 77;
Chenjie Yu5caaa9d2018-03-06 15:48:54 -0800134 AppCrashOccurred app_crash_occurred = 78;
135 ANROccurred anr_occurred = 79;
136 WTFOccurred wtf_occurred = 80;
137 LowMemReported low_mem_reported = 81;
Howard Rocb767f62018-06-19 19:58:05 -0700138 GenericAtom generic_atom = 82;
Yangster-mac48b3d622018-08-18 12:38:11 -0700139 KeyValuePairsAtom key_value_pairs_atom = 83;
Bookatza7020bd2018-08-28 16:29:35 -0700140 VibratorStateChanged vibrator_state_changed = 84;
Yangster-mac96353002018-09-05 11:18:55 -0700141 DeferredJobStatsReported deferred_job_stats_reported = 85;
Yangster-mace16189a2018-08-26 12:20:16 -0700142 ThermalThrottlingStateChanged thermal_throttling = 86;
Tej Singhd6d6d772018-09-05 17:41:25 -0700143 FingerprintAcquired fingerprint_acquired = 87;
144 FingerprintAuthenticated fingerprint_authenticated = 88;
145 FingerprintErrorOccurred fingerprint_error_occurred = 89;
Howard Ro688ae182018-09-25 00:09:36 -0700146 Notification notification = 90;
Howard Roa46b6582018-09-18 16:45:02 -0700147 BatteryHealthSnapshot battery_health_snapshot = 91;
148 SlowIo slow_io = 92;
149 BatteryCausedShutdown battery_caused_shutdown = 93;
Yangsteraf9aee72018-10-12 09:26:16 -0700150 PhoneServiceStateChanged phone_service_state_changed = 94;
151 PhoneStateChanged phone_state_changed = 95;
arangelovd5db50e2018-10-12 20:24:39 +0100152 UserRestrictionChanged user_restriction_changed = 96;
Fan Zhang916c13b2018-10-16 22:49:45 -0700153 SettingsUIChanged settings_ui_changed = 97;
Chenjie Yuae9dfac2018-10-25 16:06:56 -0700154 ConnectivityStateChanged connectivity_state_changed = 98;
Chenjie Yu75b3c492018-10-06 21:45:19 -0700155 // TODO: service state change is very noisy shortly after boot, as well
156 // as at other transitions - coming out of doze, device plugged in, etc.
157 // Consider removing this if it becomes a problem
158 ServiceStateChanged service_state_changed = 99;
159 ServiceLaunchReported service_launch_reported = 100;
Yangster-macb89807e2018-11-15 21:10:57 -0800160 PhenotypeFlagStateChanged phenotype_flag_state_changed = 101;
161 BinaryPushStateChanged binary_push_state_changed = 102;
arangelov4e994062018-11-13 16:12:38 +0000162 DevicePolicyEvent device_policy_event = 103;
shawnlinea5b66b2018-11-13 15:05:29 +0800163 DocsUIFileOperationCanceledReported docs_ui_file_op_canceled = 104;
164 DocsUIFileOperationCopyMoveModeReported docs_ui_file_op_copy_move_mode_reported = 105;
165 DocsUIFileOperationFailureReported docs_ui_file_op_failure = 106;
166 DocsUIFileOperationReported docs_ui_provider_file_op = 107;
167 DocsUIInvalidScopedAccessRequestReported docs_ui_invalid_scoped_access_request = 108;
168 DocsUILaunchReported docs_ui_launch_reported = 109;
169 DocsUIRootVisitedReported docs_ui_root_visited = 110;
170 DocsUIStartupMsReported docs_ui_startup_ms = 111;
171 DocsUIUserActionReported docs_ui_user_action_reported = 112;
Yao Chend54f9dd2017-10-17 17:37:48 +0000172 }
David Chenc8a43242017-10-17 16:23:28 -0700173
David Chen6e3e6cb2018-01-03 16:14:06 -0800174 // Pulled events will start at field 10000.
Rafal Slawik3bea8952018-11-15 12:39:33 +0000175 // Next: 10043
David Chenc8a43242017-10-17 16:23:28 -0700176 oneof pulled {
David Chen6e3e6cb2018-01-03 16:14:06 -0800177 WifiBytesTransfer wifi_bytes_transfer = 10000;
178 WifiBytesTransferByFgBg wifi_bytes_transfer_by_fg_bg = 10001;
179 MobileBytesTransfer mobile_bytes_transfer = 10002;
180 MobileBytesTransferByFgBg mobile_bytes_transfer_by_fg_bg = 10003;
Chenjie Yu9d7720b2018-01-24 10:34:48 -0800181 BluetoothBytesTransfer bluetooth_bytes_transfer = 10006;
David Chen6e3e6cb2018-01-03 16:14:06 -0800182 KernelWakelock kernel_wakelock = 10004;
Chenjie Yuc8b7f222018-01-11 23:25:57 -0800183 SubsystemSleepState subsystem_sleep_state = 10005;
David Chen6e3e6cb2018-01-03 16:14:06 -0800184 CpuTimePerFreq cpu_time_per_freq = 10008;
185 CpuTimePerUid cpu_time_per_uid = 10009;
186 CpuTimePerUidFreq cpu_time_per_uid_freq = 10010;
Chenjie Yu5caaa9d2018-03-06 15:48:54 -0800187 WifiActivityInfo wifi_activity_info = 10011;
David Chen6e3e6cb2018-01-03 16:14:06 -0800188 ModemActivityInfo modem_activity_info = 10012;
Chenjie Yu9d7720b2018-01-24 10:34:48 -0800189 BluetoothActivityInfo bluetooth_activity_info = 10007;
Rajeev Kumar8a9fa052018-01-25 19:03:09 -0800190 ProcessMemoryState process_memory_state = 10013;
Chenjie Yu9d7720b2018-01-24 10:34:48 -0800191 SystemElapsedRealtime system_elapsed_realtime = 10014;
192 SystemUptime system_uptime = 10015;
Chenjie Yu9da105b2018-01-13 12:41:08 -0800193 CpuActiveTime cpu_active_time = 10016;
194 CpuClusterTime cpu_cluster_time = 10017;
Tej Singh86dc9db2018-09-06 00:39:57 +0000195 DiskSpace disk_space = 10018 [deprecated=true];
Tej Singhbf972d92018-01-10 20:51:13 -0800196 RemainingBatteryCapacity remaining_battery_capacity = 10019;
197 FullBatteryCapacity full_battery_capacity = 10020;
Tej Singh40298312018-02-16 00:15:09 -0800198 Temperature temperature = 10021;
Olivier Gaillard00bfb1b2018-07-10 11:25:09 +0100199 BinderCalls binder_calls = 10022;
Olivier Gaillard9ea238d2018-07-24 10:26:31 +0100200 BinderCallsExceptions binder_calls_exceptions = 10023;
Marcin Oczeretkod8cc8592018-08-22 16:07:36 +0100201 LooperStats looper_stats = 10024;
Tej Singh86dc9db2018-09-06 00:39:57 +0000202 DiskStats disk_stats = 10025;
203 DirectoryUsage directory_usage = 10026;
204 AppSize app_size = 10027;
205 CategorySize category_size = 10028;
Chenjie Yuab530202018-09-26 12:39:20 -0700206 ProcStats proc_stats = 10029;
Bookatz17f0d8a2018-09-13 12:56:32 -0700207 BatteryVoltage battery_voltage = 10030;
Tej Singhd6d6d772018-09-05 17:41:25 -0700208 NumFingerprints num_fingerprints = 10031;
Tej Singhe7726dc2018-09-21 11:42:12 -0700209 DiskIo disk_io = 10032;
Chenjie Yuab530202018-09-26 12:39:20 -0700210 PowerProfile power_profile = 10033;
Chenjie Yub52779e2018-10-05 12:03:36 -0700211 ProcStats proc_stats_pkg_proc = 10034;
Yangster-mac308ea0c2018-10-22 13:10:25 -0700212 ProcessCpuTime process_cpu_time = 10035;
Rafal Slawik08621582018-10-15 14:53:07 +0100213 NativeProcessMemoryState native_process_memory_state = 10036;
Misha Wagner5a51e002018-10-03 15:04:09 +0100214 CpuTimePerThreadFreq cpu_time_per_thread_freq = 10037;
Bookatz92da2832018-11-01 18:10:03 -0700215 OnDevicePowerMeasurement on_device_power_measurement = 10038;
Bookatz75ee6042018-11-09 12:27:37 -0800216 DeviceCalculatedPowerUse device_calculated_power_use = 10039;
217 DeviceCalculatedPowerBlameUid device_calculated_power_blame_uid = 10040;
218 DeviceCalculatedPowerBlameOther device_calculated_power_blame_other = 10041;
Rafal Slawik3bea8952018-11-15 12:39:33 +0000219 ProcessMemoryHighWaterMark process_memory_high_water_mark = 10042;
Tej Singhb1dbc8b2018-11-19 15:49:47 -0800220 BatteryLevel battery_level = 10043;
Bookatz366a4432018-11-20 09:42:33 -0800221 BuildInformation build_information = 10044;
David Chenc8a43242017-10-17 16:23:28 -0700222 }
yroa1fe77c2018-02-26 14:22:54 -0800223
Bookatz76aafcf2018-09-17 16:17:10 -0700224 // DO NOT USE field numbers above 100,000 in AOSP.
225 // Field numbers 100,000 - 199,999 are reserved for non-AOSP (e.g. OEMs) to use.
226 // Field numbers 200,000 and above are reserved for future use; do not use them at all.
Stefan Lafoncdb1a0e2017-09-27 20:24:15 -0700227}
228
Yao Chend54f9dd2017-10-17 17:37:48 +0000229/**
Yangster-mac20877162017-12-22 17:19:39 -0800230 * This proto represents a node of an attribution chain.
231 * Note: All attribution chains are represented as a repeated field of type
232 * AttributionNode. It is understood that in such arrays, the order is that
233 * of calls, that is [A, B, C] if A calls B that calls C.
Yao Chend54f9dd2017-10-17 17:37:48 +0000234 */
Yangster-mac20877162017-12-22 17:19:39 -0800235message AttributionNode {
236 // The uid for a given element in the attribution chain.
Yangster-mac7604aea2017-12-11 22:55:49 -0800237 optional int32 uid = 1;
Yangster-mac7604aea2017-12-11 22:55:49 -0800238
Yangster-mac20877162017-12-22 17:19:39 -0800239 // The (optional) string tag for an element in the attribution chain. If the
240 // element has no tag, it is encoded as an empty string.
241 optional string tag = 2;
Stefan Lafoncdb1a0e2017-09-27 20:24:15 -0700242}
243
Yangster-mac48b3d622018-08-18 12:38:11 -0700244message KeyValuePair {
245 optional int32 key = 1;
246 oneof value {
Howard Ro4078dd42018-09-27 17:41:08 -0700247 int32 value_int = 2;
248 int64 value_long = 3;
249 string value_str = 4;
250 float value_float = 5;
Yangster-mac48b3d622018-08-18 12:38:11 -0700251 }
252}
253
254message KeyValuePairsAtom {
255 optional int32 uid = 1;
256 repeated KeyValuePair pairs = 2;
257}
258
Yao Chend54f9dd2017-10-17 17:37:48 +0000259/*
260 * *****************************************************************************
yrode4ca102017-11-15 22:57:24 -0800261 * Below are all of the individual atoms that are logged by Android via statsd.
Yao Chend54f9dd2017-10-17 17:37:48 +0000262 *
263 * RULES:
264 * - The field ids for each atom must start at 1, and count upwards by 1.
265 * Skipping field ids is not allowed.
266 * - These form an API, so renaming, renumbering or removing fields is
267 * not allowed between android releases. (This is not currently enforced,
268 * but there will be a tool to enforce this restriction).
269 * - The types must be built-in protocol buffer types, namely, no sub-messages
270 * are allowed (yet). The bytes type is also not allowed.
271 * - The CamelCase name of the message type should match the
Stefan Lafonae2df012017-11-14 09:17:21 -0800272 * underscore_separated name as defined in Atom.
Yao Chend54f9dd2017-10-17 17:37:48 +0000273 * - If an atom represents work that can be attributed to an app, there can
Yangster-mac7604aea2017-12-11 22:55:49 -0800274 * be exactly one AttributionChain field. It must be field number 1.
Yao Chend54f9dd2017-10-17 17:37:48 +0000275 * - A field that is a uid should be a string field, tagged with the [xxx]
276 * annotation. The generated code on android will be represented by UIDs,
277 * and those UIDs will be translated in xxx to those strings.
278 *
279 * CONVENTIONS:
Bookatzc1a050a2017-10-10 15:49:28 -0700280 * - Events are past tense. e.g. ScreenStateChanged, not ScreenStateChange.
Yao Chend54f9dd2017-10-17 17:37:48 +0000281 * - If there is a UID, it goes first. Think in an object-oriented fashion.
282 * *****************************************************************************
283 */
Stefan Lafoncdb1a0e2017-09-27 20:24:15 -0700284
Yao Chend54f9dd2017-10-17 17:37:48 +0000285/**
Yangster-mace16189a2018-08-26 12:20:16 -0700286 * Logs when the Thermal service HAL notifies the throttling start/stop events.
287 *
288 * Logged from:
289 * frameworks/base/services/core/java/com/android/server/stats/StatsCompanionService.java
290 */
291message ThermalThrottlingStateChanged {
292 optional android.os.TemperatureTypeEnum sensor_type = 1;
293
294 enum State {
295 UNKNOWN = 0;
296 START = 1;
297 STOP = 2;
298 }
299
300 optional State state = 2;
301
302 optional float temperature = 3;
303}
304
305/**
Yao Chend54f9dd2017-10-17 17:37:48 +0000306 * Logs when the screen state changes.
307 *
308 * Logged from:
309 * frameworks/base/services/core/java/com/android/server/am/BatteryStatsService.java
310 */
311message ScreenStateChanged {
Bookatz1a1b0462018-01-12 11:47:03 -0800312 // New screen state, from frameworks/base/core/proto/android/view/enums.proto.
Yangster-macb6b77c62018-10-12 19:33:24 -0700313 optional android.view.DisplayStateEnum state = 1 [(state_field_option).option = EXCLUSIVE];
Stefan Lafoncdb1a0e2017-09-27 20:24:15 -0700314}
Yao Chend54f9dd2017-10-17 17:37:48 +0000315
316/**
Chenjie Yubd1a28f2018-07-17 14:55:19 -0700317 * Logs that the process state of the uid, as determined by ActivityManager
318 * (i.e. the highest process state of that uid's processes) has changed.
Yao Chend54f9dd2017-10-17 17:37:48 +0000319 *
320 * Logged from:
321 * frameworks/base/services/core/java/com/android/server/am/BatteryStatsService.java
322 */
Bookatzc1a050a2017-10-10 15:49:28 -0700323message UidProcessStateChanged {
Yangster-macb6b77c62018-10-12 19:33:24 -0700324 optional int32 uid = 1 [(state_field_option).option = PRIMARY, (is_uid) = true];
Yao Chend54f9dd2017-10-17 17:37:48 +0000325
Bookatzdb026a22018-01-10 19:01:56 -0800326 // The state, from frameworks/base/core/proto/android/app/enums.proto.
Yangster-macb6b77c62018-10-12 19:33:24 -0700327 optional android.app.ProcessStateEnum state = 2 [(state_field_option).option = EXCLUSIVE];
Yao Chend54f9dd2017-10-17 17:37:48 +0000328}
329
330/**
Chenjie Yubd1a28f2018-07-17 14:55:19 -0700331 * Logs process state change of a process, as per the activity manager.
332 *
333 * Logged from:
334 * frameworks/base/services/core/java/com/android/server/am/ProcessRecord.java
335 */
336message ProcessStateChanged {
337 optional int32 uid = 1;
338 optional string process_name = 2;
339 optional string package_name = 3;
340 // TODO: remove this when validation is done
341 optional int64 version = 5;
342 // The state, from frameworks/base/core/proto/android/app/enums.proto.
343 optional android.app.ProcessStateEnum state = 4;
344}
345
346/**
347 * Logs when ActivityManagerService sleep state is changed.
348 *
349 * Logged from:
350 * frameworks/base/services/core/java/com/android/server/am/ActivityTaskManagerService.java
351 */
352message ActivityManagerSleepStateChanged {
353 // TODO: import frameworks proto
354 enum State {
355 UNKNOWN = 0;
356 ASLEEP = 1;
357 AWAKE = 2;
358 }
Yangster-macb6b77c62018-10-12 19:33:24 -0700359 optional State state = 1 [(state_field_option).option = EXCLUSIVE];
Chenjie Yubd1a28f2018-07-17 14:55:19 -0700360}
361
362/**
363 * Logs when system memory state changes.
364 *
365 * Logged from:
366 * frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
367 */
368message MemoryFactorStateChanged {
369 // TODO: import frameworks proto
370 enum State {
371 MEMORY_UNKNOWN = 0;
372 NORMAL = 1; // normal.
373 MODERATE = 2; // moderate memory pressure.
374 LOW = 3; // low memory.
375 CRITICAL = 4; // critical memory.
376
377 }
Yangster-macb6b77c62018-10-12 19:33:24 -0700378 optional State factor = 1 [(state_field_option).option = EXCLUSIVE];
Chenjie Yubd1a28f2018-07-17 14:55:19 -0700379}
380
381/**
382 * Logs when app is using too much cpu, according to ActivityManagerService.
383 *
384 * Logged from:
385 * frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
386 */
387message ExcessiveCpuUsageReported {
388 optional int32 uid = 1;
389 optional string process_name = 2;
390 optional string package_name = 3;
391 // package version. TODO: remove this when validation is done
392 optional int64 version = 4;
393}
394
395/**
396 * Logs when a cached process is killed, along with its pss.
397 *
398 * Logged from:
399 * frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
400 */
401message CachedKillReported {
402 optional int32 uid = 1;
403 optional string process_name = 2;
404 optional string package_name = 3;
405 // TODO: remove this when validation is done
406 optional int64 version = 5;
407 optional int64 pss = 4;
408}
409
410/**
411 * Logs when memory stats of a process is reported.
412 *
413 * Logged from:
414 * frameworks/base/services/core/java/com/android/server/am/ProcessRecord.java
415 */
416message ProcessMemoryStatReported {
417 optional int32 uid = 1;
418 optional string process_name = 2;
419 optional string package_name = 3;
420 //TODO: remove this when validation is done
421 optional int64 version = 9;
422 optional int64 pss = 4;
423 optional int64 uss = 5;
424 optional int64 rss = 6;
425 enum Type {
426 ADD_PSS_INTERNAL_SINGLE = 0;
427 ADD_PSS_INTERNAL_ALL_MEM = 1;
428 ADD_PSS_INTERNAL_ALL_POLL = 2;
429 ADD_PSS_EXTERNAL = 3;
430 ADD_PSS_EXTERNAL_SLOW = 4;
431 }
432 optional Type type = 7;
433 optional int64 duration = 8;
434}
435
436/**
Bookatzc1a050a2017-10-10 15:49:28 -0700437 * Logs that a process started, finished, crashed, or ANRed.
438 *
439 * Logged from:
440 * frameworks/base/services/core/java/com/android/server/am/BatteryStatsService.java
441 */
442message ProcessLifeCycleStateChanged {
Yao Chenc40a19d2018-03-15 16:48:25 -0700443 optional int32 uid = 1 [(is_uid) = true];
Bookatzc1a050a2017-10-10 15:49:28 -0700444
David Chen0b5c90c2018-01-25 16:51:49 -0800445 // The process name (usually same as the app name).
Chenjie Yu5caaa9d2018-03-06 15:48:54 -0800446 optional string process_name = 2;
Bookatzc1a050a2017-10-10 15:49:28 -0700447
Bookatzddccf0a2017-11-28 16:48:14 -0800448 // What lifecycle state the process changed to.
449 // This enum is specific to atoms.proto.
Chenjie Yu5caaa9d2018-03-06 15:48:54 -0800450 enum State {
451 FINISHED = 0;
452 STARTED = 1;
453 CRASHED = 2;
Bookatzddccf0a2017-11-28 16:48:14 -0800454 }
Chenjie Yu5caaa9d2018-03-06 15:48:54 -0800455 optional State state = 3;
Bookatzc1a050a2017-10-10 15:49:28 -0700456}
457
Bookatzc1a050a2017-10-10 15:49:28 -0700458/**
459 * Logs when the ble scan state changes.
460 *
461 * Logged from:
Bookatz17a879d2018-03-28 15:05:28 -0700462 * packages/apps/Bluetooth/src/com/android/bluetooth/gatt/AppScanStats.java
Bookatzc1a050a2017-10-10 15:49:28 -0700463 */
464message BleScanStateChanged {
Yangster-macafad8c62018-01-05 22:30:49 -0800465 repeated AttributionNode attribution_node = 1;
Bookatzc1a050a2017-10-10 15:49:28 -0700466
467 enum State {
468 OFF = 0;
469 ON = 1;
Bookatze5ec0b42018-03-26 13:34:56 -0700470 // RESET indicates all ble stopped. Used when it (re)starts (e.g. after it crashes).
471 RESET = 2;
Bookatzc1a050a2017-10-10 15:49:28 -0700472 }
473 optional State state = 2;
Bookatzc1a050a2017-10-10 15:49:28 -0700474
Bookatze5ec0b42018-03-26 13:34:56 -0700475 // Does the scan have a filter.
476 optional bool is_filtered = 3;
477 // Whether the scan is a CALLBACK_TYPE_FIRST_MATCH scan. Called 'background' scan internally.
478 optional bool is_first_match = 4;
479 // Whether the scan set to piggy-back off the results of other scans (SCAN_MODE_OPPORTUNISTIC).
480 optional bool is_opportunistic = 5;
Bookatzc1a050a2017-10-10 15:49:28 -0700481}
482
483/**
484 * Logs reporting of a ble scan finding results.
485 *
486 * Logged from:
Bookatzae6738e2018-09-13 11:38:56 -0700487 * packages/apps/Bluetooth/src/com/android/bluetooth/gatt/AppScanStats.java
Bookatzc1a050a2017-10-10 15:49:28 -0700488 */
Bookatzae6738e2018-09-13 11:38:56 -0700489// TODO: Consider also tracking per-scanner-id.
Bookatzc1a050a2017-10-10 15:49:28 -0700490message BleScanResultReceived {
Yangster-macafad8c62018-01-05 22:30:49 -0800491 repeated AttributionNode attribution_node = 1;
Bookatzc1a050a2017-10-10 15:49:28 -0700492
493 // Number of ble scan results returned.
Chenjie Yu5caaa9d2018-03-06 15:48:54 -0800494 optional int32 num_results = 2;
Bookatzc1a050a2017-10-10 15:49:28 -0700495}
496
497/**
498 * Logs when a sensor state changes.
499 *
500 * Logged from:
Bookatz235343d2018-03-26 13:03:50 -0700501 * frameworks/base/services/core/java/com/android/server/am/BatteryStatsService.java
Bookatzc1a050a2017-10-10 15:49:28 -0700502 */
503message SensorStateChanged {
Yangster-macafad8c62018-01-05 22:30:49 -0800504 repeated AttributionNode attribution_node = 1;
Bookatzc1a050a2017-10-10 15:49:28 -0700505
Bookatzc1a050a2017-10-10 15:49:28 -0700506 // The id (int) of the sensor.
507 optional int32 sensor_id = 2;
508
509 enum State {
510 OFF = 0;
511 ON = 1;
512 }
513 optional State state = 3;
514}
515
Bookatzc1a050a2017-10-10 15:49:28 -0700516/**
517 * Logs when GPS state changes.
518 *
519 * Logged from:
520 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
521 */
522message GpsScanStateChanged {
Yangster-macafad8c62018-01-05 22:30:49 -0800523 repeated AttributionNode attribution_node = 1;
Bookatzc1a050a2017-10-10 15:49:28 -0700524
525 enum State {
526 OFF = 0;
527 ON = 1;
528 }
529 optional State state = 2;
530}
531
Bookatz48d362e2018-11-06 15:49:08 -0800532/**
533 * Logs when GPS signal quality.
534 *
535 * Logged from:
536 * /frameworks/base/location/java/com/android/internal/location/gnssmetrics/GnssMetrics.java
537 */
538message GpsSignalQualityChanged {
539 optional android.server.location.GpsSignalQualityEnum level = 1;
540}
541
Bookatzc1a050a2017-10-10 15:49:28 -0700542
543/**
544 * Logs when a sync manager sync state changes.
545 *
546 * Logged from:
Bookatz235343d2018-03-26 13:03:50 -0700547 * frameworks/base/services/core/java/com/android/server/am/BatteryStatsService.java
Bookatzc1a050a2017-10-10 15:49:28 -0700548 */
549message SyncStateChanged {
Yangster-macafad8c62018-01-05 22:30:49 -0800550 repeated AttributionNode attribution_node = 1;
Bookatzc1a050a2017-10-10 15:49:28 -0700551
David Chen0b5c90c2018-01-25 16:51:49 -0800552 // Name of the sync (as named in the app). Can be chosen at run-time.
Chenjie Yu5caaa9d2018-03-06 15:48:54 -0800553 optional string sync_name = 2;
Bookatzc1a050a2017-10-10 15:49:28 -0700554
555 enum State {
556 OFF = 0;
557 ON = 1;
558 }
559 optional State state = 3;
560}
561
Yangster-mac96353002018-09-05 11:18:55 -0700562/*
563 * Deferred job stats.
564 *
565 * Logged from:
566 * frameworks/base/services/core/java/com/android/server/job/JobSchedulerService.java
567*/
568message DeferredJobStatsReported {
569 repeated AttributionNode attribution_node = 1;
570
571 // Number of jobs deferred.
572 optional int32 num_jobs_deferred = 2;
573
574 // Time since the last job runs.
575 optional int64 time_since_last_job_millis = 3;
576}
577
Bookatzc1a050a2017-10-10 15:49:28 -0700578/**
579 * Logs when a job scheduler job state changes.
580 *
581 * Logged from:
Bookatz235343d2018-03-26 13:03:50 -0700582 * frameworks/base/services/core/java/com/android/server/am/BatteryStatsService.java
Bookatzc1a050a2017-10-10 15:49:28 -0700583 */
584message ScheduledJobStateChanged {
Yangster-macafad8c62018-01-05 22:30:49 -0800585 repeated AttributionNode attribution_node = 1;
Bookatzc1a050a2017-10-10 15:49:28 -0700586
587 // Name of the job (as named in the app)
Chenjie Yu5caaa9d2018-03-06 15:48:54 -0800588 optional string job_name = 2;
Bookatzc1a050a2017-10-10 15:49:28 -0700589
590 enum State {
Tej Singhd5747a62018-01-08 20:57:35 -0800591 FINISHED = 0;
592 STARTED = 1;
593 SCHEDULED = 2;
Bookatzc1a050a2017-10-10 15:49:28 -0700594 }
595 optional State state = 3;
596
Tej Singh33a412b2018-03-16 18:43:59 -0700597 // The reason a job has stopped.
598 // This is only applicable when the state is FINISHED.
Bookatz235343d2018-03-26 13:03:50 -0700599 // The default value is STOP_REASON_UNKNOWN.
Tej Singh33a412b2018-03-16 18:43:59 -0700600 optional android.app.job.StopReasonEnum stop_reason = 4;
Bookatzc1a050a2017-10-10 15:49:28 -0700601}
602
603/**
604 * Logs when the audio 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 AudioStateChanged {
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 audio 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 video codec 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 */
Chenjie Yu5caaa9d2018-03-06 15:48:54 -0800627message MediaCodecStateChanged {
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 mediaCodec 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 when the flashlight state changes.
641 *
642 * Logged from:
Bookatz235343d2018-03-26 13:03:50 -0700643 * frameworks/base/services/core/java/com/android/server/am/BatteryStatsService.java
Bookatzc1a050a2017-10-10 15:49:28 -0700644 */
645message FlashlightStateChanged {
Yangster-macafad8c62018-01-05 22:30:49 -0800646 repeated AttributionNode attribution_node = 1;
Bookatzc1a050a2017-10-10 15:49:28 -0700647
648 enum State {
649 OFF = 0;
650 ON = 1;
Bookatz235343d2018-03-26 13:03:50 -0700651 // RESET indicates all flashlight stopped. Used when it (re)starts (e.g. after it crashes).
652 RESET = 2;
Bookatzc1a050a2017-10-10 15:49:28 -0700653 }
654 optional State state = 2;
655}
656
657/**
658 * Logs when the camera state changes.
659 *
660 * Logged from:
Bookatz235343d2018-03-26 13:03:50 -0700661 * frameworks/base/services/core/java/com/android/server/am/BatteryStatsService.java
Bookatzc1a050a2017-10-10 15:49:28 -0700662 */
663message CameraStateChanged {
Yangster-macafad8c62018-01-05 22:30:49 -0800664 repeated AttributionNode attribution_node = 1;
Bookatzc1a050a2017-10-10 15:49:28 -0700665
666 enum State {
667 OFF = 0;
668 ON = 1;
Bookatz235343d2018-03-26 13:03:50 -0700669 // RESET indicates all camera stopped. Used when it (re)starts (e.g. after it crashes).
670 RESET = 2;
Bookatzc1a050a2017-10-10 15:49:28 -0700671 }
672 optional State state = 2;
673}
674
675/**
676 * Logs that the state of a wakelock (per app and per wakelock name) has changed.
Yao Chend54f9dd2017-10-17 17:37:48 +0000677 *
678 * Logged from:
679 * TODO
680 */
Bookatzd6746242017-10-24 18:39:35 -0700681message WakelockStateChanged {
Yangster-mac20877162017-12-22 17:19:39 -0800682 repeated AttributionNode attribution_node = 1;
Yao Chend54f9dd2017-10-17 17:37:48 +0000683
Bookatz1a1b0462018-01-12 11:47:03 -0800684 // The type (level) of the wakelock; e.g. a partial wakelock or a full wakelock.
685 // From frameworks/base/core/proto/android/os/enums.proto.
Yangster-maca8a30442018-10-13 23:46:34 -0700686 optional android.os.WakeLockLevelEnum type = 2;
Bookatzc1a050a2017-10-10 15:49:28 -0700687
688 // The wakelock tag (Called tag in the Java API, sometimes name elsewhere).
689 optional string tag = 3;
690
691 enum State {
Yangster-maccfdf3a42017-12-06 13:42:38 -0800692 RELEASE = 0;
693 ACQUIRE = 1;
694 CHANGE_RELEASE = 2;
695 CHANGE_ACQUIRE = 3;
Bookatzc1a050a2017-10-10 15:49:28 -0700696 }
697 optional State state = 4;
698}
699
700/**
Bookatzc1a050a2017-10-10 15:49:28 -0700701 * Logs when a partial wakelock is considered 'long' (over 1 min).
702 *
703 * Logged from:
704 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
705 */
706message LongPartialWakelockStateChanged {
Yangster-macafad8c62018-01-05 22:30:49 -0800707 repeated AttributionNode attribution_node = 1;
Bookatzc1a050a2017-10-10 15:49:28 -0700708
Yao Chend54f9dd2017-10-17 17:37:48 +0000709 // The wakelock tag (Called tag in the Java API, sometimes name elsewhere).
710 optional string tag = 2;
711
Bookatzc1a050a2017-10-10 15:49:28 -0700712 // TODO: I have no idea what this is.
713 optional string history_tag = 3;
714
715 enum State {
716 OFF = 0;
717 ON = 1;
718 }
719 optional State state = 4;
Yao Chend54f9dd2017-10-17 17:37:48 +0000720}
721
Bookatzc1a050a2017-10-10 15:49:28 -0700722/**
Bookatza66083f2018-09-20 17:24:00 -0700723 * Logs when the device is interactive, according to the PowerManager Notifier.
724 *
725 * Logged from:
726 * frameworks/base/services/core/java/com/android/server/power/Notifier.java
727 */
728message InteractiveStateChanged {
729 enum State {
730 OFF = 0;
731 ON = 1;
732 }
733 optional State state = 1;
734}
735
736/**
Bookatzc1a050a2017-10-10 15:49:28 -0700737 * Logs Battery Saver state change.
738 *
739 * Logged from:
740 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
741 */
742message BatterySaverModeStateChanged {
743 enum State {
744 OFF = 0;
745 ON = 1;
746 }
747 optional State state = 1;
748}
749
750/**
751 * Logs Doze mode state change.
752 *
753 * Logged from:
Bookatzddccf0a2017-11-28 16:48:14 -0800754 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
Bookatzc1a050a2017-10-10 15:49:28 -0700755 */
756message DeviceIdleModeStateChanged {
Bookatz8bdae8d2018-01-16 11:24:30 -0800757 optional android.server.DeviceIdleModeEnum state = 1;
Bookatzddccf0a2017-11-28 16:48:14 -0800758}
759
760
761/**
762 * Logs state change of Doze mode including maintenance windows.
763 *
764 * Logged from:
765 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
766 */
767message DeviceIdlingModeStateChanged {
Bookatz8bdae8d2018-01-16 11:24:30 -0800768 optional android.server.DeviceIdleModeEnum state = 1;
Bookatzc1a050a2017-10-10 15:49:28 -0700769}
770
771/**
772 * Logs screen brightness level.
773 *
774 * Logged from:
775 * frameworks/base/services/core/java/com/android/server/am/BatteryStatsService.java
776 */
777message ScreenBrightnessChanged {
778 // Screen brightness level. Should be in [-1, 255] according to PowerManager.java.
779 optional int32 level = 1;
Bookatz8c6571b2017-10-24 15:04:41 -0700780}
781
782/**
783 * Logs battery level (percent full, from 0 to 100).
784 *
785 * Logged from:
David Chenc28b2bb2017-10-24 12:52:52 -0700786 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
Bookatz8c6571b2017-10-24 15:04:41 -0700787 */
788message BatteryLevelChanged {
789 // Battery level. Should be in [0, 100].
790 optional int32 battery_level = 1;
791}
792
793/**
794 * Logs change in charging status of the device.
795 *
796 * Logged from:
David Chenc28b2bb2017-10-24 12:52:52 -0700797 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
Bookatz8c6571b2017-10-24 15:04:41 -0700798 */
799message ChargingStateChanged {
Bookatz1a1b0462018-01-12 11:47:03 -0800800 // State of the battery, from frameworks/base/core/proto/android/os/enums.proto.
801 optional android.os.BatteryStatusEnum state = 1;
Bookatz8c6571b2017-10-24 15:04:41 -0700802}
803
804/**
805 * Logs whether the device is plugged in, and what power source it is using.
806 *
807 * Logged from:
David Chenc28b2bb2017-10-24 12:52:52 -0700808 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
Bookatz8c6571b2017-10-24 15:04:41 -0700809 */
810message PluggedStateChanged {
Bookatz1a1b0462018-01-12 11:47:03 -0800811 // Whether the device is plugged in, from frameworks/base/core/proto/android/os/enums.proto.
812 optional android.os.BatteryPluggedStateEnum state = 1;
Bookatz8c6571b2017-10-24 15:04:41 -0700813}
814
Bookatz8c6571b2017-10-24 15:04:41 -0700815/**
816 * Logs when an app's wakeup alarm fires.
817 *
818 * Logged from:
David Chenc28b2bb2017-10-24 12:52:52 -0700819 * frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
Bookatz8c6571b2017-10-24 15:04:41 -0700820 */
821message WakeupAlarmOccurred {
Yangster-macafad8c62018-01-05 22:30:49 -0800822 repeated AttributionNode attribution_node = 1;
Bookatzddccf0a2017-11-28 16:48:14 -0800823
824 // Name of the wakeup alarm.
825 optional string tag = 2;
Bookatzcaf2293e2018-09-23 13:07:43 -0700826
827 // Name of source package (for historical reasons, since BatteryStats tracked it).
828 optional string package_name = 3;
Bookatzddccf0a2017-11-28 16:48:14 -0800829}
830
831/**
832 * Logs when an an app causes the mobile radio to change state.
833 * Changing from LOW to MEDIUM or HIGH can be considered the app waking the mobile radio.
834 *
835 * Logged from:
Bookatz0b028b12018-05-31 16:51:17 -0700836 * frameworks/base/services/core/java/com/android/server/NetworkManagementService.java
Bookatzddccf0a2017-11-28 16:48:14 -0800837 */
838message MobileRadioPowerStateChanged {
Chenjie Yu5caaa9d2018-03-06 15:48:54 -0800839 repeated AttributionNode attribution_node = 1;
Bookatzddccf0a2017-11-28 16:48:14 -0800840
Bookatz1a1b0462018-01-12 11:47:03 -0800841 // Power state, from frameworks/base/core/proto/android/telephony/enums.proto.
842 optional android.telephony.DataConnectionPowerStateEnum state = 2;
Bookatzddccf0a2017-11-28 16:48:14 -0800843}
844
845/**
846 * Logs when an an app causes the wifi radio to change state.
847 * Changing from LOW to MEDIUM or HIGH can be considered the app waking the wifi radio.
848 *
849 * Logged from:
Bookatz0b028b12018-05-31 16:51:17 -0700850 * frameworks/base/services/core/java/com/android/server/NetworkManagementService.java
Bookatzddccf0a2017-11-28 16:48:14 -0800851 */
852message WifiRadioPowerStateChanged {
Chenjie Yu5caaa9d2018-03-06 15:48:54 -0800853 repeated AttributionNode attribution_node = 1;
Bookatzddccf0a2017-11-28 16:48:14 -0800854
Bookatz1a1b0462018-01-12 11:47:03 -0800855 // Power state, from frameworks/base/core/proto/android/telephony/enums.proto.
856 optional android.telephony.DataConnectionPowerStateEnum state = 2;
Bookatz8c6571b2017-10-24 15:04:41 -0700857}
858
859/**
860 * Logs kernel wakeup reasons and aborts.
861 *
862 * Logged from:
Bookatz56585ca2018-09-07 11:38:45 -0700863 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
Bookatz8c6571b2017-10-24 15:04:41 -0700864 */
865message KernelWakeupReported {
866 // Name of the kernel wakeup reason (or abort).
867 optional string wakeup_reason_name = 1;
868
869 // Duration (in microseconds) for the wake-up interrupt to be serviced.
David Chen0b5c90c2018-01-25 16:51:49 -0800870 optional int64 duration_micros = 2;
Bookatze5885242017-10-24 20:10:31 -0700871}
872
873/**
874 * Logs wifi locks held by an app.
875 *
876 * Logged from:
David Chenc28b2bb2017-10-24 12:52:52 -0700877 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
Bookatze5885242017-10-24 20:10:31 -0700878 */
879message WifiLockStateChanged {
Yangster-macafad8c62018-01-05 22:30:49 -0800880 repeated AttributionNode attribution_node = 1;
Bookatze5885242017-10-24 20:10:31 -0700881
882 enum State {
883 OFF = 0;
884 ON = 1;
885 }
886 optional State state = 2;
887}
888
889/**
890 * Logs wifi signal strength changes.
891 *
892 * Logged from:
David Chenc28b2bb2017-10-24 12:52:52 -0700893 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
Bookatze5885242017-10-24 20:10:31 -0700894 */
895message WifiSignalStrengthChanged {
Bookatz1a1b0462018-01-12 11:47:03 -0800896 // Signal strength, from frameworks/base/core/proto/android/telephony/enums.proto.
897 optional android.telephony.SignalStrengthEnum signal_strength = 1;
Bookatze5885242017-10-24 20:10:31 -0700898}
899
900/**
901 * Logs wifi scans performed by an app.
902 *
903 * Logged from:
David Chenc28b2bb2017-10-24 12:52:52 -0700904 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
Bookatze5885242017-10-24 20:10:31 -0700905 */
906message WifiScanStateChanged {
Yangster-macafad8c62018-01-05 22:30:49 -0800907 repeated AttributionNode attribution_node = 1;
Bookatze5885242017-10-24 20:10:31 -0700908
909 enum State {
910 OFF = 0;
911 ON = 1;
912 }
913 optional State state = 2;
914}
915
916/**
Tej Singh4503e102018-01-04 14:35:01 -0800917 * Logs wifi multicast locks held by an app
918 *
919 * Logged from:
920 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
921 */
922message WifiMulticastLockStateChanged {
923 repeated AttributionNode attribution_node = 1;
924
925 enum State {
926 OFF = 0;
927 ON = 1;
928 }
929 optional State state = 2;
930}
931
932/**
Tej Singh1ea42892018-01-19 09:27:00 -0800933 * Logs shutdown reason and duration on next boot.
934 *
935 * Logged from:
936 * frameworks/base/core/java/com/android/server/BootReceiver.java
937 */
938message ShutdownSequenceReported {
939 // True if shutdown is for a reboot. Default: false if we do not know.
940 optional bool reboot = 1;
941
942 // Reason for shutdown. Eg: userrequested. Default: "<EMPTY>".
943 optional string reason = 2;
944
945 // Beginning of shutdown time in ms using wall clock time since unix epoch.
946 // Default: 0 if no start time received.
David Chen0b5c90c2018-01-25 16:51:49 -0800947 optional int64 start_time_millis = 3;
Tej Singh1ea42892018-01-19 09:27:00 -0800948
949 // Duration of shutdown in ms. Default: 0 if no duration received.
David Chen0b5c90c2018-01-25 16:51:49 -0800950 optional int64 duration_millis = 4;
Tej Singh1ea42892018-01-19 09:27:00 -0800951}
952
Tej Singh6483ea42018-01-25 17:45:49 -0800953
954/**
955 * Logs boot reason and duration.
956 *
957 * Logged from:
958 * system/core/bootstat/bootstat.cpp
959 */
960message BootSequenceReported {
961 // Reason for bootloader boot. Eg. reboot. See bootstat.cpp for larger list
962 // Default: "<EMPTY>" if not available.
963 optional string bootloader_reason = 1;
964
965 // Reason for system boot. Eg. bootloader, reboot,userrequested
966 // Default: "<EMPTY>" if not available.
967 optional string system_reason = 2;
968
969 // End of boot time in ms from unix epoch using system wall clock.
David Chen0b5c90c2018-01-25 16:51:49 -0800970 optional int64 end_time_millis = 3;
Tej Singh6483ea42018-01-25 17:45:49 -0800971
972 // Total boot duration in ms.
David Chen0b5c90c2018-01-25 16:51:49 -0800973 optional int64 total_duration_millis = 4;
Tej Singh6483ea42018-01-25 17:45:49 -0800974
975 // Bootloader duration in ms.
David Chen0b5c90c2018-01-25 16:51:49 -0800976 optional int64 bootloader_duration_millis = 5;
Tej Singh6483ea42018-01-25 17:45:49 -0800977
978 // Time since last boot in ms. Default: 0 if not available.
979 optional int64 time_since_last_boot = 6;
980}
981
Tej Singhc477d9c2018-02-05 18:31:39 -0800982
983/**
984 * Logs call state and disconnect cause (if applicable).
985 *
986 * Logged from:
987 * packages/services/Telecomm/src/com/android/server/telecom/Call.java
988 */
989message CallStateChanged {
990 // The state of the call. Eg. DIALING, ACTIVE, ON_HOLD, DISCONNECTED.
991 // From frameworks/base/core/proto/android/telecomm/enums.proto.
992 optional android.telecom.CallStateEnum call_state = 1;
993
994 // The reason the call disconnected. Eg. ERROR, MISSED, REJECTED, BUSY.
995 // This value is only applicable when the call_state is DISCONNECTED, and
996 // should always be UNKNOWN if the call_state is not DISCONNECTED.
997 // From frameworks/base/core/proto/android/telecomm/enums.proto.
998 optional android.telecom.DisconnectCauseEnum disconnect_cause = 2;
999
1000 // True if the call is self-managed, which are apps that use the
1001 // telecom infrastructure to make their own calls.
1002 optional bool self_managed = 3;
1003
1004 // True if call is external. External calls are calls on connected Wear
1005 // devices but show up in Telecom so the user can pull them onto the device.
1006 optional bool external_call = 4;
1007}
1008
Tej Singh1ea42892018-01-19 09:27:00 -08001009/**
Tej Singhdd7bd352018-02-09 19:33:15 -08001010 * Logs keyguard state. The keyguard is the lock screen.
1011 *
1012 * Logged from:
1013 * frameworks/base/packages/SystemUI/src/com/android/systemui/statusbar/phone/StatusBarKeyguardViewManager.java
1014 */
1015message KeyguardStateChanged {
1016 enum State {
1017 UNKNOWN = 0;
1018 // The keyguard is hidden when the phone is unlocked.
1019 HIDDEN = 1;
1020 // The keyguard is shown when the phone is locked (screen turns off).
1021 SHOWN= 2;
1022 // The keyguard is occluded when something is overlaying the keyguard.
1023 // Eg. Opening the camera while on the lock screen.
1024 OCCLUDED = 3;
1025 }
1026 optional State state = 1;
1027}
1028
1029/**
1030 * Logs keyguard bouncer state. The bouncer is a part of the keyguard, and
1031 * prompts the user to enter a password (pattern, pin, etc).
1032 *
1033 * Logged from:
1034 * frameworks/base/packages/SystemUI/src/com/android/systemui/statusbar/phone/KeyguardBouncer.java
1035 */
1036
1037message KeyguardBouncerStateChanged {
1038 enum State {
1039 UNKNOWN = 0;
1040 // Bouncer is hidden, either as a result of successfully entering the
1041 // password, screen timing out, or user going back to lock screen.
1042 HIDDEN = 1;
1043 // This is when the user is being prompted to enter the password.
1044 SHOWN = 2;
1045 }
1046 optional State state = 1;
1047}
1048
1049/**
1050 * Logs the result of entering a password into the keyguard bouncer.
1051 *
1052 * Logged from:
1053 * frameworks/base/packages/SystemUI/src/com/android/keyguard/KeyguardSecurityContainer.java
1054 */
1055message KeyguardBouncerPasswordEntered {
1056 enum BouncerResult {
1057 UNKNOWN = 0;
1058 // The password entered was incorrect.
1059 FAILURE = 1;
1060 // The password entered was correct.
1061 SUCCESS = 2;
1062 }
1063 optional BouncerResult result = 1;
1064}
1065
Tej Singha883b372018-02-15 11:30:01 -08001066/*
1067 * Logs changes to the configuration of the device. The configuration is defined
1068 * in frameworks/base/core/java/android/content/res/Configuration.java
1069 * More documentation is at https://d.android.com/reference/android/content/res/Configuration.html
1070 * Please go there to interpret the possible values each field can be.
1071 *
1072 * Logged from:
1073 * frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
1074 */
1075message ResourceConfigurationChanged {
1076 // Bit mask of color capabilities of the screen.
1077 // Contains information about the color gamut and hdr mode of the screen.
1078 // See: https://d.android.com/reference/android/content/res/Configuration.html#colorMode
Yangster-maca8a30442018-10-13 23:46:34 -07001079 optional int32 color_mode = 1;
Tej Singha883b372018-02-15 11:30:01 -08001080
1081 // The target screen density being rendered to.
1082 // See: https://d.android.com/reference/android/content/res/Configuration.html#densityDpi
Yangster-maca8a30442018-10-13 23:46:34 -07001083 optional int32 density_dpi = 2;
Tej Singha883b372018-02-15 11:30:01 -08001084
1085 // Current user preference for the scaling factor for fonts,
1086 // relative to the base density scaling.
1087 // See: https://d.android.com/reference/android/content/res/Configuration.html#fontScale
Yangster-maca8a30442018-10-13 23:46:34 -07001088 optional float font_scale = 3;
Tej Singha883b372018-02-15 11:30:01 -08001089
1090 // Flag indicating whether the hard keyboard is hidden.
1091 // See: https://d.android.com/reference/android/content/res/Configuration.html#hardKeyboardHidden
Yangster-maca8a30442018-10-13 23:46:34 -07001092 optional int32 hard_keyboard_hidden = 4;
Tej Singha883b372018-02-15 11:30:01 -08001093
1094 // The type of keyboard attached to the device.
1095 // See: https://d.android.com/reference/android/content/res/Configuration.html#keyboard
1096 optional int32 keyboard = 5;
1097
1098 // Flag indicating whether any keyboard is available. Takes soft keyboards into account.
1099 // See: https://d.android.com/reference/android/content/res/Configuration.html#keyboardHidden
Yangster-maca8a30442018-10-13 23:46:34 -07001100 optional int32 keyboard_hidden = 6;
Tej Singha883b372018-02-15 11:30:01 -08001101
1102 // IMSI MCC (Mobile Country Code), corresponding to mcc resource qualifier.
1103 // 0 if undefined.
1104 // See: https://d.android.com/reference/android/content/res/Configuration.html#mcc
1105 optional int32 mcc = 7;
1106
1107 // IMSI MNC (Mobile Network Code), corresponding to mnc resource qualifier.
1108 // 0 if undefined. Note: the actual MNC may be 0, to check for this use the
1109 // MNC_ZERO symbol defined in Configuration.java.
1110 // See: https://d.android.com/reference/android/content/res/Configuration.html#mnc
1111 optional int32 mnc = 8;
1112
1113 // The kind of navigation available on the device.
1114 // See: https://developer.android.com/reference/android/content/res/Configuration.html#navigation
1115 optional int32 navigation = 9;
1116
1117 // Flag indicating whether the navigation is available.
1118 // See: https://d.android.com/reference/android/content/res/Configuration.html#navigationHidden
Yangster-maca8a30442018-10-13 23:46:34 -07001119 optional int32 navigation_hidden = 10;
Tej Singha883b372018-02-15 11:30:01 -08001120
1121 // Overall orientation of the screen.
1122 // See: https://d.android.com/reference/android/content/res/Configuration.html#orientation
1123 optional int32 orientation = 11;
1124
1125 // The current height of the available screen space, in dp units.
1126 // See: https://d.android.com/reference/android/content/res/Configuration.html#screenHeightDp
Yangster-maca8a30442018-10-13 23:46:34 -07001127 optional int32 screen_height_dp = 12;
Tej Singha883b372018-02-15 11:30:01 -08001128
1129 // Bit mask of overall layout of the screen.
1130 // Contains information about screen size, whether the screen is wider/taller
1131 // than normal, whether the screen layout is right-tl-left or left-to-right,
1132 // and whether the screen has a rounded shape.
1133 // See: https://d.android.com/reference/android/content/res/Configuration.html#screenLayout
Yangster-maca8a30442018-10-13 23:46:34 -07001134 optional int32 screen_layout = 13;
Tej Singha883b372018-02-15 11:30:01 -08001135
1136 // Current width of the available screen space, in dp units.
1137 // See: https://d.android.com/reference/android/content/res/Configuration.html#screenWidthDp
Yangster-maca8a30442018-10-13 23:46:34 -07001138 optional int32 screen_width_dp = 14;
Tej Singha883b372018-02-15 11:30:01 -08001139
1140 // The smallest screen size an application will see in normal operation.
1141 // This is the smallest value of both screenWidthDp and screenHeightDp
1142 // in portrait and landscape.
1143 // See: https://d.android.com/reference/android/content/res/Configuration.html#smallestScreenWidthDp
Yangster-maca8a30442018-10-13 23:46:34 -07001144 optional int32 smallest_screen_width_dp = 15;
Tej Singha883b372018-02-15 11:30:01 -08001145
1146 // The type of touch screen attached to the device.
1147 // See: https://d.android.com/reference/android/content/res/Configuration.html#touchscreen
1148 optional int32 touchscreen = 16;
1149
1150 // Bit mask of the ui mode.
1151 // Contains information about the overall ui mode of the device.
1152 // Eg: NORMAL, DESK, CAR, TELEVISION, WATCH, VR_HEADSET
1153 // Also contains information about whether the device is in night mode.
1154 // See: https://d.android.com/reference/android/content/res/Configuration.html#uiMode
Yangster-maca8a30442018-10-13 23:46:34 -07001155 optional int32 ui_mode = 17;
Tej Singha883b372018-02-15 11:30:01 -08001156}
1157
Tej Singheee317b2018-03-07 19:28:05 -08001158
1159/**
1160 * Logs changes in the connection state of the mobile radio.
1161 *
1162 * Logged from:
1163 * frameworks/opt/telephony/src/java/com/android/internal/telephony/dataconnection/DataConnection.java
1164 */
1165message MobileConnectionStateChanged {
1166 // States are from the state machine DataConnection.java.
1167 enum State {
1168 UNKNOWN = 0;
1169 // The connection is inactive, or disconnected.
1170 INACTIVE = 1;
1171 // The connection is being activated, or connecting.
1172 ACTIVATING = 2;
1173 // The connection is active, or connected.
1174 ACTIVE = 3;
1175 // The connection is disconnecting.
1176 DISCONNECTING = 4;
1177 // The connection is disconnecting after creating a connection.
1178 DISCONNECTION_ERROR_CREATING_CONNECTION = 5;
1179 }
1180 optional State state = 1;
1181 // For multi-sim phones, this distinguishes between the sim cards.
1182 optional int32 sim_slot_index = 2;
1183 // Used to identify the connection. Starts at 0 and increments by 1 for
1184 // every new network created. Resets whenever the device reboots.
1185 optional int32 data_connection_id = 3;
1186 // A bitmask for the capabilities of this connection.
1187 // Eg. DEFAULT (internet), MMS, SUPL, DUN, IMS.
1188 // Default value (if we have no information): 0
1189 optional int64 capabilities = 4;
1190 // If this connection has internet.
1191 // This just checks if the DEFAULT bit of capabilities is set.
1192 optional bool has_internet = 5;
1193}
1194
1195/**
1196 * Logs changes in mobile radio technology. eg: LTE, EDGE, CDMA.
1197 *
1198 * Logged from:
1199 * frameworks/opt/telephony/src/java/com/android/internal/telephony/ServiceStateTracker.java
1200 */
1201message MobileRadioTechnologyChanged {
1202 optional android.telephony.NetworkTypeEnum state = 1;
1203 // For multi-sim phones, this distinguishes between the sim cards.
1204 optional int32 sim_slot_index = 2;
1205}
1206
Andrew Chantb56388b2018-03-22 21:07:33 -07001207/**
1208 * Logs the VID and PID of any connected USB devices.
1209 *
1210 * Notes if any Audio, HID (input buttons/mouse/keyboard), or Storage interfaces are present.
1211 *
1212 * Logged by Vendor.
1213 */
1214message UsbDeviceAttached {
1215 optional int32 vid = 1;
1216 optional int32 pid = 2;
1217 optional bool has_audio = 3;
1218 optional bool has_hid = 4;
1219 optional bool has_storage = 5;
1220}
1221
Tej Singheee317b2018-03-07 19:28:05 -08001222
Tej Singhdd7bd352018-02-09 19:33:15 -08001223/**
Tej Singh5d991e12018-03-09 19:48:11 -08001224 * Logs when Bluetooth is enabled and disabled.
1225 *
1226 * Logged from:
1227 * services/core/java/com/android/server/BluetoothManagerService.java
1228 */
1229message BluetoothEnabledStateChanged {
1230 repeated AttributionNode attribution_node = 1;
1231 // Whether or not bluetooth is enabled on the device.
1232 enum State {
1233 UNKNOWN = 0;
1234 ENABLED = 1;
1235 DISABLED = 2;
1236 }
1237 optional State state = 2;
1238 // The reason for being enabled/disabled.
1239 // Eg. Airplane mode, crash, application request.
1240 optional android.bluetooth.EnableDisableReasonEnum reason = 3;
1241 // If the reason is an application request, this will be the package name.
Yangster-maca8a30442018-10-13 23:46:34 -07001242 optional string pkg_name = 4;
Tej Singh5d991e12018-03-09 19:48:11 -08001243}
1244
1245/**
1246 * Logs when a Bluetooth device connects and disconnects.
1247 *
1248 * Logged from:
1249 * packages/apps/Bluetooth/src/com/android/bluetooth/btservice/AdapterProperties.java
1250 */
1251message BluetoothConnectionStateChanged {
1252 // The state of the connection.
1253 // Eg: CONNECTING, CONNECTED, DISCONNECTING, DISCONNECTED.
1254 optional android.bluetooth.ConnectionStateEnum state = 1;
1255 // An identifier that can be used to match connect and disconnect events.
1256 // Currently is last two bytes of a hash of a device level ID and
1257 // the mac address of the bluetooth device that is connected.
1258 optional int32 obfuscated_id = 2;
1259 // The profile that is connected. Eg. GATT, A2DP, HEADSET.
1260 // From android.bluetooth.BluetoothAdapter.java
1261 optional int32 bt_profile = 3;
1262}
1263
1264/**
Andrew Chant28d627e2018-02-22 15:17:05 -08001265 * Logs when something is plugged into or removed from the USB-C connector.
1266 *
1267 * Logged from:
1268 * Vendor USB HAL.
1269 */
1270message UsbConnectorStateChanged {
1271 enum State {
1272 DISCONNECTED = 0;
1273 CONNECTED = 1;
1274 }
1275 optional State state = 1;
1276}
1277
1278/**
1279 * Logs the reported speaker impedance.
1280 *
1281 * Logged from:
1282 * Vendor audio implementation.
1283 */
1284message SpeakerImpedanceReported {
1285 optional int32 speaker_location = 1;
1286 optional int32 impedance = 2;
1287}
1288
1289/**
1290 * Logs the report of a failed hardware.
1291 *
1292 * Logged from:
1293 * Vendor HALs.
1294 *
1295 */
1296message HardwareFailed {
1297 enum HardwareType {
1298 HARDWARE_FAILED_UNKNOWN = 0;
1299 HARDWARE_FAILED_MICROPHONE = 1;
1300 HARDWARE_FAILED_CODEC = 2;
1301 HARDWARE_FAILED_SPEAKER = 3;
1302 HARDWARE_FAILED_FINGERPRINT = 4;
1303 }
1304 optional HardwareType hardware_type = 1;
1305
1306 /* hardware_location allows vendors to differentiate between multiple instances of
1307 * the same hardware_type. The specific locations are vendor defined integers,
1308 * referring to board-specific numbering schemes.
1309 */
1310 optional int32 hardware_location = 2;
1311
1312 /* failure_code is specific to the HardwareType of the failed hardware.
1313 * It should use the enum values defined below.
1314 */
1315 enum MicrophoneFailureCode {
1316 MICROPHONE_FAILURE_COMPLETE = 0;
1317 }
1318 enum CodecFailureCode {
1319 CODEC_FAILURE_COMPLETE = 0;
1320 }
1321 enum SpeakerFailureCode {
1322 SPEAKER_FAILURE_COMPLETE = 0;
1323 SPEAKER_FAILURE_HIGH_Z = 1;
1324 SPEAKER_FAILURE_SHORT = 2;
1325 }
1326 enum FingerprintFailureCode {
1327 FINGERPRINT_FAILURE_COMPLETE = 0;
1328 FINGERPRINT_SENSOR_BROKEN = 1;
1329 FINGERPRINT_TOO_MANY_DEAD_PIXELS = 2;
1330 }
1331 optional int32 failure_code = 3;
1332}
1333
1334/**
1335 * Log an event when the device has been physically dropped.
1336 * Reported from the /vendor partition.
1337 */
1338message PhysicalDropDetected {
1339 // Confidence that the event was actually a drop, 0 -> 100
1340 optional int32 confidence_pctg = 1;
1341 // Peak acceleration of the drop, in 1/1000s of a g.
1342 optional int32 accel_peak_thousandths_g = 2;
Andrew Chantb56388b2018-03-22 21:07:33 -07001343 // Duration of freefall in ms
1344 optional int32 freefall_time_millis = 3;
Andrew Chant28d627e2018-02-22 15:17:05 -08001345}
1346
1347/**
1348 * Log bucketed battery charge cycles.
1349 *
1350 * Each bucket represents cycles of the battery past
Maggie White38c9d322018-11-20 10:07:52 -08001351 * a given charge point. For example, if 10 cycle buckets are
1352 * initialized, bucket 1 is the lowest 1/10th of the battery,
1353 * and bucket 10 is 100%.
Andrew Chant28d627e2018-02-22 15:17:05 -08001354 *
1355 * Logged from:
1356 * /sys/class/power_supply/bms/cycle_count, via Vendor.
1357 */
1358message ChargeCyclesReported {
1359 optional int32 cycle_bucket_1 = 1;
1360 optional int32 cycle_bucket_2 = 2;
1361 optional int32 cycle_bucket_3 = 3;
1362 optional int32 cycle_bucket_4 = 4;
1363 optional int32 cycle_bucket_5 = 5;
1364 optional int32 cycle_bucket_6 = 6;
1365 optional int32 cycle_bucket_7 = 7;
1366 optional int32 cycle_bucket_8 = 8;
Maggie White38c9d322018-11-20 10:07:52 -08001367 optional int32 cycle_bucket_9 = 9;
1368 optional int32 cycle_bucket_10 = 10;
Andrew Chant28d627e2018-02-22 15:17:05 -08001369}
1370
1371/**
Howard Roa46b6582018-09-18 16:45:02 -07001372 * Log battery health snapshot.
1373 *
1374 * Resistance, Voltage, Open Circuit Voltage, Temperature, and Charge Level
1375 * are snapshotted periodically over 24hrs.
1376 */
1377message BatteryHealthSnapshot {
1378 enum BatterySnapshotType {
1379 UNKNOWN = 0;
1380 MIN_TEMP = 1; // Snapshot at min batt temp over 24hrs.
1381 MAX_TEMP = 2; // Snapshot at max batt temp over 24hrs.
1382 MIN_RESISTANCE = 3; // Snapshot at min batt resistance over 24hrs.
1383 MAX_RESISTANCE = 4; // Snapshot at max batt resistance over 24hrs.
1384 MIN_VOLTAGE = 5; // Snapshot at min batt voltage over 24hrs.
1385 MAX_VOLTAGE = 6; // Snapshot at max batt voltage over 24hrs.
1386 MIN_CURRENT = 7; // Snapshot at min batt current over 24hrs.
1387 MAX_CURRENT = 8; // Snapshot at max batt current over 24hrs.
1388 MIN_BATT_LEVEL = 9; // Snapshot at min battery level (SoC) over 24hrs.
1389 MAX_BATT_LEVEL = 10; // Snapshot at max battery level (SoC) over 24hrs.
1390 AVG_RESISTANCE = 11; // Snapshot at average battery resistance over 24hrs.
1391 }
1392 optional BatterySnapshotType type = 1;
1393 // Temperature, in 1/10ths of degree C.
Yangster-maca8a30442018-10-13 23:46:34 -07001394 optional int32 temperature_deci_celsius = 2;
Howard Roa46b6582018-09-18 16:45:02 -07001395 // Voltage Battery Voltage, in microVolts.
1396 optional int32 voltage_micro_volt = 3;
1397 // Current Battery current, in microAmps.
1398 optional int32 current_micro_amps = 4;
1399 // OpenCircuitVoltage Battery Open Circuit Voltage, in microVolts.
1400 optional int32 open_circuit_micro_volt = 5;
1401 // Resistance Battery Resistance, in microOhms.
1402 optional int32 resistance_micro_ohm = 6;
1403 // Level Battery Level, as % of full.
1404 optional int32 level_percent = 7;
1405}
1406
1407/**
1408 * Log slow I/O operations on the primary storage.
1409 */
1410message SlowIo {
1411 // Classifications of IO Operations.
1412 enum IoOperation {
1413 UNKNOWN = 0;
1414 READ = 1;
1415 WRITE = 2;
1416 UNMAP = 3;
1417 SYNC = 4;
1418 }
1419 optional IoOperation operation = 1;
1420
1421 // The number of slow IO operations of this type over 24 hours.
1422 optional int32 count = 2;
1423}
1424
1425/**
1426 * Log battery caused shutdown with the last recorded voltage.
1427 */
1428message BatteryCausedShutdown {
1429 // The last recorded battery voltage prior to shutdown.
1430 optional int32 last_recorded_micro_volt = 1;
1431}
1432
1433/**
Tej Singhbb8554a2018-01-26 11:59:14 -08001434 * Logs the duration of a davey (jank of >=700ms) when it occurs
1435 *
1436 * Logged from:
1437 * frameworks/base/libs/hwui/JankTracker.cpp
1438 */
1439message DaveyOccurred {
David Chen77ef6712018-02-23 18:23:42 -08001440 // The UID that logged this atom.
Yao Chenc40a19d2018-03-15 16:48:25 -07001441 optional int32 uid = 1 [(is_uid) = true];
David Chen77ef6712018-02-23 18:23:42 -08001442
Tej Singhbb8554a2018-01-26 11:59:14 -08001443 // Amount of time it took to render the frame. Should be >=700ms.
David Chen77ef6712018-02-23 18:23:42 -08001444 optional int64 jank_duration_millis = 2;
Tej Singhbb8554a2018-01-26 11:59:14 -08001445}
1446
1447/**
Bookatze5885242017-10-24 20:10:31 -07001448 * Logs phone signal strength changes.
1449 *
1450 * Logged from:
David Chenc28b2bb2017-10-24 12:52:52 -07001451 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
Bookatze5885242017-10-24 20:10:31 -07001452 */
1453message PhoneSignalStrengthChanged {
Bookatz1a1b0462018-01-12 11:47:03 -08001454 // Signal strength, from frameworks/base/core/proto/android/telephony/enums.proto.
1455 optional android.telephony.SignalStrengthEnum signal_strength = 1;
David Chenc28b2bb2017-10-24 12:52:52 -07001456}
1457
Yangster4ccebea2018-10-09 17:09:02 -07001458
1459/**
1460 * Logs when the phone state, sim state or signal strength changes
1461 *
1462 * Logged from:
1463 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
1464 */
1465message PhoneServiceStateChanged {
1466 optional android.telephony.ServiceStateEnum state = 1;
1467 optional android.telephony.SimStateEnum sim_state = 2;
1468 optional android.telephony.SignalStrengthEnum signal_strength = 3;
1469}
1470
1471/**
1472 * Logs when the phone becomes on or off.
1473 *
1474 * Logged from:
1475 * frameworks/base/core/java/com/android/internal/os/TelephonyRegistry.java
1476 */
1477message PhoneStateChanged {
1478 enum State {
1479 OFF = 0;
1480 ON = 1;
1481 }
1482 optional State state = 1;
1483}
1484
Hyunyoung Songc6d6b772018-10-17 13:35:32 -07001485message LauncherUIChanged {
Yao Chen8c433862018-10-24 14:09:20 -07001486 optional android.stats.launcher.LauncherAction action = 1;
1487 optional android.stats.launcher.LauncherState src_state = 2;
1488 optional android.stats.launcher.LauncherState dst_state = 3;
1489 optional android.stats.launcher.LauncherExtension extension = 4 [(log_mode) = MODE_BYTES];
Hyunyoung Songc6d6b772018-10-17 13:35:32 -07001490 optional bool is_swipe_up_enabled = 5;
1491}
1492
David Chenc28b2bb2017-10-24 12:52:52 -07001493/**
Fan Zhang916c13b2018-10-16 22:49:45 -07001494 * Logs when Settings UI has changed.
1495 *
1496 * Logged from:
1497 * packages/apps/Settings
1498 */
1499message SettingsUIChanged {
1500 /**
Fan Zhang916c13b2018-10-16 22:49:45 -07001501 * Where this SettingsUIChange event comes from. For example, if
1502 * it's a PAGE_VISIBLE event, where the page is opened from.
1503 */
Fan Zhangf837b8e2018-10-23 12:38:30 -07001504 optional android.app.settings.PageId attribution = 1;
Fan Zhang916c13b2018-10-16 22:49:45 -07001505
1506 /**
1507 * What the UI action is.
1508 */
Fan Zhangf837b8e2018-10-23 12:38:30 -07001509 optional android.app.settings.Action action = 2;
Fan Zhang916c13b2018-10-16 22:49:45 -07001510
1511 /**
1512 * Where the action is happening
1513 */
Fan Zhangff2332b2018-12-06 15:16:41 -08001514 optional android.app.settings.PageId page_id = 3;
Fan Zhang916c13b2018-10-16 22:49:45 -07001515
1516 /**
1517 * What preference changed in this event.
1518 */
Fan Zhangff2332b2018-12-06 15:16:41 -08001519 optional string changed_preference_key = 4;
Fan Zhang916c13b2018-10-16 22:49:45 -07001520
1521 /**
1522 * The new value of the changed preference.
1523 */
Fan Zhangff2332b2018-12-06 15:16:41 -08001524 optional int64 changed_preference_int_value = 5;
Fan Zhang916c13b2018-10-16 22:49:45 -07001525}
1526
1527/**
David Chenc28b2bb2017-10-24 12:52:52 -07001528 * Logs that a setting was updated.
1529 * Logged from:
David Chenbd789912018-03-16 17:19:55 -07001530 * frameworks/base/packages/SettingsProvider/src/com/android/providers/settings/SettingsState.java
David Chenc28b2bb2017-10-24 12:52:52 -07001531 * The tag and is_default allow resetting of settings to default values based on the specified
1532 * tag. See Settings#putString(ContentResolver, String, String, String, boolean) for more details.
1533 */
1534message SettingChanged {
1535 // The name of the setting.
1536 optional string setting = 1;
1537
1538 // The change being imposed on this setting. May represent a number, eg "3".
1539 optional string value = 2;
1540
1541 // The new value of this setting. For most settings, this is same as value. For some settings,
1542 // value is +X or -X where X represents an element in a set. For example, if the previous value
1543 // is A,B,C and value is -B, then new_value is A,C and prev_value is A,B,C.
1544 // The +/- feature is currently only used for location_providers_allowed.
1545 optional string new_value = 3;
1546
1547 // The previous value of this setting.
1548 optional string prev_value = 4;
1549
1550 // The tag used with the is_default for resetting sets of settings. This is generally null.
1551 optional string tag = 5;
1552
Bookatz90867622018-01-31 15:05:57 -08001553 // True if this setting with tag should be resettable.
1554 optional bool is_default = 6;
David Chenc28b2bb2017-10-24 12:52:52 -07001555
David Chenbd789912018-03-16 17:19:55 -07001556 // The associated user (for multi-user feature). Defined in android/os/UserHandle.java
David Chenc28b2bb2017-10-24 12:52:52 -07001557 optional int32 user = 7;
David Chenbd789912018-03-16 17:19:55 -07001558
1559 enum ChangeReason {
1560 UPDATED = 1; // Updated can be an insertion or an update.
1561 DELETED = 2;
1562 }
1563 optional ChangeReason reason = 8;
David Chenc28b2bb2017-10-24 12:52:52 -07001564}
Chenjie Yub3dda412017-10-24 13:41:59 -07001565
Chenjie Yu05013b32017-11-21 10:21:41 -08001566/**
Chenjie Yu3d4f6042017-10-27 15:39:34 -07001567 * Logs activity going to foreground or background
1568 *
1569 * Logged from:
1570 * frameworks/base/services/core/java/com/android/server/am/ActivityRecord.java
1571 */
1572message ActivityForegroundStateChanged {
Yao Chenc40a19d2018-03-15 16:48:25 -07001573 optional int32 uid = 1 [(is_uid) = true];
Yangster-mac20877162017-12-22 17:19:39 -08001574 optional string pkg_name = 2;
1575 optional string class_name = 3;
1576
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001577 enum State {
1578 BACKGROUND = 0;
1579 FOREGROUND = 1;
Chenjie Yu3d4f6042017-10-27 15:39:34 -07001580 }
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001581 optional State state = 4;
Chenjie Yu3d4f6042017-10-27 15:39:34 -07001582}
David Chenc8a43242017-10-17 16:23:28 -07001583
1584/**
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001585 * Logs when an app crashes.
David Chen9e3808c2017-11-20 17:25:34 -08001586 * Logged from:
1587 * frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
1588 */
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001589message AppCrashOccurred {
Yao Chenc40a19d2018-03-15 16:48:25 -07001590 optional int32 uid = 1 [(is_uid) = true];
David Chen9e3808c2017-11-20 17:25:34 -08001591
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001592 optional string event_type = 2;
David Chen9e3808c2017-11-20 17:25:34 -08001593
1594 // The name of the process.
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001595 // system_server if it is not by an app
David Chen9e3808c2017-11-20 17:25:34 -08001596 optional string process_name = 3;
1597
1598 // The pid if available. -1 means not available.
David Chen6e3e6cb2018-01-03 16:14:06 -08001599 optional sint32 pid = 4;
Chenjie Yuf17bf622018-04-02 14:22:19 -07001600
1601 optional string package_name = 5;
1602
1603 enum InstantApp {
1604 UNAVAILABLE = 0;
1605 FALSE = 1;
1606 TRUE = 2;
1607 }
1608 optional InstantApp is_instant_app = 6;
1609
1610 enum ForegroundState {
1611 UNKNOWN = 0;
1612 BACKGROUND = 1;
1613 FOREGROUND = 2;
1614 }
1615 optional ForegroundState foreground_state = 7;
Yang Lu732d6382018-11-05 07:53:12 -08001616
1617 optional android.server.ErrorSource error_source = 8;
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001618}
David Chen9e3808c2017-11-20 17:25:34 -08001619
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001620/**
1621 * Logs when a WTF (What a Terrible Failure) happened.
1622 * Logged from:
1623 * frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
1624 */
1625message WTFOccurred {
1626 optional int32 uid = 1 [(is_uid) = true];
David Chen9e3808c2017-11-20 17:25:34 -08001627
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001628 optional string tag = 2;
David Chen9e3808c2017-11-20 17:25:34 -08001629
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001630 // The name of the process.
1631 // system_server if it is not by an app
1632 optional string process_name = 3;
David Chen6e3e6cb2018-01-03 16:14:06 -08001633
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001634 // The pid if available. -1 means not available.
1635 optional sint32 pid = 4;
Yang Lu732d6382018-11-05 07:53:12 -08001636
1637 optional android.server.ErrorSource error_source = 5;
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001638}
1639
1640/**
1641 * Logs when system server reports low memory.
1642 * Logged from:
1643 * frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
1644 */
1645message LowMemReported {
1646}
1647
1648/**
1649 * Logs when an app ANR (App Not Responding) occurs.
1650 * Logged from:
1651 * frameworks/base/services/core/java/com/android/server/am/AppErrors.java
1652 */
1653message ANROccurred {
1654 optional int32 uid = 1 [(is_uid) = true];
1655
1656 optional string process_name = 2;
1657
1658 optional string short_component_name = 3;
1659
1660 optional string reason = 4;
Chenjie Yuf17bf622018-04-02 14:22:19 -07001661
1662 enum InstantApp {
1663 UNAVAILABLE = 0;
1664 FALSE = 1;
1665 TRUE = 2;
1666 }
1667 optional InstantApp is_instant_app = 5;
1668
1669 enum ForegroundState {
1670 UNKNOWN = 0;
1671 BACKGROUND = 1;
1672 FOREGROUND = 2;
1673 }
1674 optional ForegroundState foreground_state = 6;
Yang Lu732d6382018-11-05 07:53:12 -08001675
1676 optional android.server.ErrorSource error_source = 7;
1677
1678 optional string package_name = 8;
David Chen9e3808c2017-11-20 17:25:34 -08001679}
1680
Bookatza7020bd2018-08-28 16:29:35 -07001681/**
1682 * Logs when the vibrator state changes.
1683 * Logged from:
1684 * frameworks/base/services/core/java/com/android/server/VibratorService.java
1685 */
1686message VibratorStateChanged {
1687 repeated AttributionNode attribution_node = 1;
1688
1689 enum State {
1690 OFF = 0;
1691 ON = 1;
1692 }
1693 optional State state = 2;
1694
1695 // Duration (in milliseconds) requested to keep the vibrator on.
1696 // Only applicable for State == ON.
1697 optional int64 duration_millis = 3;
1698}
1699
David Chen0a368b22017-12-06 16:28:16 -08001700/*
1701 * Allows other apps to push events into statsd.
1702 * Logged from:
1703 * frameworks/base/core/java/android/util/StatsLog.java
1704 */
David Chen0b5c90c2018-01-25 16:51:49 -08001705message AppBreadcrumbReported {
David Chen0a368b22017-12-06 16:28:16 -08001706 // The uid of the application that sent this custom atom.
Yao Chenc40a19d2018-03-15 16:48:25 -07001707 optional int32 uid = 1 [(is_uid) = true];
David Chen0a368b22017-12-06 16:28:16 -08001708
1709 // An arbitrary label chosen by the developer. For Android P, the label should be in [0, 16).
1710 optional int32 label = 2;
1711
1712 // Allows applications to easily use a custom event as start/stop boundaries (ie, define custom
1713 // predicates for the metrics).
1714 enum State {
1715 UNKNOWN = 0;
1716 UNSPECIFIED = 1; // For events that are known to not represent START/STOP.
1717 STOP = 2;
1718 START = 3;
1719 }
1720 optional State state = 3;
1721}
1722
David Chen9e3808c2017-11-20 17:25:34 -08001723/**
Bookatz7948c872018-09-04 12:58:33 -07001724 * Logs the wall-clock time when a significant wall-clock time shift occurs.
1725 * For example, this could be due to the user manually changing the time.
1726 *
1727 * Logged from:
1728 * frameworks/base/services/core/java/com/android/server/AlarmManagerService.java
1729 */
1730message WallClockTimeShifted {
1731 // New wall-clock time in milliseconds, according to System.currentTimeMillis().
1732 optional int64 wall_clock_timestamp_millis = 1;
1733}
1734
1735/**
Bookatz8fcd09a2017-12-18 13:01:10 -08001736 * Logs when statsd detects an anomaly.
1737 *
1738 * Logged from:
1739 * frameworks/base/cmds/statsd/src/anomaly/AnomalyTracker.cpp
1740 */
1741message AnomalyDetected {
1742 // Uid that owns the config whose anomaly detection alert fired.
Yao Chenc40a19d2018-03-15 16:48:25 -07001743 optional int32 config_uid = 1 [(is_uid) = true];
Bookatz8fcd09a2017-12-18 13:01:10 -08001744
Yangster-mac94e197c2018-01-02 16:03:03 -08001745 // Id of the config whose anomaly detection alert fired.
1746 optional int64 config_id = 2;
Bookatz8fcd09a2017-12-18 13:01:10 -08001747
Yangster-mac94e197c2018-01-02 16:03:03 -08001748 // Id of the alert (i.e. name of the anomaly that was detected).
1749 optional int64 alert_id = 3;
Bookatz8fcd09a2017-12-18 13:01:10 -08001750}
1751
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001752message AppStartOccurred {
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001753 // The uid if available. -1 means not available.
Yao Chenc40a19d2018-03-15 16:48:25 -07001754 optional int32 uid = 1 [(is_uid) = true];
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001755
1756 // The app package name.
1757 optional string pkg_name = 2;
1758
1759 enum TransitionType {
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001760 UNKNOWN = 0;
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001761 WARM = 1;
1762 HOT = 2;
1763 COLD = 3;
1764 }
1765 // The transition type.
1766 optional TransitionType type = 3;
1767
1768 // The activity name.
1769 optional string activity_name = 4;
1770
1771 // The name of the calling app. Empty if not set.
1772 optional string calling_pkg_name = 5;
1773
1774 // Whether the app is an instant app.
1775 optional bool is_instant_app = 6;
1776
1777 // Device uptime when activity started.
David Chen0b5c90c2018-01-25 16:51:49 -08001778 optional int64 activity_start_millis = 7;
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001779
Bookatz80d11a02018-01-16 10:46:35 -08001780 optional android.app.AppTransitionReasonEnum reason = 8;
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001781
David Chen0b5c90c2018-01-25 16:51:49 -08001782 optional int32 transition_delay_millis = 9;
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001783 // -1 if not set.
David Chen0b5c90c2018-01-25 16:51:49 -08001784 optional int32 starting_window_delay_millis = 10;
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001785 // -1 if not set.
David Chen0b5c90c2018-01-25 16:51:49 -08001786 optional int32 bind_application_delay_millis = 11;
1787 optional int32 windows_drawn_delay_millis = 12;
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001788
1789 // Empty if not set.
1790 optional string launch_token = 13;
1791
Calin Juravle759fbda2018-02-20 19:52:30 +00001792 // The compiler filter used when when the package was optimized.
Calin Juravlea86783b2018-03-21 14:25:59 -07001793 optional int32 package_optimization_compilation_filter = 14;
Calin Juravle759fbda2018-02-20 19:52:30 +00001794
1795 // The reason why the package was optimized.
Calin Juravlea86783b2018-03-21 14:25:59 -07001796 optional int32 package_optimization_compilation_reason = 15;
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001797}
1798
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001799message AppStartCanceled {
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001800 // The uid if available. -1 means not available.
Yao Chenc40a19d2018-03-15 16:48:25 -07001801 optional int32 uid = 1 [(is_uid) = true];
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001802
1803 // The app package name.
1804 optional string pkg_name = 2;
1805
1806 enum TransitionType {
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001807 UNKNOWN = 0;
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001808 WARM = 1;
1809 HOT = 2;
1810 COLD = 3;
1811 }
1812 // The transition type.
1813 optional TransitionType type = 3;
1814
1815 // The activity name.
1816 optional string activity_name = 4;
1817}
1818
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001819message AppStartFullyDrawn {
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001820 // The uid if available. -1 means not available.
Yao Chenc40a19d2018-03-15 16:48:25 -07001821 optional int32 uid = 1 [(is_uid) = true];
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001822
1823 // The app package name.
1824 optional string pkg_name = 2;
1825
1826 enum TransitionType {
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001827 UNKNOWN = 0;
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001828 WITH_BUNDLE = 1;
1829 WITHOUT_BUNDLE = 2;
1830 }
1831 // The transition type.
1832 optional TransitionType type = 3;
1833
1834 // The activity name.
1835 optional string activity_name = 4;
1836
1837 optional bool transition_process_running = 5;
1838
1839 // App startup time (until call to Activity#reportFullyDrawn()).
David Chen0b5c90c2018-01-25 16:51:49 -08001840 optional int64 app_startup_time_millis = 6;
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001841}
1842
Bookatz8fcd09a2017-12-18 13:01:10 -08001843/**
Chenjie Yu52cacc62017-12-08 18:11:45 -08001844 * Logs a picture-in-picture action
1845 * Logged from:
1846 * frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
1847 * frameworks/base/services/core/java/com/android/server/am/ActivityStackSupervisor.java
1848 * frameworks/base/packages/SystemUI/src/com/android/systemui/pip/phone/PipTouchHandler.java
1849 */
1850message PictureInPictureStateChanged {
Chenjie Yuae9fdf042018-02-15 10:19:32 -08001851 // -1 if it is not available
Yao Chenc40a19d2018-03-15 16:48:25 -07001852 optional int32 uid = 1 [(is_uid) = true];
Chenjie Yu52cacc62017-12-08 18:11:45 -08001853
Chenjie Yuae9fdf042018-02-15 10:19:32 -08001854 optional string short_name = 2;
Chenjie Yu52cacc62017-12-08 18:11:45 -08001855
Chenjie Yu52cacc62017-12-08 18:11:45 -08001856 enum State {
1857 ENTERED = 1;
1858 EXPANDED_TO_FULL_SCREEN = 2;
1859 MINIMIZED = 3;
1860 DISMISSED = 4;
1861 }
Chenjie Yuae9fdf042018-02-15 10:19:32 -08001862 optional State state = 3;
Chenjie Yu52cacc62017-12-08 18:11:45 -08001863}
1864
1865/**
Chenjie Yue8904192017-12-08 19:12:57 -08001866 * Logs overlay action
1867 * Logged from:
1868 * services/core/java/com/android/server/wm/Session.java
1869 */
1870message OverlayStateChanged {
Yao Chenc40a19d2018-03-15 16:48:25 -07001871 optional int32 uid = 1 [(is_uid) = true];
Chenjie Yue8904192017-12-08 19:12:57 -08001872
1873 optional string package_name = 2;
1874
1875 optional bool using_alert_window = 3;
1876
1877 enum State {
1878 ENTERED = 1;
1879 EXITED = 2;
1880 }
1881 optional State state = 4;
1882}
1883
Chenjie Yuccfe6452018-01-30 11:33:21 -08001884/*
1885 * Logs foreground service starts and stops.
1886 * Note that this is not when a service starts or stops, but when it is
1887 * considered foreground.
1888 * Logged from
1889 * //frameworks/base/services/core/java/com/android/server/am/ActiveServices.java
1890 */
1891message ForegroundServiceStateChanged {
Yao Chenc40a19d2018-03-15 16:48:25 -07001892 optional int32 uid = 1 [(is_uid) = true];
Chenjie Yuccfe6452018-01-30 11:33:21 -08001893 // package_name + "/" + class_name
1894 optional string short_name = 2;
1895
1896 enum State {
1897 ENTER = 1;
1898 EXIT = 2;
1899 }
1900 optional State state = 3;
1901}
1902
Chenjie Yue8904192017-12-08 19:12:57 -08001903/**
Chenjie Yubbcbc602018-02-05 16:51:52 -08001904 * Logs creation or removal of an isolated uid. Isolated uid's are temporary uid's to sandbox risky
1905 * behavior in its own uid. However, the metrics of these isolated uid's almost always should be
1906 * attributed back to the parent (host) uid. One example is Chrome.
1907 *
1908 * Logged from:
1909 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
1910 */
1911message IsolatedUidChanged {
1912 // The host UID. Generally, we should attribute metrics from the isolated uid to the host uid.
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001913 // NOTE: DO NOT annotate uid field in this atom. This atom is specially handled in statsd.
Bookatz3c648862018-05-25 13:32:43 -07001914 // This field is ignored when event == REMOVED.
Chenjie Yubbcbc602018-02-05 16:51:52 -08001915 optional int32 parent_uid = 1;
1916
1917 optional int32 isolated_uid = 2;
1918
1919 // We expect an isolated uid to be removed before if it's used for another parent uid.
1920 enum Event {
1921 REMOVED = 0;
1922 CREATED = 1;
1923 }
1924 optional Event event = 3;
1925}
1926
1927/*
1928 * Logs the reception of an incoming network packet causing the main system to wake up for
1929 * processing that packet. These events are notified by the kernel via Netlink NFLOG to Netd
1930 * and processed by WakeupController.cpp.
1931 */
1932message PacketWakeupOccurred {
1933 // The uid owning the socket into which the packet was delivered, or -1 if the packet was
1934 // delivered nowhere.
Yao Chenc40a19d2018-03-15 16:48:25 -07001935 optional int32 uid = 1 [(is_uid) = true];
Chenjie Yubbcbc602018-02-05 16:51:52 -08001936 // The interface name on which the packet was received.
1937 optional string iface = 2;
1938 // The ethertype value of the packet.
1939 optional int32 ethertype = 3;
1940 // String representation of the destination MAC address of the packet.
1941 optional string destination_hardware_address = 4;
1942 // String representation of the source address of the packet if this was an IP packet.
1943 optional string source_ip = 5;
1944 // String representation of the destination address of the packet if this was an IP packet.
1945 optional string destination_ip = 6;
1946 // The value of the protocol field if this was an IPv4 packet or the value of the Next Header
1947 // field if this was an IPv6 packet. The range of possible values is the same for both IP
1948 // families.
1949 optional int32 ip_next_header = 7;
1950 // The source port if this was a TCP or UDP packet.
1951 optional int32 source_port = 8;
1952 // The destination port if this was a TCP or UDP packet.
1953 optional int32 destination_port = 9;
1954}
1955
1956/*
1957 * Logs the memory stats for an app on startup.
1958 * Logged from:
1959 * frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
1960 */
1961message AppStartMemoryStateCaptured {
1962 // The uid if available. -1 means not available.
Yao Chenc40a19d2018-03-15 16:48:25 -07001963 optional int32 uid = 1 [(is_uid) = true];
Chenjie Yubbcbc602018-02-05 16:51:52 -08001964
1965 // The process name.
1966 optional string process_name = 2;
1967
1968 // The activity name.
1969 optional string activity_name = 3;
1970
1971 // # of page-faults
Yangster-maca8a30442018-10-13 23:46:34 -07001972 optional int64 page_fault = 4;
Chenjie Yubbcbc602018-02-05 16:51:52 -08001973
1974 // # of major page-faults
Yangster-maca8a30442018-10-13 23:46:34 -07001975 optional int64 page_major_fault = 5;
Chenjie Yubbcbc602018-02-05 16:51:52 -08001976
1977 // RSS
1978 optional int64 rss_in_bytes = 6;
1979
1980 // CACHE
1981 optional int64 cache_in_bytes = 7;
1982
1983 // SWAP
1984 optional int64 swap_in_bytes = 8;
1985}
1986
1987/*
1988 * Logs the change in Low Memory Killer Daemon (LMKD) state which is used as start/stop boundaries
1989 * for LMK event.
1990 * Logged from:
1991 * system/core/lmkd/lmkd.c
1992 */
1993message LmkStateChanged {
1994 enum State {
1995 UNKNOWN = 0;
1996 START = 1;
1997 STOP = 2;
1998 }
1999 optional State state = 1;
2000}
2001
2002/*
2003 * Logs the event when Low Memory Killer Daemon (LMKD) kills a process to reduce memory pressure.
2004 * Logged from:
2005 * system/core/lmkd/lmkd.c
2006 */
2007message LmkKillOccurred {
2008 // The uid if available. -1 means not available.
Yao Chenc40a19d2018-03-15 16:48:25 -07002009 optional int32 uid = 1 [(is_uid) = true];
Chenjie Yubbcbc602018-02-05 16:51:52 -08002010
2011 // The process name.
2012 optional string process_name = 2;
2013
2014 // oom adj score.
Yangster-maca8a30442018-10-13 23:46:34 -07002015 optional int32 oom_adj_score = 3;
Chenjie Yubbcbc602018-02-05 16:51:52 -08002016
2017 // # of page-faults
Yangster-maca8a30442018-10-13 23:46:34 -07002018 optional int64 page_fault = 4;
Chenjie Yubbcbc602018-02-05 16:51:52 -08002019
2020 // # of major page-faults
Yangster-maca8a30442018-10-13 23:46:34 -07002021 optional int64 page_major_fault = 5;
Chenjie Yubbcbc602018-02-05 16:51:52 -08002022
2023 // RSS
2024 optional int64 rss_in_bytes = 6;
2025
2026 // CACHE
2027 optional int64 cache_in_bytes = 7;
2028
2029 // SWAP
2030 optional int64 swap_in_bytes = 8;
Jim Blackler8593d1f2018-11-21 15:24:48 +00002031
2032 // The elapsed real time of start of the process.
2033 optional int64 process_start_time_nanos = 9;
Chenjie Yubbcbc602018-02-05 16:51:52 -08002034}
2035
Rajeev Kumar51b54602018-03-01 12:18:26 -08002036/*
2037 * Logs when the ActivityManagerService detects that an app died.
2038 *
2039 * Logged from:
2040 * frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
2041 */
2042message AppDied {
2043 // timestamp(elapsedRealtime) of record creation
Yangster-macb6b77c62018-10-12 19:33:24 -07002044 optional uint64 timestamp_millis = 1 [(state_field_option).option = EXCLUSIVE];
Rajeev Kumar51b54602018-03-01 12:18:26 -08002045}
2046
Howard Ro21a039c2018-08-06 14:55:47 -07002047/**
2048 * An atom for generic metrics logging. Available from Android Q.
2049 */
2050message GenericAtom {
2051 // The uid of the application that sent this custom atom.
2052 optional int32 uid = 1 [(is_uid) = true];
2053
2054 // An event_id indicates the type of event.
Howard Ro9a862de2018-10-11 16:03:33 -07002055 optional android.stats.EventType event_id = 2;
Howard Ro21a039c2018-08-06 14:55:47 -07002056}
2057
Tej Singhd6d6d772018-09-05 17:41:25 -07002058/**
2059 * Logs when a fingerprint acquire event occurs.
2060 *
2061 * Logged from:
2062 * frameworks/base/services/core/java/com/android/server/biometrics/fingerprint/FingerprintService.java
2063 */
2064message FingerprintAcquired {
2065 // The associated user. Eg: 0 for owners, 10+ for others.
2066 // Defined in android/os/UserHandle.java
2067 optional int32 user = 1;
2068 // If this acquire is for a crypto fingerprint.
2069 // e.g. Secure purchases, unlock password storage.
2070 optional bool is_crypto = 2;
2071}
2072
2073/**
2074 * Logs when a fingerprint authentication event occurs.
2075 *
2076 * Logged from:
2077 * frameworks/base/services/core/java/com/android/server/biometrics/fingerprint/FingerprintService.java
2078 */
2079message FingerprintAuthenticated {
2080 // The associated user. Eg: 0 for owners, 10+ for others.
2081 // Defined in android/os/UserHandle.java
2082 optional int32 user = 1;
2083 // If this authentication is for a crypto fingerprint.
2084 // e.g. Secure purchases, unlock password storage.
2085 optional bool is_crypto = 2;
2086 // Whether or not this authentication was successful.
2087 optional bool is_authenticated = 3;
2088}
2089
2090/**
2091 * Logs when a fingerprint error occurs.
2092 *
2093 * Logged from:
2094 * frameworks/base/services/core/java/com/android/server/biometrics/fingerprint/FingerprintService.java
2095 */
2096message FingerprintErrorOccurred {
2097 // The associated user. Eg: 0 for owners, 10+ for others.
2098 // Defined in android/os/UserHandle.java
2099 optional int32 user = 1;
2100 // If this error is for a crypto fingerprint.
2101 // e.g. Secure purchases, unlock password storage.
2102 optional bool is_crypto = 2;
2103
2104 enum Error {
2105 UNKNOWN = 0;
2106 LOCKOUT = 1;
2107 PERMANENT_LOCKOUT = 2;
2108 }
2109 // The type of error.
2110 optional Error error = 3;
2111}
Howard Ro688ae182018-09-25 00:09:36 -07002112
2113message Notification {
2114
2115 // Type of notification event.
2116 enum Type {
2117 TYPE_UNKNOWN = 0;
2118 // Notification became visible to the user.
2119 TYPE_OPEN = 1;
2120 // Notification became hidden.
2121 TYPE_CLOSE = 2;
2122 // Notification switched to detail mode.
2123 TYPE_DETAIL = 3;
2124 // Notification was clicked.
2125 TYPE_ACTION = 4;
2126 // Notification was dismissed.
2127 TYPE_DISMISS = 5;
2128 // Notification switched to summary mode. The enum value of 14 is to
2129 // match that of metrics_constants.
2130 TYPE_COLLAPSE = 14;
2131 }
2132 optional Type type = 1;
2133
2134 // Package name associated with the notification.
2135 optional string package_name = 2;
2136
2137 // Tag associated with notification.
2138 optional string tag = 3;
2139
2140 // Application-supplied ID associated with the notification.
2141 optional int32 id = 4;
2142
2143 // Index of notification in the notification panel.
2144 optional int32 shade_index = 5;
2145
2146 // The number of notifications in the notification panel.
2147 optional int32 shade_count = 6;
2148
2149 // Importance for the notification.
2150 optional int32 importance = 7;
2151
2152 // ID for the notification channel.
Howard Ro183c2bd2018-10-18 13:52:10 -07002153 optional string channel_id = 8;
Howard Ro688ae182018-09-25 00:09:36 -07002154
2155 // Importance for the notification channel.
2156 optional int32 channel_importance = 9;
2157
Howard Ro183c2bd2018-10-18 13:52:10 -07002158 // Application-supplied ID associated with the notifications group.
2159 optional string group_id = 10;
2160
Howard Ro688ae182018-09-25 00:09:36 -07002161 // Whether notification was a group summary.
Howard Ro183c2bd2018-10-18 13:52:10 -07002162 optional bool group_summary = 11;
Howard Ro688ae182018-09-25 00:09:36 -07002163
Howard Ro183c2bd2018-10-18 13:52:10 -07002164 // Reason for dismissal of a notification. This field is only meaningful for
2165 // TYPE_DISMISS events.
2166 optional int32 dismiss_reason = 12;
Howard Ro688ae182018-09-25 00:09:36 -07002167
Howard Ro183c2bd2018-10-18 13:52:10 -07002168 // The first post time of notification, stable across updates.
2169 optional int64 creation_millis = 13;
Howard Ro688ae182018-09-25 00:09:36 -07002170
Howard Ro183c2bd2018-10-18 13:52:10 -07002171 // The most recent interruption time, or the creation time if no updates.
2172 // Differs from update_millis because updates are filtered based on whether
2173 // they actually interrupted the user.
2174 optional int64 interruption_millis = 14;
Howard Ro688ae182018-09-25 00:09:36 -07002175
Howard Ro183c2bd2018-10-18 13:52:10 -07002176 // The most recent update time, or the creation time if no updates.
2177 optional int64 update_millis = 15;
2178
2179 // The most recent visibility event.
2180 optional int64 visible_millis = 16;
Howard Ro688ae182018-09-25 00:09:36 -07002181}
2182
Chenjie Yuae9dfac2018-10-25 16:06:56 -07002183/*
Yangster-macb89807e2018-11-15 21:10:57 -08002184 * Logs when a flag flip state changes.
2185 * Logged in P/h.
2186 */
2187message PhenotypeFlagStateChanged {
2188 // Mendel configuration name.
2189 optional string mendel_config_name = 1;
2190 // State
2191 enum State {
2192 STATE_UNKNOWN = 0;
2193 COMMITTED = 1;
2194 }
2195 optional State state = 2;
2196}
2197
2198/*
2199 * Logs when a binary push state changes.
2200 * Logged in Play store
2201 */
2202message BinaryPushStateChanged {
2203 // Binary package name.
2204 optional string binary_name = 1;
2205 // Version code.
2206 optional int64 version = 2;
2207 // State
2208 enum State {
2209 STATE_UNKNOWN = 0;
2210 DOWNLOAD_START = 1;
2211 DOWNLOAD_DONE = 2;
2212 INSTALL_START = 3;
2213 INSTALL_DONE = 4;
2214 REBOOT_START = 5;
2215 REBOOT_DONE = 6;
2216 }
2217 optional State state = 3;
2218}
2219
2220/*
Chenjie Yuae9dfac2018-10-25 16:06:56 -07002221 * Logs when a connection becomes available and lost.
2222 * Logged in StatsCompanionService.java
2223 */
2224message ConnectivityStateChanged {
Chenjie Yu75b3c492018-10-06 21:45:19 -07002225 // Id of the network.
2226 optional int32 net_id = 1;
2227
2228 enum State {
2229 UNKNOWN = 0;
2230 CONNECTED = 1;
2231 DISCONNECTED = 2;
2232 }
2233 // Connected state of a network.
2234 optional State state = 2;
2235}
2236
2237/**
2238 * Logs when a service starts and stops.
2239 * Logged from:
2240 * services/core/java/com/android/server/am/ActiveServices.java
2241 */
2242message ServiceStateChanged {
2243
2244 optional int32 uid = 1 [(is_uid) = true];
2245
2246 optional string package_name = 2;
2247
2248 optional string service_name = 3;
Chenjie Yuae9dfac2018-10-25 16:06:56 -07002249
2250 enum State {
Chenjie Yu75b3c492018-10-06 21:45:19 -07002251 START = 1;
2252 STOP = 2;
Chenjie Yuae9dfac2018-10-25 16:06:56 -07002253 }
Chenjie Yu75b3c492018-10-06 21:45:19 -07002254
2255 optional State state = 4;
2256}
2257
2258/**
2259 * Logs when a service is launched.
2260 * Logged from:
2261 * services/core/java/com/android/server/am/ActiveServices.java
2262 */
2263message ServiceLaunchReported {
2264
2265 optional int32 uid = 1 [(is_uid) = true];
2266
2267 optional string package_name = 2;
2268
2269 optional string service_name = 3;
Chenjie Yuae9dfac2018-10-25 16:06:56 -07002270}
Howard Ro688ae182018-09-25 00:09:36 -07002271
Chenjie Yubbcbc602018-02-05 16:51:52 -08002272//////////////////////////////////////////////////////////////////////
2273// Pulled atoms below this line //
2274//////////////////////////////////////////////////////////////////////
2275
2276/**
David Chenc8a43242017-10-17 16:23:28 -07002277 * Pulls bytes transferred via wifi (Sum of foreground and background usage).
2278 *
2279 * Pulled from:
2280 * StatsCompanionService (using BatteryStats to get which interfaces are wifi)
2281 */
Chenjie Yu31d14d72017-12-12 17:54:33 -08002282message WifiBytesTransfer {
Yao Chenc40a19d2018-03-15 16:48:25 -07002283 optional int32 uid = 1 [(is_uid) = true];
David Chenc8a43242017-10-17 16:23:28 -07002284
2285 optional int64 rx_bytes = 2;
2286
2287 optional int64 rx_packets = 3;
2288
2289 optional int64 tx_bytes = 4;
2290
2291 optional int64 tx_packets = 5;
2292}
2293
2294/**
2295 * Pulls bytes transferred via wifi (separated by foreground and background usage).
2296 *
2297 * Pulled from:
2298 * StatsCompanionService (using BatteryStats to get which interfaces are wifi)
2299 */
Chenjie Yu31d14d72017-12-12 17:54:33 -08002300message WifiBytesTransferByFgBg {
Yao Chenc40a19d2018-03-15 16:48:25 -07002301 optional int32 uid = 1 [(is_uid) = true];
David Chenc8a43242017-10-17 16:23:28 -07002302
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08002303 // 1 denotes foreground and 0 denotes background. This is called Set in NetworkStats.
2304 optional bool is_foreground = 2;
David Chenc8a43242017-10-17 16:23:28 -07002305
2306 optional int64 rx_bytes = 3;
2307
2308 optional int64 rx_packets = 4;
2309
2310 optional int64 tx_bytes = 5;
2311
2312 optional int64 tx_packets = 6;
2313}
2314
2315/**
2316 * Pulls bytes transferred via mobile networks (Sum of foreground and background usage).
2317 *
2318 * Pulled from:
2319 * StatsCompanionService (using BatteryStats to get which interfaces are mobile data)
2320 */
Chenjie Yu31d14d72017-12-12 17:54:33 -08002321message MobileBytesTransfer {
Yao Chenc40a19d2018-03-15 16:48:25 -07002322 optional int32 uid = 1 [(is_uid) = true];
David Chenc8a43242017-10-17 16:23:28 -07002323
2324 optional int64 rx_bytes = 2;
2325
2326 optional int64 rx_packets = 3;
2327
2328 optional int64 tx_bytes = 4;
2329
2330 optional int64 tx_packets = 5;
2331}
2332
2333/**
2334 * Pulls bytes transferred via mobile networks (separated by foreground and background usage).
2335 *
2336 * Pulled from:
2337 * StatsCompanionService (using BatteryStats to get which interfaces are mobile data)
2338 */
Chenjie Yu31d14d72017-12-12 17:54:33 -08002339message MobileBytesTransferByFgBg {
Yao Chenc40a19d2018-03-15 16:48:25 -07002340 optional int32 uid = 1 [(is_uid) = true];
David Chenc8a43242017-10-17 16:23:28 -07002341
Yao Chenc40a19d2018-03-15 16:48:25 -07002342 // 1 denotes foreground and 0 denotes background. This is called Set in
2343 // NetworkStats.
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08002344 optional bool is_foreground = 2;
David Chenc8a43242017-10-17 16:23:28 -07002345
2346 optional int64 rx_bytes = 3;
2347
2348 optional int64 rx_packets = 4;
2349
2350 optional int64 tx_bytes = 5;
2351
2352 optional int64 tx_packets = 6;
2353}
2354
2355/**
Chenjie Yu9d7720b2018-01-24 10:34:48 -08002356 * Pulls bytes transferred via bluetooth. It is pulled from Bluetooth controller.
2357 *
2358 * Pulled from:
2359 * StatsCompanionService
2360 */
2361message BluetoothBytesTransfer {
Yao Chenc40a19d2018-03-15 16:48:25 -07002362 optional int32 uid = 1 [(is_uid) = true];
Chenjie Yu9d7720b2018-01-24 10:34:48 -08002363
2364 optional int64 rx_bytes = 2;
2365
2366 optional int64 tx_bytes = 3;
2367}
2368
2369/**
David Chenc8a43242017-10-17 16:23:28 -07002370 * Pulls the kernel wakelock durations. This atom is adapted from
2371 * android/internal/os/KernelWakelockStats.java
2372 *
2373 * Pulled from:
2374 * StatsCompanionService using KernelWakelockReader.
2375 */
Chenjie Yu31d14d72017-12-12 17:54:33 -08002376message KernelWakelock {
David Chenc8a43242017-10-17 16:23:28 -07002377 optional string name = 1;
2378
2379 optional int32 count = 2;
2380
2381 optional int32 version = 3;
2382
Yangster-maca8a30442018-10-13 23:46:34 -07002383 optional int64 time_micros = 4;
David Chenc8a43242017-10-17 16:23:28 -07002384}
Chenjie Yu5305e1d2017-10-31 13:49:36 -07002385
Chenjie Yu05013b32017-11-21 10:21:41 -08002386/**
Benjamin Schwartz51329b72018-12-06 10:48:03 -08002387 * Pulls low power state information. If power.stats HAL is not available, this
2388 * includes platform and subsystem sleep state information,
2389 * PowerStatePlatformSleepState, PowerStateVoter or PowerStateSubsystemSleepState
2390 * as defined in:
Chenjie Yu5305e1d2017-10-31 13:49:36 -07002391 * hardware/interfaces/power/1.0/types.hal
Chenjie Yu5305e1d2017-10-31 13:49:36 -07002392 * hardware/interfaces/power/1.1/types.hal
Benjamin Schwartz51329b72018-12-06 10:48:03 -08002393 * If power.stats HAL is available, this includes PowerEntityStateResidencyResult
2394 * as defined in:
2395 * hardware/interfaces/power/stats/1.0/types.hal
Chenjie Yu5305e1d2017-10-31 13:49:36 -07002396 */
Chenjie Yu31d14d72017-12-12 17:54:33 -08002397message SubsystemSleepState {
Chenjie Yubbcbc602018-02-05 16:51:52 -08002398 // Subsystem name
2399 optional string subsystem_name = 1;
2400 // For PlatformLowPowerStats (hal 1.0), this is the voter name, which could be empty.
2401 // For SubsystemLowPowerStats (hal 1.1), this is the sleep state name.
Benjamin Schwartz51329b72018-12-06 10:48:03 -08002402 // For PowerEntityStateResidencyResult (hal power/stats/1.0) this is the
2403 // powerEntityStateName from the corresponding PowerEntityStateInfo.
Chenjie Yubbcbc602018-02-05 16:51:52 -08002404 optional string subname = 2;
Chenjie Yuc8b7f222018-01-11 23:25:57 -08002405 // The number of times it entered, or voted for entering the sleep state
Chenjie Yubbcbc602018-02-05 16:51:52 -08002406 optional uint64 count = 3;
Chenjie Yuc8b7f222018-01-11 23:25:57 -08002407 // The length of time spent in, or spent voting for, the sleep state
David Chen0b5c90c2018-01-25 16:51:49 -08002408 optional uint64 time_millis = 4;
David Chen21582962017-11-01 17:32:46 -07002409}
Chenjie Yu7f8def92017-11-03 09:33:15 -07002410
Chenjie Yu05013b32017-11-21 10:21:41 -08002411/**
Bookatz92da2832018-11-01 18:10:03 -07002412 * Pulls on-device power measurement information.
2413 * Data defined by hardware/interfaces/power/stats/1.0/types.hal.
2414 * Pulled from:
2415 * frameworks/base/cmds/statsd/src/external/PowerStatsPuller.cpp
2416 */
2417message OnDevicePowerMeasurement {
2418 // Name of the subsystem (to which the rail belongs).
2419 optional string subsystem_name = 1;
2420
2421 // Rail name. The rail lies within the subsystem.
2422 optional string rail_name = 2;
2423
2424 // Time (in ms since boot) at which the rail energy value was measured.
2425 // This may differ slightly from the time that statsd logs this information.
2426 optional uint64 measurement_timestamp_millis = 3;
2427
2428 // Accumulated energy used via the rail since device boot in uWs.
2429 optional uint64 energy_microwatt_secs = 4;
2430}
2431
2432/**
Chenjie Yu7f8def92017-11-03 09:33:15 -07002433 * Pulls Cpu time per frequency.
Chenjie Yu1ee9b742018-01-10 16:02:57 -08002434 * Pulls the time the cpu spend on the frequency index. Frequency index
2435 * starts from highest to lowest. The value should be monotonically
2436 * increasing since boot. However, if there is a cpu
2437 * hotplug event, the value would be reset as well.
Chenjie Yu7f8def92017-11-03 09:33:15 -07002438 */
Chenjie Yu31d14d72017-12-12 17:54:33 -08002439message CpuTimePerFreq {
Chenjie Yu7f8def92017-11-03 09:33:15 -07002440 optional uint32 cluster = 1;
2441 optional uint32 freq_index = 2;
David Chen0b5c90c2018-01-25 16:51:49 -08002442 optional uint64 time_millis = 3;
Chenjie Yu7f8def92017-11-03 09:33:15 -07002443}
Chenjie Yue33bc3b2017-11-06 17:56:44 -08002444
Chenjie Yu05013b32017-11-21 10:21:41 -08002445/**
Chenjie Yue33bc3b2017-11-06 17:56:44 -08002446 * Pulls Cpu Time Per Uid.
2447 * Note that isolated process uid time should be attributed to host uids.
2448 */
Chenjie Yu31d14d72017-12-12 17:54:33 -08002449message CpuTimePerUid {
Yao Chenc40a19d2018-03-15 16:48:25 -07002450 optional int32 uid = 1 [(is_uid) = true];
Misha Wagner6bc6c912018-11-16 13:19:54 +00002451 optional uint64 user_time_micros = 2;
2452 optional uint64 sys_time_micros = 3;
Chenjie Yue33bc3b2017-11-06 17:56:44 -08002453}
2454
2455/**
2456 * Pulls Cpu Time Per Uid per frequency.
2457 * Note that isolated process uid time should be attributed to host uids.
2458 * For each uid, we order the time by descending frequencies.
2459 */
Chenjie Yu31d14d72017-12-12 17:54:33 -08002460message CpuTimePerUidFreq {
Yao Chenc40a19d2018-03-15 16:48:25 -07002461 optional int32 uid = 1 [(is_uid) = true];
Chenjie Yuec676612018-03-07 09:19:17 -08002462 optional uint32 freq_index = 2;
David Chen0b5c90c2018-01-25 16:51:49 -08002463 optional uint64 time_millis = 3;
Chenjie Yue33bc3b2017-11-06 17:56:44 -08002464}
Hugo Benichi884970e2017-11-14 22:42:46 +09002465
Chenjie Yu05013b32017-11-21 10:21:41 -08002466/**
2467 * Pulls Wifi Controller Activity Energy Info
2468 */
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08002469message WifiActivityInfo {
Chenjie Yu05013b32017-11-21 10:21:41 -08002470 // timestamp(wall clock) of record creation
David Chen0b5c90c2018-01-25 16:51:49 -08002471 optional uint64 timestamp_millis = 1;
Chenjie Yu05013b32017-11-21 10:21:41 -08002472 // stack reported state
2473 // TODO: replace this with proto enum
2474 optional int32 stack_state = 2;
Yangster-maca8a30442018-10-13 23:46:34 -07002475 // tx time in millis
David Chen0b5c90c2018-01-25 16:51:49 -08002476 optional uint64 controller_tx_time_millis = 3;
Yangster-maca8a30442018-10-13 23:46:34 -07002477 // rx time in millis
David Chen0b5c90c2018-01-25 16:51:49 -08002478 optional uint64 controller_rx_time_millis = 4;
Yangster-maca8a30442018-10-13 23:46:34 -07002479 // idle time in millis
David Chen0b5c90c2018-01-25 16:51:49 -08002480 optional uint64 controller_idle_time_millis = 5;
Chenjie Yu05013b32017-11-21 10:21:41 -08002481 // product of current(mA), voltage(V) and time(ms)
2482 optional uint64 controller_energy_used = 6;
2483}
2484
2485/**
2486 * Pulls Modem Activity Energy Info
2487 */
Chenjie Yu31d14d72017-12-12 17:54:33 -08002488message ModemActivityInfo {
Chenjie Yu05013b32017-11-21 10:21:41 -08002489 // timestamp(wall clock) of record creation
David Chen0b5c90c2018-01-25 16:51:49 -08002490 optional uint64 timestamp_millis = 1;
Yangster-maca8a30442018-10-13 23:46:34 -07002491 // sleep time in millis.
David Chen0b5c90c2018-01-25 16:51:49 -08002492 optional uint64 sleep_time_millis = 2;
Yangster-maca8a30442018-10-13 23:46:34 -07002493 // idle time in millis
David Chen0b5c90c2018-01-25 16:51:49 -08002494 optional uint64 controller_idle_time_millis = 3;
Chenjie Yu05013b32017-11-21 10:21:41 -08002495 /**
2496 * Tx power index
2497 * index 0 = tx_power < 0dBm
2498 * index 1 = 0dBm < tx_power < 5dBm
2499 * index 2 = 5dBm < tx_power < 15dBm
2500 * index 3 = 15dBm < tx_power < 20dBm
2501 * index 4 = tx_power > 20dBm
2502 */
2503 // tx time in ms at power level 0
David Chen0b5c90c2018-01-25 16:51:49 -08002504 optional uint64 controller_tx_time_pl0_millis = 4;
Chenjie Yu05013b32017-11-21 10:21:41 -08002505 // tx time in ms at power level 1
David Chen0b5c90c2018-01-25 16:51:49 -08002506 optional uint64 controller_tx_time_pl1_millis = 5;
Chenjie Yu05013b32017-11-21 10:21:41 -08002507 // tx time in ms at power level 2
David Chen0b5c90c2018-01-25 16:51:49 -08002508 optional uint64 controller_tx_time_pl2_millis = 6;
Chenjie Yu05013b32017-11-21 10:21:41 -08002509 // tx time in ms at power level 3
David Chen0b5c90c2018-01-25 16:51:49 -08002510 optional uint64 controller_tx_time_pl3_millis = 7;
Chenjie Yu05013b32017-11-21 10:21:41 -08002511 // tx time in ms at power level 4
David Chen0b5c90c2018-01-25 16:51:49 -08002512 optional uint64 controller_tx_time_pl4_millis = 8;
Chenjie Yu05013b32017-11-21 10:21:41 -08002513 // rx time in ms at power level 5
David Chen0b5c90c2018-01-25 16:51:49 -08002514 optional uint64 controller_rx_time_millis = 9;
Chenjie Yu05013b32017-11-21 10:21:41 -08002515 // product of current(mA), voltage(V) and time(ms)
2516 optional uint64 energy_used = 10;
Joe Onorato62c220b2017-11-18 20:32:56 -08002517}
Rajeev Kumar508a9bf2018-01-18 15:49:11 -08002518
Chenjie Yu9d7720b2018-01-24 10:34:48 -08002519/**
2520 * Pulls Bluetooth Activity Energy Info
2521 * Note: BluetoothBytesTransfer is pulled at the same time from the controller.
2522 */
2523message BluetoothActivityInfo {
2524 // timestamp(wall clock) of record creation
David Chen0b5c90c2018-01-25 16:51:49 -08002525 optional uint64 timestamp_millis = 1;
Chenjie Yu9d7720b2018-01-24 10:34:48 -08002526 // bluetooth stack state
2527 optional int32 bluetooth_stack_state = 2;
Yangster-maca8a30442018-10-13 23:46:34 -07002528 // tx time in millis
David Chen0b5c90c2018-01-25 16:51:49 -08002529 optional uint64 controller_tx_time_millis = 3;
Yangster-maca8a30442018-10-13 23:46:34 -07002530 // rx time in millis
David Chen0b5c90c2018-01-25 16:51:49 -08002531 optional uint64 controller_rx_time_millis = 4;
Yangster-maca8a30442018-10-13 23:46:34 -07002532 // idle time in millis
David Chen0b5c90c2018-01-25 16:51:49 -08002533 optional uint64 controller_idle_time_millis = 5;
Chenjie Yu9d7720b2018-01-24 10:34:48 -08002534 // product of current(mA), voltage(V) and time(ms)
2535 optional uint64 energy_used = 6;
2536}
2537
Rajeev Kumar508a9bf2018-01-18 15:49:11 -08002538/*
Rajeev Kumar8a9fa052018-01-25 19:03:09 -08002539 * Logs the memory stats for a process.
2540 */
2541message ProcessMemoryState {
2542 // The uid if available. -1 means not available.
Yao Chenc40a19d2018-03-15 16:48:25 -07002543 optional int32 uid = 1 [(is_uid) = true];
Rajeev Kumar8a9fa052018-01-25 19:03:09 -08002544
2545 // The process name.
2546 optional string process_name = 2;
2547
2548 // oom adj score.
Yangster-maca8a30442018-10-13 23:46:34 -07002549 optional int32 oom_adj_score = 3;
Rajeev Kumar8a9fa052018-01-25 19:03:09 -08002550
2551 // # of page-faults
Yangster-maca8a30442018-10-13 23:46:34 -07002552 optional int64 page_fault = 4;
Rajeev Kumar8a9fa052018-01-25 19:03:09 -08002553
2554 // # of major page-faults
Yangster-maca8a30442018-10-13 23:46:34 -07002555 optional int64 page_major_fault = 5;
Rajeev Kumar8a9fa052018-01-25 19:03:09 -08002556
Rajeev Kumar90235992018-01-29 11:06:48 -08002557 // RSS
2558 optional int64 rss_in_bytes = 6;
2559
2560 // CACHE
2561 optional int64 cache_in_bytes = 7;
2562
2563 // SWAP
2564 optional int64 swap_in_bytes = 8;
Rafal Slawikaaf60892018-09-12 13:04:30 +01002565
Rafal Slawikd03ae422018-11-20 11:27:45 +00002566 // Deprecated: use ProcessMemoryHighWaterMark atom instead. Always 0.
Rafal Slawik3bea8952018-11-15 12:39:33 +00002567 optional int64 rss_high_watermark_in_bytes = 9 [deprecated = true];
Rafal Slawik272a8162018-11-01 15:12:28 +00002568
2569 // Elapsed real time when the process started.
2570 // Value is read from /proc/PID/stat, field 22. 0 if read from per-app memory cgroups.
2571 optional int64 start_time_nanos = 10;
Rajeev Kumar8a9fa052018-01-25 19:03:09 -08002572}
2573
2574/*
Rafal Slawik08621582018-10-15 14:53:07 +01002575 * Logs the memory stats for a native process (from procfs).
2576 */
2577message NativeProcessMemoryState {
Rafal Slawikbf67d072018-10-23 11:07:54 +01002578 // The uid if available. -1 means not available.
2579 optional int32 uid = 1 [(is_uid) = true];
Rafal Slawik08621582018-10-15 14:53:07 +01002580
Rafal Slawikbf67d072018-10-23 11:07:54 +01002581 // The process name.
2582 optional string process_name = 2;
Rafal Slawik08621582018-10-15 14:53:07 +01002583
Rafal Slawikbf67d072018-10-23 11:07:54 +01002584 // # of page-faults
2585 optional int64 page_fault = 3;
Rafal Slawik08621582018-10-15 14:53:07 +01002586
Rafal Slawikbf67d072018-10-23 11:07:54 +01002587 // # of major page-faults
2588 optional int64 page_major_fault = 4;
Rafal Slawik08621582018-10-15 14:53:07 +01002589
Rafal Slawikbf67d072018-10-23 11:07:54 +01002590 // RSS
2591 optional int64 rss_in_bytes = 5;
Rafal Slawik08621582018-10-15 14:53:07 +01002592
Rafal Slawikd03ae422018-11-20 11:27:45 +00002593 // Deprecated: use ProcessMemoryHighWaterMark atom instead. Always 0.
Rafal Slawik3bea8952018-11-15 12:39:33 +00002594 optional int64 rss_high_watermark_in_bytes = 6 [deprecated = true];
Rafal Slawikbf67d072018-10-23 11:07:54 +01002595
2596 // Elapsed real time when the process started.
2597 // Value is read from /proc/PID/stat, field 22.
2598 optional int64 start_time_nanos = 7;
Rafal Slawik08621582018-10-15 14:53:07 +01002599}
2600
2601/*
Rafal Slawik3bea8952018-11-15 12:39:33 +00002602 * Logs the memory high-water mark for a process.
2603 * Recorded in ActivityManagerService.
2604 */
2605message ProcessMemoryHighWaterMark {
2606 // The uid if available. -1 means not available.
2607 optional int32 uid = 1 [(is_uid) = true];
2608
2609 // The process name. Provided by ActivityManagerService or read from /proc/PID/cmdline.
2610 optional string process_name = 2;
2611
2612 // RSS high-water mark. Peak RSS usage of the process. Read from the VmHWM field in
2613 // /proc/PID/status.
2614 optional int64 rss_high_water_mark_in_bytes = 3;
2615}
2616
2617/*
Chenjie Yu9d7720b2018-01-24 10:34:48 -08002618 * Elapsed real time from SystemClock.
Chenjie Yu9da105b2018-01-13 12:41:08 -08002619 */
Chenjie Yu9d7720b2018-01-24 10:34:48 -08002620message SystemElapsedRealtime {
David Chen0b5c90c2018-01-25 16:51:49 -08002621 optional uint64 time_millis = 1;
Chenjie Yu9da105b2018-01-13 12:41:08 -08002622}
2623
2624/*
Chenjie Yu9d7720b2018-01-24 10:34:48 -08002625 * Up time from SystemClock.
Chenjie Yu9da105b2018-01-13 12:41:08 -08002626 */
Chenjie Yu9d7720b2018-01-24 10:34:48 -08002627message SystemUptime {
2628 // Milliseconds since the system was booted.
2629 // This clock stops when the system enters deep sleep (CPU off, display dark, device waiting
2630 // for external input).
2631 // It is not affected by clock scaling, idle, or other power saving mechanisms.
David Chen0b5c90c2018-01-25 16:51:49 -08002632 optional uint64 uptime_millis = 1;
Chenjie Yu9da105b2018-01-13 12:41:08 -08002633}
2634
2635/*
2636 * Reads from /proc/uid_concurrent_active_time which has the format:
2637 * active: X (X is # cores)
2638 * [uid0]: [time-0] [time-1] [time-2] ... (# entries = # cores)
2639 * [uid1]: [time-0] [time-1] [time-2] ... ...
2640 * ...
2641 * Time-N means the CPU time a UID spent running concurrently with N other processes.
2642 * The file contains a monotonically increasing count of time for a single boot.
2643 */
2644message CpuActiveTime {
Yao Chenc40a19d2018-03-15 16:48:25 -07002645 optional int32 uid = 1 [(is_uid) = true];
Chenjie Yuec676612018-03-07 09:19:17 -08002646 optional uint64 time_millis = 2;
Chenjie Yu9da105b2018-01-13 12:41:08 -08002647}
2648
2649/**
2650 * Reads from /proc/uid_concurrent_policy_time which has the format:
2651 * policy0: X policy4: Y (there are X cores on policy0, Y cores on policy4)
2652 * [uid0]: [time-0-0] [time-0-1] ... [time-1-0] [time-1-1] ...
2653 * [uid1]: [time-0-0] [time-0-1] ... [time-1-0] [time-1-1] ...
2654 * ...
2655 * Time-X-Y means the time a UID spent on clusterX running concurrently with Y other processes.
2656 * The file contains a monotonically increasing count of time for a single boot.
2657 */
2658message CpuClusterTime {
Yao Chenc40a19d2018-03-15 16:48:25 -07002659 optional int32 uid = 1 [(is_uid) = true];
Chenjie Yuec676612018-03-07 09:19:17 -08002660 optional int32 cluster_index = 2;
David Chen0b5c90c2018-01-25 16:51:49 -08002661 optional uint64 time_millis = 3;
Chenjie Yu937d7422018-01-10 16:37:53 -08002662}
2663
2664/*
2665 * Pulls free disk space, for data, system partition and temporary directory.
2666 */
2667message DiskSpace {
2668 // available bytes in data partition
2669 optional uint64 data_available_bytes = 1;
2670 // available bytes in system partition
2671 optional uint64 system_available_bytes = 2;
2672 // available bytes in download cache or temp directories
2673 optional uint64 temp_available_bytes = 3;
2674}
Tej Singhbf972d92018-01-10 20:51:13 -08002675
2676/**
2677 * Pulls battery coulomb counter, which is the remaining battery charge in uAh.
Tej Singh40298312018-02-16 00:15:09 -08002678 * Pulled from:
2679 * frameworks/base/cmds/statsd/src/external/ResourceHealthManagerPuller.cpp
Tej Singhbf972d92018-01-10 20:51:13 -08002680 */
2681message RemainingBatteryCapacity {
Yangster-maca8a30442018-10-13 23:46:34 -07002682 optional int32 charge_micro_ampere_hour = 1;
Tej Singhbf972d92018-01-10 20:51:13 -08002683}
2684
2685/**
2686 * Pulls battery capacity, which is the battery capacity when full in uAh.
Tej Singh40298312018-02-16 00:15:09 -08002687 * Pulled from:
2688 * frameworks/base/cmds/statsd/src/external/ResourceHealthManagerPuller.cpp
Tej Singhbf972d92018-01-10 20:51:13 -08002689 */
2690message FullBatteryCapacity {
Yangster-maca8a30442018-10-13 23:46:34 -07002691 optional int32 capacity_micro_ampere_hour = 1;
Tej Singh40298312018-02-16 00:15:09 -08002692}
2693
2694/**
Bookatz17f0d8a2018-09-13 12:56:32 -07002695 * Pulls battery voltage.
2696 * Pulled from:
2697 * frameworks/base/cmds/statsd/src/external/ResourceHealthManagerPuller.cpp
2698 */
2699message BatteryVoltage {
2700 // The voltage of the battery, in millivolts.
Yangster-maca8a30442018-10-13 23:46:34 -07002701 optional int32 voltage_millivolt = 1;
Bookatz17f0d8a2018-09-13 12:56:32 -07002702}
2703
2704/**
Tej Singhb1dbc8b2018-11-19 15:49:47 -08002705 * Pulls battery level (percent full, from 0 to 100).
2706 *
2707 * Pulled from:
2708 * frameworks/base/cmds/statsd/src/external/ResourceHealthManagerPuller.cpp
2709 */
2710message BatteryLevel {
2711 // Battery level. Should be in [0, 100].
2712 optional int32 battery_level = 1;
2713}
2714
2715/**
Tej Singhd89137e2018-03-26 14:51:40 -07002716 * Pulls the temperature of various parts of the device.
2717 * The units are tenths of a degree Celsius. Eg: 30.3C is reported as 303.
Tej Singh40298312018-02-16 00:15:09 -08002718 *
2719 * Pulled from:
2720 * frameworks/base/cmds/statsd/src/external/ResourceThermalManagerPuller.cpp
2721 */
2722message Temperature {
2723 // The type of temperature being reported. Eg. CPU, GPU, SKIN, BATTERY.
2724 optional android.os.TemperatureTypeEnum sensor_location = 1;
2725
2726 // The name of the temperature source. Eg. CPU0
2727 optional string sensor_name = 2;
2728
Tej Singhd89137e2018-03-26 14:51:40 -07002729 // Temperature in tenths of a degree C.
Yangster-maca8a30442018-10-13 23:46:34 -07002730 optional int32 temperature_deci_celsius = 3;
yroa1fe77c2018-02-26 14:22:54 -08002731}
Olivier Gaillard00bfb1b2018-07-10 11:25:09 +01002732
2733/**
2734 * Pulls the statistics of calls to Binder.
2735 *
Olivier Gaillardd25f7a82018-09-12 14:28:48 +01002736 * Binder stats will be reset every time the data is pulled. It means it can only be pulled by one
2737 * config on the device.
Olivier Gaillard9ea238d2018-07-24 10:26:31 +01002738 *
Olivier Gaillard720ec5b2018-10-30 17:32:56 +00002739 * Next tag: 15
Olivier Gaillard00bfb1b2018-07-10 11:25:09 +01002740 */
2741message BinderCalls {
Olivier Gaillard720ec5b2018-10-30 17:32:56 +00002742 // UID of the process responsible for the binder transaction. It will be set if the process
2743 // executing the binder transaction attribute the transaction to another uid using
2744 // Binder.setThreadWorkSource().
2745 //
2746 // If not set, the value will be -1.
Olivier Gaillard9ea238d2018-07-24 10:26:31 +01002747 optional int32 uid = 1 [(is_uid) = true];
Olivier Gaillard720ec5b2018-10-30 17:32:56 +00002748 // UID of the process executing the binder transaction.
2749 optional int32 direct_caller_uid = 14;
Olivier Gaillard9ea238d2018-07-24 10:26:31 +01002750 // Fully qualified class name of the API call.
2751 //
2752 // This is a system server class name.
2753 //
2754 // TODO(gaillard): figure out if binder call stats includes data from isolated uids, if a uid
2755 // gets recycled and we have isolated uids, we might attribute the data incorrectly.
2756 // TODO(gaillard): there is a high dimensions cardinality, figure out if we should drop the less
2757 // commonly used APIs.
2758 optional string service_class_name = 2;
2759 // Method name of the API call. It can also be a transaction code if we cannot
2760 // resolve it to a name. See Binder#getTransactionName.
2761 //
2762 // This is a system server method name.
2763 optional string service_method_name = 3;
2764 // Total number of API calls.
2765 optional int64 call_count = 4;
2766 // True if the screen was interactive PowerManager#isInteractive at the end of the call.
2767 optional bool screen_interactive = 13;
2768 // Total number of API calls we have data recorded for. If we collected data for all the calls,
2769 // call_count will be equal to recorded_call_count.
2770 //
2771 // If recorded_call_count is different than call_count, it means data collection has been
2772 // sampled. All the fields below will be sampled in this case.
2773 optional int64 recorded_call_count = 12;
2774 // Number of exceptions thrown by the API.
2775 optional int64 recorded_exception_count = 5;
2776 // Total latency of all API calls.
2777 // Average can be computed using total_latency_micros / recorded_call_count.
2778 optional int64 recorded_total_latency_micros = 6;
2779 // Maximum latency of one API call.
2780 optional int64 recorded_max_latency_micros = 7;
2781 // Total CPU usage of all API calls.
2782 // Average can be computed using total_cpu_micros / recorded_call_count.
2783 // Total can be computed using total_cpu_micros / recorded_call_count * call_count.
2784 optional int64 recorded_total_cpu_micros = 8;
2785 // Maximum CPU usage of one API call.
2786 optional int64 recorded_max_cpu_micros = 9;
2787 // Maximum parcel reply size of one API call.
2788 optional int64 recorded_max_reply_size_bytes = 10;
2789 // Maximum parcel request size of one API call.
2790 optional int64 recorded_max_request_size_bytes = 11;
2791}
2792
2793/**
2794 * Pulls the statistics of exceptions during calls to Binder.
2795 *
2796 * Binder stats are cumulative from boot unless somebody reset the data using
2797 * > adb shell dumpsys binder_calls_stats --reset
2798 */
2799message BinderCallsExceptions {
2800 // Exception class name, e.g. java.lang.IllegalArgumentException.
2801 //
2802 // This is an exception class name thrown by the system server.
2803 optional string exception_class_name = 1;
2804 // Total number of exceptions.
2805 optional int64 exception_count = 2;
Olivier Gaillard00bfb1b2018-07-10 11:25:09 +01002806}
Marcin Oczeretkod8cc8592018-08-22 16:07:36 +01002807
Marcin Oczeretko3e6494e2018-09-10 18:06:52 +01002808/**
2809 * Pulls the statistics of message dispatching on HandlerThreads.
2810 *
2811 * Looper stats will be reset every time the data is pulled. It means it can only be pulled by one
2812 * config on the device.
2813 *
2814 * Next tag: 11
2815 */
Marcin Oczeretkod8cc8592018-08-22 16:07:36 +01002816message LooperStats {
Marcin Oczeretkoec758722018-09-12 12:53:47 +01002817 // The uid that made a call to the System Server and caused the message to be enqueued.
Marcin Oczeretkod8cc8592018-08-22 16:07:36 +01002818 optional int32 uid = 1 [(is_uid) = true];
2819
2820 // Fully qualified class name of the handler target class.
2821 //
2822 // This field does not contain PII. This is a system server class name.
2823 optional string handler_class_name = 2;
2824
2825 // The name of the thread that runs the Looper.
2826 //
2827 // This field does not contain PII. This is a system server thread name.
2828 optional string looper_thread_name = 3;
2829
2830 // The name of the dispatched message.
2831 //
2832 // This field does not contain PII. This is a system server constant or class
2833 // name.
2834 optional string message_name = 4;
2835
2836 // Total number of successfully dispatched messages.
2837 optional int64 message_count = 5;
2838
2839 // Total number of messages that failed dispatching.
2840 optional int64 exception_count = 6;
2841
2842 // Total number of processed messages we have data recorded for. If we
2843 // collected data for all the messages, message_count will be equal to
2844 // recorded_message_count.
2845 //
2846 // If recorded_message_count is different than message_count, it means data
Marcin Oczeretkoc06331a2018-10-02 13:00:38 +01002847 // collection has been sampled. The fields below will be sampled in this case.
Marcin Oczeretkod8cc8592018-08-22 16:07:36 +01002848 optional int64 recorded_message_count = 7;
2849
2850 // Total latency of all processed messages.
2851 // Average can be computed using recorded_total_latency_micros /
2852 // recorded_message_count.
2853 optional int64 recorded_total_latency_micros = 8;
2854
2855 // Total CPU usage of all processed message.
2856 // Average can be computed using recorded_total_cpu_micros /
2857 // recorded_message_count. Total can be computed using
Marcin Oczeretko3e6494e2018-09-10 18:06:52 +01002858 // recorded_total_cpu_micros / recorded_message_count * message_count.
Marcin Oczeretkod8cc8592018-08-22 16:07:36 +01002859 optional int64 recorded_total_cpu_micros = 9;
Marcin Oczeretko3e6494e2018-09-10 18:06:52 +01002860
2861 // True if the screen was interactive PowerManager#isInteractive at the end of the call.
2862 optional bool screen_interactive = 10;
Marcin Oczeretkoc06331a2018-10-02 13:00:38 +01002863
2864 // Max recorded CPU usage of all processed messages.
2865 optional int64 recorded_max_cpu_micros = 11;
2866
2867 // Max recorded latency of all processed messages.
2868 optional int64 recorded_max_latency_micros = 12;
2869
2870 // Total number of messages we tracked the dispatching delay for. If we
2871 // collected data for all the messages, message_count will be equal to
2872 // recorded_delay_message_count.
2873 //
2874 // If recorded_delay_message_count is different than message_count, it means data
2875 // collection has been sampled or/and not all messages specified the target dispatch time.
2876 // The fields below will be sampled in this case.
2877 optional int64 recorded_delay_message_count = 13;
2878
2879 // Total dispatching delay of all processed messages.
2880 // Calculated as a difference between the target dispatching time (Message.when)
2881 // and the actual dispatching time.
2882 // Average can be computed using recorded_total_delay_millis / recorded_delay_message_count.
2883 optional int64 recorded_total_delay_millis = 14;
2884
2885 // Max dispatching delay of all processed messages.
2886 // Calculated as a difference between the target dispatching time (Message.when)
2887 // and the actual dispatching time.
2888 optional int64 recorded_max_delay_millis = 15;
Marcin Oczeretkod8cc8592018-08-22 16:07:36 +01002889}
Tej Singh86dc9db2018-09-06 00:39:57 +00002890
2891/**
2892 * Pulls disk information, such as write speed and latency.
2893 */
2894message DiskStats {
2895 // Time taken to open, write 512B to, and close a file.
2896 // -1 if error performing the check.
2897 optional int64 data_write_latency_millis = 1;
2898
2899 optional bool file_based_encryption = 2;
2900
2901 // Recent disk write speed in kB/s.
2902 // -1 if error querying storageed.
2903 // 0 if data is unavailable.
2904 optional int32 recent_disk_write_speed = 3;
2905}
2906
2907
2908/**
2909 * Free and total bytes of the Data, Cache, and System partition.
2910 */
2911message DirectoryUsage {
2912 enum Directory {
2913 UNKNOWN = 0;
2914 DATA = 1;
2915 CACHE = 2;
2916 SYSTEM = 3;
2917 }
2918 optional Directory directory = 1;
2919 optional int64 free_bytes = 2;
2920 optional int64 total_bytes = 3;
2921}
2922
2923
2924/**
2925 * Size of an application: apk size, data size, and cache size.
2926 * Reads from a cached file produced daily by DiskStatsLoggingService.java.
2927 * Information is only reported for apps with the primary user (user 0).
2928 * Sizes are aggregated by package name.
2929 */
2930message AppSize {
2931 // Including uids will involve modifying diskstats logic.
2932 optional string package_name = 1;
2933 // App size in bytes. -1 if unavailable.
2934 optional int64 app_size_bytes = 2;
2935 // App data size in bytes. -1 if unavailable.
2936 optional int64 app_data_size_bytes = 3;
2937 // App cache size in bytes. -1 if unavailable.
2938 optional int64 app_cache_size_bytes = 4;
2939 // Time that the cache file was produced.
2940 // Uses System.currentTimeMillis(), which is wall clock time.
2941 optional int64 cache_time_millis = 5;
2942}
2943
2944
2945/**
2946 * Size of a particular category. Eg: photos, videos.
2947 * Reads from a cached file produced daily by DiskStatsLoggingService.java.
2948 */
2949message CategorySize {
2950 enum Category {
2951 UNKNOWN = 0;
2952 APP_SIZE = 1;
2953 APP_DATA_SIZE = 2;
2954 APP_CACHE_SIZE = 3;
2955 PHOTOS = 4;
2956 VIDEOS = 5;
2957 AUDIO = 6;
2958 DOWNLOADS = 7;
2959 SYSTEM = 8;
2960 OTHER = 9;
2961 }
2962 optional Category category = 1;
2963 // Category size in bytes.
2964 optional int64 size_bytes = 2;
2965 // Time that the cache file was produced.
2966 // Uses System.currentTimeMillis(), which is wall clock time.
2967 optional int64 cache_time_millis = 3;
2968}
Tej Singhd6d6d772018-09-05 17:41:25 -07002969
2970/**
Tej Singhe7726dc2018-09-21 11:42:12 -07002971 * Pulls per uid I/O stats. The stats are cumulative since boot.
2972 *
2973 * Read/write bytes are I/O events from a storage device
2974 * Read/write chars are data requested by read/write syscalls, and can be
2975 * satisfied by caching.
2976 *
2977 * Pulled from StatsCompanionService, which reads proc/uid_io/stats.
2978 */
2979message DiskIo {
2980 optional int32 uid = 1 [(is_uid) = true];
2981 optional int64 fg_chars_read = 2;
2982 optional int64 fg_chars_write = 3;
2983 optional int64 fg_bytes_read = 4;
2984 optional int64 fg_bytes_write = 5;
2985 optional int64 bg_chars_read = 6;
2986 optional int64 bg_chars_write = 7;
2987 optional int64 bg_bytes_read = 8;
2988 optional int64 bg_bytes_write = 9;
2989 optional int64 fg_fsync = 10;
2990 optional int64 bg_fsync= 11;
2991}
2992
2993
2994/**
Tej Singhd6d6d772018-09-05 17:41:25 -07002995 * Pulls the number of fingerprints for each user.
2996 *
2997 * Pulled from StatsCompanionService, which queries FingerprintManager.
2998 */
2999message NumFingerprints {
3000 // The associated user. Eg: 0 for owners, 10+ for others.
3001 // Defined in android/os/UserHandle.java
3002 optional int32 user = 1;
3003 // Number of fingerprints registered to that user.
3004 optional int32 num_fingerprints = 2;
3005}
Chenjie Yu12e5e672018-09-14 15:54:59 -07003006
Yangsteraf9aee72018-10-12 09:26:16 -07003007message AggStats {
3008 optional int64 min = 1;
3009
3010 optional int64 average = 2;
3011
3012 optional int64 max = 3;
3013}
3014
3015message ProcessStatsStateProto {
3016 optional android.service.procstats.ScreenState screen_state = 1;
3017
3018 optional android.service.procstats.MemoryState memory_state = 2;
3019
3020 // this enum list is from frameworks/base/core/java/com/android/internal/app/procstats/ProcessStats.java
3021 // and not frameworks/base/core/java/android/app/ActivityManager.java
3022 optional android.service.procstats.ProcessState process_state = 3;
3023
3024 // Millisecond uptime duration spent in this state
Yangster-maca8a30442018-10-13 23:46:34 -07003025 optional int64 duration_millis = 4;
Yangsteraf9aee72018-10-12 09:26:16 -07003026
3027 // Millisecond elapsed realtime duration spent in this state
Yangster-maca8a30442018-10-13 23:46:34 -07003028 optional int64 realtime_duration_millis = 9;
Yangsteraf9aee72018-10-12 09:26:16 -07003029
3030 // # of samples taken
3031 optional int32 sample_size = 5;
3032
3033 // PSS is memory reserved for this process
3034 optional AggStats pss = 6;
3035
3036 // USS is memory shared between processes, divided evenly for accounting
3037 optional AggStats uss = 7;
3038
3039 // RSS is memory resident for this process
3040 optional AggStats rss = 8;
3041}
3042
3043// Next Tag: 7
3044message ProcessStatsProto {
3045 // Name of process.
3046 optional string process = 1;
3047
3048 // Uid of the process.
3049 optional int32 uid = 2;
3050
3051 // Information about how often kills occurred
3052 message Kill {
3053 // Count of excessive CPU kills
3054 optional int32 cpu = 1;
3055
3056 // Count of kills when cached
3057 optional int32 cached = 2;
3058
3059 // PSS stats during cached kill
3060 optional AggStats cached_pss = 3;
3061 }
3062 optional Kill kill = 3;
3063
3064 // Time and memory spent in various states.
3065 repeated ProcessStatsStateProto states = 5;
3066
3067 // Total time process has been running... screen_state, memory_state, and process_state
3068 // will not be set.
3069 optional ProcessStatsStateProto total_running_state = 6;
3070}
3071
3072message PackageServiceOperationStatsProto {
3073 // Operate enum: Started, Foreground, Bound, Executing
3074 optional android.service.procstats.ServiceOperationState operation = 1;
3075
3076 // Number of times the service was in this operation.
3077 optional int32 count = 2;
3078
3079 // Information about a state the service can be in.
3080 message StateStats {
3081 // Screen state enum.
3082 optional android.service.procstats.ScreenState screen_state = 1;
3083 // Memory state enum.
3084 optional android.service.procstats.MemoryState memory_state = 2;
3085
3086 // duration in milliseconds.
Yangster-maca8a30442018-10-13 23:46:34 -07003087 optional int64 duration_millis = 3;
Yangsteraf9aee72018-10-12 09:26:16 -07003088 // Millisecond elapsed realtime duration spent in this state
Yangster-maca8a30442018-10-13 23:46:34 -07003089 optional int64 realtime_duration_millis = 4;
Yangsteraf9aee72018-10-12 09:26:16 -07003090 }
3091 repeated StateStats state_stats = 3;
3092}
3093
3094message PackageServiceStatsProto {
3095 // Name of service component.
3096 optional string service_name = 1;
3097
3098 // The operation stats.
3099 // The package_name, package_uid, package_version, service_name will not be set to save space.
3100 repeated PackageServiceOperationStatsProto operation_stats = 2;
3101}
3102
3103message PackageAssociationSourceProcessStatsProto {
3104 // Uid of the process.
3105 optional int32 process_uid = 1;
3106 // Process name.
3107 optional string process_name = 2;
3108
3109 // Total count of the times this association appeared.
3110 optional int32 total_count = 3;
3111
3112 // Millisecond uptime total duration this association was around.
Yangster-maca8a30442018-10-13 23:46:34 -07003113 optional int64 total_duration_millis = 4;
Yangsteraf9aee72018-10-12 09:26:16 -07003114
3115 // Total count of the times this association became actively impacting its target process.
3116 optional int32 active_count = 5;
3117
3118 // Information on one source in this association.
3119 message StateStats {
3120 // Process state enum.
3121 optional android.service.procstats.ProcessState process_state = 1;
3122 // Millisecond uptime duration spent in this state
Yangster-maca8a30442018-10-13 23:46:34 -07003123 optional int64 duration_millis = 2;
Yangsteraf9aee72018-10-12 09:26:16 -07003124 // Millisecond elapsed realtime duration spent in this state
Yangster-maca8a30442018-10-13 23:46:34 -07003125 optional int64 realtime_duration_mmillis = 3;
Yangsteraf9aee72018-10-12 09:26:16 -07003126 }
3127 repeated StateStats active_state_stats = 6;
3128}
3129
3130message PackageAssociationProcessStatsProto {
3131 // Name of the target component.
3132 optional string component_name = 1;
3133 // Information on one source in this association.
3134 repeated PackageAssociationSourceProcessStatsProto sources = 2;
3135}
3136
3137
3138message ProcessStatsPackageProto {
3139 // Name of package.
3140 optional string package = 1;
3141
3142 // Uid of the package.
3143 optional int32 uid = 2;
3144
3145 // Version of the package.
3146 optional int64 version = 3;
3147
3148 // Stats for each process running with the package loaded in to it.
3149 repeated ProcessStatsProto process_stats = 4;
3150
3151 // Stats for each of the package's services.
3152 repeated PackageServiceStatsProto service_stats = 5;
3153
3154 // Stats for each association with the package.
3155 repeated PackageAssociationProcessStatsProto association_stats = 6;
3156}
3157
3158message ProcessStatsSectionProto {
3159 // Elapsed realtime at start of report.
Yangster-maca8a30442018-10-13 23:46:34 -07003160 optional int64 start_realtime_millis = 1;
Yangsteraf9aee72018-10-12 09:26:16 -07003161
3162 // Elapsed realtime at end of report.
Yangster-maca8a30442018-10-13 23:46:34 -07003163 optional int64 end_realtime_millis = 2;
Yangsteraf9aee72018-10-12 09:26:16 -07003164
3165 // CPU uptime at start of report.
Yangster-maca8a30442018-10-13 23:46:34 -07003166 optional int64 start_uptime_millis = 3;
Yangsteraf9aee72018-10-12 09:26:16 -07003167
3168 // CPU uptime at end of report.
Yangster-maca8a30442018-10-13 23:46:34 -07003169 optional int64 end_uptime_millis = 4;
Yangsteraf9aee72018-10-12 09:26:16 -07003170
3171 // System runtime library. e.g. "libdvm.so", "libart.so".
3172 optional string runtime = 5;
3173
3174 // whether kernel reports swapped pss.
3175 optional bool has_swapped_pss = 6;
3176
3177 // Data completeness. e.g. "complete", "partial", shutdown", or "sysprops".
3178 enum Status {
3179 STATUS_UNKNOWN = 0;
3180 STATUS_COMPLETE = 1;
3181 STATUS_PARTIAL = 2;
3182 STATUS_SHUTDOWN = 3;
3183 STATUS_SYSPROPS = 4;
3184 }
3185 repeated Status status = 7;
3186
3187 // Stats for each process.
3188 repeated ProcessStatsProto process_stats = 8;
3189
3190 // Stats for each package.
3191 repeated ProcessStatsPackageProto package_stats = 9;
3192}
3193
Chenjie Yu12e5e672018-09-14 15:54:59 -07003194/**
3195 * Pulled from ProcessStatsService.java
3196 */
3197message ProcStats {
Yangsteraf9aee72018-10-12 09:26:16 -07003198 optional ProcessStatsSectionProto proc_stats_section = 1;
3199}
3200
3201message PowerProfileProto {
3202 optional double cpu_suspend = 1;
3203
3204 optional double cpu_idle = 2;
3205
3206 optional double cpu_active = 3;
3207
3208 message CpuCluster {
3209 optional int32 id = 1;
3210 optional double cluster_power = 2;
3211 optional int32 cores = 3;
3212 repeated int64 speed = 4;
3213 repeated double core_power = 5;
3214 }
3215
3216 repeated CpuCluster cpu_cluster = 40;
3217
3218 optional double wifi_scan = 4;
3219
3220 optional double wifi_on = 5;
3221
3222 optional double wifi_active = 6;
3223
3224 optional double wifi_controller_idle = 7;
3225
3226 optional double wifi_controller_rx = 8;
3227
3228 optional double wifi_controller_tx = 9;
3229
3230 repeated double wifi_controller_tx_levels = 10;
3231
3232 optional double wifi_controller_operating_voltage = 11;
3233
3234 optional double bluetooth_controller_idle = 12;
3235
3236 optional double bluetooth_controller_rx = 13;
3237
3238 optional double bluetooth_controller_tx = 14;
3239
3240 optional double bluetooth_controller_operating_voltage = 15;
3241
3242 optional double modem_controller_sleep = 16;
3243
3244 optional double modem_controller_idle = 17;
3245
3246 optional double modem_controller_rx = 18;
3247
3248 repeated double modem_controller_tx = 19;
3249
3250 optional double modem_controller_operating_voltage = 20;
3251
3252 optional double gps_on = 21;
3253
3254 repeated double gps_signal_quality_based = 22;
3255
3256 optional double gps_operating_voltage = 23;
3257
3258 optional double bluetooth_on = 24;
3259
3260 optional double bluetooth_active = 25;
3261
3262 optional double bluetooth_at_cmd = 26;
3263
3264 optional double ambient_display = 27;
3265
3266 optional double screen_on = 28;
3267
3268 optional double radio_on = 29;
3269
3270 optional double radio_scanning = 30;
3271
3272 optional double radio_active = 31;
3273
3274 optional double screen_full = 32;
3275
3276 optional double audio = 33;
3277
3278 optional double video = 34;
3279
3280 optional double flashlight = 35;
3281
3282 optional double memory = 36;
3283
3284 optional double camera = 37;
3285
3286 optional double wifi_batched_scan = 38;
3287
3288 optional double battery_capacity = 39;
Chenjie Yu12e5e672018-09-14 15:54:59 -07003289}
Chenjie Yuab530202018-09-26 12:39:20 -07003290
3291/**
3292 * power_profile.xml and other constants for power model calculations.
3293 * Pulled from PowerProfile.java
3294 */
3295message PowerProfile {
Yangsteraf9aee72018-10-12 09:26:16 -07003296 optional PowerProfileProto power_profile = 1;
Howard Ro9a862de2018-10-11 16:03:33 -07003297}
Chenjie Yub35b5f72018-10-13 23:25:11 -07003298
3299/**
arangelovd5db50e2018-10-12 20:24:39 +01003300 * Logs when a user restriction was added or removed.
3301 *
3302 * Logged from:
3303 * frameworks/base/services/devicepolicy/java/com/android/server/devicepolicy/DevicePolicyManagerService.java
3304 */
3305message UserRestrictionChanged {
3306 // The raw string of the user restriction as defined in UserManager.
3307 // Allowed values are defined in UserRestrictionsUtils#USER_RESTRICTIONS.
3308 optional string restriction = 1;
3309 // Whether the restriction is enabled or disabled.
3310 optional bool enabled = 2;
Howard Ro183c2bd2018-10-18 13:52:10 -07003311}
Yangster-mac308ea0c2018-10-22 13:10:25 -07003312
3313/**
3314 * Pulls process user time and system time. Puller takes a snapshot of all pids
3315 * in the system and returns cpu stats for those that are working at the time.
3316 * Dead pids will be dropped. Kernel processes are excluded.
3317 * Min cool-down is 5 sec.
3318 */
3319message ProcessCpuTime {
3320 optional int32 uid = 1 [(is_uid) = true];
3321
3322 optional string process_name = 2;
3323 // Process cpu time in user space, cumulative from boot/process start
3324 optional int64 user_time_millis = 3;
3325 // Process cpu time in system space, cumulative from boot/process start
3326 optional int64 system_time_millis = 4;
Rafal Slawikbf67d072018-10-23 11:07:54 +01003327}
Misha Wagner5a51e002018-10-03 15:04:09 +01003328
3329/**
3330 * Pulls the CPU usage for each thread.
3331 *
3332 * Read from /proc/$PID/task/$TID/time_in_state files.
3333 *
3334 * TODO(mishaw): This is an experimental atom. Issues with big/little CPU frequencies, and
3335 * time_in_state files not being present on some phones, have not been addressed. These should be
3336 * considered before a public release.
3337 */
3338message CpuTimePerThreadFreq {
3339 // UID that owns the process.
3340 optional int32 uid = 1 [(is_uid) = true];
3341 // ID of the process.
Misha Wagnerdfa548c2018-11-16 11:18:00 +00003342 optional int32 process_id = 2;
Misha Wagner5a51e002018-10-03 15:04:09 +01003343 // ID of the thread.
Misha Wagnerdfa548c2018-11-16 11:18:00 +00003344 optional int32 thread_id = 3;
Misha Wagner5a51e002018-10-03 15:04:09 +01003345 // Name of the process taken from `/proc/$PID/cmdline`.
3346 optional string process_name = 4;
3347 // Name of the thread taken from `/proc/$PID/task/$TID/comm`
3348 optional string thread_name = 5;
Misha Wagnerfde69582018-11-28 13:26:32 +00003349
3350 // Report eight different frequencies, and how much time is spent in each frequency. Frequencies
3351 // are given in KHz, and time is given in milliseconds since the thread started. All eight
3352 // frequencies are given here as the alternative is sending eight separate atoms. This method
3353 // significantly reduces the amount of data created
3354 optional int32 frequency1_khz = 6;
3355 optional int32 time1_millis = 7;
3356 optional int32 frequency2_khz = 8;
3357 optional int32 time2_millis = 9;
3358 optional int32 frequency3_khz = 10;
3359 optional int32 time3_millis = 11;
3360 optional int32 frequency4_khz = 12;
3361 optional int32 time4_millis = 13;
3362 optional int32 frequency5_khz = 14;
3363 optional int32 time5_millis = 15;
3364 optional int32 frequency6_khz = 16;
3365 optional int32 time6_millis = 17;
3366 optional int32 frequency7_khz = 18;
3367 optional int32 time7_millis = 19;
3368 optional int32 frequency8_khz = 20;
3369 optional int32 time8_millis = 21;
Misha Wagner5a51e002018-10-03 15:04:09 +01003370}
Bookatz75ee6042018-11-09 12:27:37 -08003371
3372/**
Bookatz366a4432018-11-20 09:42:33 -08003373 * Pulls information about the device's build.
3374 */
3375message BuildInformation {
3376 // Build.FINGERPRINT. A string that uniquely identifies this build. Do not parse.
3377 // E.g. may be composed of the brand, product, device, release, id, incremental, type, and tags.
3378 optional string fingerprint = 1;
3379
3380 // Build.BRAND. The consumer-visible brand with which the product/hardware will be associated.
3381 optional string brand = 2;
3382
3383 // Build.PRODUCT. The name of the overall product.
3384 optional string product = 3;
3385
3386 // Build.DEVICE. The name of the industrial design.
3387 optional string device = 4;
3388
3389 // Build.VERSION.RELEASE. The user-visible version string. E.g., "1.0" or "3.4b5" or "bananas".
3390 optional string version_release = 5;
3391
3392 // Build.ID. E.g. a label like "M4-rc20".
3393 optional string id = 6;
3394
3395 // Build.VERSION.INCREMENTAL. The internal value used by the underlying source control to
3396 // represent this build.
3397 optional string version_incremental = 7;
3398
3399 // Build.TYPE. The type of build, like "user" or "eng".
3400 optional string type = 8;
3401
3402 // Build.TAGS. Comma-separated tags describing the build, like "unsigned,debug".
3403 optional string tags = 9;
3404}
3405
3406/**
Bookatz75ee6042018-11-09 12:27:37 -08003407 * Pulls on-device BatteryStats power use calculations for the overall device.
3408 */
3409message DeviceCalculatedPowerUse {
3410 // Power used by the device in mAh, as computed by BatteryStats, since BatteryStats last reset
3411 // (i.e. roughly since device was last significantly charged).
3412 // Currently, this is BatteryStatsHelper.getComputedPower() (not getTotalPower()).
3413 optional float computed_power_milli_amp_hours = 1;
3414}
3415
3416/**
3417 * Pulls on-device BatteryStats power use calculations broken down by uid.
3418 * This atom should be complemented by DeviceCalculatedPowerBlameOther, which contains the power use
3419 * that is attributed to non-uid items. They must all be included to get the total power use.
3420 */
3421message DeviceCalculatedPowerBlameUid {
3422 // Uid being blamed. Note: isolated uids have already been mapped to host uid.
3423 optional int32 uid = 1 [(is_uid) = true];
3424
3425 // Power used by this uid in mAh, as computed by BatteryStats, since BatteryStats last reset
3426 // (i.e. roughly since device was last significantly charged).
3427 optional float power_milli_amp_hours = 2;
3428}
3429
3430/**
3431 * Pulls on-device BatteryStats power use calculations that are not due to a uid, broken down by
3432 * drain type.
3433 * This atom should be complemented by DeviceCalculatedPowerBlameUid, which contains the blame that
3434 * is attributed uids. They must all be included to get the total power use.
3435 */
3436message DeviceCalculatedPowerBlameOther {
3437 // The type of item whose power use is being reported.
3438 enum DrainType {
3439 AMBIENT_DISPLAY = 0;
3440 // reserved 1; reserved "APP"; // Logged instead in DeviceCalculatedPowerBlameUid.
3441 BLUETOOTH = 2;
3442 CAMERA = 3;
3443 // Cell-standby
3444 CELL = 4;
3445 FLASHLIGHT = 5;
3446 IDLE = 6;
3447 MEMORY = 7;
3448 // Amount that total computed drain exceeded the drain estimated using the
3449 // battery level changes and capacity.
3450 OVERCOUNTED = 8;
3451 PHONE = 9;
3452 SCREEN = 10;
3453 // Amount that total computed drain was below the drain estimated using the
3454 // battery level changes and capacity.
3455 UNACCOUNTED = 11;
3456 // reserved 12; reserved "USER"; // Entire drain for a user. This is NOT supported.
3457 WIFI = 13;
3458 }
3459 optional DrainType drain_type = 1;
3460
3461 // Power used by this item in mAh, as computed by BatteryStats, since BatteryStats last reset
3462 // (i.e. roughly since device was last significantly charged).
3463 optional float power_milli_amp_hours = 2;
Rafal Slawik3bea8952018-11-15 12:39:33 +00003464}
arangelov4e994062018-11-13 16:12:38 +00003465
3466/**
3467 * Logs device policy features.
3468 *
3469 * Logged from:
3470 * frameworks/base/services/devicepolicy/java/com/android/server/devicepolicy/DevicePolicyManagerService.java
3471 * packages/apps/ManagedProvisioning/src/com/android/managedprovisioning/
3472 */
3473message DevicePolicyEvent {
3474 // The event id - unique for each event.
3475 optional android.stats.devicepolicy.EventId event_id = 1;
3476 // The admin package name.
3477 optional string admin_package_name = 2;
3478 // A generic integer parameter.
3479 optional int32 integer_value = 3;
3480 // A generic boolean parameter.
3481 optional bool boolean_value = 4;
3482 // A parameter specifying a time period in milliseconds.
3483 optional uint64 time_period_millis = 5;
3484 // A parameter specifying a list of package names, bundle extras or string parameters.
3485 optional android.stats.devicepolicy.StringList string_list_value = 6 [(log_mode) = MODE_BYTES];
3486}
shawnlinea5b66b2018-11-13 15:05:29 +08003487
3488/**
3489 * Logs when DocumentsUI is started, and how. Call this when DocumentsUI first starts up.
3490 *
3491 * Logged from:
3492 * package/app/DocumentsUI/src/com/android/documentsui/Metrics.java
3493 */
3494message DocsUILaunchReported {
3495 optional android.stats.docsui.LaunchAction launch_action = 1;
3496 optional bool has_initial_uri = 2;
3497 optional android.stats.docsui.MimeType mime_type = 3;
3498 optional android.stats.docsui.Root initial_root = 4;
3499}
3500
3501/**
3502 * Logs root/app visited event in file managers/picker. Call this when the user
3503 * taps on root/app in hamburger menu.
3504 *
3505 * Logged from:
3506 * package/app/DocumentsUI/src/com/android/documentsui/Metrics.java
3507 */
3508message DocsUIRootVisitedReported {
3509 optional android.stats.docsui.ContextScope scope = 1;
3510 optional android.stats.docsui.Root root = 2;
3511}
3512
3513/**
3514 * Logs file operation stats. Call this when a file operation has completed.
3515 *
3516 * Logged from:
3517 * package/app/DocumentsUI/src/com/android/documentsui/Metrics.java
3518 */
3519message DocsUIFileOperationReported {
3520 optional android.stats.docsui.Provider provider = 1;
3521 optional android.stats.docsui.FileOperation file_op = 2;
3522}
3523
3524/**
3525 * Logs file operation stats. Call this when a copy/move operation has completed with a specific
3526 * mode.
3527 *
3528 * Logged from:
3529 * package/app/DocumentsUI/src/com/android/documentsui/Metrics.java
3530 */
3531message DocsUIFileOperationCopyMoveModeReported {
3532 optional android.stats.docsui.FileOperation file_op = 1;
3533 optional android.stats.docsui.CopyMoveOpMode mode = 2;
3534}
3535
3536
3537/**
3538 * Logs file sub operation stats. Call this when a file operation has failed.
3539 *
3540 * Logged from:
3541 * package/app/DocumentsUI/src/com/android/documentsui/Metrics.java
3542 */
3543message DocsUIFileOperationFailureReported {
3544 optional android.stats.docsui.Authority authority = 1;
3545 optional android.stats.docsui.SubFileOperation sub_op = 2;
3546}
3547
3548/**
3549* Logs the cancellation of a file operation. Call this when a job is canceled
3550*
3551* Logged from:
3552* package/app/DocumentsUI/src/com/android/documentsui/Metrics.java
3553*/
3554message DocsUIFileOperationCanceledReported {
3555 optional android.stats.docsui.FileOperation file_op = 1;
3556}
3557
3558/**
3559 * Logs startup time in milliseconds.
3560 *
3561 * Logged from:
3562 * package/app/DocumentsUI/src/com/android/documentsui/Metrics.java
3563 */
3564message DocsUIStartupMsReported {
3565 optional int32 startup_millis = 1;
3566}
3567
3568/**
3569 * Logs the action that was started by user.
3570 *
3571 * Logged from:
3572 * package/app/DocumentsUI/src/com/android/documentsui/Metrics.java
3573 */
3574message DocsUIUserActionReported {
3575 optional android.stats.docsui.UserAction action = 1;
3576}
3577
3578/**
3579 * Logs the invalid type when invalid scoped access is requested.
3580 *
3581 * Logged from:
3582 * package/app/DocumentsUI/src/com/android/documentsui/ScopedAccessMetrics.java
3583 */
3584message DocsUIInvalidScopedAccessRequestReported {
3585 optional android.stats.docsui.InvalidScopedAccess type = 1;
3586}