blob: 43aeeca18b4c3848513f3fcadf5e1fff6382a685 [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:
Bookatz819ea832018-11-28 16:53:31 -0800893 * frameworks/opt/net/wifi/service/java/com/android/server/wifi/ClientModeImpl.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:
Bookatz819ea832018-11-28 16:53:31 -0800904 * frameworks/opt/net/wifi/service/java/com/android/server/wifi/scanner/WifiScanningServiceImpl.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:
Bookatz819ea832018-11-28 16:53:31 -0800920 * frameworks/opt/net/wifi/service/java/com/android/server/wifi/WifiMulticastLockManager.java
Tej Singh4503e102018-01-04 14:35:01 -0800921 */
922message WifiMulticastLockStateChanged {
923 repeated AttributionNode attribution_node = 1;
924
925 enum State {
926 OFF = 0;
927 ON = 1;
928 }
929 optional State state = 2;
Bookatz819ea832018-11-28 16:53:31 -0800930
931 optional string tag = 3;
Tej Singh4503e102018-01-04 14:35:01 -0800932}
933
934/**
Tej Singh1ea42892018-01-19 09:27:00 -0800935 * Logs shutdown reason and duration on next boot.
936 *
937 * Logged from:
938 * frameworks/base/core/java/com/android/server/BootReceiver.java
939 */
940message ShutdownSequenceReported {
941 // True if shutdown is for a reboot. Default: false if we do not know.
942 optional bool reboot = 1;
943
944 // Reason for shutdown. Eg: userrequested. Default: "<EMPTY>".
945 optional string reason = 2;
946
947 // Beginning of shutdown time in ms using wall clock time since unix epoch.
948 // Default: 0 if no start time received.
David Chen0b5c90c2018-01-25 16:51:49 -0800949 optional int64 start_time_millis = 3;
Tej Singh1ea42892018-01-19 09:27:00 -0800950
951 // Duration of shutdown in ms. Default: 0 if no duration received.
David Chen0b5c90c2018-01-25 16:51:49 -0800952 optional int64 duration_millis = 4;
Tej Singh1ea42892018-01-19 09:27:00 -0800953}
954
Tej Singh6483ea42018-01-25 17:45:49 -0800955
956/**
957 * Logs boot reason and duration.
958 *
959 * Logged from:
960 * system/core/bootstat/bootstat.cpp
961 */
962message BootSequenceReported {
963 // Reason for bootloader boot. Eg. reboot. See bootstat.cpp for larger list
964 // Default: "<EMPTY>" if not available.
965 optional string bootloader_reason = 1;
966
967 // Reason for system boot. Eg. bootloader, reboot,userrequested
968 // Default: "<EMPTY>" if not available.
969 optional string system_reason = 2;
970
971 // End of boot time in ms from unix epoch using system wall clock.
David Chen0b5c90c2018-01-25 16:51:49 -0800972 optional int64 end_time_millis = 3;
Tej Singh6483ea42018-01-25 17:45:49 -0800973
974 // Total boot duration in ms.
David Chen0b5c90c2018-01-25 16:51:49 -0800975 optional int64 total_duration_millis = 4;
Tej Singh6483ea42018-01-25 17:45:49 -0800976
977 // Bootloader duration in ms.
David Chen0b5c90c2018-01-25 16:51:49 -0800978 optional int64 bootloader_duration_millis = 5;
Tej Singh6483ea42018-01-25 17:45:49 -0800979
980 // Time since last boot in ms. Default: 0 if not available.
981 optional int64 time_since_last_boot = 6;
982}
983
Tej Singhc477d9c2018-02-05 18:31:39 -0800984
985/**
986 * Logs call state and disconnect cause (if applicable).
987 *
988 * Logged from:
989 * packages/services/Telecomm/src/com/android/server/telecom/Call.java
990 */
991message CallStateChanged {
992 // The state of the call. Eg. DIALING, ACTIVE, ON_HOLD, DISCONNECTED.
993 // From frameworks/base/core/proto/android/telecomm/enums.proto.
994 optional android.telecom.CallStateEnum call_state = 1;
995
996 // The reason the call disconnected. Eg. ERROR, MISSED, REJECTED, BUSY.
997 // This value is only applicable when the call_state is DISCONNECTED, and
998 // should always be UNKNOWN if the call_state is not DISCONNECTED.
999 // From frameworks/base/core/proto/android/telecomm/enums.proto.
1000 optional android.telecom.DisconnectCauseEnum disconnect_cause = 2;
1001
1002 // True if the call is self-managed, which are apps that use the
1003 // telecom infrastructure to make their own calls.
1004 optional bool self_managed = 3;
1005
1006 // True if call is external. External calls are calls on connected Wear
1007 // devices but show up in Telecom so the user can pull them onto the device.
1008 optional bool external_call = 4;
1009}
1010
Tej Singh1ea42892018-01-19 09:27:00 -08001011/**
Tej Singhdd7bd352018-02-09 19:33:15 -08001012 * Logs keyguard state. The keyguard is the lock screen.
1013 *
1014 * Logged from:
1015 * frameworks/base/packages/SystemUI/src/com/android/systemui/statusbar/phone/StatusBarKeyguardViewManager.java
1016 */
1017message KeyguardStateChanged {
1018 enum State {
1019 UNKNOWN = 0;
1020 // The keyguard is hidden when the phone is unlocked.
1021 HIDDEN = 1;
1022 // The keyguard is shown when the phone is locked (screen turns off).
1023 SHOWN= 2;
1024 // The keyguard is occluded when something is overlaying the keyguard.
1025 // Eg. Opening the camera while on the lock screen.
1026 OCCLUDED = 3;
1027 }
1028 optional State state = 1;
1029}
1030
1031/**
1032 * Logs keyguard bouncer state. The bouncer is a part of the keyguard, and
1033 * prompts the user to enter a password (pattern, pin, etc).
1034 *
1035 * Logged from:
1036 * frameworks/base/packages/SystemUI/src/com/android/systemui/statusbar/phone/KeyguardBouncer.java
1037 */
1038
1039message KeyguardBouncerStateChanged {
1040 enum State {
1041 UNKNOWN = 0;
1042 // Bouncer is hidden, either as a result of successfully entering the
1043 // password, screen timing out, or user going back to lock screen.
1044 HIDDEN = 1;
1045 // This is when the user is being prompted to enter the password.
1046 SHOWN = 2;
1047 }
1048 optional State state = 1;
1049}
1050
1051/**
1052 * Logs the result of entering a password into the keyguard bouncer.
1053 *
1054 * Logged from:
1055 * frameworks/base/packages/SystemUI/src/com/android/keyguard/KeyguardSecurityContainer.java
1056 */
1057message KeyguardBouncerPasswordEntered {
1058 enum BouncerResult {
1059 UNKNOWN = 0;
1060 // The password entered was incorrect.
1061 FAILURE = 1;
1062 // The password entered was correct.
1063 SUCCESS = 2;
1064 }
1065 optional BouncerResult result = 1;
1066}
1067
Tej Singha883b372018-02-15 11:30:01 -08001068/*
1069 * Logs changes to the configuration of the device. The configuration is defined
1070 * in frameworks/base/core/java/android/content/res/Configuration.java
1071 * More documentation is at https://d.android.com/reference/android/content/res/Configuration.html
1072 * Please go there to interpret the possible values each field can be.
1073 *
1074 * Logged from:
1075 * frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
1076 */
1077message ResourceConfigurationChanged {
1078 // Bit mask of color capabilities of the screen.
1079 // Contains information about the color gamut and hdr mode of the screen.
1080 // See: https://d.android.com/reference/android/content/res/Configuration.html#colorMode
Yangster-maca8a30442018-10-13 23:46:34 -07001081 optional int32 color_mode = 1;
Tej Singha883b372018-02-15 11:30:01 -08001082
1083 // The target screen density being rendered to.
1084 // See: https://d.android.com/reference/android/content/res/Configuration.html#densityDpi
Yangster-maca8a30442018-10-13 23:46:34 -07001085 optional int32 density_dpi = 2;
Tej Singha883b372018-02-15 11:30:01 -08001086
1087 // Current user preference for the scaling factor for fonts,
1088 // relative to the base density scaling.
1089 // See: https://d.android.com/reference/android/content/res/Configuration.html#fontScale
Yangster-maca8a30442018-10-13 23:46:34 -07001090 optional float font_scale = 3;
Tej Singha883b372018-02-15 11:30:01 -08001091
1092 // Flag indicating whether the hard keyboard is hidden.
1093 // See: https://d.android.com/reference/android/content/res/Configuration.html#hardKeyboardHidden
Yangster-maca8a30442018-10-13 23:46:34 -07001094 optional int32 hard_keyboard_hidden = 4;
Tej Singha883b372018-02-15 11:30:01 -08001095
1096 // The type of keyboard attached to the device.
1097 // See: https://d.android.com/reference/android/content/res/Configuration.html#keyboard
1098 optional int32 keyboard = 5;
1099
1100 // Flag indicating whether any keyboard is available. Takes soft keyboards into account.
1101 // See: https://d.android.com/reference/android/content/res/Configuration.html#keyboardHidden
Yangster-maca8a30442018-10-13 23:46:34 -07001102 optional int32 keyboard_hidden = 6;
Tej Singha883b372018-02-15 11:30:01 -08001103
1104 // IMSI MCC (Mobile Country Code), corresponding to mcc resource qualifier.
1105 // 0 if undefined.
1106 // See: https://d.android.com/reference/android/content/res/Configuration.html#mcc
1107 optional int32 mcc = 7;
1108
1109 // IMSI MNC (Mobile Network Code), corresponding to mnc resource qualifier.
1110 // 0 if undefined. Note: the actual MNC may be 0, to check for this use the
1111 // MNC_ZERO symbol defined in Configuration.java.
1112 // See: https://d.android.com/reference/android/content/res/Configuration.html#mnc
1113 optional int32 mnc = 8;
1114
1115 // The kind of navigation available on the device.
1116 // See: https://developer.android.com/reference/android/content/res/Configuration.html#navigation
1117 optional int32 navigation = 9;
1118
1119 // Flag indicating whether the navigation is available.
1120 // See: https://d.android.com/reference/android/content/res/Configuration.html#navigationHidden
Yangster-maca8a30442018-10-13 23:46:34 -07001121 optional int32 navigation_hidden = 10;
Tej Singha883b372018-02-15 11:30:01 -08001122
1123 // Overall orientation of the screen.
1124 // See: https://d.android.com/reference/android/content/res/Configuration.html#orientation
1125 optional int32 orientation = 11;
1126
1127 // The current height of the available screen space, in dp units.
1128 // See: https://d.android.com/reference/android/content/res/Configuration.html#screenHeightDp
Yangster-maca8a30442018-10-13 23:46:34 -07001129 optional int32 screen_height_dp = 12;
Tej Singha883b372018-02-15 11:30:01 -08001130
1131 // Bit mask of overall layout of the screen.
1132 // Contains information about screen size, whether the screen is wider/taller
1133 // than normal, whether the screen layout is right-tl-left or left-to-right,
1134 // and whether the screen has a rounded shape.
1135 // See: https://d.android.com/reference/android/content/res/Configuration.html#screenLayout
Yangster-maca8a30442018-10-13 23:46:34 -07001136 optional int32 screen_layout = 13;
Tej Singha883b372018-02-15 11:30:01 -08001137
1138 // Current width of the available screen space, in dp units.
1139 // See: https://d.android.com/reference/android/content/res/Configuration.html#screenWidthDp
Yangster-maca8a30442018-10-13 23:46:34 -07001140 optional int32 screen_width_dp = 14;
Tej Singha883b372018-02-15 11:30:01 -08001141
1142 // The smallest screen size an application will see in normal operation.
1143 // This is the smallest value of both screenWidthDp and screenHeightDp
1144 // in portrait and landscape.
1145 // See: https://d.android.com/reference/android/content/res/Configuration.html#smallestScreenWidthDp
Yangster-maca8a30442018-10-13 23:46:34 -07001146 optional int32 smallest_screen_width_dp = 15;
Tej Singha883b372018-02-15 11:30:01 -08001147
1148 // The type of touch screen attached to the device.
1149 // See: https://d.android.com/reference/android/content/res/Configuration.html#touchscreen
1150 optional int32 touchscreen = 16;
1151
1152 // Bit mask of the ui mode.
1153 // Contains information about the overall ui mode of the device.
1154 // Eg: NORMAL, DESK, CAR, TELEVISION, WATCH, VR_HEADSET
1155 // Also contains information about whether the device is in night mode.
1156 // See: https://d.android.com/reference/android/content/res/Configuration.html#uiMode
Yangster-maca8a30442018-10-13 23:46:34 -07001157 optional int32 ui_mode = 17;
Tej Singha883b372018-02-15 11:30:01 -08001158}
1159
Tej Singheee317b2018-03-07 19:28:05 -08001160
1161/**
1162 * Logs changes in the connection state of the mobile radio.
1163 *
1164 * Logged from:
1165 * frameworks/opt/telephony/src/java/com/android/internal/telephony/dataconnection/DataConnection.java
1166 */
1167message MobileConnectionStateChanged {
1168 // States are from the state machine DataConnection.java.
1169 enum State {
1170 UNKNOWN = 0;
1171 // The connection is inactive, or disconnected.
1172 INACTIVE = 1;
1173 // The connection is being activated, or connecting.
1174 ACTIVATING = 2;
1175 // The connection is active, or connected.
1176 ACTIVE = 3;
1177 // The connection is disconnecting.
1178 DISCONNECTING = 4;
1179 // The connection is disconnecting after creating a connection.
1180 DISCONNECTION_ERROR_CREATING_CONNECTION = 5;
1181 }
1182 optional State state = 1;
1183 // For multi-sim phones, this distinguishes between the sim cards.
1184 optional int32 sim_slot_index = 2;
1185 // Used to identify the connection. Starts at 0 and increments by 1 for
1186 // every new network created. Resets whenever the device reboots.
1187 optional int32 data_connection_id = 3;
1188 // A bitmask for the capabilities of this connection.
1189 // Eg. DEFAULT (internet), MMS, SUPL, DUN, IMS.
1190 // Default value (if we have no information): 0
1191 optional int64 capabilities = 4;
1192 // If this connection has internet.
1193 // This just checks if the DEFAULT bit of capabilities is set.
1194 optional bool has_internet = 5;
1195}
1196
1197/**
1198 * Logs changes in mobile radio technology. eg: LTE, EDGE, CDMA.
1199 *
1200 * Logged from:
1201 * frameworks/opt/telephony/src/java/com/android/internal/telephony/ServiceStateTracker.java
1202 */
1203message MobileRadioTechnologyChanged {
1204 optional android.telephony.NetworkTypeEnum state = 1;
1205 // For multi-sim phones, this distinguishes between the sim cards.
1206 optional int32 sim_slot_index = 2;
1207}
1208
Andrew Chantb56388b2018-03-22 21:07:33 -07001209/**
1210 * Logs the VID and PID of any connected USB devices.
1211 *
1212 * Notes if any Audio, HID (input buttons/mouse/keyboard), or Storage interfaces are present.
1213 *
1214 * Logged by Vendor.
1215 */
1216message UsbDeviceAttached {
1217 optional int32 vid = 1;
1218 optional int32 pid = 2;
1219 optional bool has_audio = 3;
1220 optional bool has_hid = 4;
1221 optional bool has_storage = 5;
Badhri Jagan Sridharan5ec629f2018-11-16 15:39:22 -08001222 enum State {
1223 STATE_DISCONNECTED = 0;
1224 STATE_CONNECTED = 1;
1225 }
1226 optional State state = 6;
1227 optional int64 last_connect_duration_ms = 7;
Andrew Chantb56388b2018-03-22 21:07:33 -07001228}
1229
Tej Singheee317b2018-03-07 19:28:05 -08001230
Tej Singhdd7bd352018-02-09 19:33:15 -08001231/**
Tej Singh5d991e12018-03-09 19:48:11 -08001232 * Logs when Bluetooth is enabled and disabled.
1233 *
1234 * Logged from:
1235 * services/core/java/com/android/server/BluetoothManagerService.java
1236 */
1237message BluetoothEnabledStateChanged {
1238 repeated AttributionNode attribution_node = 1;
1239 // Whether or not bluetooth is enabled on the device.
1240 enum State {
1241 UNKNOWN = 0;
1242 ENABLED = 1;
1243 DISABLED = 2;
1244 }
1245 optional State state = 2;
1246 // The reason for being enabled/disabled.
1247 // Eg. Airplane mode, crash, application request.
1248 optional android.bluetooth.EnableDisableReasonEnum reason = 3;
1249 // If the reason is an application request, this will be the package name.
Yangster-maca8a30442018-10-13 23:46:34 -07001250 optional string pkg_name = 4;
Tej Singh5d991e12018-03-09 19:48:11 -08001251}
1252
1253/**
1254 * Logs when a Bluetooth device connects and disconnects.
1255 *
1256 * Logged from:
1257 * packages/apps/Bluetooth/src/com/android/bluetooth/btservice/AdapterProperties.java
1258 */
1259message BluetoothConnectionStateChanged {
1260 // The state of the connection.
1261 // Eg: CONNECTING, CONNECTED, DISCONNECTING, DISCONNECTED.
1262 optional android.bluetooth.ConnectionStateEnum state = 1;
1263 // An identifier that can be used to match connect and disconnect events.
1264 // Currently is last two bytes of a hash of a device level ID and
1265 // the mac address of the bluetooth device that is connected.
1266 optional int32 obfuscated_id = 2;
1267 // The profile that is connected. Eg. GATT, A2DP, HEADSET.
1268 // From android.bluetooth.BluetoothAdapter.java
1269 optional int32 bt_profile = 3;
1270}
1271
1272/**
Andrew Chant28d627e2018-02-22 15:17:05 -08001273 * Logs when something is plugged into or removed from the USB-C connector.
1274 *
1275 * Logged from:
Badhri Jagan Sridharan223b3c72018-11-16 16:02:35 -08001276 * UsbService
Andrew Chant28d627e2018-02-22 15:17:05 -08001277 */
1278message UsbConnectorStateChanged {
1279 enum State {
Badhri Jagan Sridharan223b3c72018-11-16 16:02:35 -08001280 STATE_DISCONNECTED = 0;
1281 STATE_CONNECTED = 1;
Andrew Chant28d627e2018-02-22 15:17:05 -08001282 }
1283 optional State state = 1;
Badhri Jagan Sridharan223b3c72018-11-16 16:02:35 -08001284 optional string id = 2;
Badhri Jagan Sridharanfaf62072018-11-16 17:17:03 -08001285 // Last active session in ms.
1286 // 0 when the port is in connected state.
1287 optional int64 last_connect_duration_millis = 3;
Andrew Chant28d627e2018-02-22 15:17:05 -08001288}
1289
1290/**
1291 * Logs the reported speaker impedance.
1292 *
1293 * Logged from:
1294 * Vendor audio implementation.
1295 */
1296message SpeakerImpedanceReported {
1297 optional int32 speaker_location = 1;
1298 optional int32 impedance = 2;
1299}
1300
1301/**
1302 * Logs the report of a failed hardware.
1303 *
1304 * Logged from:
1305 * Vendor HALs.
1306 *
1307 */
1308message HardwareFailed {
1309 enum HardwareType {
1310 HARDWARE_FAILED_UNKNOWN = 0;
1311 HARDWARE_FAILED_MICROPHONE = 1;
1312 HARDWARE_FAILED_CODEC = 2;
1313 HARDWARE_FAILED_SPEAKER = 3;
1314 HARDWARE_FAILED_FINGERPRINT = 4;
1315 }
1316 optional HardwareType hardware_type = 1;
1317
1318 /* hardware_location allows vendors to differentiate between multiple instances of
1319 * the same hardware_type. The specific locations are vendor defined integers,
1320 * referring to board-specific numbering schemes.
1321 */
1322 optional int32 hardware_location = 2;
1323
1324 /* failure_code is specific to the HardwareType of the failed hardware.
1325 * It should use the enum values defined below.
1326 */
1327 enum MicrophoneFailureCode {
1328 MICROPHONE_FAILURE_COMPLETE = 0;
1329 }
1330 enum CodecFailureCode {
1331 CODEC_FAILURE_COMPLETE = 0;
1332 }
1333 enum SpeakerFailureCode {
1334 SPEAKER_FAILURE_COMPLETE = 0;
1335 SPEAKER_FAILURE_HIGH_Z = 1;
1336 SPEAKER_FAILURE_SHORT = 2;
1337 }
1338 enum FingerprintFailureCode {
1339 FINGERPRINT_FAILURE_COMPLETE = 0;
1340 FINGERPRINT_SENSOR_BROKEN = 1;
1341 FINGERPRINT_TOO_MANY_DEAD_PIXELS = 2;
1342 }
1343 optional int32 failure_code = 3;
1344}
1345
1346/**
1347 * Log an event when the device has been physically dropped.
1348 * Reported from the /vendor partition.
1349 */
1350message PhysicalDropDetected {
1351 // Confidence that the event was actually a drop, 0 -> 100
1352 optional int32 confidence_pctg = 1;
1353 // Peak acceleration of the drop, in 1/1000s of a g.
1354 optional int32 accel_peak_thousandths_g = 2;
Andrew Chantb56388b2018-03-22 21:07:33 -07001355 // Duration of freefall in ms
1356 optional int32 freefall_time_millis = 3;
Andrew Chant28d627e2018-02-22 15:17:05 -08001357}
1358
1359/**
1360 * Log bucketed battery charge cycles.
1361 *
1362 * Each bucket represents cycles of the battery past
Maggie White38c9d322018-11-20 10:07:52 -08001363 * a given charge point. For example, if 10 cycle buckets are
1364 * initialized, bucket 1 is the lowest 1/10th of the battery,
1365 * and bucket 10 is 100%.
Andrew Chant28d627e2018-02-22 15:17:05 -08001366 *
1367 * Logged from:
1368 * /sys/class/power_supply/bms/cycle_count, via Vendor.
1369 */
1370message ChargeCyclesReported {
1371 optional int32 cycle_bucket_1 = 1;
1372 optional int32 cycle_bucket_2 = 2;
1373 optional int32 cycle_bucket_3 = 3;
1374 optional int32 cycle_bucket_4 = 4;
1375 optional int32 cycle_bucket_5 = 5;
1376 optional int32 cycle_bucket_6 = 6;
1377 optional int32 cycle_bucket_7 = 7;
1378 optional int32 cycle_bucket_8 = 8;
Maggie White38c9d322018-11-20 10:07:52 -08001379 optional int32 cycle_bucket_9 = 9;
1380 optional int32 cycle_bucket_10 = 10;
Andrew Chant28d627e2018-02-22 15:17:05 -08001381}
1382
1383/**
Howard Roa46b6582018-09-18 16:45:02 -07001384 * Log battery health snapshot.
1385 *
1386 * Resistance, Voltage, Open Circuit Voltage, Temperature, and Charge Level
1387 * are snapshotted periodically over 24hrs.
1388 */
1389message BatteryHealthSnapshot {
1390 enum BatterySnapshotType {
1391 UNKNOWN = 0;
1392 MIN_TEMP = 1; // Snapshot at min batt temp over 24hrs.
1393 MAX_TEMP = 2; // Snapshot at max batt temp over 24hrs.
1394 MIN_RESISTANCE = 3; // Snapshot at min batt resistance over 24hrs.
1395 MAX_RESISTANCE = 4; // Snapshot at max batt resistance over 24hrs.
1396 MIN_VOLTAGE = 5; // Snapshot at min batt voltage over 24hrs.
1397 MAX_VOLTAGE = 6; // Snapshot at max batt voltage over 24hrs.
1398 MIN_CURRENT = 7; // Snapshot at min batt current over 24hrs.
1399 MAX_CURRENT = 8; // Snapshot at max batt current over 24hrs.
1400 MIN_BATT_LEVEL = 9; // Snapshot at min battery level (SoC) over 24hrs.
1401 MAX_BATT_LEVEL = 10; // Snapshot at max battery level (SoC) over 24hrs.
1402 AVG_RESISTANCE = 11; // Snapshot at average battery resistance over 24hrs.
1403 }
1404 optional BatterySnapshotType type = 1;
1405 // Temperature, in 1/10ths of degree C.
Yangster-maca8a30442018-10-13 23:46:34 -07001406 optional int32 temperature_deci_celsius = 2;
Howard Roa46b6582018-09-18 16:45:02 -07001407 // Voltage Battery Voltage, in microVolts.
1408 optional int32 voltage_micro_volt = 3;
1409 // Current Battery current, in microAmps.
1410 optional int32 current_micro_amps = 4;
1411 // OpenCircuitVoltage Battery Open Circuit Voltage, in microVolts.
1412 optional int32 open_circuit_micro_volt = 5;
1413 // Resistance Battery Resistance, in microOhms.
1414 optional int32 resistance_micro_ohm = 6;
1415 // Level Battery Level, as % of full.
1416 optional int32 level_percent = 7;
1417}
1418
1419/**
1420 * Log slow I/O operations on the primary storage.
1421 */
1422message SlowIo {
1423 // Classifications of IO Operations.
1424 enum IoOperation {
1425 UNKNOWN = 0;
1426 READ = 1;
1427 WRITE = 2;
1428 UNMAP = 3;
1429 SYNC = 4;
1430 }
1431 optional IoOperation operation = 1;
1432
1433 // The number of slow IO operations of this type over 24 hours.
1434 optional int32 count = 2;
1435}
1436
1437/**
1438 * Log battery caused shutdown with the last recorded voltage.
1439 */
1440message BatteryCausedShutdown {
1441 // The last recorded battery voltage prior to shutdown.
1442 optional int32 last_recorded_micro_volt = 1;
1443}
1444
1445/**
Tej Singhbb8554a2018-01-26 11:59:14 -08001446 * Logs the duration of a davey (jank of >=700ms) when it occurs
1447 *
1448 * Logged from:
1449 * frameworks/base/libs/hwui/JankTracker.cpp
1450 */
1451message DaveyOccurred {
David Chen77ef6712018-02-23 18:23:42 -08001452 // The UID that logged this atom.
Yao Chenc40a19d2018-03-15 16:48:25 -07001453 optional int32 uid = 1 [(is_uid) = true];
David Chen77ef6712018-02-23 18:23:42 -08001454
Tej Singhbb8554a2018-01-26 11:59:14 -08001455 // Amount of time it took to render the frame. Should be >=700ms.
David Chen77ef6712018-02-23 18:23:42 -08001456 optional int64 jank_duration_millis = 2;
Tej Singhbb8554a2018-01-26 11:59:14 -08001457}
1458
1459/**
Bookatze5885242017-10-24 20:10:31 -07001460 * Logs phone signal strength changes.
1461 *
1462 * Logged from:
David Chenc28b2bb2017-10-24 12:52:52 -07001463 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
Bookatze5885242017-10-24 20:10:31 -07001464 */
1465message PhoneSignalStrengthChanged {
Bookatz1a1b0462018-01-12 11:47:03 -08001466 // Signal strength, from frameworks/base/core/proto/android/telephony/enums.proto.
1467 optional android.telephony.SignalStrengthEnum signal_strength = 1;
David Chenc28b2bb2017-10-24 12:52:52 -07001468}
1469
Yangster4ccebea2018-10-09 17:09:02 -07001470
1471/**
1472 * Logs when the phone state, sim state or signal strength changes
1473 *
1474 * Logged from:
1475 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
1476 */
1477message PhoneServiceStateChanged {
1478 optional android.telephony.ServiceStateEnum state = 1;
1479 optional android.telephony.SimStateEnum sim_state = 2;
1480 optional android.telephony.SignalStrengthEnum signal_strength = 3;
1481}
1482
1483/**
1484 * Logs when the phone becomes on or off.
1485 *
1486 * Logged from:
1487 * frameworks/base/core/java/com/android/internal/os/TelephonyRegistry.java
1488 */
1489message PhoneStateChanged {
1490 enum State {
1491 OFF = 0;
1492 ON = 1;
1493 }
1494 optional State state = 1;
1495}
1496
Hyunyoung Songc6d6b772018-10-17 13:35:32 -07001497message LauncherUIChanged {
Yao Chen8c433862018-10-24 14:09:20 -07001498 optional android.stats.launcher.LauncherAction action = 1;
1499 optional android.stats.launcher.LauncherState src_state = 2;
1500 optional android.stats.launcher.LauncherState dst_state = 3;
1501 optional android.stats.launcher.LauncherExtension extension = 4 [(log_mode) = MODE_BYTES];
Hyunyoung Songc6d6b772018-10-17 13:35:32 -07001502 optional bool is_swipe_up_enabled = 5;
1503}
1504
David Chenc28b2bb2017-10-24 12:52:52 -07001505/**
Fan Zhang916c13b2018-10-16 22:49:45 -07001506 * Logs when Settings UI has changed.
1507 *
1508 * Logged from:
1509 * packages/apps/Settings
1510 */
1511message SettingsUIChanged {
1512 /**
Fan Zhang916c13b2018-10-16 22:49:45 -07001513 * Where this SettingsUIChange event comes from. For example, if
1514 * it's a PAGE_VISIBLE event, where the page is opened from.
1515 */
Fan Zhangf837b8e2018-10-23 12:38:30 -07001516 optional android.app.settings.PageId attribution = 1;
Fan Zhang916c13b2018-10-16 22:49:45 -07001517
1518 /**
1519 * What the UI action is.
1520 */
Fan Zhangf837b8e2018-10-23 12:38:30 -07001521 optional android.app.settings.Action action = 2;
Fan Zhang916c13b2018-10-16 22:49:45 -07001522
1523 /**
1524 * Where the action is happening
1525 */
Fan Zhangff2332b2018-12-06 15:16:41 -08001526 optional android.app.settings.PageId page_id = 3;
Fan Zhang916c13b2018-10-16 22:49:45 -07001527
1528 /**
1529 * What preference changed in this event.
1530 */
Fan Zhangff2332b2018-12-06 15:16:41 -08001531 optional string changed_preference_key = 4;
Fan Zhang916c13b2018-10-16 22:49:45 -07001532
1533 /**
1534 * The new value of the changed preference.
1535 */
Fan Zhangff2332b2018-12-06 15:16:41 -08001536 optional int64 changed_preference_int_value = 5;
Fan Zhang916c13b2018-10-16 22:49:45 -07001537}
1538
1539/**
David Chenc28b2bb2017-10-24 12:52:52 -07001540 * Logs that a setting was updated.
1541 * Logged from:
David Chenbd789912018-03-16 17:19:55 -07001542 * frameworks/base/packages/SettingsProvider/src/com/android/providers/settings/SettingsState.java
David Chenc28b2bb2017-10-24 12:52:52 -07001543 * The tag and is_default allow resetting of settings to default values based on the specified
1544 * tag. See Settings#putString(ContentResolver, String, String, String, boolean) for more details.
1545 */
1546message SettingChanged {
1547 // The name of the setting.
1548 optional string setting = 1;
1549
1550 // The change being imposed on this setting. May represent a number, eg "3".
1551 optional string value = 2;
1552
1553 // The new value of this setting. For most settings, this is same as value. For some settings,
1554 // value is +X or -X where X represents an element in a set. For example, if the previous value
1555 // is A,B,C and value is -B, then new_value is A,C and prev_value is A,B,C.
1556 // The +/- feature is currently only used for location_providers_allowed.
1557 optional string new_value = 3;
1558
1559 // The previous value of this setting.
1560 optional string prev_value = 4;
1561
1562 // The tag used with the is_default for resetting sets of settings. This is generally null.
1563 optional string tag = 5;
1564
Bookatz90867622018-01-31 15:05:57 -08001565 // True if this setting with tag should be resettable.
1566 optional bool is_default = 6;
David Chenc28b2bb2017-10-24 12:52:52 -07001567
David Chenbd789912018-03-16 17:19:55 -07001568 // The associated user (for multi-user feature). Defined in android/os/UserHandle.java
David Chenc28b2bb2017-10-24 12:52:52 -07001569 optional int32 user = 7;
David Chenbd789912018-03-16 17:19:55 -07001570
1571 enum ChangeReason {
1572 UPDATED = 1; // Updated can be an insertion or an update.
1573 DELETED = 2;
1574 }
1575 optional ChangeReason reason = 8;
David Chenc28b2bb2017-10-24 12:52:52 -07001576}
Chenjie Yub3dda412017-10-24 13:41:59 -07001577
Chenjie Yu05013b32017-11-21 10:21:41 -08001578/**
Chenjie Yu3d4f6042017-10-27 15:39:34 -07001579 * Logs activity going to foreground or background
1580 *
1581 * Logged from:
1582 * frameworks/base/services/core/java/com/android/server/am/ActivityRecord.java
1583 */
1584message ActivityForegroundStateChanged {
Yao Chenc40a19d2018-03-15 16:48:25 -07001585 optional int32 uid = 1 [(is_uid) = true];
Yangster-mac20877162017-12-22 17:19:39 -08001586 optional string pkg_name = 2;
1587 optional string class_name = 3;
1588
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001589 enum State {
1590 BACKGROUND = 0;
1591 FOREGROUND = 1;
Chenjie Yu3d4f6042017-10-27 15:39:34 -07001592 }
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001593 optional State state = 4;
Chenjie Yu3d4f6042017-10-27 15:39:34 -07001594}
David Chenc8a43242017-10-17 16:23:28 -07001595
1596/**
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001597 * Logs when an app crashes.
David Chen9e3808c2017-11-20 17:25:34 -08001598 * Logged from:
1599 * frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
1600 */
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001601message AppCrashOccurred {
Yao Chenc40a19d2018-03-15 16:48:25 -07001602 optional int32 uid = 1 [(is_uid) = true];
David Chen9e3808c2017-11-20 17:25:34 -08001603
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001604 optional string event_type = 2;
David Chen9e3808c2017-11-20 17:25:34 -08001605
1606 // The name of the process.
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001607 // system_server if it is not by an app
David Chen9e3808c2017-11-20 17:25:34 -08001608 optional string process_name = 3;
1609
1610 // The pid if available. -1 means not available.
David Chen6e3e6cb2018-01-03 16:14:06 -08001611 optional sint32 pid = 4;
Chenjie Yuf17bf622018-04-02 14:22:19 -07001612
1613 optional string package_name = 5;
1614
1615 enum InstantApp {
1616 UNAVAILABLE = 0;
1617 FALSE = 1;
1618 TRUE = 2;
1619 }
1620 optional InstantApp is_instant_app = 6;
1621
1622 enum ForegroundState {
1623 UNKNOWN = 0;
1624 BACKGROUND = 1;
1625 FOREGROUND = 2;
1626 }
1627 optional ForegroundState foreground_state = 7;
Yang Lu732d6382018-11-05 07:53:12 -08001628
1629 optional android.server.ErrorSource error_source = 8;
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001630}
David Chen9e3808c2017-11-20 17:25:34 -08001631
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001632/**
1633 * Logs when a WTF (What a Terrible Failure) happened.
1634 * Logged from:
1635 * frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
1636 */
1637message WTFOccurred {
1638 optional int32 uid = 1 [(is_uid) = true];
David Chen9e3808c2017-11-20 17:25:34 -08001639
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001640 optional string tag = 2;
David Chen9e3808c2017-11-20 17:25:34 -08001641
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001642 // The name of the process.
1643 // system_server if it is not by an app
1644 optional string process_name = 3;
David Chen6e3e6cb2018-01-03 16:14:06 -08001645
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001646 // The pid if available. -1 means not available.
1647 optional sint32 pid = 4;
Yang Lu732d6382018-11-05 07:53:12 -08001648
1649 optional android.server.ErrorSource error_source = 5;
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001650}
1651
1652/**
1653 * Logs when system server reports low memory.
1654 * Logged from:
1655 * frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
1656 */
1657message LowMemReported {
1658}
1659
1660/**
1661 * Logs when an app ANR (App Not Responding) occurs.
1662 * Logged from:
1663 * frameworks/base/services/core/java/com/android/server/am/AppErrors.java
1664 */
1665message ANROccurred {
1666 optional int32 uid = 1 [(is_uid) = true];
1667
1668 optional string process_name = 2;
1669
1670 optional string short_component_name = 3;
1671
1672 optional string reason = 4;
Chenjie Yuf17bf622018-04-02 14:22:19 -07001673
1674 enum InstantApp {
1675 UNAVAILABLE = 0;
1676 FALSE = 1;
1677 TRUE = 2;
1678 }
1679 optional InstantApp is_instant_app = 5;
1680
1681 enum ForegroundState {
1682 UNKNOWN = 0;
1683 BACKGROUND = 1;
1684 FOREGROUND = 2;
1685 }
1686 optional ForegroundState foreground_state = 6;
Yang Lu732d6382018-11-05 07:53:12 -08001687
1688 optional android.server.ErrorSource error_source = 7;
1689
1690 optional string package_name = 8;
David Chen9e3808c2017-11-20 17:25:34 -08001691}
1692
Bookatza7020bd2018-08-28 16:29:35 -07001693/**
1694 * Logs when the vibrator state changes.
1695 * Logged from:
1696 * frameworks/base/services/core/java/com/android/server/VibratorService.java
1697 */
1698message VibratorStateChanged {
1699 repeated AttributionNode attribution_node = 1;
1700
1701 enum State {
1702 OFF = 0;
1703 ON = 1;
1704 }
1705 optional State state = 2;
1706
1707 // Duration (in milliseconds) requested to keep the vibrator on.
1708 // Only applicable for State == ON.
1709 optional int64 duration_millis = 3;
1710}
1711
David Chen0a368b22017-12-06 16:28:16 -08001712/*
1713 * Allows other apps to push events into statsd.
1714 * Logged from:
1715 * frameworks/base/core/java/android/util/StatsLog.java
1716 */
David Chen0b5c90c2018-01-25 16:51:49 -08001717message AppBreadcrumbReported {
David Chen0a368b22017-12-06 16:28:16 -08001718 // The uid of the application that sent this custom atom.
Yao Chenc40a19d2018-03-15 16:48:25 -07001719 optional int32 uid = 1 [(is_uid) = true];
David Chen0a368b22017-12-06 16:28:16 -08001720
1721 // An arbitrary label chosen by the developer. For Android P, the label should be in [0, 16).
1722 optional int32 label = 2;
1723
1724 // Allows applications to easily use a custom event as start/stop boundaries (ie, define custom
1725 // predicates for the metrics).
1726 enum State {
1727 UNKNOWN = 0;
1728 UNSPECIFIED = 1; // For events that are known to not represent START/STOP.
1729 STOP = 2;
1730 START = 3;
1731 }
1732 optional State state = 3;
1733}
1734
David Chen9e3808c2017-11-20 17:25:34 -08001735/**
Bookatz7948c872018-09-04 12:58:33 -07001736 * Logs the wall-clock time when a significant wall-clock time shift occurs.
1737 * For example, this could be due to the user manually changing the time.
1738 *
1739 * Logged from:
1740 * frameworks/base/services/core/java/com/android/server/AlarmManagerService.java
1741 */
1742message WallClockTimeShifted {
1743 // New wall-clock time in milliseconds, according to System.currentTimeMillis().
1744 optional int64 wall_clock_timestamp_millis = 1;
1745}
1746
1747/**
Bookatz8fcd09a2017-12-18 13:01:10 -08001748 * Logs when statsd detects an anomaly.
1749 *
1750 * Logged from:
1751 * frameworks/base/cmds/statsd/src/anomaly/AnomalyTracker.cpp
1752 */
1753message AnomalyDetected {
1754 // Uid that owns the config whose anomaly detection alert fired.
Yao Chenc40a19d2018-03-15 16:48:25 -07001755 optional int32 config_uid = 1 [(is_uid) = true];
Bookatz8fcd09a2017-12-18 13:01:10 -08001756
Yangster-mac94e197c2018-01-02 16:03:03 -08001757 // Id of the config whose anomaly detection alert fired.
1758 optional int64 config_id = 2;
Bookatz8fcd09a2017-12-18 13:01:10 -08001759
Yangster-mac94e197c2018-01-02 16:03:03 -08001760 // Id of the alert (i.e. name of the anomaly that was detected).
1761 optional int64 alert_id = 3;
Bookatz8fcd09a2017-12-18 13:01:10 -08001762}
1763
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001764message AppStartOccurred {
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001765 // The uid if available. -1 means not available.
Yao Chenc40a19d2018-03-15 16:48:25 -07001766 optional int32 uid = 1 [(is_uid) = true];
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001767
1768 // The app package name.
1769 optional string pkg_name = 2;
1770
1771 enum TransitionType {
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001772 UNKNOWN = 0;
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001773 WARM = 1;
1774 HOT = 2;
1775 COLD = 3;
1776 }
1777 // The transition type.
1778 optional TransitionType type = 3;
1779
1780 // The activity name.
1781 optional string activity_name = 4;
1782
1783 // The name of the calling app. Empty if not set.
1784 optional string calling_pkg_name = 5;
1785
1786 // Whether the app is an instant app.
1787 optional bool is_instant_app = 6;
1788
1789 // Device uptime when activity started.
David Chen0b5c90c2018-01-25 16:51:49 -08001790 optional int64 activity_start_millis = 7;
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001791
Bookatz80d11a02018-01-16 10:46:35 -08001792 optional android.app.AppTransitionReasonEnum reason = 8;
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001793
David Chen0b5c90c2018-01-25 16:51:49 -08001794 optional int32 transition_delay_millis = 9;
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001795 // -1 if not set.
David Chen0b5c90c2018-01-25 16:51:49 -08001796 optional int32 starting_window_delay_millis = 10;
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001797 // -1 if not set.
David Chen0b5c90c2018-01-25 16:51:49 -08001798 optional int32 bind_application_delay_millis = 11;
1799 optional int32 windows_drawn_delay_millis = 12;
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001800
1801 // Empty if not set.
1802 optional string launch_token = 13;
1803
Calin Juravle759fbda2018-02-20 19:52:30 +00001804 // The compiler filter used when when the package was optimized.
Calin Juravlea86783b2018-03-21 14:25:59 -07001805 optional int32 package_optimization_compilation_filter = 14;
Calin Juravle759fbda2018-02-20 19:52:30 +00001806
1807 // The reason why the package was optimized.
Calin Juravlea86783b2018-03-21 14:25:59 -07001808 optional int32 package_optimization_compilation_reason = 15;
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001809}
1810
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001811message AppStartCanceled {
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001812 // The uid if available. -1 means not available.
Yao Chenc40a19d2018-03-15 16:48:25 -07001813 optional int32 uid = 1 [(is_uid) = true];
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001814
1815 // The app package name.
1816 optional string pkg_name = 2;
1817
1818 enum TransitionType {
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001819 UNKNOWN = 0;
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001820 WARM = 1;
1821 HOT = 2;
1822 COLD = 3;
1823 }
1824 // The transition type.
1825 optional TransitionType type = 3;
1826
1827 // The activity name.
1828 optional string activity_name = 4;
1829}
1830
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001831message AppStartFullyDrawn {
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001832 // The uid if available. -1 means not available.
Yao Chenc40a19d2018-03-15 16:48:25 -07001833 optional int32 uid = 1 [(is_uid) = true];
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001834
1835 // The app package name.
1836 optional string pkg_name = 2;
1837
1838 enum TransitionType {
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001839 UNKNOWN = 0;
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001840 WITH_BUNDLE = 1;
1841 WITHOUT_BUNDLE = 2;
1842 }
1843 // The transition type.
1844 optional TransitionType type = 3;
1845
1846 // The activity name.
1847 optional string activity_name = 4;
1848
1849 optional bool transition_process_running = 5;
1850
1851 // App startup time (until call to Activity#reportFullyDrawn()).
David Chen0b5c90c2018-01-25 16:51:49 -08001852 optional int64 app_startup_time_millis = 6;
Olivier Gaillardaed7f122017-12-12 14:26:22 +00001853}
1854
Bookatz8fcd09a2017-12-18 13:01:10 -08001855/**
Chenjie Yu52cacc62017-12-08 18:11:45 -08001856 * Logs a picture-in-picture action
1857 * Logged from:
1858 * frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
1859 * frameworks/base/services/core/java/com/android/server/am/ActivityStackSupervisor.java
1860 * frameworks/base/packages/SystemUI/src/com/android/systemui/pip/phone/PipTouchHandler.java
1861 */
1862message PictureInPictureStateChanged {
Chenjie Yuae9fdf042018-02-15 10:19:32 -08001863 // -1 if it is not available
Yao Chenc40a19d2018-03-15 16:48:25 -07001864 optional int32 uid = 1 [(is_uid) = true];
Chenjie Yu52cacc62017-12-08 18:11:45 -08001865
Chenjie Yuae9fdf042018-02-15 10:19:32 -08001866 optional string short_name = 2;
Chenjie Yu52cacc62017-12-08 18:11:45 -08001867
Chenjie Yu52cacc62017-12-08 18:11:45 -08001868 enum State {
1869 ENTERED = 1;
1870 EXPANDED_TO_FULL_SCREEN = 2;
1871 MINIMIZED = 3;
1872 DISMISSED = 4;
1873 }
Chenjie Yuae9fdf042018-02-15 10:19:32 -08001874 optional State state = 3;
Chenjie Yu52cacc62017-12-08 18:11:45 -08001875}
1876
1877/**
Chenjie Yue8904192017-12-08 19:12:57 -08001878 * Logs overlay action
1879 * Logged from:
1880 * services/core/java/com/android/server/wm/Session.java
1881 */
1882message OverlayStateChanged {
Yao Chenc40a19d2018-03-15 16:48:25 -07001883 optional int32 uid = 1 [(is_uid) = true];
Chenjie Yue8904192017-12-08 19:12:57 -08001884
1885 optional string package_name = 2;
1886
1887 optional bool using_alert_window = 3;
1888
1889 enum State {
1890 ENTERED = 1;
1891 EXITED = 2;
1892 }
1893 optional State state = 4;
1894}
1895
Chenjie Yuccfe6452018-01-30 11:33:21 -08001896/*
1897 * Logs foreground service starts and stops.
1898 * Note that this is not when a service starts or stops, but when it is
1899 * considered foreground.
1900 * Logged from
1901 * //frameworks/base/services/core/java/com/android/server/am/ActiveServices.java
1902 */
1903message ForegroundServiceStateChanged {
Yao Chenc40a19d2018-03-15 16:48:25 -07001904 optional int32 uid = 1 [(is_uid) = true];
Chenjie Yuccfe6452018-01-30 11:33:21 -08001905 // package_name + "/" + class_name
1906 optional string short_name = 2;
1907
1908 enum State {
1909 ENTER = 1;
1910 EXIT = 2;
1911 }
1912 optional State state = 3;
1913}
1914
Chenjie Yue8904192017-12-08 19:12:57 -08001915/**
Chenjie Yubbcbc602018-02-05 16:51:52 -08001916 * Logs creation or removal of an isolated uid. Isolated uid's are temporary uid's to sandbox risky
1917 * behavior in its own uid. However, the metrics of these isolated uid's almost always should be
1918 * attributed back to the parent (host) uid. One example is Chrome.
1919 *
1920 * Logged from:
1921 * frameworks/base/core/java/com/android/internal/os/BatteryStatsImpl.java
1922 */
1923message IsolatedUidChanged {
1924 // The host UID. Generally, we should attribute metrics from the isolated uid to the host uid.
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08001925 // NOTE: DO NOT annotate uid field in this atom. This atom is specially handled in statsd.
Bookatz3c648862018-05-25 13:32:43 -07001926 // This field is ignored when event == REMOVED.
Chenjie Yubbcbc602018-02-05 16:51:52 -08001927 optional int32 parent_uid = 1;
1928
1929 optional int32 isolated_uid = 2;
1930
1931 // We expect an isolated uid to be removed before if it's used for another parent uid.
1932 enum Event {
1933 REMOVED = 0;
1934 CREATED = 1;
1935 }
1936 optional Event event = 3;
1937}
1938
1939/*
1940 * Logs the reception of an incoming network packet causing the main system to wake up for
1941 * processing that packet. These events are notified by the kernel via Netlink NFLOG to Netd
1942 * and processed by WakeupController.cpp.
1943 */
1944message PacketWakeupOccurred {
1945 // The uid owning the socket into which the packet was delivered, or -1 if the packet was
1946 // delivered nowhere.
Yao Chenc40a19d2018-03-15 16:48:25 -07001947 optional int32 uid = 1 [(is_uid) = true];
Chenjie Yubbcbc602018-02-05 16:51:52 -08001948 // The interface name on which the packet was received.
1949 optional string iface = 2;
1950 // The ethertype value of the packet.
1951 optional int32 ethertype = 3;
1952 // String representation of the destination MAC address of the packet.
1953 optional string destination_hardware_address = 4;
1954 // String representation of the source address of the packet if this was an IP packet.
1955 optional string source_ip = 5;
1956 // String representation of the destination address of the packet if this was an IP packet.
1957 optional string destination_ip = 6;
1958 // The value of the protocol field if this was an IPv4 packet or the value of the Next Header
1959 // field if this was an IPv6 packet. The range of possible values is the same for both IP
1960 // families.
1961 optional int32 ip_next_header = 7;
1962 // The source port if this was a TCP or UDP packet.
1963 optional int32 source_port = 8;
1964 // The destination port if this was a TCP or UDP packet.
1965 optional int32 destination_port = 9;
1966}
1967
1968/*
1969 * Logs the memory stats for an app on startup.
1970 * Logged from:
1971 * frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
1972 */
1973message AppStartMemoryStateCaptured {
1974 // The uid if available. -1 means not available.
Yao Chenc40a19d2018-03-15 16:48:25 -07001975 optional int32 uid = 1 [(is_uid) = true];
Chenjie Yubbcbc602018-02-05 16:51:52 -08001976
1977 // The process name.
1978 optional string process_name = 2;
1979
1980 // The activity name.
1981 optional string activity_name = 3;
1982
1983 // # of page-faults
Yangster-maca8a30442018-10-13 23:46:34 -07001984 optional int64 page_fault = 4;
Chenjie Yubbcbc602018-02-05 16:51:52 -08001985
1986 // # of major page-faults
Yangster-maca8a30442018-10-13 23:46:34 -07001987 optional int64 page_major_fault = 5;
Chenjie Yubbcbc602018-02-05 16:51:52 -08001988
1989 // RSS
1990 optional int64 rss_in_bytes = 6;
1991
1992 // CACHE
1993 optional int64 cache_in_bytes = 7;
1994
1995 // SWAP
1996 optional int64 swap_in_bytes = 8;
1997}
1998
1999/*
2000 * Logs the change in Low Memory Killer Daemon (LMKD) state which is used as start/stop boundaries
2001 * for LMK event.
2002 * Logged from:
2003 * system/core/lmkd/lmkd.c
2004 */
2005message LmkStateChanged {
2006 enum State {
2007 UNKNOWN = 0;
2008 START = 1;
2009 STOP = 2;
2010 }
2011 optional State state = 1;
2012}
2013
2014/*
2015 * Logs the event when Low Memory Killer Daemon (LMKD) kills a process to reduce memory pressure.
2016 * Logged from:
2017 * system/core/lmkd/lmkd.c
2018 */
2019message LmkKillOccurred {
2020 // The uid if available. -1 means not available.
Yao Chenc40a19d2018-03-15 16:48:25 -07002021 optional int32 uid = 1 [(is_uid) = true];
Chenjie Yubbcbc602018-02-05 16:51:52 -08002022
2023 // The process name.
2024 optional string process_name = 2;
2025
2026 // oom adj score.
Yangster-maca8a30442018-10-13 23:46:34 -07002027 optional int32 oom_adj_score = 3;
Chenjie Yubbcbc602018-02-05 16:51:52 -08002028
2029 // # of page-faults
Yangster-maca8a30442018-10-13 23:46:34 -07002030 optional int64 page_fault = 4;
Chenjie Yubbcbc602018-02-05 16:51:52 -08002031
2032 // # of major page-faults
Yangster-maca8a30442018-10-13 23:46:34 -07002033 optional int64 page_major_fault = 5;
Chenjie Yubbcbc602018-02-05 16:51:52 -08002034
2035 // RSS
2036 optional int64 rss_in_bytes = 6;
2037
2038 // CACHE
2039 optional int64 cache_in_bytes = 7;
2040
2041 // SWAP
2042 optional int64 swap_in_bytes = 8;
Jim Blackler8593d1f2018-11-21 15:24:48 +00002043
2044 // The elapsed real time of start of the process.
2045 optional int64 process_start_time_nanos = 9;
Chenjie Yubbcbc602018-02-05 16:51:52 -08002046}
2047
Rajeev Kumar51b54602018-03-01 12:18:26 -08002048/*
2049 * Logs when the ActivityManagerService detects that an app died.
2050 *
2051 * Logged from:
2052 * frameworks/base/services/core/java/com/android/server/am/ActivityManagerService.java
2053 */
2054message AppDied {
2055 // timestamp(elapsedRealtime) of record creation
Yangster-macb6b77c62018-10-12 19:33:24 -07002056 optional uint64 timestamp_millis = 1 [(state_field_option).option = EXCLUSIVE];
Rajeev Kumar51b54602018-03-01 12:18:26 -08002057}
2058
Howard Ro21a039c2018-08-06 14:55:47 -07002059/**
2060 * An atom for generic metrics logging. Available from Android Q.
2061 */
2062message GenericAtom {
2063 // The uid of the application that sent this custom atom.
2064 optional int32 uid = 1 [(is_uid) = true];
2065
2066 // An event_id indicates the type of event.
Howard Ro9a862de2018-10-11 16:03:33 -07002067 optional android.stats.EventType event_id = 2;
Howard Ro21a039c2018-08-06 14:55:47 -07002068}
2069
Tej Singhd6d6d772018-09-05 17:41:25 -07002070/**
2071 * Logs when a fingerprint acquire event occurs.
2072 *
2073 * Logged from:
2074 * frameworks/base/services/core/java/com/android/server/biometrics/fingerprint/FingerprintService.java
2075 */
2076message FingerprintAcquired {
2077 // The associated user. Eg: 0 for owners, 10+ for others.
2078 // Defined in android/os/UserHandle.java
2079 optional int32 user = 1;
2080 // If this acquire is for a crypto fingerprint.
2081 // e.g. Secure purchases, unlock password storage.
2082 optional bool is_crypto = 2;
2083}
2084
2085/**
2086 * Logs when a fingerprint authentication event occurs.
2087 *
2088 * Logged from:
2089 * frameworks/base/services/core/java/com/android/server/biometrics/fingerprint/FingerprintService.java
2090 */
2091message FingerprintAuthenticated {
2092 // The associated user. Eg: 0 for owners, 10+ for others.
2093 // Defined in android/os/UserHandle.java
2094 optional int32 user = 1;
2095 // If this authentication is for a crypto fingerprint.
2096 // e.g. Secure purchases, unlock password storage.
2097 optional bool is_crypto = 2;
2098 // Whether or not this authentication was successful.
2099 optional bool is_authenticated = 3;
2100}
2101
2102/**
2103 * Logs when a fingerprint error occurs.
2104 *
2105 * Logged from:
2106 * frameworks/base/services/core/java/com/android/server/biometrics/fingerprint/FingerprintService.java
2107 */
2108message FingerprintErrorOccurred {
2109 // The associated user. Eg: 0 for owners, 10+ for others.
2110 // Defined in android/os/UserHandle.java
2111 optional int32 user = 1;
2112 // If this error is for a crypto fingerprint.
2113 // e.g. Secure purchases, unlock password storage.
2114 optional bool is_crypto = 2;
2115
2116 enum Error {
2117 UNKNOWN = 0;
2118 LOCKOUT = 1;
2119 PERMANENT_LOCKOUT = 2;
2120 }
2121 // The type of error.
2122 optional Error error = 3;
2123}
Howard Ro688ae182018-09-25 00:09:36 -07002124
2125message Notification {
2126
2127 // Type of notification event.
2128 enum Type {
2129 TYPE_UNKNOWN = 0;
2130 // Notification became visible to the user.
2131 TYPE_OPEN = 1;
2132 // Notification became hidden.
2133 TYPE_CLOSE = 2;
2134 // Notification switched to detail mode.
2135 TYPE_DETAIL = 3;
2136 // Notification was clicked.
2137 TYPE_ACTION = 4;
2138 // Notification was dismissed.
2139 TYPE_DISMISS = 5;
2140 // Notification switched to summary mode. The enum value of 14 is to
2141 // match that of metrics_constants.
2142 TYPE_COLLAPSE = 14;
2143 }
2144 optional Type type = 1;
2145
2146 // Package name associated with the notification.
2147 optional string package_name = 2;
2148
2149 // Tag associated with notification.
2150 optional string tag = 3;
2151
2152 // Application-supplied ID associated with the notification.
2153 optional int32 id = 4;
2154
2155 // Index of notification in the notification panel.
2156 optional int32 shade_index = 5;
2157
2158 // The number of notifications in the notification panel.
2159 optional int32 shade_count = 6;
2160
2161 // Importance for the notification.
2162 optional int32 importance = 7;
2163
2164 // ID for the notification channel.
Howard Ro183c2bd2018-10-18 13:52:10 -07002165 optional string channel_id = 8;
Howard Ro688ae182018-09-25 00:09:36 -07002166
2167 // Importance for the notification channel.
2168 optional int32 channel_importance = 9;
2169
Howard Ro183c2bd2018-10-18 13:52:10 -07002170 // Application-supplied ID associated with the notifications group.
2171 optional string group_id = 10;
2172
Howard Ro688ae182018-09-25 00:09:36 -07002173 // Whether notification was a group summary.
Howard Ro183c2bd2018-10-18 13:52:10 -07002174 optional bool group_summary = 11;
Howard Ro688ae182018-09-25 00:09:36 -07002175
Howard Ro183c2bd2018-10-18 13:52:10 -07002176 // Reason for dismissal of a notification. This field is only meaningful for
2177 // TYPE_DISMISS events.
2178 optional int32 dismiss_reason = 12;
Howard Ro688ae182018-09-25 00:09:36 -07002179
Howard Ro183c2bd2018-10-18 13:52:10 -07002180 // The first post time of notification, stable across updates.
2181 optional int64 creation_millis = 13;
Howard Ro688ae182018-09-25 00:09:36 -07002182
Howard Ro183c2bd2018-10-18 13:52:10 -07002183 // The most recent interruption time, or the creation time if no updates.
2184 // Differs from update_millis because updates are filtered based on whether
2185 // they actually interrupted the user.
2186 optional int64 interruption_millis = 14;
Howard Ro688ae182018-09-25 00:09:36 -07002187
Howard Ro183c2bd2018-10-18 13:52:10 -07002188 // The most recent update time, or the creation time if no updates.
2189 optional int64 update_millis = 15;
2190
2191 // The most recent visibility event.
2192 optional int64 visible_millis = 16;
Howard Ro688ae182018-09-25 00:09:36 -07002193}
2194
Chenjie Yuae9dfac2018-10-25 16:06:56 -07002195/*
Yangster-macb89807e2018-11-15 21:10:57 -08002196 * Logs when a flag flip state changes.
2197 * Logged in P/h.
2198 */
2199message PhenotypeFlagStateChanged {
2200 // Mendel configuration name.
2201 optional string mendel_config_name = 1;
2202 // State
2203 enum State {
2204 STATE_UNKNOWN = 0;
2205 COMMITTED = 1;
2206 }
2207 optional State state = 2;
2208}
2209
2210/*
2211 * Logs when a binary push state changes.
2212 * Logged in Play store
2213 */
2214message BinaryPushStateChanged {
2215 // Binary package name.
2216 optional string binary_name = 1;
2217 // Version code.
2218 optional int64 version = 2;
2219 // State
2220 enum State {
2221 STATE_UNKNOWN = 0;
2222 DOWNLOAD_START = 1;
2223 DOWNLOAD_DONE = 2;
2224 INSTALL_START = 3;
2225 INSTALL_DONE = 4;
2226 REBOOT_START = 5;
2227 REBOOT_DONE = 6;
2228 }
2229 optional State state = 3;
2230}
2231
2232/*
Chenjie Yuae9dfac2018-10-25 16:06:56 -07002233 * Logs when a connection becomes available and lost.
2234 * Logged in StatsCompanionService.java
2235 */
2236message ConnectivityStateChanged {
Chenjie Yu75b3c492018-10-06 21:45:19 -07002237 // Id of the network.
2238 optional int32 net_id = 1;
2239
2240 enum State {
2241 UNKNOWN = 0;
2242 CONNECTED = 1;
2243 DISCONNECTED = 2;
2244 }
2245 // Connected state of a network.
2246 optional State state = 2;
2247}
2248
2249/**
2250 * Logs when a service starts and stops.
2251 * Logged from:
2252 * services/core/java/com/android/server/am/ActiveServices.java
2253 */
2254message ServiceStateChanged {
2255
2256 optional int32 uid = 1 [(is_uid) = true];
2257
2258 optional string package_name = 2;
2259
2260 optional string service_name = 3;
Chenjie Yuae9dfac2018-10-25 16:06:56 -07002261
2262 enum State {
Chenjie Yu75b3c492018-10-06 21:45:19 -07002263 START = 1;
2264 STOP = 2;
Chenjie Yuae9dfac2018-10-25 16:06:56 -07002265 }
Chenjie Yu75b3c492018-10-06 21:45:19 -07002266
2267 optional State state = 4;
2268}
2269
2270/**
2271 * Logs when a service is launched.
2272 * Logged from:
2273 * services/core/java/com/android/server/am/ActiveServices.java
2274 */
2275message ServiceLaunchReported {
2276
2277 optional int32 uid = 1 [(is_uid) = true];
2278
2279 optional string package_name = 2;
2280
2281 optional string service_name = 3;
Chenjie Yuae9dfac2018-10-25 16:06:56 -07002282}
Howard Ro688ae182018-09-25 00:09:36 -07002283
Chenjie Yubbcbc602018-02-05 16:51:52 -08002284//////////////////////////////////////////////////////////////////////
2285// Pulled atoms below this line //
2286//////////////////////////////////////////////////////////////////////
2287
2288/**
David Chenc8a43242017-10-17 16:23:28 -07002289 * Pulls bytes transferred via wifi (Sum of foreground and background usage).
2290 *
2291 * Pulled from:
2292 * StatsCompanionService (using BatteryStats to get which interfaces are wifi)
2293 */
Chenjie Yu31d14d72017-12-12 17:54:33 -08002294message WifiBytesTransfer {
Yao Chenc40a19d2018-03-15 16:48:25 -07002295 optional int32 uid = 1 [(is_uid) = true];
David Chenc8a43242017-10-17 16:23:28 -07002296
2297 optional int64 rx_bytes = 2;
2298
2299 optional int64 rx_packets = 3;
2300
2301 optional int64 tx_bytes = 4;
2302
2303 optional int64 tx_packets = 5;
2304}
2305
2306/**
2307 * Pulls bytes transferred via wifi (separated by foreground and background usage).
2308 *
2309 * Pulled from:
2310 * StatsCompanionService (using BatteryStats to get which interfaces are wifi)
2311 */
Chenjie Yu31d14d72017-12-12 17:54:33 -08002312message WifiBytesTransferByFgBg {
Yao Chenc40a19d2018-03-15 16:48:25 -07002313 optional int32 uid = 1 [(is_uid) = true];
David Chenc8a43242017-10-17 16:23:28 -07002314
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08002315 // 1 denotes foreground and 0 denotes background. This is called Set in NetworkStats.
2316 optional bool is_foreground = 2;
David Chenc8a43242017-10-17 16:23:28 -07002317
2318 optional int64 rx_bytes = 3;
2319
2320 optional int64 rx_packets = 4;
2321
2322 optional int64 tx_bytes = 5;
2323
2324 optional int64 tx_packets = 6;
2325}
2326
2327/**
2328 * Pulls bytes transferred via mobile networks (Sum of foreground and background usage).
2329 *
2330 * Pulled from:
2331 * StatsCompanionService (using BatteryStats to get which interfaces are mobile data)
2332 */
Chenjie Yu31d14d72017-12-12 17:54:33 -08002333message MobileBytesTransfer {
Yao Chenc40a19d2018-03-15 16:48:25 -07002334 optional int32 uid = 1 [(is_uid) = true];
David Chenc8a43242017-10-17 16:23:28 -07002335
2336 optional int64 rx_bytes = 2;
2337
2338 optional int64 rx_packets = 3;
2339
2340 optional int64 tx_bytes = 4;
2341
2342 optional int64 tx_packets = 5;
2343}
2344
2345/**
2346 * Pulls bytes transferred via mobile networks (separated by foreground and background usage).
2347 *
2348 * Pulled from:
2349 * StatsCompanionService (using BatteryStats to get which interfaces are mobile data)
2350 */
Chenjie Yu31d14d72017-12-12 17:54:33 -08002351message MobileBytesTransferByFgBg {
Yao Chenc40a19d2018-03-15 16:48:25 -07002352 optional int32 uid = 1 [(is_uid) = true];
David Chenc8a43242017-10-17 16:23:28 -07002353
Yao Chenc40a19d2018-03-15 16:48:25 -07002354 // 1 denotes foreground and 0 denotes background. This is called Set in
2355 // NetworkStats.
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08002356 optional bool is_foreground = 2;
David Chenc8a43242017-10-17 16:23:28 -07002357
2358 optional int64 rx_bytes = 3;
2359
2360 optional int64 rx_packets = 4;
2361
2362 optional int64 tx_bytes = 5;
2363
2364 optional int64 tx_packets = 6;
2365}
2366
2367/**
Chenjie Yu9d7720b2018-01-24 10:34:48 -08002368 * Pulls bytes transferred via bluetooth. It is pulled from Bluetooth controller.
2369 *
2370 * Pulled from:
2371 * StatsCompanionService
2372 */
2373message BluetoothBytesTransfer {
Yao Chenc40a19d2018-03-15 16:48:25 -07002374 optional int32 uid = 1 [(is_uid) = true];
Chenjie Yu9d7720b2018-01-24 10:34:48 -08002375
2376 optional int64 rx_bytes = 2;
2377
2378 optional int64 tx_bytes = 3;
2379}
2380
2381/**
David Chenc8a43242017-10-17 16:23:28 -07002382 * Pulls the kernel wakelock durations. This atom is adapted from
2383 * android/internal/os/KernelWakelockStats.java
2384 *
2385 * Pulled from:
2386 * StatsCompanionService using KernelWakelockReader.
2387 */
Chenjie Yu31d14d72017-12-12 17:54:33 -08002388message KernelWakelock {
David Chenc8a43242017-10-17 16:23:28 -07002389 optional string name = 1;
2390
2391 optional int32 count = 2;
2392
2393 optional int32 version = 3;
2394
Yangster-maca8a30442018-10-13 23:46:34 -07002395 optional int64 time_micros = 4;
David Chenc8a43242017-10-17 16:23:28 -07002396}
Chenjie Yu5305e1d2017-10-31 13:49:36 -07002397
Chenjie Yu05013b32017-11-21 10:21:41 -08002398/**
Benjamin Schwartz51329b72018-12-06 10:48:03 -08002399 * Pulls low power state information. If power.stats HAL is not available, this
2400 * includes platform and subsystem sleep state information,
2401 * PowerStatePlatformSleepState, PowerStateVoter or PowerStateSubsystemSleepState
2402 * as defined in:
Chenjie Yu5305e1d2017-10-31 13:49:36 -07002403 * hardware/interfaces/power/1.0/types.hal
Chenjie Yu5305e1d2017-10-31 13:49:36 -07002404 * hardware/interfaces/power/1.1/types.hal
Benjamin Schwartz51329b72018-12-06 10:48:03 -08002405 * If power.stats HAL is available, this includes PowerEntityStateResidencyResult
2406 * as defined in:
2407 * hardware/interfaces/power/stats/1.0/types.hal
Chenjie Yu5305e1d2017-10-31 13:49:36 -07002408 */
Chenjie Yu31d14d72017-12-12 17:54:33 -08002409message SubsystemSleepState {
Chenjie Yubbcbc602018-02-05 16:51:52 -08002410 // Subsystem name
2411 optional string subsystem_name = 1;
2412 // For PlatformLowPowerStats (hal 1.0), this is the voter name, which could be empty.
2413 // For SubsystemLowPowerStats (hal 1.1), this is the sleep state name.
Benjamin Schwartz51329b72018-12-06 10:48:03 -08002414 // For PowerEntityStateResidencyResult (hal power/stats/1.0) this is the
2415 // powerEntityStateName from the corresponding PowerEntityStateInfo.
Chenjie Yubbcbc602018-02-05 16:51:52 -08002416 optional string subname = 2;
Chenjie Yuc8b7f222018-01-11 23:25:57 -08002417 // The number of times it entered, or voted for entering the sleep state
Chenjie Yubbcbc602018-02-05 16:51:52 -08002418 optional uint64 count = 3;
Chenjie Yuc8b7f222018-01-11 23:25:57 -08002419 // The length of time spent in, or spent voting for, the sleep state
David Chen0b5c90c2018-01-25 16:51:49 -08002420 optional uint64 time_millis = 4;
David Chen21582962017-11-01 17:32:46 -07002421}
Chenjie Yu7f8def92017-11-03 09:33:15 -07002422
Chenjie Yu05013b32017-11-21 10:21:41 -08002423/**
Bookatz92da2832018-11-01 18:10:03 -07002424 * Pulls on-device power measurement information.
2425 * Data defined by hardware/interfaces/power/stats/1.0/types.hal.
2426 * Pulled from:
2427 * frameworks/base/cmds/statsd/src/external/PowerStatsPuller.cpp
2428 */
2429message OnDevicePowerMeasurement {
2430 // Name of the subsystem (to which the rail belongs).
2431 optional string subsystem_name = 1;
2432
2433 // Rail name. The rail lies within the subsystem.
2434 optional string rail_name = 2;
2435
2436 // Time (in ms since boot) at which the rail energy value was measured.
2437 // This may differ slightly from the time that statsd logs this information.
2438 optional uint64 measurement_timestamp_millis = 3;
2439
2440 // Accumulated energy used via the rail since device boot in uWs.
2441 optional uint64 energy_microwatt_secs = 4;
2442}
2443
2444/**
Chenjie Yu7f8def92017-11-03 09:33:15 -07002445 * Pulls Cpu time per frequency.
Chenjie Yu1ee9b742018-01-10 16:02:57 -08002446 * Pulls the time the cpu spend on the frequency index. Frequency index
2447 * starts from highest to lowest. The value should be monotonically
2448 * increasing since boot. However, if there is a cpu
2449 * hotplug event, the value would be reset as well.
Chenjie Yu7f8def92017-11-03 09:33:15 -07002450 */
Chenjie Yu31d14d72017-12-12 17:54:33 -08002451message CpuTimePerFreq {
Chenjie Yu7f8def92017-11-03 09:33:15 -07002452 optional uint32 cluster = 1;
2453 optional uint32 freq_index = 2;
David Chen0b5c90c2018-01-25 16:51:49 -08002454 optional uint64 time_millis = 3;
Chenjie Yu7f8def92017-11-03 09:33:15 -07002455}
Chenjie Yue33bc3b2017-11-06 17:56:44 -08002456
Chenjie Yu05013b32017-11-21 10:21:41 -08002457/**
Chenjie Yue33bc3b2017-11-06 17:56:44 -08002458 * Pulls Cpu Time Per Uid.
2459 * Note that isolated process uid time should be attributed to host uids.
2460 */
Chenjie Yu31d14d72017-12-12 17:54:33 -08002461message CpuTimePerUid {
Yao Chenc40a19d2018-03-15 16:48:25 -07002462 optional int32 uid = 1 [(is_uid) = true];
Misha Wagner6bc6c912018-11-16 13:19:54 +00002463 optional uint64 user_time_micros = 2;
2464 optional uint64 sys_time_micros = 3;
Chenjie Yue33bc3b2017-11-06 17:56:44 -08002465}
2466
2467/**
2468 * Pulls Cpu Time Per Uid per frequency.
2469 * Note that isolated process uid time should be attributed to host uids.
2470 * For each uid, we order the time by descending frequencies.
2471 */
Chenjie Yu31d14d72017-12-12 17:54:33 -08002472message CpuTimePerUidFreq {
Yao Chenc40a19d2018-03-15 16:48:25 -07002473 optional int32 uid = 1 [(is_uid) = true];
Chenjie Yuec676612018-03-07 09:19:17 -08002474 optional uint32 freq_index = 2;
David Chen0b5c90c2018-01-25 16:51:49 -08002475 optional uint64 time_millis = 3;
Chenjie Yue33bc3b2017-11-06 17:56:44 -08002476}
Hugo Benichi884970e2017-11-14 22:42:46 +09002477
Chenjie Yu05013b32017-11-21 10:21:41 -08002478/**
2479 * Pulls Wifi Controller Activity Energy Info
2480 */
Chenjie Yu5caaa9d2018-03-06 15:48:54 -08002481message WifiActivityInfo {
Chenjie Yu05013b32017-11-21 10:21:41 -08002482 // timestamp(wall clock) of record creation
David Chen0b5c90c2018-01-25 16:51:49 -08002483 optional uint64 timestamp_millis = 1;
Chenjie Yu05013b32017-11-21 10:21:41 -08002484 // stack reported state
2485 // TODO: replace this with proto enum
2486 optional int32 stack_state = 2;
Yangster-maca8a30442018-10-13 23:46:34 -07002487 // tx time in millis
David Chen0b5c90c2018-01-25 16:51:49 -08002488 optional uint64 controller_tx_time_millis = 3;
Yangster-maca8a30442018-10-13 23:46:34 -07002489 // rx time in millis
David Chen0b5c90c2018-01-25 16:51:49 -08002490 optional uint64 controller_rx_time_millis = 4;
Yangster-maca8a30442018-10-13 23:46:34 -07002491 // idle time in millis
David Chen0b5c90c2018-01-25 16:51:49 -08002492 optional uint64 controller_idle_time_millis = 5;
Chenjie Yu05013b32017-11-21 10:21:41 -08002493 // product of current(mA), voltage(V) and time(ms)
2494 optional uint64 controller_energy_used = 6;
2495}
2496
2497/**
2498 * Pulls Modem Activity Energy Info
2499 */
Chenjie Yu31d14d72017-12-12 17:54:33 -08002500message ModemActivityInfo {
Chenjie Yu05013b32017-11-21 10:21:41 -08002501 // timestamp(wall clock) of record creation
David Chen0b5c90c2018-01-25 16:51:49 -08002502 optional uint64 timestamp_millis = 1;
Yangster-maca8a30442018-10-13 23:46:34 -07002503 // sleep time in millis.
David Chen0b5c90c2018-01-25 16:51:49 -08002504 optional uint64 sleep_time_millis = 2;
Yangster-maca8a30442018-10-13 23:46:34 -07002505 // idle time in millis
David Chen0b5c90c2018-01-25 16:51:49 -08002506 optional uint64 controller_idle_time_millis = 3;
Chenjie Yu05013b32017-11-21 10:21:41 -08002507 /**
2508 * Tx power index
2509 * index 0 = tx_power < 0dBm
2510 * index 1 = 0dBm < tx_power < 5dBm
2511 * index 2 = 5dBm < tx_power < 15dBm
2512 * index 3 = 15dBm < tx_power < 20dBm
2513 * index 4 = tx_power > 20dBm
2514 */
2515 // tx time in ms at power level 0
David Chen0b5c90c2018-01-25 16:51:49 -08002516 optional uint64 controller_tx_time_pl0_millis = 4;
Chenjie Yu05013b32017-11-21 10:21:41 -08002517 // tx time in ms at power level 1
David Chen0b5c90c2018-01-25 16:51:49 -08002518 optional uint64 controller_tx_time_pl1_millis = 5;
Chenjie Yu05013b32017-11-21 10:21:41 -08002519 // tx time in ms at power level 2
David Chen0b5c90c2018-01-25 16:51:49 -08002520 optional uint64 controller_tx_time_pl2_millis = 6;
Chenjie Yu05013b32017-11-21 10:21:41 -08002521 // tx time in ms at power level 3
David Chen0b5c90c2018-01-25 16:51:49 -08002522 optional uint64 controller_tx_time_pl3_millis = 7;
Chenjie Yu05013b32017-11-21 10:21:41 -08002523 // tx time in ms at power level 4
David Chen0b5c90c2018-01-25 16:51:49 -08002524 optional uint64 controller_tx_time_pl4_millis = 8;
Chenjie Yu05013b32017-11-21 10:21:41 -08002525 // rx time in ms at power level 5
David Chen0b5c90c2018-01-25 16:51:49 -08002526 optional uint64 controller_rx_time_millis = 9;
Chenjie Yu05013b32017-11-21 10:21:41 -08002527 // product of current(mA), voltage(V) and time(ms)
2528 optional uint64 energy_used = 10;
Joe Onorato62c220b2017-11-18 20:32:56 -08002529}
Rajeev Kumar508a9bf2018-01-18 15:49:11 -08002530
Chenjie Yu9d7720b2018-01-24 10:34:48 -08002531/**
2532 * Pulls Bluetooth Activity Energy Info
2533 * Note: BluetoothBytesTransfer is pulled at the same time from the controller.
2534 */
2535message BluetoothActivityInfo {
2536 // timestamp(wall clock) of record creation
David Chen0b5c90c2018-01-25 16:51:49 -08002537 optional uint64 timestamp_millis = 1;
Chenjie Yu9d7720b2018-01-24 10:34:48 -08002538 // bluetooth stack state
2539 optional int32 bluetooth_stack_state = 2;
Yangster-maca8a30442018-10-13 23:46:34 -07002540 // tx time in millis
David Chen0b5c90c2018-01-25 16:51:49 -08002541 optional uint64 controller_tx_time_millis = 3;
Yangster-maca8a30442018-10-13 23:46:34 -07002542 // rx time in millis
David Chen0b5c90c2018-01-25 16:51:49 -08002543 optional uint64 controller_rx_time_millis = 4;
Yangster-maca8a30442018-10-13 23:46:34 -07002544 // idle time in millis
David Chen0b5c90c2018-01-25 16:51:49 -08002545 optional uint64 controller_idle_time_millis = 5;
Chenjie Yu9d7720b2018-01-24 10:34:48 -08002546 // product of current(mA), voltage(V) and time(ms)
2547 optional uint64 energy_used = 6;
2548}
2549
Rajeev Kumar508a9bf2018-01-18 15:49:11 -08002550/*
Rajeev Kumar8a9fa052018-01-25 19:03:09 -08002551 * Logs the memory stats for a process.
2552 */
2553message ProcessMemoryState {
2554 // The uid if available. -1 means not available.
Yao Chenc40a19d2018-03-15 16:48:25 -07002555 optional int32 uid = 1 [(is_uid) = true];
Rajeev Kumar8a9fa052018-01-25 19:03:09 -08002556
2557 // The process name.
2558 optional string process_name = 2;
2559
2560 // oom adj score.
Yangster-maca8a30442018-10-13 23:46:34 -07002561 optional int32 oom_adj_score = 3;
Rajeev Kumar8a9fa052018-01-25 19:03:09 -08002562
2563 // # of page-faults
Yangster-maca8a30442018-10-13 23:46:34 -07002564 optional int64 page_fault = 4;
Rajeev Kumar8a9fa052018-01-25 19:03:09 -08002565
2566 // # of major page-faults
Yangster-maca8a30442018-10-13 23:46:34 -07002567 optional int64 page_major_fault = 5;
Rajeev Kumar8a9fa052018-01-25 19:03:09 -08002568
Rajeev Kumar90235992018-01-29 11:06:48 -08002569 // RSS
2570 optional int64 rss_in_bytes = 6;
2571
2572 // CACHE
2573 optional int64 cache_in_bytes = 7;
2574
2575 // SWAP
2576 optional int64 swap_in_bytes = 8;
Rafal Slawikaaf60892018-09-12 13:04:30 +01002577
Rafal Slawikd03ae422018-11-20 11:27:45 +00002578 // Deprecated: use ProcessMemoryHighWaterMark atom instead. Always 0.
Rafal Slawik3bea8952018-11-15 12:39:33 +00002579 optional int64 rss_high_watermark_in_bytes = 9 [deprecated = true];
Rafal Slawik272a8162018-11-01 15:12:28 +00002580
2581 // Elapsed real time when the process started.
2582 // Value is read from /proc/PID/stat, field 22. 0 if read from per-app memory cgroups.
2583 optional int64 start_time_nanos = 10;
Rajeev Kumar8a9fa052018-01-25 19:03:09 -08002584}
2585
2586/*
Rafal Slawik08621582018-10-15 14:53:07 +01002587 * Logs the memory stats for a native process (from procfs).
2588 */
2589message NativeProcessMemoryState {
Rafal Slawikbf67d072018-10-23 11:07:54 +01002590 // The uid if available. -1 means not available.
2591 optional int32 uid = 1 [(is_uid) = true];
Rafal Slawik08621582018-10-15 14:53:07 +01002592
Rafal Slawikbf67d072018-10-23 11:07:54 +01002593 // The process name.
2594 optional string process_name = 2;
Rafal Slawik08621582018-10-15 14:53:07 +01002595
Rafal Slawikbf67d072018-10-23 11:07:54 +01002596 // # of page-faults
2597 optional int64 page_fault = 3;
Rafal Slawik08621582018-10-15 14:53:07 +01002598
Rafal Slawikbf67d072018-10-23 11:07:54 +01002599 // # of major page-faults
2600 optional int64 page_major_fault = 4;
Rafal Slawik08621582018-10-15 14:53:07 +01002601
Rafal Slawikbf67d072018-10-23 11:07:54 +01002602 // RSS
2603 optional int64 rss_in_bytes = 5;
Rafal Slawik08621582018-10-15 14:53:07 +01002604
Rafal Slawikd03ae422018-11-20 11:27:45 +00002605 // Deprecated: use ProcessMemoryHighWaterMark atom instead. Always 0.
Rafal Slawik3bea8952018-11-15 12:39:33 +00002606 optional int64 rss_high_watermark_in_bytes = 6 [deprecated = true];
Rafal Slawikbf67d072018-10-23 11:07:54 +01002607
2608 // Elapsed real time when the process started.
2609 // Value is read from /proc/PID/stat, field 22.
2610 optional int64 start_time_nanos = 7;
Rafal Slawik08621582018-10-15 14:53:07 +01002611}
2612
2613/*
Rafal Slawik3bea8952018-11-15 12:39:33 +00002614 * Logs the memory high-water mark for a process.
2615 * Recorded in ActivityManagerService.
2616 */
2617message ProcessMemoryHighWaterMark {
2618 // The uid if available. -1 means not available.
2619 optional int32 uid = 1 [(is_uid) = true];
2620
2621 // The process name. Provided by ActivityManagerService or read from /proc/PID/cmdline.
2622 optional string process_name = 2;
2623
2624 // RSS high-water mark. Peak RSS usage of the process. Read from the VmHWM field in
2625 // /proc/PID/status.
2626 optional int64 rss_high_water_mark_in_bytes = 3;
2627}
2628
2629/*
Chenjie Yu9d7720b2018-01-24 10:34:48 -08002630 * Elapsed real time from SystemClock.
Chenjie Yu9da105b2018-01-13 12:41:08 -08002631 */
Chenjie Yu9d7720b2018-01-24 10:34:48 -08002632message SystemElapsedRealtime {
David Chen0b5c90c2018-01-25 16:51:49 -08002633 optional uint64 time_millis = 1;
Chenjie Yu9da105b2018-01-13 12:41:08 -08002634}
2635
2636/*
Chenjie Yu9d7720b2018-01-24 10:34:48 -08002637 * Up time from SystemClock.
Chenjie Yu9da105b2018-01-13 12:41:08 -08002638 */
Chenjie Yu9d7720b2018-01-24 10:34:48 -08002639message SystemUptime {
2640 // Milliseconds since the system was booted.
2641 // This clock stops when the system enters deep sleep (CPU off, display dark, device waiting
2642 // for external input).
2643 // It is not affected by clock scaling, idle, or other power saving mechanisms.
David Chen0b5c90c2018-01-25 16:51:49 -08002644 optional uint64 uptime_millis = 1;
Chenjie Yu9da105b2018-01-13 12:41:08 -08002645}
2646
2647/*
2648 * Reads from /proc/uid_concurrent_active_time which has the format:
2649 * active: X (X is # cores)
2650 * [uid0]: [time-0] [time-1] [time-2] ... (# entries = # cores)
2651 * [uid1]: [time-0] [time-1] [time-2] ... ...
2652 * ...
2653 * Time-N means the CPU time a UID spent running concurrently with N other processes.
2654 * The file contains a monotonically increasing count of time for a single boot.
2655 */
2656message CpuActiveTime {
Yao Chenc40a19d2018-03-15 16:48:25 -07002657 optional int32 uid = 1 [(is_uid) = true];
Chenjie Yuec676612018-03-07 09:19:17 -08002658 optional uint64 time_millis = 2;
Chenjie Yu9da105b2018-01-13 12:41:08 -08002659}
2660
2661/**
2662 * Reads from /proc/uid_concurrent_policy_time which has the format:
2663 * policy0: X policy4: Y (there are X cores on policy0, Y cores on policy4)
2664 * [uid0]: [time-0-0] [time-0-1] ... [time-1-0] [time-1-1] ...
2665 * [uid1]: [time-0-0] [time-0-1] ... [time-1-0] [time-1-1] ...
2666 * ...
2667 * Time-X-Y means the time a UID spent on clusterX running concurrently with Y other processes.
2668 * The file contains a monotonically increasing count of time for a single boot.
2669 */
2670message CpuClusterTime {
Yao Chenc40a19d2018-03-15 16:48:25 -07002671 optional int32 uid = 1 [(is_uid) = true];
Chenjie Yuec676612018-03-07 09:19:17 -08002672 optional int32 cluster_index = 2;
David Chen0b5c90c2018-01-25 16:51:49 -08002673 optional uint64 time_millis = 3;
Chenjie Yu937d7422018-01-10 16:37:53 -08002674}
2675
2676/*
2677 * Pulls free disk space, for data, system partition and temporary directory.
2678 */
2679message DiskSpace {
2680 // available bytes in data partition
2681 optional uint64 data_available_bytes = 1;
2682 // available bytes in system partition
2683 optional uint64 system_available_bytes = 2;
2684 // available bytes in download cache or temp directories
2685 optional uint64 temp_available_bytes = 3;
2686}
Tej Singhbf972d92018-01-10 20:51:13 -08002687
2688/**
2689 * Pulls battery coulomb counter, which is the remaining battery charge in uAh.
Tej Singh40298312018-02-16 00:15:09 -08002690 * Pulled from:
2691 * frameworks/base/cmds/statsd/src/external/ResourceHealthManagerPuller.cpp
Tej Singhbf972d92018-01-10 20:51:13 -08002692 */
2693message RemainingBatteryCapacity {
Yangster-maca8a30442018-10-13 23:46:34 -07002694 optional int32 charge_micro_ampere_hour = 1;
Tej Singhbf972d92018-01-10 20:51:13 -08002695}
2696
2697/**
2698 * Pulls battery capacity, which is the battery capacity when full in uAh.
Tej Singh40298312018-02-16 00:15:09 -08002699 * Pulled from:
2700 * frameworks/base/cmds/statsd/src/external/ResourceHealthManagerPuller.cpp
Tej Singhbf972d92018-01-10 20:51:13 -08002701 */
2702message FullBatteryCapacity {
Yangster-maca8a30442018-10-13 23:46:34 -07002703 optional int32 capacity_micro_ampere_hour = 1;
Tej Singh40298312018-02-16 00:15:09 -08002704}
2705
2706/**
Bookatz17f0d8a2018-09-13 12:56:32 -07002707 * Pulls battery voltage.
2708 * Pulled from:
2709 * frameworks/base/cmds/statsd/src/external/ResourceHealthManagerPuller.cpp
2710 */
2711message BatteryVoltage {
2712 // The voltage of the battery, in millivolts.
Yangster-maca8a30442018-10-13 23:46:34 -07002713 optional int32 voltage_millivolt = 1;
Bookatz17f0d8a2018-09-13 12:56:32 -07002714}
2715
2716/**
Tej Singhb1dbc8b2018-11-19 15:49:47 -08002717 * Pulls battery level (percent full, from 0 to 100).
2718 *
2719 * Pulled from:
2720 * frameworks/base/cmds/statsd/src/external/ResourceHealthManagerPuller.cpp
2721 */
2722message BatteryLevel {
2723 // Battery level. Should be in [0, 100].
2724 optional int32 battery_level = 1;
2725}
2726
2727/**
Tej Singhd89137e2018-03-26 14:51:40 -07002728 * Pulls the temperature of various parts of the device.
2729 * The units are tenths of a degree Celsius. Eg: 30.3C is reported as 303.
Tej Singh40298312018-02-16 00:15:09 -08002730 *
2731 * Pulled from:
2732 * frameworks/base/cmds/statsd/src/external/ResourceThermalManagerPuller.cpp
2733 */
2734message Temperature {
2735 // The type of temperature being reported. Eg. CPU, GPU, SKIN, BATTERY.
2736 optional android.os.TemperatureTypeEnum sensor_location = 1;
2737
2738 // The name of the temperature source. Eg. CPU0
2739 optional string sensor_name = 2;
2740
Tej Singhd89137e2018-03-26 14:51:40 -07002741 // Temperature in tenths of a degree C.
Yangster-maca8a30442018-10-13 23:46:34 -07002742 optional int32 temperature_deci_celsius = 3;
yroa1fe77c2018-02-26 14:22:54 -08002743}
Olivier Gaillard00bfb1b2018-07-10 11:25:09 +01002744
2745/**
2746 * Pulls the statistics of calls to Binder.
2747 *
Olivier Gaillardd25f7a82018-09-12 14:28:48 +01002748 * Binder stats will be reset every time the data is pulled. It means it can only be pulled by one
2749 * config on the device.
Olivier Gaillard9ea238d2018-07-24 10:26:31 +01002750 *
Olivier Gaillard720ec5b2018-10-30 17:32:56 +00002751 * Next tag: 15
Olivier Gaillard00bfb1b2018-07-10 11:25:09 +01002752 */
2753message BinderCalls {
Olivier Gaillard720ec5b2018-10-30 17:32:56 +00002754 // UID of the process responsible for the binder transaction. It will be set if the process
2755 // executing the binder transaction attribute the transaction to another uid using
2756 // Binder.setThreadWorkSource().
2757 //
2758 // If not set, the value will be -1.
Olivier Gaillard9ea238d2018-07-24 10:26:31 +01002759 optional int32 uid = 1 [(is_uid) = true];
Olivier Gaillard720ec5b2018-10-30 17:32:56 +00002760 // UID of the process executing the binder transaction.
2761 optional int32 direct_caller_uid = 14;
Olivier Gaillard9ea238d2018-07-24 10:26:31 +01002762 // Fully qualified class name of the API call.
2763 //
2764 // This is a system server class name.
2765 //
2766 // TODO(gaillard): figure out if binder call stats includes data from isolated uids, if a uid
2767 // gets recycled and we have isolated uids, we might attribute the data incorrectly.
2768 // TODO(gaillard): there is a high dimensions cardinality, figure out if we should drop the less
2769 // commonly used APIs.
2770 optional string service_class_name = 2;
2771 // Method name of the API call. It can also be a transaction code if we cannot
2772 // resolve it to a name. See Binder#getTransactionName.
2773 //
2774 // This is a system server method name.
2775 optional string service_method_name = 3;
2776 // Total number of API calls.
2777 optional int64 call_count = 4;
2778 // True if the screen was interactive PowerManager#isInteractive at the end of the call.
2779 optional bool screen_interactive = 13;
2780 // Total number of API calls we have data recorded for. If we collected data for all the calls,
2781 // call_count will be equal to recorded_call_count.
2782 //
2783 // If recorded_call_count is different than call_count, it means data collection has been
2784 // sampled. All the fields below will be sampled in this case.
2785 optional int64 recorded_call_count = 12;
2786 // Number of exceptions thrown by the API.
2787 optional int64 recorded_exception_count = 5;
2788 // Total latency of all API calls.
2789 // Average can be computed using total_latency_micros / recorded_call_count.
2790 optional int64 recorded_total_latency_micros = 6;
2791 // Maximum latency of one API call.
2792 optional int64 recorded_max_latency_micros = 7;
2793 // Total CPU usage of all API calls.
2794 // Average can be computed using total_cpu_micros / recorded_call_count.
2795 // Total can be computed using total_cpu_micros / recorded_call_count * call_count.
2796 optional int64 recorded_total_cpu_micros = 8;
2797 // Maximum CPU usage of one API call.
2798 optional int64 recorded_max_cpu_micros = 9;
2799 // Maximum parcel reply size of one API call.
2800 optional int64 recorded_max_reply_size_bytes = 10;
2801 // Maximum parcel request size of one API call.
2802 optional int64 recorded_max_request_size_bytes = 11;
2803}
2804
2805/**
2806 * Pulls the statistics of exceptions during calls to Binder.
2807 *
2808 * Binder stats are cumulative from boot unless somebody reset the data using
2809 * > adb shell dumpsys binder_calls_stats --reset
2810 */
2811message BinderCallsExceptions {
2812 // Exception class name, e.g. java.lang.IllegalArgumentException.
2813 //
2814 // This is an exception class name thrown by the system server.
2815 optional string exception_class_name = 1;
2816 // Total number of exceptions.
2817 optional int64 exception_count = 2;
Olivier Gaillard00bfb1b2018-07-10 11:25:09 +01002818}
Marcin Oczeretkod8cc8592018-08-22 16:07:36 +01002819
Marcin Oczeretko3e6494e2018-09-10 18:06:52 +01002820/**
2821 * Pulls the statistics of message dispatching on HandlerThreads.
2822 *
2823 * Looper stats will be reset every time the data is pulled. It means it can only be pulled by one
2824 * config on the device.
2825 *
2826 * Next tag: 11
2827 */
Marcin Oczeretkod8cc8592018-08-22 16:07:36 +01002828message LooperStats {
Marcin Oczeretkoec758722018-09-12 12:53:47 +01002829 // The uid that made a call to the System Server and caused the message to be enqueued.
Marcin Oczeretkod8cc8592018-08-22 16:07:36 +01002830 optional int32 uid = 1 [(is_uid) = true];
2831
2832 // Fully qualified class name of the handler target class.
2833 //
2834 // This field does not contain PII. This is a system server class name.
2835 optional string handler_class_name = 2;
2836
2837 // The name of the thread that runs the Looper.
2838 //
2839 // This field does not contain PII. This is a system server thread name.
2840 optional string looper_thread_name = 3;
2841
2842 // The name of the dispatched message.
2843 //
2844 // This field does not contain PII. This is a system server constant or class
2845 // name.
2846 optional string message_name = 4;
2847
2848 // Total number of successfully dispatched messages.
2849 optional int64 message_count = 5;
2850
2851 // Total number of messages that failed dispatching.
2852 optional int64 exception_count = 6;
2853
2854 // Total number of processed messages we have data recorded for. If we
2855 // collected data for all the messages, message_count will be equal to
2856 // recorded_message_count.
2857 //
2858 // If recorded_message_count is different than message_count, it means data
Marcin Oczeretkoc06331a2018-10-02 13:00:38 +01002859 // collection has been sampled. The fields below will be sampled in this case.
Marcin Oczeretkod8cc8592018-08-22 16:07:36 +01002860 optional int64 recorded_message_count = 7;
2861
2862 // Total latency of all processed messages.
2863 // Average can be computed using recorded_total_latency_micros /
2864 // recorded_message_count.
2865 optional int64 recorded_total_latency_micros = 8;
2866
2867 // Total CPU usage of all processed message.
2868 // Average can be computed using recorded_total_cpu_micros /
2869 // recorded_message_count. Total can be computed using
Marcin Oczeretko3e6494e2018-09-10 18:06:52 +01002870 // recorded_total_cpu_micros / recorded_message_count * message_count.
Marcin Oczeretkod8cc8592018-08-22 16:07:36 +01002871 optional int64 recorded_total_cpu_micros = 9;
Marcin Oczeretko3e6494e2018-09-10 18:06:52 +01002872
2873 // True if the screen was interactive PowerManager#isInteractive at the end of the call.
2874 optional bool screen_interactive = 10;
Marcin Oczeretkoc06331a2018-10-02 13:00:38 +01002875
2876 // Max recorded CPU usage of all processed messages.
2877 optional int64 recorded_max_cpu_micros = 11;
2878
2879 // Max recorded latency of all processed messages.
2880 optional int64 recorded_max_latency_micros = 12;
2881
2882 // Total number of messages we tracked the dispatching delay for. If we
2883 // collected data for all the messages, message_count will be equal to
2884 // recorded_delay_message_count.
2885 //
2886 // If recorded_delay_message_count is different than message_count, it means data
2887 // collection has been sampled or/and not all messages specified the target dispatch time.
2888 // The fields below will be sampled in this case.
2889 optional int64 recorded_delay_message_count = 13;
2890
2891 // Total dispatching delay of all processed messages.
2892 // Calculated as a difference between the target dispatching time (Message.when)
2893 // and the actual dispatching time.
2894 // Average can be computed using recorded_total_delay_millis / recorded_delay_message_count.
2895 optional int64 recorded_total_delay_millis = 14;
2896
2897 // Max dispatching delay of all processed messages.
2898 // Calculated as a difference between the target dispatching time (Message.when)
2899 // and the actual dispatching time.
2900 optional int64 recorded_max_delay_millis = 15;
Marcin Oczeretkod8cc8592018-08-22 16:07:36 +01002901}
Tej Singh86dc9db2018-09-06 00:39:57 +00002902
2903/**
2904 * Pulls disk information, such as write speed and latency.
2905 */
2906message DiskStats {
2907 // Time taken to open, write 512B to, and close a file.
2908 // -1 if error performing the check.
2909 optional int64 data_write_latency_millis = 1;
2910
2911 optional bool file_based_encryption = 2;
2912
2913 // Recent disk write speed in kB/s.
2914 // -1 if error querying storageed.
2915 // 0 if data is unavailable.
2916 optional int32 recent_disk_write_speed = 3;
2917}
2918
2919
2920/**
2921 * Free and total bytes of the Data, Cache, and System partition.
2922 */
2923message DirectoryUsage {
2924 enum Directory {
2925 UNKNOWN = 0;
2926 DATA = 1;
2927 CACHE = 2;
2928 SYSTEM = 3;
2929 }
2930 optional Directory directory = 1;
2931 optional int64 free_bytes = 2;
2932 optional int64 total_bytes = 3;
2933}
2934
2935
2936/**
2937 * Size of an application: apk size, data size, and cache size.
2938 * Reads from a cached file produced daily by DiskStatsLoggingService.java.
2939 * Information is only reported for apps with the primary user (user 0).
2940 * Sizes are aggregated by package name.
2941 */
2942message AppSize {
2943 // Including uids will involve modifying diskstats logic.
2944 optional string package_name = 1;
2945 // App size in bytes. -1 if unavailable.
2946 optional int64 app_size_bytes = 2;
2947 // App data size in bytes. -1 if unavailable.
2948 optional int64 app_data_size_bytes = 3;
2949 // App cache size in bytes. -1 if unavailable.
2950 optional int64 app_cache_size_bytes = 4;
2951 // Time that the cache file was produced.
2952 // Uses System.currentTimeMillis(), which is wall clock time.
2953 optional int64 cache_time_millis = 5;
2954}
2955
2956
2957/**
2958 * Size of a particular category. Eg: photos, videos.
2959 * Reads from a cached file produced daily by DiskStatsLoggingService.java.
2960 */
2961message CategorySize {
2962 enum Category {
2963 UNKNOWN = 0;
2964 APP_SIZE = 1;
2965 APP_DATA_SIZE = 2;
2966 APP_CACHE_SIZE = 3;
2967 PHOTOS = 4;
2968 VIDEOS = 5;
2969 AUDIO = 6;
2970 DOWNLOADS = 7;
2971 SYSTEM = 8;
2972 OTHER = 9;
2973 }
2974 optional Category category = 1;
2975 // Category size in bytes.
2976 optional int64 size_bytes = 2;
2977 // Time that the cache file was produced.
2978 // Uses System.currentTimeMillis(), which is wall clock time.
2979 optional int64 cache_time_millis = 3;
2980}
Tej Singhd6d6d772018-09-05 17:41:25 -07002981
2982/**
Tej Singhe7726dc2018-09-21 11:42:12 -07002983 * Pulls per uid I/O stats. The stats are cumulative since boot.
2984 *
2985 * Read/write bytes are I/O events from a storage device
2986 * Read/write chars are data requested by read/write syscalls, and can be
2987 * satisfied by caching.
2988 *
2989 * Pulled from StatsCompanionService, which reads proc/uid_io/stats.
2990 */
2991message DiskIo {
2992 optional int32 uid = 1 [(is_uid) = true];
2993 optional int64 fg_chars_read = 2;
2994 optional int64 fg_chars_write = 3;
2995 optional int64 fg_bytes_read = 4;
2996 optional int64 fg_bytes_write = 5;
2997 optional int64 bg_chars_read = 6;
2998 optional int64 bg_chars_write = 7;
2999 optional int64 bg_bytes_read = 8;
3000 optional int64 bg_bytes_write = 9;
3001 optional int64 fg_fsync = 10;
3002 optional int64 bg_fsync= 11;
3003}
3004
3005
3006/**
Tej Singhd6d6d772018-09-05 17:41:25 -07003007 * Pulls the number of fingerprints for each user.
3008 *
3009 * Pulled from StatsCompanionService, which queries FingerprintManager.
3010 */
3011message NumFingerprints {
3012 // The associated user. Eg: 0 for owners, 10+ for others.
3013 // Defined in android/os/UserHandle.java
3014 optional int32 user = 1;
3015 // Number of fingerprints registered to that user.
3016 optional int32 num_fingerprints = 2;
3017}
Chenjie Yu12e5e672018-09-14 15:54:59 -07003018
Yangsteraf9aee72018-10-12 09:26:16 -07003019message AggStats {
3020 optional int64 min = 1;
3021
3022 optional int64 average = 2;
3023
3024 optional int64 max = 3;
3025}
3026
3027message ProcessStatsStateProto {
3028 optional android.service.procstats.ScreenState screen_state = 1;
3029
3030 optional android.service.procstats.MemoryState memory_state = 2;
3031
3032 // this enum list is from frameworks/base/core/java/com/android/internal/app/procstats/ProcessStats.java
3033 // and not frameworks/base/core/java/android/app/ActivityManager.java
3034 optional android.service.procstats.ProcessState process_state = 3;
3035
3036 // Millisecond uptime duration spent in this state
Yangster-maca8a30442018-10-13 23:46:34 -07003037 optional int64 duration_millis = 4;
Yangsteraf9aee72018-10-12 09:26:16 -07003038
3039 // Millisecond elapsed realtime duration spent in this state
Yangster-maca8a30442018-10-13 23:46:34 -07003040 optional int64 realtime_duration_millis = 9;
Yangsteraf9aee72018-10-12 09:26:16 -07003041
3042 // # of samples taken
3043 optional int32 sample_size = 5;
3044
3045 // PSS is memory reserved for this process
3046 optional AggStats pss = 6;
3047
3048 // USS is memory shared between processes, divided evenly for accounting
3049 optional AggStats uss = 7;
3050
3051 // RSS is memory resident for this process
3052 optional AggStats rss = 8;
3053}
3054
3055// Next Tag: 7
3056message ProcessStatsProto {
3057 // Name of process.
3058 optional string process = 1;
3059
3060 // Uid of the process.
3061 optional int32 uid = 2;
3062
3063 // Information about how often kills occurred
3064 message Kill {
3065 // Count of excessive CPU kills
3066 optional int32 cpu = 1;
3067
3068 // Count of kills when cached
3069 optional int32 cached = 2;
3070
3071 // PSS stats during cached kill
3072 optional AggStats cached_pss = 3;
3073 }
3074 optional Kill kill = 3;
3075
3076 // Time and memory spent in various states.
3077 repeated ProcessStatsStateProto states = 5;
3078
3079 // Total time process has been running... screen_state, memory_state, and process_state
3080 // will not be set.
3081 optional ProcessStatsStateProto total_running_state = 6;
3082}
3083
3084message PackageServiceOperationStatsProto {
3085 // Operate enum: Started, Foreground, Bound, Executing
3086 optional android.service.procstats.ServiceOperationState operation = 1;
3087
3088 // Number of times the service was in this operation.
3089 optional int32 count = 2;
3090
3091 // Information about a state the service can be in.
3092 message StateStats {
3093 // Screen state enum.
3094 optional android.service.procstats.ScreenState screen_state = 1;
3095 // Memory state enum.
3096 optional android.service.procstats.MemoryState memory_state = 2;
3097
3098 // duration in milliseconds.
Yangster-maca8a30442018-10-13 23:46:34 -07003099 optional int64 duration_millis = 3;
Yangsteraf9aee72018-10-12 09:26:16 -07003100 // Millisecond elapsed realtime duration spent in this state
Yangster-maca8a30442018-10-13 23:46:34 -07003101 optional int64 realtime_duration_millis = 4;
Yangsteraf9aee72018-10-12 09:26:16 -07003102 }
3103 repeated StateStats state_stats = 3;
3104}
3105
3106message PackageServiceStatsProto {
3107 // Name of service component.
3108 optional string service_name = 1;
3109
3110 // The operation stats.
3111 // The package_name, package_uid, package_version, service_name will not be set to save space.
3112 repeated PackageServiceOperationStatsProto operation_stats = 2;
3113}
3114
3115message PackageAssociationSourceProcessStatsProto {
3116 // Uid of the process.
3117 optional int32 process_uid = 1;
3118 // Process name.
3119 optional string process_name = 2;
3120
3121 // Total count of the times this association appeared.
3122 optional int32 total_count = 3;
3123
3124 // Millisecond uptime total duration this association was around.
Yangster-maca8a30442018-10-13 23:46:34 -07003125 optional int64 total_duration_millis = 4;
Yangsteraf9aee72018-10-12 09:26:16 -07003126
3127 // Total count of the times this association became actively impacting its target process.
3128 optional int32 active_count = 5;
3129
3130 // Information on one source in this association.
3131 message StateStats {
3132 // Process state enum.
3133 optional android.service.procstats.ProcessState process_state = 1;
3134 // Millisecond uptime duration spent in this state
Yangster-maca8a30442018-10-13 23:46:34 -07003135 optional int64 duration_millis = 2;
Yangsteraf9aee72018-10-12 09:26:16 -07003136 // Millisecond elapsed realtime duration spent in this state
Yangster-maca8a30442018-10-13 23:46:34 -07003137 optional int64 realtime_duration_mmillis = 3;
Yangsteraf9aee72018-10-12 09:26:16 -07003138 }
3139 repeated StateStats active_state_stats = 6;
3140}
3141
3142message PackageAssociationProcessStatsProto {
3143 // Name of the target component.
3144 optional string component_name = 1;
3145 // Information on one source in this association.
3146 repeated PackageAssociationSourceProcessStatsProto sources = 2;
3147}
3148
3149
3150message ProcessStatsPackageProto {
3151 // Name of package.
3152 optional string package = 1;
3153
3154 // Uid of the package.
3155 optional int32 uid = 2;
3156
3157 // Version of the package.
3158 optional int64 version = 3;
3159
3160 // Stats for each process running with the package loaded in to it.
3161 repeated ProcessStatsProto process_stats = 4;
3162
3163 // Stats for each of the package's services.
3164 repeated PackageServiceStatsProto service_stats = 5;
3165
3166 // Stats for each association with the package.
3167 repeated PackageAssociationProcessStatsProto association_stats = 6;
3168}
3169
3170message ProcessStatsSectionProto {
3171 // Elapsed realtime at start of report.
Yangster-maca8a30442018-10-13 23:46:34 -07003172 optional int64 start_realtime_millis = 1;
Yangsteraf9aee72018-10-12 09:26:16 -07003173
3174 // Elapsed realtime at end of report.
Yangster-maca8a30442018-10-13 23:46:34 -07003175 optional int64 end_realtime_millis = 2;
Yangsteraf9aee72018-10-12 09:26:16 -07003176
3177 // CPU uptime at start of report.
Yangster-maca8a30442018-10-13 23:46:34 -07003178 optional int64 start_uptime_millis = 3;
Yangsteraf9aee72018-10-12 09:26:16 -07003179
3180 // CPU uptime at end of report.
Yangster-maca8a30442018-10-13 23:46:34 -07003181 optional int64 end_uptime_millis = 4;
Yangsteraf9aee72018-10-12 09:26:16 -07003182
3183 // System runtime library. e.g. "libdvm.so", "libart.so".
3184 optional string runtime = 5;
3185
3186 // whether kernel reports swapped pss.
3187 optional bool has_swapped_pss = 6;
3188
3189 // Data completeness. e.g. "complete", "partial", shutdown", or "sysprops".
3190 enum Status {
3191 STATUS_UNKNOWN = 0;
3192 STATUS_COMPLETE = 1;
3193 STATUS_PARTIAL = 2;
3194 STATUS_SHUTDOWN = 3;
3195 STATUS_SYSPROPS = 4;
3196 }
3197 repeated Status status = 7;
3198
3199 // Stats for each process.
3200 repeated ProcessStatsProto process_stats = 8;
3201
3202 // Stats for each package.
3203 repeated ProcessStatsPackageProto package_stats = 9;
3204}
3205
Chenjie Yu12e5e672018-09-14 15:54:59 -07003206/**
3207 * Pulled from ProcessStatsService.java
3208 */
3209message ProcStats {
Yangsteraf9aee72018-10-12 09:26:16 -07003210 optional ProcessStatsSectionProto proc_stats_section = 1;
3211}
3212
3213message PowerProfileProto {
3214 optional double cpu_suspend = 1;
3215
3216 optional double cpu_idle = 2;
3217
3218 optional double cpu_active = 3;
3219
3220 message CpuCluster {
3221 optional int32 id = 1;
3222 optional double cluster_power = 2;
3223 optional int32 cores = 3;
3224 repeated int64 speed = 4;
3225 repeated double core_power = 5;
3226 }
3227
3228 repeated CpuCluster cpu_cluster = 40;
3229
3230 optional double wifi_scan = 4;
3231
3232 optional double wifi_on = 5;
3233
3234 optional double wifi_active = 6;
3235
3236 optional double wifi_controller_idle = 7;
3237
3238 optional double wifi_controller_rx = 8;
3239
3240 optional double wifi_controller_tx = 9;
3241
3242 repeated double wifi_controller_tx_levels = 10;
3243
3244 optional double wifi_controller_operating_voltage = 11;
3245
3246 optional double bluetooth_controller_idle = 12;
3247
3248 optional double bluetooth_controller_rx = 13;
3249
3250 optional double bluetooth_controller_tx = 14;
3251
3252 optional double bluetooth_controller_operating_voltage = 15;
3253
3254 optional double modem_controller_sleep = 16;
3255
3256 optional double modem_controller_idle = 17;
3257
3258 optional double modem_controller_rx = 18;
3259
3260 repeated double modem_controller_tx = 19;
3261
3262 optional double modem_controller_operating_voltage = 20;
3263
3264 optional double gps_on = 21;
3265
3266 repeated double gps_signal_quality_based = 22;
3267
3268 optional double gps_operating_voltage = 23;
3269
3270 optional double bluetooth_on = 24;
3271
3272 optional double bluetooth_active = 25;
3273
3274 optional double bluetooth_at_cmd = 26;
3275
3276 optional double ambient_display = 27;
3277
3278 optional double screen_on = 28;
3279
3280 optional double radio_on = 29;
3281
3282 optional double radio_scanning = 30;
3283
3284 optional double radio_active = 31;
3285
3286 optional double screen_full = 32;
3287
3288 optional double audio = 33;
3289
3290 optional double video = 34;
3291
3292 optional double flashlight = 35;
3293
3294 optional double memory = 36;
3295
3296 optional double camera = 37;
3297
3298 optional double wifi_batched_scan = 38;
3299
3300 optional double battery_capacity = 39;
Chenjie Yu12e5e672018-09-14 15:54:59 -07003301}
Chenjie Yuab530202018-09-26 12:39:20 -07003302
3303/**
3304 * power_profile.xml and other constants for power model calculations.
3305 * Pulled from PowerProfile.java
3306 */
3307message PowerProfile {
Yangsteraf9aee72018-10-12 09:26:16 -07003308 optional PowerProfileProto power_profile = 1;
Howard Ro9a862de2018-10-11 16:03:33 -07003309}
Chenjie Yub35b5f72018-10-13 23:25:11 -07003310
3311/**
arangelovd5db50e2018-10-12 20:24:39 +01003312 * Logs when a user restriction was added or removed.
3313 *
3314 * Logged from:
3315 * frameworks/base/services/devicepolicy/java/com/android/server/devicepolicy/DevicePolicyManagerService.java
3316 */
3317message UserRestrictionChanged {
3318 // The raw string of the user restriction as defined in UserManager.
3319 // Allowed values are defined in UserRestrictionsUtils#USER_RESTRICTIONS.
3320 optional string restriction = 1;
3321 // Whether the restriction is enabled or disabled.
3322 optional bool enabled = 2;
Howard Ro183c2bd2018-10-18 13:52:10 -07003323}
Yangster-mac308ea0c2018-10-22 13:10:25 -07003324
3325/**
3326 * Pulls process user time and system time. Puller takes a snapshot of all pids
3327 * in the system and returns cpu stats for those that are working at the time.
3328 * Dead pids will be dropped. Kernel processes are excluded.
3329 * Min cool-down is 5 sec.
3330 */
3331message ProcessCpuTime {
3332 optional int32 uid = 1 [(is_uid) = true];
3333
3334 optional string process_name = 2;
3335 // Process cpu time in user space, cumulative from boot/process start
3336 optional int64 user_time_millis = 3;
3337 // Process cpu time in system space, cumulative from boot/process start
3338 optional int64 system_time_millis = 4;
Rafal Slawikbf67d072018-10-23 11:07:54 +01003339}
Misha Wagner5a51e002018-10-03 15:04:09 +01003340
3341/**
3342 * Pulls the CPU usage for each thread.
3343 *
3344 * Read from /proc/$PID/task/$TID/time_in_state files.
3345 *
3346 * TODO(mishaw): This is an experimental atom. Issues with big/little CPU frequencies, and
3347 * time_in_state files not being present on some phones, have not been addressed. These should be
3348 * considered before a public release.
3349 */
3350message CpuTimePerThreadFreq {
3351 // UID that owns the process.
3352 optional int32 uid = 1 [(is_uid) = true];
3353 // ID of the process.
Misha Wagnerdfa548c2018-11-16 11:18:00 +00003354 optional int32 process_id = 2;
Misha Wagner5a51e002018-10-03 15:04:09 +01003355 // ID of the thread.
Misha Wagnerdfa548c2018-11-16 11:18:00 +00003356 optional int32 thread_id = 3;
Misha Wagner5a51e002018-10-03 15:04:09 +01003357 // Name of the process taken from `/proc/$PID/cmdline`.
3358 optional string process_name = 4;
3359 // Name of the thread taken from `/proc/$PID/task/$TID/comm`
3360 optional string thread_name = 5;
Misha Wagnerfde69582018-11-28 13:26:32 +00003361
3362 // Report eight different frequencies, and how much time is spent in each frequency. Frequencies
3363 // are given in KHz, and time is given in milliseconds since the thread started. All eight
3364 // frequencies are given here as the alternative is sending eight separate atoms. This method
3365 // significantly reduces the amount of data created
3366 optional int32 frequency1_khz = 6;
3367 optional int32 time1_millis = 7;
3368 optional int32 frequency2_khz = 8;
3369 optional int32 time2_millis = 9;
3370 optional int32 frequency3_khz = 10;
3371 optional int32 time3_millis = 11;
3372 optional int32 frequency4_khz = 12;
3373 optional int32 time4_millis = 13;
3374 optional int32 frequency5_khz = 14;
3375 optional int32 time5_millis = 15;
3376 optional int32 frequency6_khz = 16;
3377 optional int32 time6_millis = 17;
3378 optional int32 frequency7_khz = 18;
3379 optional int32 time7_millis = 19;
3380 optional int32 frequency8_khz = 20;
3381 optional int32 time8_millis = 21;
Misha Wagner5a51e002018-10-03 15:04:09 +01003382}
Bookatz75ee6042018-11-09 12:27:37 -08003383
3384/**
Bookatz366a4432018-11-20 09:42:33 -08003385 * Pulls information about the device's build.
3386 */
3387message BuildInformation {
3388 // Build.FINGERPRINT. A string that uniquely identifies this build. Do not parse.
3389 // E.g. may be composed of the brand, product, device, release, id, incremental, type, and tags.
3390 optional string fingerprint = 1;
3391
3392 // Build.BRAND. The consumer-visible brand with which the product/hardware will be associated.
3393 optional string brand = 2;
3394
3395 // Build.PRODUCT. The name of the overall product.
3396 optional string product = 3;
3397
3398 // Build.DEVICE. The name of the industrial design.
3399 optional string device = 4;
3400
3401 // Build.VERSION.RELEASE. The user-visible version string. E.g., "1.0" or "3.4b5" or "bananas".
3402 optional string version_release = 5;
3403
3404 // Build.ID. E.g. a label like "M4-rc20".
3405 optional string id = 6;
3406
3407 // Build.VERSION.INCREMENTAL. The internal value used by the underlying source control to
3408 // represent this build.
3409 optional string version_incremental = 7;
3410
3411 // Build.TYPE. The type of build, like "user" or "eng".
3412 optional string type = 8;
3413
3414 // Build.TAGS. Comma-separated tags describing the build, like "unsigned,debug".
3415 optional string tags = 9;
3416}
3417
3418/**
Bookatz75ee6042018-11-09 12:27:37 -08003419 * Pulls on-device BatteryStats power use calculations for the overall device.
3420 */
3421message DeviceCalculatedPowerUse {
3422 // Power used by the device in mAh, as computed by BatteryStats, since BatteryStats last reset
3423 // (i.e. roughly since device was last significantly charged).
3424 // Currently, this is BatteryStatsHelper.getComputedPower() (not getTotalPower()).
3425 optional float computed_power_milli_amp_hours = 1;
3426}
3427
3428/**
3429 * Pulls on-device BatteryStats power use calculations broken down by uid.
3430 * This atom should be complemented by DeviceCalculatedPowerBlameOther, which contains the power use
3431 * that is attributed to non-uid items. They must all be included to get the total power use.
3432 */
3433message DeviceCalculatedPowerBlameUid {
3434 // Uid being blamed. Note: isolated uids have already been mapped to host uid.
3435 optional int32 uid = 1 [(is_uid) = true];
3436
3437 // Power used by this uid in mAh, as computed by BatteryStats, since BatteryStats last reset
3438 // (i.e. roughly since device was last significantly charged).
3439 optional float power_milli_amp_hours = 2;
3440}
3441
3442/**
3443 * Pulls on-device BatteryStats power use calculations that are not due to a uid, broken down by
3444 * drain type.
3445 * This atom should be complemented by DeviceCalculatedPowerBlameUid, which contains the blame that
3446 * is attributed uids. They must all be included to get the total power use.
3447 */
3448message DeviceCalculatedPowerBlameOther {
3449 // The type of item whose power use is being reported.
3450 enum DrainType {
3451 AMBIENT_DISPLAY = 0;
3452 // reserved 1; reserved "APP"; // Logged instead in DeviceCalculatedPowerBlameUid.
3453 BLUETOOTH = 2;
3454 CAMERA = 3;
3455 // Cell-standby
3456 CELL = 4;
3457 FLASHLIGHT = 5;
3458 IDLE = 6;
3459 MEMORY = 7;
3460 // Amount that total computed drain exceeded the drain estimated using the
3461 // battery level changes and capacity.
3462 OVERCOUNTED = 8;
3463 PHONE = 9;
3464 SCREEN = 10;
3465 // Amount that total computed drain was below the drain estimated using the
3466 // battery level changes and capacity.
3467 UNACCOUNTED = 11;
3468 // reserved 12; reserved "USER"; // Entire drain for a user. This is NOT supported.
3469 WIFI = 13;
3470 }
3471 optional DrainType drain_type = 1;
3472
3473 // Power used by this item in mAh, as computed by BatteryStats, since BatteryStats last reset
3474 // (i.e. roughly since device was last significantly charged).
3475 optional float power_milli_amp_hours = 2;
Rafal Slawik3bea8952018-11-15 12:39:33 +00003476}
arangelov4e994062018-11-13 16:12:38 +00003477
3478/**
3479 * Logs device policy features.
3480 *
3481 * Logged from:
3482 * frameworks/base/services/devicepolicy/java/com/android/server/devicepolicy/DevicePolicyManagerService.java
3483 * packages/apps/ManagedProvisioning/src/com/android/managedprovisioning/
3484 */
3485message DevicePolicyEvent {
3486 // The event id - unique for each event.
3487 optional android.stats.devicepolicy.EventId event_id = 1;
3488 // The admin package name.
3489 optional string admin_package_name = 2;
3490 // A generic integer parameter.
3491 optional int32 integer_value = 3;
3492 // A generic boolean parameter.
3493 optional bool boolean_value = 4;
3494 // A parameter specifying a time period in milliseconds.
3495 optional uint64 time_period_millis = 5;
3496 // A parameter specifying a list of package names, bundle extras or string parameters.
3497 optional android.stats.devicepolicy.StringList string_list_value = 6 [(log_mode) = MODE_BYTES];
3498}
shawnlinea5b66b2018-11-13 15:05:29 +08003499
3500/**
3501 * Logs when DocumentsUI is started, and how. Call this when DocumentsUI first starts up.
3502 *
3503 * Logged from:
3504 * package/app/DocumentsUI/src/com/android/documentsui/Metrics.java
3505 */
3506message DocsUILaunchReported {
3507 optional android.stats.docsui.LaunchAction launch_action = 1;
3508 optional bool has_initial_uri = 2;
3509 optional android.stats.docsui.MimeType mime_type = 3;
3510 optional android.stats.docsui.Root initial_root = 4;
3511}
3512
3513/**
3514 * Logs root/app visited event in file managers/picker. Call this when the user
3515 * taps on root/app in hamburger menu.
3516 *
3517 * Logged from:
3518 * package/app/DocumentsUI/src/com/android/documentsui/Metrics.java
3519 */
3520message DocsUIRootVisitedReported {
3521 optional android.stats.docsui.ContextScope scope = 1;
3522 optional android.stats.docsui.Root root = 2;
3523}
3524
3525/**
3526 * Logs file operation stats. Call this when a file operation has completed.
3527 *
3528 * Logged from:
3529 * package/app/DocumentsUI/src/com/android/documentsui/Metrics.java
3530 */
3531message DocsUIFileOperationReported {
3532 optional android.stats.docsui.Provider provider = 1;
3533 optional android.stats.docsui.FileOperation file_op = 2;
3534}
3535
3536/**
3537 * Logs file operation stats. Call this when a copy/move operation has completed with a specific
3538 * mode.
3539 *
3540 * Logged from:
3541 * package/app/DocumentsUI/src/com/android/documentsui/Metrics.java
3542 */
3543message DocsUIFileOperationCopyMoveModeReported {
3544 optional android.stats.docsui.FileOperation file_op = 1;
3545 optional android.stats.docsui.CopyMoveOpMode mode = 2;
3546}
3547
3548
3549/**
3550 * Logs file sub operation stats. Call this when a file operation has failed.
3551 *
3552 * Logged from:
3553 * package/app/DocumentsUI/src/com/android/documentsui/Metrics.java
3554 */
3555message DocsUIFileOperationFailureReported {
3556 optional android.stats.docsui.Authority authority = 1;
3557 optional android.stats.docsui.SubFileOperation sub_op = 2;
3558}
3559
3560/**
3561* Logs the cancellation of a file operation. Call this when a job is canceled
3562*
3563* Logged from:
3564* package/app/DocumentsUI/src/com/android/documentsui/Metrics.java
3565*/
3566message DocsUIFileOperationCanceledReported {
3567 optional android.stats.docsui.FileOperation file_op = 1;
3568}
3569
3570/**
3571 * Logs startup time in milliseconds.
3572 *
3573 * Logged from:
3574 * package/app/DocumentsUI/src/com/android/documentsui/Metrics.java
3575 */
3576message DocsUIStartupMsReported {
3577 optional int32 startup_millis = 1;
3578}
3579
3580/**
3581 * Logs the action that was started by user.
3582 *
3583 * Logged from:
3584 * package/app/DocumentsUI/src/com/android/documentsui/Metrics.java
3585 */
3586message DocsUIUserActionReported {
3587 optional android.stats.docsui.UserAction action = 1;
3588}
3589
3590/**
3591 * Logs the invalid type when invalid scoped access is requested.
3592 *
3593 * Logged from:
3594 * package/app/DocumentsUI/src/com/android/documentsui/ScopedAccessMetrics.java
3595 */
3596message DocsUIInvalidScopedAccessRequestReported {
3597 optional android.stats.docsui.InvalidScopedAccess type = 1;
3598}