blob: de89161fe8ae25a5b6727e6042793b0bdf07ca44 [file] [log] [blame]
Glen Kuhne94814572016-10-25 12:40:35 -07001/*
2 * Copyright (C) 2016 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";
18
19package clearcut.connectivity;
20
21option java_package = "com.android.server.wifi";
22option java_outer_classname = "WifiMetricsProto";
23
24// The information about the Wifi events.
25message WifiLog {
26
27 // Session information that gets logged for every Wifi connection.
28 repeated ConnectionEvent connection_event = 1;
29
30 // Number of saved networks in the user profile.
31 optional int32 num_saved_networks = 2;
32
33 // Number of open networks in the saved networks.
34 optional int32 num_open_networks = 3;
35
Hai Shalom808ceb32019-01-25 13:49:49 -080036 // Number of legacy personal networks.
37 optional int32 num_legacy_personal_networks = 4;
Glen Kuhne94814572016-10-25 12:40:35 -070038
Hai Shalom808ceb32019-01-25 13:49:49 -080039 // Number of legacy enterprise networks.
40 optional int32 num_legacy_enterprise_networks = 5;
Glen Kuhne94814572016-10-25 12:40:35 -070041
42 // Does the user have location setting enabled.
43 optional bool is_location_enabled = 6;
44
45 // Does the user have scanning enabled.
46 optional bool is_scanning_always_enabled = 7;
47
48 // Number of times user toggled wifi using the settings menu.
49 optional int32 num_wifi_toggled_via_settings = 8;
50
51 // Number of times user toggled wifi using the airplane menu.
52 optional int32 num_wifi_toggled_via_airplane = 9;
53
54 // Number of networks added by the user.
55 optional int32 num_networks_added_by_user = 10;
56
57 // Number of networks added by applications.
58 optional int32 num_networks_added_by_apps = 11;
59
60 // Number scans that returned empty results.
61 optional int32 num_empty_scan_results = 12;
62
63 // Number scans that returned at least one result.
64 optional int32 num_non_empty_scan_results = 13;
65
Ningyuan Wang72886332017-12-20 16:17:33 -080066 // Number of single scans requests.
Glen Kuhne94814572016-10-25 12:40:35 -070067 optional int32 num_oneshot_scans = 14;
68
69 // Number of repeated background scans that were scheduled to the chip.
70 optional int32 num_background_scans = 15;
71
72 // Error codes that a scan can result in.
73 enum ScanReturnCode {
74
75 // Return Code is unknown.
76 SCAN_UNKNOWN = 0;
77
78 // Scan was successful.
79 SCAN_SUCCESS = 1;
80
81 // Scan was successfully started, but was interrupted.
82 SCAN_FAILURE_INTERRUPTED = 2;
83
84 // Scan failed to start because of invalid configuration
85 // (bad channel, etc).
86 SCAN_FAILURE_INVALID_CONFIGURATION = 3;
87
88 // Could not start a scan because wifi is disabled.
89 FAILURE_WIFI_DISABLED = 4;
90
91 }
92
93 // Mapping of error codes to the number of times that scans resulted
94 // in that error.
95 repeated ScanReturnEntry scan_return_entries = 16;
96
97 message ScanReturnEntry {
98
Hai Shaloma18c32c2019-01-22 10:01:09 -080099 // Return code of the scan.
100 optional ScanReturnCode scan_return_code = 1;
Glen Kuhne94814572016-10-25 12:40:35 -0700101
Hai Shaloma18c32c2019-01-22 10:01:09 -0800102 // Number of entries that were found in the scan.
103 optional int32 scan_results_count = 2;
Glen Kuhne94814572016-10-25 12:40:35 -0700104 }
105
106 // State of the Wifi.
107 enum WifiState {
108
109 // State is unknown.
110 WIFI_UNKNOWN = 0;
111
112 // Wifi is disabled.
113 WIFI_DISABLED = 1;
114
115 // Wifi is enabled.
116 WIFI_DISCONNECTED = 2;
117
118 // Wifi is enabled and associated with an AP.
119 WIFI_ASSOCIATED = 3;
120 }
121
122 // Mapping of system state to the number of times that scans were requested in
123 // that state
124 repeated WifiSystemStateEntry wifi_system_state_entries = 17;
125
126 message WifiSystemStateEntry {
127
Hai Shaloma18c32c2019-01-22 10:01:09 -0800128 // Current WiFi state.
129 optional WifiState wifi_state = 1;
Glen Kuhne94814572016-10-25 12:40:35 -0700130
Hai Shaloma18c32c2019-01-22 10:01:09 -0800131 // Count of scans in state.
132 optional int32 wifi_state_count = 2;
Glen Kuhne94814572016-10-25 12:40:35 -0700133
Hai Shaloma18c32c2019-01-22 10:01:09 -0800134 // Is screen on.
135 optional bool is_screen_on = 3;
Glen Kuhne94814572016-10-25 12:40:35 -0700136 }
137
138 // Mapping of Error/Success codes to the number of background scans that resulted in it
139 repeated ScanReturnEntry background_scan_return_entries = 18;
140
141 // Mapping of system state to the number of times that Background scans were requested in that
142 // state
143 repeated WifiSystemStateEntry background_scan_request_state = 19;
144
145 // Total number of times the Watchdog of Last Resort triggered, resetting the wifi stack
146 optional int32 num_last_resort_watchdog_triggers = 20;
147
148 // Total number of networks over bad association threshold when watchdog triggered
149 optional int32 num_last_resort_watchdog_bad_association_networks_total = 21;
150
151 // Total number of networks over bad authentication threshold when watchdog triggered
152 optional int32 num_last_resort_watchdog_bad_authentication_networks_total = 22;
153
154 // Total number of networks over bad dhcp threshold when watchdog triggered
155 optional int32 num_last_resort_watchdog_bad_dhcp_networks_total = 23;
156
157 // Total number of networks over bad other threshold when watchdog triggered
158 optional int32 num_last_resort_watchdog_bad_other_networks_total = 24;
159
160 // Total count of networks seen when watchdog triggered
161 optional int32 num_last_resort_watchdog_available_networks_total = 25;
162
163 // Total count of triggers with atleast one bad association network
164 optional int32 num_last_resort_watchdog_triggers_with_bad_association = 26;
165
166 // Total count of triggers with atleast one bad authentication network
167 optional int32 num_last_resort_watchdog_triggers_with_bad_authentication = 27;
168
169 // Total count of triggers with atleast one bad dhcp network
170 optional int32 num_last_resort_watchdog_triggers_with_bad_dhcp = 28;
171
172 // Total count of triggers with atleast one bad other network
173 optional int32 num_last_resort_watchdog_triggers_with_bad_other = 29;
174
175 // Count of times connectivity watchdog confirmed pno is working
176 optional int32 num_connectivity_watchdog_pno_good = 30;
177
178 // Count of times connectivity watchdog found pno not working
179 optional int32 num_connectivity_watchdog_pno_bad = 31;
180
181 // Count of times connectivity watchdog confirmed background scan is working
182 optional int32 num_connectivity_watchdog_background_good = 32;
183
184 // Count of times connectivity watchdog found background scan not working
185 optional int32 num_connectivity_watchdog_background_bad = 33;
186
187 // The time duration represented by this wifi log, from start to end of capture
188 optional int32 record_duration_sec = 34;
189
190 // Counts the occurrences of each individual RSSI poll level
191 repeated RssiPollCount rssi_poll_rssi_count = 35;
192
193 // Total number of times WiFi connected immediately after a Last Resort Watchdog trigger,
194 // without new networks becoming available.
195 optional int32 num_last_resort_watchdog_successes = 36;
196
197 // Total number of saved hidden networks
198 optional int32 num_hidden_networks = 37;
199
200 // Total number of saved passpoint / hotspot 2.0 networks
201 optional int32 num_passpoint_networks = 38;
202
203 // Total number of scan results
204 optional int32 num_total_scan_results = 39;
205
206 // Total number of scan results for open networks
207 optional int32 num_open_network_scan_results = 40;
208
Hai Shalom808ceb32019-01-25 13:49:49 -0800209 // Total number of scan results for legacy personal networks
210 optional int32 num_legacy_personal_network_scan_results = 41;
Glen Kuhne94814572016-10-25 12:40:35 -0700211
Hai Shalom808ceb32019-01-25 13:49:49 -0800212 // Total number of scan results for legacy enterprise networks
213 optional int32 num_legacy_enterprise_network_scan_results = 42;
Glen Kuhne94814572016-10-25 12:40:35 -0700214
215 // Total number of scan results for hidden networks
216 optional int32 num_hidden_network_scan_results = 43;
217
218 // Total number of scan results for hotspot 2.0 r1 networks
219 optional int32 num_hotspot2_r1_network_scan_results = 44;
220
221 // Total number of scan results for hotspot 2.0 r2 networks
222 optional int32 num_hotspot2_r2_network_scan_results = 45;
223
224 // Total number of scans handled by framework (oneshot or otherwise)
225 optional int32 num_scans = 46;
226
227 // Counts the occurrences of each alert reason.
228 repeated AlertReasonCount alert_reason_count = 47;
229
230 // Counts the occurrences of each Wifi score
231 repeated WifiScoreCount wifi_score_count = 48;
232
233 // Histogram of Soft AP Durations
234 repeated SoftApDurationBucket soft_ap_duration = 49;
235
236 // Histogram of Soft AP ReturnCode
237 repeated SoftApReturnCodeCount soft_ap_return_code = 50;
238
239 // Histogram of the delta between scan result RSSI and RSSI polls
240 repeated RssiPollCount rssi_poll_delta_count = 51;
Glen Kuhne8ce9a1c2017-03-28 14:02:48 -0700241
242 // List of events
243 repeated StaEvent sta_event_list = 52;
Roshan Pius3607a392017-05-11 09:05:58 -0700244
245 // Total number of times WiFi HAL crashed.
246 optional int32 num_hal_crashes = 53;
247
248 // Total number of times WiFicond crashed.
249 optional int32 num_wificond_crashes = 54;
250
251 // Indicates the number of times an error was encountered in
Roshan Piusa66e6382018-03-14 16:10:16 -0700252 // Wifi HAL on |WifiNative.setupInterfaceForClientMode|.
253 optional int32 num_setup_client_interface_failure_due_to_hal = 55;
Roshan Pius3607a392017-05-11 09:05:58 -0700254
255 // Indicates the number of times an error was encountered in
Roshan Piusa66e6382018-03-14 16:10:16 -0700256 // Wificond on |WifiNative.setupInterfaceForClientMode|.
257 optional int32 num_setup_client_interface_failure_due_to_wificond = 56;
Etan Cohen737addc2017-04-26 08:01:57 -0700258
259 // Wi-Fi Aware metrics
260 optional WifiAwareLog wifi_aware_log = 57;
Peter Qiu84243152017-06-22 13:44:04 -0700261
262 // Number of saved Passpoint providers in user profile.
263 optional int32 num_passpoint_providers = 58;
264
265 // Count of times Passpoint provider being installed.
266 optional int32 num_passpoint_provider_installation = 59;
267
268 // Count of times Passpoint provivider is installed successfully.
269 optional int32 num_passpoint_provider_install_success = 60;
270
271 // Count of times Passpoint provider is being uninstalled.
272 optional int32 num_passpoint_provider_uninstallation = 61;
273
274 // Count of times Passpoint provider is uninstalled successfully.
275 optional int32 num_passpoint_provider_uninstall_success = 62;
276
277 // Count of saved Passpoint providers device has ever connected to.
278 optional int32 num_passpoint_providers_successfully_connected = 63;
Glen Kuhnee2d67c02017-04-25 13:08:29 -0700279
280 // Histogram counting instances of scans with N many ScanResults with unique ssids
281 repeated NumConnectableNetworksBucket total_ssids_in_scan_histogram = 64;
282
283 // Histogram counting instances of scans with N many ScanResults/bssids
284 repeated NumConnectableNetworksBucket total_bssids_in_scan_histogram = 65;
285
286 // Histogram counting instances of scans with N many unique open ssids
287 repeated NumConnectableNetworksBucket available_open_ssids_in_scan_histogram = 66;
288
289 // Histogram counting instances of scans with N many bssids for open networks
290 repeated NumConnectableNetworksBucket available_open_bssids_in_scan_histogram = 67;
291
292 // Histogram counting instances of scans with N many unique ssids for saved networks
293 repeated NumConnectableNetworksBucket available_saved_ssids_in_scan_histogram = 68;
294
295 // Histogram counting instances of scans with N many bssids for saved networks
296 repeated NumConnectableNetworksBucket available_saved_bssids_in_scan_histogram = 69;
297
298 // Histogram counting instances of scans with N many unique SSIDs for open or saved networks
299 repeated NumConnectableNetworksBucket available_open_or_saved_ssids_in_scan_histogram = 70;
300
301 // Histogram counting instances of scans with N many BSSIDs for open or saved networks
302 repeated NumConnectableNetworksBucket available_open_or_saved_bssids_in_scan_histogram = 71;
303
304 // Histogram counting instances of scans with N many ScanResults matching unique saved passpoint providers
305 repeated NumConnectableNetworksBucket available_saved_passpoint_provider_profiles_in_scan_histogram = 72;
306
307 // Histogram counting instances of scans with N many ScanResults BSSIDs matching a saved passpoint provider
308 repeated NumConnectableNetworksBucket available_saved_passpoint_provider_bssids_in_scan_histogram = 73;
309
310 // Counts the number of AllSingleScanLister.onResult calls with a full band scan result
311 optional int32 full_band_all_single_scan_listener_results = 74;
312
313 // Counts the number of AllSingleScanLister.onResult calls with a partial (channels) scan result
314 optional int32 partial_all_single_scan_listener_results = 75;
Mehdi Alizadehd9163cf2017-08-10 18:20:25 -0700315
316 // Pno scan metrics
317 optional PnoScanMetrics pno_scan_metrics = 76;
Stephen Chenfc0facb2017-09-14 14:35:15 -0700318
319 // Histogram of "Connect to Network" notifications.
320 // The notification Action should be unset.
321 repeated ConnectToNetworkNotificationAndActionCount connect_to_network_notification_count = 77;
322
323 // Histogram of "Connect to Network" notification user actions.
324 repeated ConnectToNetworkNotificationAndActionCount connect_to_network_notification_action_count = 78;
325
326 // The number of SSIDs blacklisted from recommendation by the open network
327 // notification recommender
328 optional int32 open_network_recommender_blacklist_size = 79;
329
330 // Is the available network notification feature turned on
331 optional bool is_wifi_networks_available_notification_on = 80;
332
333 // Count of recommendation updates made by the open network notification
334 // recommender
335 optional int32 num_open_network_recommendation_updates = 81;
336
337 // Count of connection attempts that were initiated unsuccessfully
338 optional int32 num_open_network_connect_message_failed_to_send = 82;
Etan Cohenc462a7a2017-10-09 10:27:44 -0700339
340 // Histogram counting instances of scans with N many HotSpot 2.0 R1 APs
341 repeated NumConnectableNetworksBucket observed_hotspot_r1_aps_in_scan_histogram = 83;
342
343 // Histogram counting instances of scans with N many HotSpot 2.0 R2 APs
344 repeated NumConnectableNetworksBucket observed_hotspot_r2_aps_in_scan_histogram = 84;
345
346 // Histogram counting instances of scans with N many unique HotSpot 2.0 R1 ESS.
347 // Where ESS is defined as the (HESSID, ANQP Domain ID), (SSID, ANQP Domain ID) or
348 // (SSID, BSSID) tuple depending on AP configuration (in the above priority
349 // order).
350 repeated NumConnectableNetworksBucket observed_hotspot_r1_ess_in_scan_histogram = 85;
351
352 // Histogram counting instances of scans with N many unique HotSpot 2.0 R2 ESS.
353 // Where ESS is defined as the (HESSID, ANQP Domain ID), (SSID, ANQP Domain ID) or
354 // (SSID, BSSID) tuple depending on AP configuration (in the above priority
355 // order).
356 repeated NumConnectableNetworksBucket observed_hotspot_r2_ess_in_scan_histogram = 86;
357
358 // Histogram counting number of HotSpot 2.0 R1 APs per observed ESS in a scan
359 // (one value added per unique ESS - potentially multiple counts per single
360 // scan!)
361 repeated NumConnectableNetworksBucket observed_hotspot_r1_aps_per_ess_in_scan_histogram = 87;
362
363 // Histogram counting number of HotSpot 2.0 R2 APs per observed ESS in a scan
364 // (one value added per unique ESS - potentially multiple counts per single
365 // scan!)
366 repeated NumConnectableNetworksBucket observed_hotspot_r2_aps_per_ess_in_scan_histogram = 88;
Mehdi Alizadeh2a59c52ca2017-10-18 15:42:35 -0700367
368 // SoftAP event list tracking sessions and client counts in tethered mode
369 repeated SoftApConnectedClientsEvent soft_ap_connected_clients_events_tethered = 89;
370
371 // SoftAP event list tracking sessions and client counts in local only mode
372 repeated SoftApConnectedClientsEvent soft_ap_connected_clients_events_local_only = 90;
Jong Wook Kim72c49ee2017-10-26 13:16:36 -0700373
374 // Wps connection metrics
375 optional WpsMetrics wps_metrics = 91;
Siddharth Rayac8b69a2018-01-27 18:05:44 -0800376
377 // Wifi power statistics
378 optional WifiPowerStats wifi_power_stats = 92;
Ningyuan Wang72886332017-12-20 16:17:33 -0800379
380 // Number of connectivity single scan requests.
381 optional int32 num_connectivity_oneshot_scans = 93;
Eric Schwarzenbach9f941f92018-02-16 11:10:30 -0800382
383 // WifiWake statistics
384 optional WifiWakeStats wifi_wake_stats = 94;
Etan Cohenf30125b2018-03-24 16:51:41 -0700385
386 // Histogram counting instances of scans with N many 802.11mc (RTT) supporting APs
387 repeated NumConnectableNetworksBucket observed_80211mc_supporting_aps_in_scan_histogram = 95;
Roshan Piusa66e6382018-03-14 16:10:16 -0700388
389 // Total number of times supplicant crashed.
390 optional int32 num_supplicant_crashes = 96;
391
392 // Total number of times hostapd crashed.
393 optional int32 num_hostapd_crashes = 97;
394
395 // Indicates the number of times an error was encountered in
396 // supplicant on |WifiNative.setupInterfaceForClientMode|.
397 optional int32 num_setup_client_interface_failure_due_to_supplicant = 98;
398
399 // Indicates the number of times an error was encountered in
400 // Wifi HAL on |WifiNative.setupInterfaceForSoftApMode|.
401 optional int32 num_setup_soft_ap_interface_failure_due_to_hal = 99;
402
403 // Indicates the number of times an error was encountered in
404 // Wifi HAL on |WifiNative.setupInterfaceForSoftApMode|.
405 optional int32 num_setup_soft_ap_interface_failure_due_to_wificond = 100;
406
407 // Indicates the number of times an error was encountered in
408 // Wifi HAL on |WifiNative.setupInterfaceForSoftApMode|.
409 optional int32 num_setup_soft_ap_interface_failure_due_to_hostapd = 101;
410
411 // Indicates the number of times we got an interface down in client mode.
412 optional int32 num_client_interface_down = 102;
413
414 // Indicates the number of times we got an interface down in softap mode.
415 optional int32 num_soft_ap_interface_down = 103;
Roshan Pius48f65632018-03-27 14:33:01 -0700416
417 // Indicates the number of scan requests from external apps.
418 optional int32 num_external_app_oneshot_scan_requests = 104;
419
420 // Indicates the number of times a scan request from an external foreground app was throttled.
421 optional int32 num_external_foreground_app_oneshot_scan_requests_throttled = 105;
422
423 // Indicates the number of times a scan request from an external background app was throttled.
424 optional int32 num_external_background_app_oneshot_scan_requests_throttled = 106;
xshu63522622018-03-15 16:48:29 -0700425
426 // WifiLastResortWatchdog time milliseconds delta between trigger and first connection success
427 optional int64 watchdog_trigger_to_connection_success_duration_ms = 107 [default = -1];
428
429 // The number of times wifi experienced failures after watchdog has already been triggered and is
430 // waiting for a connection success
431 optional int64 watchdog_total_connection_failure_count_after_trigger = 108;
xshu39cef4d2018-03-23 15:14:02 -0700432
433 // Number of times DFS channel scans are requested in single scan requests.
434 optional int32 num_oneshot_has_dfs_channel_scans = 109;
Etan Cohen4ec8dd32018-03-16 09:43:01 -0700435
436 // Wi-Fi RTT metrics
437 optional WifiRttLog wifi_rtt_log = 110;
Jong Wook Kim01ad38b2018-04-09 10:14:11 -0700438
439 // Flag which indicates if Connected MAC Randomization is enabled
440 optional bool is_mac_randomization_on = 111 [default = false];
Roshan Pius6de7a672018-04-24 16:30:13 -0700441
442 // Number of radio mode changes to MCC (Multi channel concurrency).
443 optional int32 num_radio_mode_change_to_mcc = 112;
444
445 // Number of radio mode changes to SCC (Single channel concurrency).
446 optional int32 num_radio_mode_change_to_scc = 113;
447
448 // Number of radio mode changes to SBS (Single band simultaneous).
449 optional int32 num_radio_mode_change_to_sbs = 114;
450
451 // Number of radio mode changes to DBS (Dual band simultaneous).
452 optional int32 num_radio_mode_change_to_dbs = 115;
Roshan Piusd3a58cb2018-05-14 15:53:44 -0700453
454 // Number of times the firmware picked a SoftAp channel not satisfying user band preference.
455 optional int32 num_soft_ap_user_band_preference_unsatisfied = 116;
Michael Plass8a779ac2018-05-09 16:56:52 -0700456
457 // Identifier for experimental scoring parameter settings.
458 optional string score_experiment_id = 117;
459
xshub483b722018-05-22 15:46:26 -0700460 // Data on wifi radio usage
461 optional WifiRadioUsage wifi_radio_usage = 118;
Jong Wook Kim411cab92018-04-26 15:09:23 -0700462
463 // Stores settings values used for metrics testing.
464 optional ExperimentValues experiment_values = 119;
465
466 // List of WifiIsUnusableEvents which get logged when we notice that WiFi is unusable.
467 // Collected only when WIFI_IS_UNUSABLE_EVENT_METRICS_ENABLED Settings is enabled.
468 repeated WifiIsUnusableEvent wifi_is_unusable_event_list = 120;
Jong Wook Kime4aa37f2018-04-23 11:18:24 -0700469
470 // Counts the occurrences of each link speed (Mbps) level
471 // with rssi (dBm) and rssi^2 sums (dBm^2)
472 repeated LinkSpeedCount link_speed_counts = 121;
Ahmed ElArabawyba64b612018-06-15 09:17:45 -0700473
474 // Number of times the SarManager failed to register SAR sensor listener
475 optional int32 num_sar_sensor_registration_failures = 122;
Ecco Park5a403002018-07-23 15:53:10 -0700476
477 // Histogram of the EAP method type of all installed Passpoint profiles
478 repeated PasspointProfileTypeCount installed_passpoint_profile_type = 123;
Siddharth Ray191b10b2018-08-10 17:36:17 -0700479
480 // Hardware revision (EVT, DVT, PVT etc.)
481 optional string hardware_revision = 124;
xshu0e0dea42018-09-17 17:30:15 -0700482
483 // Total wifi link layer usage data over the logging duration in ms.
484 optional WifiLinkLayerUsageStats wifi_link_layer_usage_stats = 125;
xshua33726e2018-09-24 15:02:23 -0700485
486 // Multiple lists of timestamped link layer stats with labels to represent whether wifi is usable
487 repeated WifiUsabilityStats wifi_usability_stats_list = 126;
Mingguang Xuca2aab12019-01-12 23:40:42 -0800488
489 // Counts the occurrences of each Wifi usability score provided by external app
490 repeated WifiUsabilityScoreCount wifi_usability_score_count = 127;
David Su367bdff2018-12-13 13:39:11 -0800491
492 // List of PNO scan stats, one element for each mobility state
493 repeated DeviceMobilityStatePnoScanStats mobility_state_pno_stats_list = 128;
Jimmy Chen0142e8b2018-11-23 16:25:57 +0800494
495 // Wifi p2p statistics
496 optional WifiP2pStats wifi_p2p_stats = 129;
Hai Shaloma18c32c2019-01-22 10:01:09 -0800497
498 // Easy Connect (DPP) metrics
499 optional WifiDppLog wifi_dpp_log = 130;
Hai Shalom808ceb32019-01-25 13:49:49 -0800500
501 // Number of Enhanced Open (OWE) networks in the saved networks.
502 optional int32 num_enhanced_open_networks = 131;
503
504 // Number of WPA3-Personal networks.
505 optional int32 num_wpa3_personal_networks = 132;
506
507 // Number of WPA3-Enterprise networks.
508 optional int32 num_wpa3_enterprise_networks = 133;
509
510 // Total number of scan results for Enhanced open networks
511 optional int32 num_enhanced_open_network_scan_results = 134;
512
513 // Total number of scan results for WPA3-Personal networks
514 optional int32 num_wpa3_personal_network_scan_results = 135;
515
516 // Total number of scan results for WPA3-Enterprise networks
517 optional int32 num_wpa3_enterprise_network_scan_results = 136;
Roshan Pius89b233d2019-01-31 10:15:22 -0800518
519 // WifiConfigStore read/write metrics.
520 optional WifiConfigStoreIO wifi_config_store_io = 137;
xshuaeabbb72019-02-08 13:27:17 -0800521
522 // Total number of saved networks with mac randomization enabled.
523 optional int32 num_saved_networks_with_mac_randomization = 138;
David Su44306932019-02-12 16:53:46 -0800524
525 // Link Probe metrics
526 optional LinkProbeStats link_probe_stats = 139;
David Sua04f5052019-02-20 17:42:28 -0800527
528 // List of NetworkSelectionExperimentDecisions stats for each experiment
529 repeated NetworkSelectionExperimentDecisions network_selection_experiment_decisions_list = 140;
Roshan Pius3f30ba82019-02-08 11:55:55 -0800530
531 // Network Request API surface metrics.
532 optional WifiNetworkRequestApiLog wifi_network_request_api_log = 141;
533
534 // Network Suggestion API surface metrics.
535 optional WifiNetworkSuggestionApiLog wifi_network_suggestion_api_log = 142;
Ahmed ElArabawy048e1482019-03-25 10:42:04 -0700536
537 // WifiLock statistics
538 optional WifiLockStats wifi_lock_stats = 143;
xshu08c67382019-04-04 17:39:33 -0700539
540 // Stats on number of times Wi-Fi is turned on/off though the WifiManager#setWifiEnabled API
541 optional WifiToggleStats wifi_toggle_stats = 144;
542
543 // Number of times WifiManager#addOrUpdateNetwork is called.
544 optional int32 num_add_or_update_network_calls = 145;
545
546 // Number of times WifiManager#enableNetwork is called.
547 optional int32 num_enable_network_calls = 146;
Glen Kuhne94814572016-10-25 12:40:35 -0700548}
549
550// Information that gets logged for every WiFi connection.
551message RouterFingerPrint {
552
553 enum RoamType {
554
555 // Type is unknown.
556 ROAM_TYPE_UNKNOWN = 0;
557
558 // No roaming - usually happens on a single band (2.4 GHz) router.
559 ROAM_TYPE_NONE = 1;
560
561 // Enterprise router.
562 ROAM_TYPE_ENTERPRISE = 2;
563
564 // DBDC => Dual Band Dual Concurrent essentially a router that
565 // supports both 2.4 GHz and 5 GHz bands.
566 ROAM_TYPE_DBDC = 3;
567 }
568
569 enum Auth {
570
571 // Auth is unknown.
572 AUTH_UNKNOWN = 0;
573
574 // No authentication.
575 AUTH_OPEN = 1;
576
577 // If the router uses a personal authentication.
578 AUTH_PERSONAL = 2;
579
580 // If the router is setup for enterprise authentication.
581 AUTH_ENTERPRISE = 3;
582 }
583
584 enum RouterTechnology {
585
586 // Router is unknown.
587 ROUTER_TECH_UNKNOWN = 0;
588
589 // Router Channel A.
590 ROUTER_TECH_A = 1;
591
592 // Router Channel B.
593 ROUTER_TECH_B = 2;
594
595 // Router Channel G.
596 ROUTER_TECH_G = 3;
597
598 // Router Channel N.
599 ROUTER_TECH_N = 4;
600
601 // Router Channel AC.
602 ROUTER_TECH_AC = 5;
603
604 // When the channel is not one of the above.
605 ROUTER_TECH_OTHER = 6;
606 }
607
608 optional RoamType roam_type = 1;
609
610 // Channel on which the connection takes place.
611 optional int32 channel_info = 2;
612
613 // DTIM setting of the router.
614 optional int32 dtim = 3;
615
616 // Authentication scheme of the router.
617 optional Auth authentication = 4;
618
619 // If the router is hidden.
620 optional bool hidden = 5;
621
622 // Channel information.
623 optional RouterTechnology router_technology = 6;
624
625 // whether ipv6 is supported.
626 optional bool supports_ipv6 = 7;
627
628 // If the router is a passpoint / hotspot 2.0 network
629 optional bool passpoint = 8;
630}
631
632message ConnectionEvent {
633
634 // Roam Type.
635 enum RoamType {
636
637 // Type is unknown.
638 ROAM_UNKNOWN = 0;
639
640 // No roaming.
Hai Shaloma18c32c2019-01-22 10:01:09 -0800641 ROAM_NONE = 1;
Glen Kuhne94814572016-10-25 12:40:35 -0700642
643 // DBDC roaming.
644 ROAM_DBDC = 2;
645
646 // Enterprise roaming.
647 ROAM_ENTERPRISE = 3;
648
649 // User selected roaming.
650 ROAM_USER_SELECTED = 4;
651
652 // Unrelated.
653 ROAM_UNRELATED = 5;
654 }
655
656 // Connectivity Level Failure.
657 enum ConnectivityLevelFailure {
658
659 // Failure is unknown.
660 HLF_UNKNOWN = 0;
661
662 // No failure.
663 HLF_NONE = 1;
664
665 // DHCP failure.
666 HLF_DHCP = 2;
667
668 // No internet connection.
669 HLF_NO_INTERNET = 3;
670
671 // No internet connection.
672 HLF_UNWANTED = 4;
673 }
674
Mingguang Xu7d2adc12019-02-12 09:07:35 -0800675 // Level 2 failure reason.
676 enum Level2FailureReason {
677
678 // Unknown default
679 FAILURE_REASON_UNKNOWN = 0;
680
681 // The reason code if there is no error during authentication. It could
682 // also imply that there no authentication in progress.
683 AUTH_FAILURE_NONE = 1;
684
685 // The reason code if there was a timeout authenticating.
686 AUTH_FAILURE_TIMEOUT = 2;
687
688 // The reason code if there was a wrong password while authenticating.
689 AUTH_FAILURE_WRONG_PSWD = 3;
690
691 // The reason code if there was EAP failure while authenticating.
692 AUTH_FAILURE_EAP_FAILURE = 4;
693 }
694
David Su21709bc2019-02-24 15:26:50 -0800695 // Entity that recommended connecting to this network.
696 enum ConnectionNominator {
697 // Unknown nominator
698 NOMINATOR_UNKNOWN = 0;
699
700 // User selected network manually
701 NOMINATOR_MANUAL = 1;
702
703 // Saved network
704 NOMINATOR_SAVED = 2;
705
706 // Suggestion API
707 NOMINATOR_SUGGESTION = 3;
708
709 // Passpoint
710 NOMINATOR_PASSPOINT = 4;
711
712 // Carrier suggestion
713 NOMINATOR_CARRIER = 5;
714
715 // External scorer
716 NOMINATOR_EXTERNAL_SCORED = 6;
717
David Sua75b6392019-03-21 20:34:22 -0700718 // Network Specifier
719 NOMINATOR_SPECIFIER = 7;
David Su21709bc2019-02-24 15:26:50 -0800720
721 // User connected choice override
722 NOMINATOR_SAVED_USER_CONNECT_CHOICE = 8;
723
724 // Open Network Available Pop-up
725 NOMINATOR_OPEN_NETWORK_AVAILABLE = 9;
726 }
727
Glen Kuhne94814572016-10-25 12:40:35 -0700728 // Start time of the connection.
729 optional int64 start_time_millis = 1;// [(datapol.semantic_type) = ST_TIMESTAMP];
730
731 // Duration to connect.
732 optional int32 duration_taken_to_connect_millis = 2;
733
734 // Router information.
735 optional RouterFingerPrint router_fingerprint = 3;
736
737 // RSSI at the start of the connection.
738 optional int32 signal_strength = 4;
739
740 // Roam Type.
741 optional RoamType roam_type = 5;
742
743 // Result of the connection.
744 optional int32 connection_result = 6;
745
746 // Reasons for level 2 failure (needs to be coordinated with wpa-supplicant).
747 optional int32 level_2_failure_code = 7;
748
749 // Failures that happen at the connectivity layer.
750 optional ConnectivityLevelFailure connectivity_level_failure_code = 8;
751
752 // Has bug report been taken.
753 optional bool automatic_bug_report_taken = 9;
xshu483a45b2019-02-08 13:24:02 -0800754
755 // Connection is using locally generated random MAC address.
756 optional bool use_randomized_mac = 10 [default = false];
David Su21709bc2019-02-24 15:26:50 -0800757
758 // Who chose to connect.
759 optional ConnectionNominator connection_nominator = 11;
760
761 // The currently running network selector when this connection event occurred.
762 optional int32 network_selector_experiment_id = 12;
Mingguang Xu7d2adc12019-02-12 09:07:35 -0800763
764 // Breakdown of level_2_failure_code with more detailed reason.
765 optional Level2FailureReason level_2_failure_reason = 13
766 [default = FAILURE_REASON_UNKNOWN];
Glen Kuhne94814572016-10-25 12:40:35 -0700767}
768
769// Number of occurrences of a specific RSSI poll rssi value
770message RssiPollCount {
771 // RSSI
772 optional int32 rssi = 1;
773
774 // Number of RSSI polls with 'rssi'
775 optional int32 count = 2;
xshu122886e2018-05-16 15:38:49 -0700776
777 // Beacon frequency of the channel in MHz
778 optional int32 frequency = 3;
Glen Kuhne94814572016-10-25 12:40:35 -0700779}
780
781// Number of occurrences of a specific alert reason value
782message AlertReasonCount {
783 // Alert reason
784 optional int32 reason = 1;
785
786 // Number of alerts with |reason|.
787 optional int32 count = 2;
788}
789
790// Counts the number of instances of a specific Wifi Score calculated by WifiScoreReport
791message WifiScoreCount {
792 // Wifi Score
793 optional int32 score = 1;
794
795 // Number of Wifi score reports with this score
796 optional int32 count = 2;
797}
798
Mingguang Xuca2aab12019-01-12 23:40:42 -0800799// Counts the number of instances of a specific Wifi Usability Score
800message WifiUsabilityScoreCount {
801 // Wifi Usability Score
802 optional int32 score = 1;
803
804 // Number of Wifi score reports with this score
805 optional int32 count = 2;
806}
807
Jong Wook Kime4aa37f2018-04-23 11:18:24 -0700808// Number of occurrences of a specific link speed (Mbps)
809// and sum of rssi (dBm) and rssi^2 (dBm^2)
810message LinkSpeedCount {
811 // Link speed (Mbps)
812 optional int32 link_speed_mbps = 1;
813
814 // Number of RSSI polls with link_speed
815 optional int32 count = 2;
816
817 // Sum of absolute values of rssi values (dBm)
818 optional int32 rssi_sum_dbm = 3;
819
820 // Sum of squares of rssi values (dBm^2)
821 optional int64 rssi_sum_of_squares_dbm_sq = 4;
822}
823
Glen Kuhne94814572016-10-25 12:40:35 -0700824// Number of occurrences of Soft AP session durations
825message SoftApDurationBucket {
826 // Bucket covers duration : [duration_sec, duration_sec + bucket_size_sec)
827 // The (inclusive) lower bound of Soft AP session duration represented by this bucket
828 optional int32 duration_sec = 1;
829
830 // The size of this bucket
831 optional int32 bucket_size_sec = 2;
832
833 // Number of soft AP session durations that fit into this bucket
834 optional int32 count = 3;
835}
836
837// Number of occurrences of a soft AP session return code
838message SoftApReturnCodeCount {
Rebecca Silberstein28d9de22017-01-24 10:42:59 -0800839
840 enum SoftApStartResult {
841
842 // SoftApManager return code unknown
843 SOFT_AP_RETURN_CODE_UNKNOWN = 0;
844
845 // SoftAp started successfully
846 SOFT_AP_STARTED_SUCCESSFULLY = 1;
847
848 // Catch all for failures with no specific failure reason
849 SOFT_AP_FAILED_GENERAL_ERROR = 2;
850
851 // SoftAp failed to start due to NO_CHANNEL error
852 SOFT_AP_FAILED_NO_CHANNEL = 3;
853 }
854
855 // Historical, no longer used for writing as of 01/2017.
856 optional int32 return_code = 1 [deprecated = true];
Glen Kuhne94814572016-10-25 12:40:35 -0700857
858 // Occurrences of this soft AP return code
859 optional int32 count = 2;
Rebecca Silberstein28d9de22017-01-24 10:42:59 -0800860
861 // Result of attempt to start SoftAp
862 optional SoftApStartResult start_result = 3;
Glen Kuhne94814572016-10-25 12:40:35 -0700863}
Glen Kuhne8ce9a1c2017-03-28 14:02:48 -0700864
865message StaEvent {
866 message ConfigInfo {
867 // The set of key management protocols supported by this configuration.
868 optional uint32 allowed_key_management = 1 [default = 0];
869
870 // The set of security protocols supported by this configuration.
871 optional uint32 allowed_protocols = 2 [default = 0];
872
873 // The set of authentication protocols supported by this configuration.
874 optional uint32 allowed_auth_algorithms = 3 [default = 0];
875
876 // The set of pairwise ciphers for WPA supported by this configuration.
877 optional uint32 allowed_pairwise_ciphers = 4 [default = 0];
878
879 // The set of group ciphers supported by this configuration.
880 optional uint32 allowed_group_ciphers = 5;
881
882 // Is this a 'hidden network'
883 optional bool hidden_ssid = 6;
884
885 // Is this a Hotspot 2.0 / passpoint network
886 optional bool is_passpoint = 7;
887
888 // Is this an 'ephemeral' network (Not in saved network list, recommended externally)
889 optional bool is_ephemeral = 8;
890
891 // Has a successful connection ever been established using this WifiConfiguration
892 optional bool has_ever_connected = 9;
893
894 // RSSI of the scan result candidate associated with this WifiConfiguration
895 optional int32 scan_rssi = 10 [default = -127];
896
897 // Frequency of the scan result candidate associated with this WifiConfiguration
898 optional int32 scan_freq = 11 [default = -1];
899 }
900
901 enum EventType {
902 // Default/Invalid event
903 TYPE_UNKNOWN = 0;
904
905 // Supplicant Association Rejection event. Code contains the 802.11
906 TYPE_ASSOCIATION_REJECTION_EVENT = 1;
907
908 // Supplicant L2 event,
909 TYPE_AUTHENTICATION_FAILURE_EVENT = 2;
910
911 // Supplicant L2 event
912 TYPE_NETWORK_CONNECTION_EVENT = 3;
913
914 // Supplicant L2 event
915 TYPE_NETWORK_DISCONNECTION_EVENT = 4;
916
917 // Supplicant L2 event
918 TYPE_SUPPLICANT_STATE_CHANGE_EVENT = 5;
919
920 // Supplicant L2 event
921 TYPE_CMD_ASSOCIATED_BSSID = 6;
922
923 // IP Manager successfully completed IP Provisioning
924 TYPE_CMD_IP_CONFIGURATION_SUCCESSFUL = 7;
925
926 // IP Manager failed to complete IP Provisioning
927 TYPE_CMD_IP_CONFIGURATION_LOST = 8;
928
929 // IP Manager lost reachability to network neighbors
930 TYPE_CMD_IP_REACHABILITY_LOST = 9;
931
932 // Indicator that Supplicant is targeting a BSSID for roam/connection
933 TYPE_CMD_TARGET_BSSID = 10;
934
935 // Wifi framework is initiating a connection attempt
936 TYPE_CMD_START_CONNECT = 11;
937
938 // Wifi framework is initiating a roaming connection attempt
939 TYPE_CMD_START_ROAM = 12;
940
941 // SystemAPI connect() command, Settings App
942 TYPE_CONNECT_NETWORK = 13;
943
944 // Network Agent has validated the internet connection (Captive Portal Check success, or user
945 // validation)
946 TYPE_NETWORK_AGENT_VALID_NETWORK = 14;
947
948 // Framework initiated disconnect. Sometimes generated to give an extra reason for a disconnect
949 // Should typically be followed by a NETWORK_DISCONNECTION_EVENT with a local_gen = true
950 TYPE_FRAMEWORK_DISCONNECT = 15;
Michael Plassbb367b62017-10-06 10:29:51 -0700951
952 // The NetworkAgent score for wifi has changed in a way that may impact
953 // connectivity
954 TYPE_SCORE_BREACH = 16;
Jong Wook Kim01ad38b2018-04-09 10:14:11 -0700955
956 // Framework changed Sta interface MAC address
957 TYPE_MAC_CHANGE = 17;
Jong Wook Kimb56979f2018-08-08 14:50:18 -0700958
959 // Wifi is turned on
960 TYPE_WIFI_ENABLED = 18;
961
962 // Wifi is turned off
963 TYPE_WIFI_DISABLED = 19;
Mingguang Xuca2aab12019-01-12 23:40:42 -0800964
965 // The NetworkAgent Wifi usability score has changed in a way that may
966 // impact connectivity
967 TYPE_WIFI_USABILITY_SCORE_BREACH = 20;
Glen Kuhne8ce9a1c2017-03-28 14:02:48 -0700968 }
969
970 enum FrameworkDisconnectReason {
971 // default/none/unknown value
972 DISCONNECT_UNKNOWN = 0;
973
974 // API DISCONNECT
975 DISCONNECT_API = 1;
976
977 // Some framework internal reason (generic)
978 DISCONNECT_GENERIC = 2;
979
980 // Network Agent network validation failed, user signaled network unwanted
981 DISCONNECT_UNWANTED = 3;
982
983 // Roaming timed out
984 DISCONNECT_ROAM_WATCHDOG_TIMER = 4;
985
986 // P2P service requested wifi disconnect
987 DISCONNECT_P2P_DISCONNECT_WIFI_REQUEST = 5;
988
989 // SIM was removed while using a SIM config
990 DISCONNECT_RESET_SIM_NETWORKS = 6;
991 }
992
993 // Authentication Failure reasons as reported through the API.
994 enum AuthFailureReason {
995 // Unknown default
996 AUTH_FAILURE_UNKNOWN = 0;
997
998 // The reason code if there is no error during authentication. It could also imply that there no
999 // authentication in progress,
1000 AUTH_FAILURE_NONE = 1;
1001
1002 // The reason code if there was a timeout authenticating.
1003 AUTH_FAILURE_TIMEOUT = 2;
1004
1005 // The reason code if there was a wrong password while authenticating.
1006 AUTH_FAILURE_WRONG_PSWD = 3;
1007
1008 // The reason code if there was EAP failure while authenticating.
1009 AUTH_FAILURE_EAP_FAILURE = 4;
1010 }
1011
1012 // What event was this
1013 optional EventType type = 1;
1014
1015 // 80211 death reason code, relevant to NETWORK_DISCONNECTION_EVENTs
1016 optional int32 reason = 2 [default = -1];
1017
1018 // 80211 Association Status code, relevant to ASSOCIATION_REJECTION_EVENTs
1019 optional int32 status = 3 [default = -1];
1020
1021 // Designates whether a NETWORK_DISCONNECT_EVENT was by the STA or AP
1022 optional bool local_gen = 4 [default = false];
1023
1024 // Network information from the WifiConfiguration of a framework initiated connection attempt
1025 optional ConfigInfo config_info = 5;
1026
1027 // RSSI from the last rssi poll (Only valid for active connections)
1028 optional int32 last_rssi = 6 [default = -127];
1029
1030 // Link speed from the last rssi poll (Only valid for active connections)
1031 optional int32 last_link_speed = 7 [default = -1];
1032
1033 // Frequency from the last rssi poll (Only valid for active connections)
1034 optional int32 last_freq = 8 [default = -1];
1035
1036 // Enum used to define bit positions in the supplicant_state_change_bitmask
1037 // See {@code frameworks/base/wifi/java/android/net/wifi/SupplicantState.java} for documentation
1038 enum SupplicantState {
1039 STATE_DISCONNECTED = 0;
1040
1041 STATE_INTERFACE_DISABLED = 1;
1042
1043 STATE_INACTIVE = 2;
1044
1045 STATE_SCANNING = 3;
1046
1047 STATE_AUTHENTICATING = 4;
1048
1049 STATE_ASSOCIATING = 5;
1050
1051 STATE_ASSOCIATED = 6;
1052
1053 STATE_FOUR_WAY_HANDSHAKE = 7;
1054
1055 STATE_GROUP_HANDSHAKE = 8;
1056
1057 STATE_COMPLETED = 9;
1058
1059 STATE_DORMANT = 10;
1060
1061 STATE_UNINITIALIZED = 11;
1062
1063 STATE_INVALID = 12;
1064 }
1065
Jong Wook Kim411cab92018-04-26 15:09:23 -07001066 // Bit mask of all supplicant state changes that occurred since the last event
Glen Kuhne8ce9a1c2017-03-28 14:02:48 -07001067 optional uint32 supplicant_state_changes_bitmask = 9 [default = 0];
1068
1069 // The number of milliseconds that have elapsed since the device booted
1070 optional int64 start_time_millis = 10 [default = 0];
1071
1072 optional FrameworkDisconnectReason framework_disconnect_reason = 11 [default = DISCONNECT_UNKNOWN];
1073
Jong Wook Kim411cab92018-04-26 15:09:23 -07001074 // Flag which indicates if an association rejection event occurred due to a timeout
Glen Kuhne8ce9a1c2017-03-28 14:02:48 -07001075 optional bool association_timed_out = 12 [default = false];
1076
1077 // Authentication failure reason, as reported by WifiManager (calculated from state & deauth code)
1078 optional AuthFailureReason auth_failure_reason = 13 [default = AUTH_FAILURE_UNKNOWN];
Michael Plassbb367b62017-10-06 10:29:51 -07001079
1080 // NetworkAgent score of connected wifi
1081 optional int32 last_score = 14 [default = -1];
Mingguang Xuca2aab12019-01-12 23:40:42 -08001082
1083 // NetworkAgent Wifi usability score of connected wifi
1084 optional int32 last_wifi_usability_score = 15 [default = -1];
Mingguang Xue7e344a2019-01-21 16:26:45 -08001085
1086 // Prediction horizon (in second) of Wifi usability score provided by external
1087 // system app
1088 optional int32 last_prediction_horizon_sec = 16 [default = -1];
Glen Kuhne8ce9a1c2017-03-28 14:02:48 -07001089}
Etan Cohen737addc2017-04-26 08:01:57 -07001090
1091// Wi-Fi Aware metrics
1092message WifiAwareLog {
1093 // total number of unique apps that used Aware (measured on attach)
1094 optional int32 num_apps = 1;
1095
1096 // total number of unique apps that used an identity callback when attaching
1097 optional int32 num_apps_using_identity_callback = 2;
1098
1099 // maximum number of attaches for an app
1100 optional int32 max_concurrent_attach_sessions_in_app = 3;
1101
1102 // histogram of attach request results
1103 repeated NanStatusHistogramBucket histogram_attach_session_status = 4;
1104
1105 // maximum number of concurrent publish sessions in a single app
1106 optional int32 max_concurrent_publish_in_app = 5;
1107
1108 // maximum number of concurrent subscribe sessions in a single app
1109 optional int32 max_concurrent_subscribe_in_app = 6;
1110
1111 // maximum number of concurrent discovery (publish+subscribe) sessions in a single app
1112 optional int32 max_concurrent_discovery_sessions_in_app = 7;
1113
1114 // maximum number of concurrent publish sessions in the system
1115 optional int32 max_concurrent_publish_in_system = 8;
1116
1117 // maximum number of concurrent subscribe sessions in the system
1118 optional int32 max_concurrent_subscribe_in_system = 9;
1119
1120 // maximum number of concurrent discovery (publish+subscribe) sessions in the system
1121 optional int32 max_concurrent_discovery_sessions_in_system = 10;
1122
1123 // histogram of publish request results
1124 repeated NanStatusHistogramBucket histogram_publish_status = 11;
1125
1126 // histogram of subscribe request results
1127 repeated NanStatusHistogramBucket histogram_subscribe_status = 12;
1128
1129 // number of unique apps which experienced a discovery session creation failure due to lack of
1130 // resources
1131 optional int32 num_apps_with_discovery_session_failure_out_of_resources = 13;
1132
1133 // histogram of create ndp request results
1134 repeated NanStatusHistogramBucket histogram_request_ndp_status = 14;
1135
1136 // histogram of create ndp out-of-band (OOB) request results
1137 repeated NanStatusHistogramBucket histogram_request_ndp_oob_status = 15;
1138
1139 // maximum number of concurrent active data-interfaces (NDI) in a single app
1140 optional int32 max_concurrent_ndi_in_app = 19;
1141
1142 // maximum number of concurrent active data-interfaces (NDI) in the system
1143 optional int32 max_concurrent_ndi_in_system = 20;
1144
1145 // maximum number of concurrent data-paths (NDP) in a single app
1146 optional int32 max_concurrent_ndp_in_app = 21;
1147
1148 // maximum number of concurrent data-paths (NDP) in the system
1149 optional int32 max_concurrent_ndp_in_system = 22;
1150
1151 // maximum number of concurrent secure data-paths (NDP) in a single app
1152 optional int32 max_concurrent_secure_ndp_in_app = 23;
1153
1154 // maximum number of concurrent secure data-paths (NDP) in the system
1155 optional int32 max_concurrent_secure_ndp_in_system = 24;
1156
1157 // maximum number of concurrent data-paths (NDP) per data-interface (NDI)
1158 optional int32 max_concurrent_ndp_per_ndi = 25;
1159
1160 // histogram of durations of Aware being available
1161 repeated HistogramBucket histogram_aware_available_duration_ms = 26;
1162
1163 // histogram of durations of Aware being enabled
1164 repeated HistogramBucket histogram_aware_enabled_duration_ms = 27;
1165
1166 // histogram of duration (in ms) of attach sessions
1167 repeated HistogramBucket histogram_attach_duration_ms = 28;
1168
1169 // histogram of duration (in ms) of publish sessions
1170 repeated HistogramBucket histogram_publish_session_duration_ms = 29;
1171
1172 // histogram of duration (in ms) of subscribe sessions
1173 repeated HistogramBucket histogram_subscribe_session_duration_ms = 30;
1174
1175 // histogram of duration (in ms) of data-paths (NDP)
1176 repeated HistogramBucket histogram_ndp_session_duration_ms = 31;
1177
1178 // histogram of usage (in MB) of data-paths (NDP)
1179 repeated HistogramBucket histogram_ndp_session_data_usage_mb = 32;
1180
1181 // histogram of usage (in MB) of data-path creation time (in ms) measured as request -> confirm
1182 repeated HistogramBucket histogram_ndp_creation_time_ms = 33;
1183
1184 // statistics for data-path (NDP) creation time (in ms) measured as request -> confirm: minimum
1185 optional int64 ndp_creation_time_ms_min = 34;
1186
1187 // statistics for data-path (NDP) creation time (in ms) measured as request -> confirm: maximum
1188 optional int64 ndp_creation_time_ms_max = 35;
1189
1190 // statistics for data-path (NDP) creation time (in ms) measured as request -> confirm: sum
1191 optional int64 ndp_creation_time_ms_sum = 36;
1192
1193 // statistics for data-path (NDP) creation time (in ms) measured as request -> confirm: sum of sq
1194 optional int64 ndp_creation_time_ms_sum_of_sq = 37;
1195
1196 // statistics for data-path (NDP) creation time (in ms) measured as request -> confirm: number of
1197 // samples
1198 optional int64 ndp_creation_time_ms_num_samples = 38;
1199
1200 // total time within the logging window that aware was available
1201 optional int64 available_time_ms = 39;
1202
1203 // total time within the logging window that aware was enabled
1204 optional int64 enabled_time_ms = 40;
1205
Etan Cohenfa723572018-03-13 07:25:50 -07001206 // maximum number of concurrent publish sessions enabling ranging in a single app
1207 optional int32 max_concurrent_publish_with_ranging_in_app = 41;
1208
1209 // maximum number of concurrent subscribe sessions specifying a geofence in a single app
1210 optional int32 max_concurrent_subscribe_with_ranging_in_app = 42;
1211
1212 // maximum number of concurrent publish sessions enabling ranging in the system
1213 optional int32 max_concurrent_publish_with_ranging_in_system = 43;
1214
1215 // maximum number of concurrent subscribe sessions specifying a geofence in the system
1216 optional int32 max_concurrent_subscribe_with_ranging_in_system = 44;
1217
1218 // histogram of subscribe session geofence minimum (only when specified)
1219 repeated HistogramBucket histogram_subscribe_geofence_min = 45;
1220
1221 // histogram of subscribe session geofence maximum (only when specified)
1222 repeated HistogramBucket histogram_subscribe_geofence_max = 46;
1223
1224 // total number of subscribe sessions which enabled ranging
1225 optional int32 num_subscribes_with_ranging = 47;
1226
1227 // total number of matches (service discovery indication) with ranging provided
1228 optional int32 num_matches_with_ranging = 48;
1229
1230 // total number of matches (service discovery indication) for service discovery with ranging
1231 // enabled which did not trigger ranging
1232 optional int32 num_matches_without_ranging_for_ranging_enabled_subscribes = 49;
1233
Etan Cohen737addc2017-04-26 08:01:57 -07001234 // Histogram bucket for Wi-Fi Aware logs. Range is [start, end)
1235 message HistogramBucket {
1236 // lower range of the bucket (inclusive)
1237 optional int64 start = 1;
1238
1239 // upper range of the bucket (exclusive)
1240 optional int64 end = 2;
1241
1242 // number of samples in the bucket
1243 optional int32 count = 3;
1244 }
1245
1246 // Status of various NAN operations
1247 enum NanStatusTypeEnum {
1248 // constant to be used by proto
1249 UNKNOWN = 0;
1250
1251 // NAN operation succeeded
1252 SUCCESS = 1;
1253
1254 // NAN Discovery Engine/Host driver failures
1255 INTERNAL_FAILURE = 2;
1256
1257 // NAN OTA failures
1258 PROTOCOL_FAILURE = 3;
1259
1260 // The publish/subscribe discovery session id is invalid
1261 INVALID_SESSION_ID = 4;
1262
1263 // Out of resources to fufill request
1264 NO_RESOURCES_AVAILABLE = 5;
1265
1266 // Invalid arguments passed
1267 INVALID_ARGS = 6;
1268
1269 // Invalid peer id
1270 INVALID_PEER_ID = 7;
1271
1272 // Invalid NAN data-path (ndp) id
1273 INVALID_NDP_ID = 8;
1274
1275 // Attempting to enable NAN when not available, e.g. wifi is disabled
1276 NAN_NOT_ALLOWED = 9;
1277
1278 // Over the air ACK not received
1279 NO_OTA_ACK = 10;
1280
1281 // Attempting to enable NAN when already enabled
1282 ALREADY_ENABLED = 11;
1283
1284 // Can't queue tx followup message foor transmission
1285 FOLLOWUP_TX_QUEUE_FULL = 12;
1286
1287 // Unsupported concurrency of NAN and another feature - NAN disabled
1288 UNSUPPORTED_CONCURRENCY_NAN_DISABLED = 13;
1289
1290 // Unknown NanStatusType
1291 UNKNOWN_HAL_STATUS = 14;
1292 }
1293
1294 // Histogram bucket for Wi-Fi Aware (NAN) status.
1295 message NanStatusHistogramBucket {
1296 // status type defining the bucket
1297 optional NanStatusTypeEnum nan_status_type = 1;
1298
1299 // number of samples in the bucket
1300 optional int32 count = 2;
1301 }
1302}
1303
Glen Kuhnee2d67c02017-04-25 13:08:29 -07001304// Data point used to build 'Number of Connectable Network' histograms
1305message NumConnectableNetworksBucket {
1306 // Number of connectable networks seen in a scan result
1307 optional int32 num_connectable_networks = 1 [default = 0];
1308
1309 // Number of scan results with num_connectable_networks
1310 optional int32 count = 2 [default = 0];
1311}
Mehdi Alizadehd9163cf2017-08-10 18:20:25 -07001312
1313// Pno scan metrics
1314// Here "Pno Scan" refers to the session of offloaded scans, these metrics count the result of a
1315// single session, and not the individual scans within that session.
1316message PnoScanMetrics {
1317 // Total number of attempts to offload pno scans
1318 optional int32 num_pno_scan_attempts = 1;
1319
1320 // Total number of pno scans failed
1321 optional int32 num_pno_scan_failed = 2;
1322
1323 // Number of pno scans started successfully over offload
1324 optional int32 num_pno_scan_started_over_offload = 3;
1325
1326 // Number of pno scans failed over offload
1327 optional int32 num_pno_scan_failed_over_offload = 4;
1328
1329 // Total number of pno scans that found any network
1330 optional int32 num_pno_found_network_events = 5;
1331}
Stephen Chenfc0facb2017-09-14 14:35:15 -07001332
1333// Number of occurrences for a particular "Connect to Network" Notification or
1334// notification Action.
1335message ConnectToNetworkNotificationAndActionCount {
1336
1337 // "Connect to Network" notifications
1338 enum Notification {
1339
1340 // Default
1341 NOTIFICATION_UNKNOWN = 0;
1342
1343 // Initial notification with a recommended network.
1344 NOTIFICATION_RECOMMEND_NETWORK = 1;
1345
1346 // Notification when connecting to the recommended network.
1347 NOTIFICATION_CONNECTING_TO_NETWORK = 2;
1348
1349 // Notification when successfully connected to the network.
1350 NOTIFICATION_CONNECTED_TO_NETWORK = 3;
1351
1352 // Notification when failed to connect to network.
1353 NOTIFICATION_FAILED_TO_CONNECT = 4;
1354 }
1355
1356 // "Connect to Network" notification actions
1357 enum Action {
1358
1359 // Default
1360 ACTION_UNKNOWN = 0;
1361
1362 // User dismissed the "Connect to Network" notification.
1363 ACTION_USER_DISMISSED_NOTIFICATION = 1;
1364
1365 // User tapped action button to connect to recommended network.
1366 ACTION_CONNECT_TO_NETWORK = 2;
1367
1368 // User tapped action button to open Wi-Fi Settings.
1369 ACTION_PICK_WIFI_NETWORK = 3;
1370
1371 // User tapped "Failed to connect" notification to open Wi-Fi Settings.
1372 ACTION_PICK_WIFI_NETWORK_AFTER_CONNECT_FAILURE = 4;
1373 }
1374
1375 // Recommenders of the "Connect to Network" notification
1376 enum Recommender {
1377
1378 // Default.
1379 RECOMMENDER_UNKNOWN = 0;
1380
1381 // Open Network Available recommender.
1382 RECOMMENDER_OPEN = 1;
1383 }
1384
1385 // Notification Type.
1386 optional Notification notification = 1;
1387
1388 // Action Type.
1389 optional Action action = 2;
1390
1391 // Recommender Type.
1392 optional Recommender recommender = 3;
1393
1394 // Occurrences of this action.
1395 optional int32 count = 4;
1396}
Mehdi Alizadeh2a59c52ca2017-10-18 15:42:35 -07001397
1398// SoftAP event tracking sessions and client counts
1399message SoftApConnectedClientsEvent {
1400
1401 // Soft AP event Types
1402 enum SoftApEventType {
1403
1404 // Soft AP is Up and ready for use
1405 SOFT_AP_UP = 0;
1406
1407 // Soft AP is Down
1408 SOFT_AP_DOWN = 1;
1409
1410 // Number of connected soft AP clients has changed
1411 NUM_CLIENTS_CHANGED = 2;
1412 }
1413
Mehdi Alizadeh24498192018-03-15 13:02:51 -07001414 // Soft AP channel bandwidth types
1415 enum ChannelBandwidth {
1416
1417 BANDWIDTH_INVALID = 0;
1418
1419 BANDWIDTH_20_NOHT = 1;
1420
1421 BANDWIDTH_20 = 2;
1422
1423 BANDWIDTH_40 = 3;
1424
1425 BANDWIDTH_80 = 4;
1426
1427 BANDWIDTH_80P80 = 5;
1428
1429 BANDWIDTH_160 = 6;
1430 }
1431
Mehdi Alizadeh2a59c52ca2017-10-18 15:42:35 -07001432 // Type of event being recorded
1433 optional SoftApEventType event_type = 1;
1434
Mehdi Alizadeh24498192018-03-15 13:02:51 -07001435 // Time passed since last boot in milliseconds
Mehdi Alizadeh2a59c52ca2017-10-18 15:42:35 -07001436 optional int64 time_stamp_millis = 2;
1437
1438 // Number of connected clients if event_type is NUM_CLIENTS_CHANGED, otherwise zero.
1439 optional int32 num_connected_clients = 3;
Mehdi Alizadeh24498192018-03-15 13:02:51 -07001440
1441 // Channel frequency used for Soft AP
1442 optional int32 channel_frequency = 4;
1443
1444 // Channel bandwidth used for Soft AP
1445 optional ChannelBandwidth channel_bandwidth = 5;
Jong Wook Kim72c49ee2017-10-26 13:16:36 -07001446}
1447
1448// Wps connection metrics
1449// Keeps track of Wi-Fi Protected Setup usage
1450message WpsMetrics {
1451 // Total number of wps connection attempts
1452 optional int32 num_wps_attempts = 1;
1453
1454 // Total number of wps connection successes
1455 optional int32 num_wps_success = 2;
1456
1457 // Total number of wps failures on start
1458 optional int32 num_wps_start_failure = 3;
1459
1460 // Total number of wps overlap failure
1461 optional int32 num_wps_overlap_failure = 4;
1462
1463 // Total number of wps timeout failure
1464 optional int32 num_wps_timeout_failure = 5;
1465
1466 // Total number of other wps failure during connection
1467 optional int32 num_wps_other_connection_failure = 6;
1468
1469 // Total number of supplicant failure after wps
1470 optional int32 num_wps_supplicant_failure = 7;
1471
1472 // Total number of wps cancellation
1473 optional int32 num_wps_cancellation = 8;
1474}
Siddharth Rayac8b69a2018-01-27 18:05:44 -08001475
1476// Power stats for Wifi
1477message WifiPowerStats {
1478
1479 // Duration of log (ms)
1480 optional int64 logging_duration_ms = 1;
1481
1482 // Energy consumed by wifi (mAh)
1483 optional double energy_consumed_mah = 2;
1484
1485 // Amount of time wifi is in idle (ms)
1486 optional int64 idle_time_ms = 3;
1487
1488 // Amount of time wifi is in rx (ms)
1489 optional int64 rx_time_ms = 4;
1490
1491 // Amount of time wifi is in tx (ms)
1492 optional int64 tx_time_ms = 5;
Blake Kragten354c83d2018-12-04 16:28:44 -08001493
1494 // Amount of time kernel is active because of wifi data (ms)
1495 optional int64 wifi_kernel_active_time_ms = 6;
1496
1497 // Number of packets sent (tx)
1498 optional int64 num_packets_tx = 7;
1499
1500 // Number of bytes sent (tx)
1501 optional int64 num_bytes_tx = 8;
1502
1503 // Number of packets received (rx)
1504 optional int64 num_packets_rx = 9;
1505
1506 // Number of bytes sent (rx)
1507 optional int64 num_bytes_rx = 10;
1508
1509 // Amount of time wifi is in sleep (ms)
1510 optional int64 sleep_time_ms = 11;
1511
1512 // Amount of time wifi is scanning (ms)
1513 optional int64 scan_time_ms = 12;
Blake Kragten0f8aa762019-01-31 16:05:15 -08001514
1515 // Actual monitored rail energy consumed by wifi (mAh)
1516 optional double monitored_rail_energy_consumed_mah = 13;
Ningyuan Wang72886332017-12-20 16:17:33 -08001517}
Eric Schwarzenbach9f941f92018-02-16 11:10:30 -08001518
1519// Metrics for Wifi Wake
1520message WifiWakeStats {
1521 // An individual session for Wifi Wake
1522 message Session {
1523 // A Wifi Wake lifecycle event
1524 message Event {
1525 // Elapsed time in milliseconds since start of session.
1526 optional int64 elapsed_time_millis = 1;
1527
1528 // Number of scans that have occurred since start of session.
1529 optional int32 elapsed_scans = 2;
1530 }
1531
1532 // Start time of session in milliseconds.
1533 optional int64 start_time_millis = 1;
1534
Eric Schwarzenbach3cad6242018-03-26 10:23:40 -07001535 // The number of networks the lock was provided with at start.
Eric Schwarzenbach9f941f92018-02-16 11:10:30 -08001536 optional int32 locked_networks_at_start = 2;
1537
Eric Schwarzenbach3cad6242018-03-26 10:23:40 -07001538 // The number of networks in the lock at the time of the initialize event. Only valid if
1539 // initialize_event is recorded.
1540 optional int32 locked_networks_at_initialize = 6;
1541
1542 // Event for fully initializing the WakeupLock (i.e. WakeupLock is "locked").
1543 optional Event initialize_event = 7;
1544
Eric Schwarzenbach9f941f92018-02-16 11:10:30 -08001545 // Event for unlocking the WakeupLock. Does not occur if lock was initialized with 0 networks.
1546 optional Event unlock_event = 3;
1547
1548 // Event for triggering wakeup.
1549 optional Event wakeup_event = 4;
1550
1551 // Event for WifiWake reset event. This event marks the end of a session.
1552 optional Event reset_event = 5;
1553 }
1554
1555 // Total number of sessions for Wifi Wake.
1556 optional int32 num_sessions = 1;
1557
1558 // Session information for every Wifi Wake session (up to a maximum of 10).
1559 repeated Session sessions = 2;
Eric Schwarzenbach3cad6242018-03-26 10:23:40 -07001560
1561 // Number of ignored calls to start (due to WakeupController already being active).
1562 optional int32 num_ignored_starts = 3;
1563
1564 // Number of Wifi Wake sessions that have recorded wakeup events.
1565 optional int32 num_wakeups = 4;
Eric Schwarzenbach9f941f92018-02-16 11:10:30 -08001566}
Etan Cohen4ec8dd32018-03-16 09:43:01 -07001567
1568// Metrics for Wi-Fi RTT
1569message WifiRttLog {
1570 // Number of RTT request API calls
1571 optional int32 num_requests = 1;
1572
1573 // Histogram of RTT operation overall status
1574 repeated RttOverallStatusHistogramBucket histogram_overall_status = 2;
1575
1576 // RTT to Access Points metrics
1577 optional RttToPeerLog rtt_to_ap = 3;
1578
1579 // RTT to Wi-Fi Aware peers metrics
1580 optional RttToPeerLog rtt_to_aware = 4;
1581
1582 // Metrics for a RTT to Peer (peer = AP or Wi-Fi Aware)
1583 message RttToPeerLog {
1584 // Total number of API calls
1585 optional int32 num_requests = 1;
1586
1587 // Total number of individual requests
1588 optional int32 num_individual_requests = 2;
1589
1590 // Total number of apps which requested RTT
1591 optional int32 num_apps = 3;
1592
1593 // Histogram of total number of RTT requests by an app (WifiRttManager#startRanging)
1594 repeated HistogramBucket histogram_num_requests_per_app = 4;
1595
1596 // Histogram of number of peers in a single RTT request (RangingRequest entries)
1597 repeated HistogramBucket histogram_num_peers_per_request = 5;
1598
1599 // Histogram of status of individual RTT operations (RangingResult entries)
1600 repeated RttIndividualStatusHistogramBucket histogram_individual_status = 6;
1601
1602 // Histogram of measured distances (RangingResult entries)
1603 repeated HistogramBucket histogram_distance = 7;
1604
1605 // Histogram of interval of RTT requests by an app (WifiRttManager#startRanging)
1606 repeated HistogramBucket histogram_request_interval_ms = 8;
1607 }
1608
Hai Shaloma18c32c2019-01-22 10:01:09 -08001609 // Histogram bucket for Wi-Fi RTT logs. Range is [start, end)
Etan Cohen4ec8dd32018-03-16 09:43:01 -07001610 message HistogramBucket {
1611 // lower range of the bucket (inclusive)
1612 optional int64 start = 1;
1613
1614 // upper range of the bucket (exclusive)
1615 optional int64 end = 2;
1616
1617 // number of samples in the bucket
1618 optional int32 count = 3;
1619 }
1620
1621 // Status codes for overall RTT operation
1622 enum RttOverallStatusTypeEnum {
1623 // constant to be used by proto
1624 OVERALL_UNKNOWN = 0;
1625
1626 // RTT operation succeeded (individual results may still fail)
1627 OVERALL_SUCCESS = 1;
1628
1629 // RTT operation failed (unspecified reason)
1630 OVERALL_FAIL = 2;
1631
1632 // RTT operation failed since RTT was not available (e.g. Airplane mode)
1633 OVERALL_RTT_NOT_AVAILABLE = 3;
1634
1635 // RTT operation timed-out: didn't receive response from HAL in expected time
1636 OVERALL_TIMEOUT = 4;
1637
1638 // RTT operation aborted since the app is spamming the service
1639 OVERALL_THROTTLE = 5;
1640
1641 // RTT request to HAL received immediate failure
1642 OVERALL_HAL_FAILURE = 6;
1643
1644 // RTT to Wi-Fi Aware peer using PeerHandle failed to get a MAC address translation
1645 OVERALL_AWARE_TRANSLATION_FAILURE = 7;
1646
1647 // RTT operation failed due to missing Location permission (post execution)
1648 OVERALL_LOCATION_PERMISSION_MISSING = 8;
1649 }
1650
1651 // Status codes for individual RTT operation
1652 enum RttIndividualStatusTypeEnum {
1653 // constant to be used by proto
1654 UNKNOWN = 0;
1655
1656 // RTT operation succeeded
1657 SUCCESS = 1;
1658
1659 // RTT failure: generic reason (no further information)
1660 FAILURE = 2;
1661
1662 // Target STA does not respond to request
1663 FAIL_NO_RSP = 3;
1664
1665 // Request rejected. Applies to 2-sided RTT only
1666 FAIL_REJECTED = 4;
1667
1668 // Operation not scheduled
1669 FAIL_NOT_SCHEDULED_YET = 5;
1670
1671 // Timing measurement times out
1672 FAIL_TM_TIMEOUT = 6;
1673
1674 // Target on different channel, cannot range
1675 FAIL_AP_ON_DIFF_CHANNEL = 7;
1676
1677 // Ranging not supported
1678 FAIL_NO_CAPABILITY = 8;
1679
1680 // Request aborted for unknown reason
1681 ABORTED = 9;
1682
1683 // Invalid T1-T4 timestamp
1684 FAIL_INVALID_TS = 10;
1685
1686 // 11mc protocol failed
1687 FAIL_PROTOCOL = 11;
1688
1689 // Request could not be scheduled
1690 FAIL_SCHEDULE = 12;
1691
1692 // Responder cannot collaborate at time of request
1693 FAIL_BUSY_TRY_LATER = 13;
1694
1695 // Bad request args
1696 INVALID_REQ = 14;
1697
1698 // WiFi not enabled
1699 NO_WIFI = 15;
1700
1701 // Responder overrides param info, cannot range with new params
1702 FAIL_FTM_PARAM_OVERRIDE = 16;
1703
1704 // HAL did not provide a result to a framework request
1705 MISSING_RESULT = 17;
1706 }
1707
1708 // Histogram bucket for Wi-Fi RTT overall operation status
1709 message RttOverallStatusHistogramBucket {
1710 // status type defining the bucket
1711 optional RttOverallStatusTypeEnum status_type = 1;
1712
1713 // number of samples in the bucket
1714 optional int32 count = 2;
1715 }
1716
1717 // Histogram bucket for Wi-Fi RTT individual operation status
1718 message RttIndividualStatusHistogramBucket {
1719 // status type defining the bucket
1720 optional RttIndividualStatusTypeEnum status_type = 1;
1721
1722 // number of samples in the bucket
1723 optional int32 count = 2;
1724 }
1725}
xshub483b722018-05-22 15:46:26 -07001726
1727// Usage data for the wifi radio while device is running on battery.
1728message WifiRadioUsage {
1729 // Duration of log (ms)
1730 optional int64 logging_duration_ms = 1;
1731
1732 // Total time for which the radio is awake due to scan.
1733 optional int64 scan_time_ms = 2;
Jong Wook Kim411cab92018-04-26 15:09:23 -07001734}
1735
1736message ExperimentValues {
1737 // Indicates if we are logging WifiIsUnusableEvent in metrics
1738 optional bool wifi_is_unusable_logging_enabled = 1;
1739
1740 // Minimum number of txBad to trigger a data stall
1741 optional int32 wifi_data_stall_min_tx_bad = 2;
1742
1743 // Minimum number of txSuccess to trigger a data stall
1744 // when rxSuccess is 0
1745 optional int32 wifi_data_stall_min_tx_success_without_rx = 3;
Jong Wook Kime4aa37f2018-04-23 11:18:24 -07001746
1747 // Indicates if we are logging LinkSpeedCount in metrics
1748 optional bool link_speed_counts_logging_enabled = 4;
Jong Wook Kim411cab92018-04-26 15:09:23 -07001749}
1750
1751message WifiIsUnusableEvent {
1752 enum TriggerType {
1753 // Default/Invalid event
1754 TYPE_UNKNOWN = 0;
1755
1756 // There is a data stall from tx failures
1757 TYPE_DATA_STALL_BAD_TX = 1;
1758
1759 // There is a data stall from rx failures
1760 TYPE_DATA_STALL_TX_WITHOUT_RX = 2;
1761
1762 // There is a data stall from both tx and rx failures
1763 TYPE_DATA_STALL_BOTH = 3;
1764
1765 // Firmware generated an alert
1766 TYPE_FIRMWARE_ALERT = 4;
Mingguang Xucd53d0b2019-03-15 15:42:07 -07001767
1768 // IP Manager lost reachability to network neighbors
1769 TYPE_IP_REACHABILITY_LOST = 5;
Jong Wook Kim411cab92018-04-26 15:09:23 -07001770 }
1771
1772 // What event triggered WifiIsUnusableEvent.
1773 optional TriggerType type = 1;
1774
1775 // The timestamp at which this event occurred.
1776 // Measured in milliseconds that have elapsed since the device booted.
1777 optional int64 start_time_millis = 2;
1778
1779 // NetworkAgent score of connected wifi.
1780 // Defaults to -1 if the score was never set.
1781 optional int32 last_score = 3 [default = -1];
1782
1783 // Delta of successfully transmitted (ACKed) unicast data packets
1784 // between the last two WifiLinkLayerStats.
1785 optional int64 tx_success_delta = 4;
1786
1787 // Delta of transmitted unicast data retry packets
1788 // between the last two WifiLinkLayerStats.
1789 optional int64 tx_retries_delta = 5;
1790
1791 // Delta of lost (not ACKed) transmitted unicast data packets
1792 // between the last two WifiLinkLayerStats.
1793 optional int64 tx_bad_delta = 6;
1794
1795 // Delta of received unicast data packets
1796 // between the last two WifiLinkLayerStats.
1797 optional int64 rx_success_delta = 7;
1798
1799 // Time in millisecond between the last two WifiLinkLayerStats.
1800 optional int64 packet_update_time_delta = 8;
1801
1802 // The timestamp at which the last WifiLinkLayerStats was updated.
1803 // Measured in milliseconds that have elapsed since the device booted.
1804 optional int64 last_link_layer_stats_update_time = 9;
1805
1806 // Firmware alert code. Only valid when the event was triggered by a firmware alert, otherwise -1.
1807 optional int32 firmware_alert_code = 10 [default = -1];
Mingguang Xuca2aab12019-01-12 23:40:42 -08001808
1809 // NetworkAgent wifi usability score of connected wifi.
1810 // Defaults to -1 if the score was never set.
1811 optional int32 last_wifi_usability_score = 11 [default = -1];
Mingguang Xue7e344a2019-01-21 16:26:45 -08001812
1813 // Prediction horizon (in second) of Wifi usability score provided by external
1814 // system app
1815 optional int32 last_prediction_horizon_sec = 12 [default = -1];
Mingguang Xu7b6e1842019-02-27 21:29:00 -08001816
1817 // Whether screen status is on when WifiIsUnusableEvent happens.
1818 optional bool screen_on = 13 [default = false];
Ahmed ElArabawyba64b612018-06-15 09:17:45 -07001819}
Ecco Park5a403002018-07-23 15:53:10 -07001820
1821message PasspointProfileTypeCount {
1822 enum EapMethod {
1823 // Unknown Type
1824 TYPE_UNKNOWN = 0;
1825
1826 // EAP_TLS (13)
1827 TYPE_EAP_TLS = 1;
1828
1829 // EAP_TTLS (21)
1830 TYPE_EAP_TTLS = 2;
1831
1832 // EAP_SIM (18)
1833 TYPE_EAP_SIM = 3;
1834
1835 // EAP_AKA (23)
1836 TYPE_EAP_AKA = 4;
1837
1838 // EAP_AKA_PRIME (50)
1839 TYPE_EAP_AKA_PRIME = 5;
1840 }
1841
1842 // Eap method type set in Passpoint profile
1843 optional EapMethod eap_method_type = 1;
1844
1845 // Num of installed Passpoint profile with same eap method
1846 optional int32 count = 2;
xshu0e0dea42018-09-17 17:30:15 -07001847}
1848
1849message WifiLinkLayerUsageStats {
1850 // Total logging duration in ms.
1851 optional int64 logging_duration_ms = 1;
1852
1853 // Total time the wifi radio is on in ms over the logging duration.
1854 optional int64 radio_on_time_ms = 2;
1855
1856 // Total time the wifi radio is doing tx in ms over the logging duration.
1857 optional int64 radio_tx_time_ms = 3;
1858
1859 // Total time the wifi radio is doing rx in ms over the logging duration.
1860 optional int64 radio_rx_time_ms = 4;
1861
1862 // Total time the wifi radio is scanning in ms over the logging duration.
1863 optional int64 radio_scan_time_ms = 5;
xshu0f91dd62018-11-08 15:51:07 -08001864
1865 // Total time the wifi radio spent doing nan scans in ms over the logging duration.
1866 optional int64 radio_nan_scan_time_ms = 6;
1867
1868 // Total time the wifi radio spent doing background scans in ms over the logging duration.
1869 optional int64 radio_background_scan_time_ms = 7;
1870
1871 // Total time the wifi radio spent doing roam scans in ms over the logging duration.
1872 optional int64 radio_roam_scan_time_ms = 8;
1873
1874 // Total time the wifi radio spent doing pno scans in ms over the logging duration.
1875 optional int64 radio_pno_scan_time_ms = 9;
1876
1877 // Total time the wifi radio spent doing hotspot 2.0 scans and GAS exchange
1878 // in ms over the logging duration.
1879 optional int64 radio_hs20_scan_time_ms = 10;
xshua33726e2018-09-24 15:02:23 -07001880}
1881
1882message WifiUsabilityStatsEntry {
Mingguang Xubed08852019-01-24 23:00:10 -08001883 // Status codes for link probe status
1884 enum LinkProbeStatus {
1885 // Link probe status is unknown
1886 PROBE_STATUS_UNKNOWN = 0;
1887
1888 // Link probe is not triggered
1889 PROBE_STATUS_NO_PROBE = 1;
1890
1891 // Link probe is triggered and the result is success
1892 PROBE_STATUS_SUCCESS = 2;
1893
1894 // Link probe is triggered and the result is failure
1895 PROBE_STATUS_FAILURE = 3;
1896 }
1897
Kai Shidfef3832019-02-26 14:55:09 -08001898 // Codes for cellular data network type
1899 enum CellularDataNetworkType {
1900 // Unknown network
1901 NETWORK_TYPE_UNKNOWN = 0;
1902
1903 // GSM network
1904 NETWORK_TYPE_GSM = 1;
1905
1906 // CDMA network
1907 NETWORK_TYPE_CDMA = 2;
1908
1909 // CDMA EVDO network
1910 NETWORK_TYPE_EVDO_0 = 3;
1911
1912 // WCDMA network
1913 NETWORK_TYPE_UMTS = 4;
1914
1915 // TDSCDMA network
1916 NETWORK_TYPE_TD_SCDMA = 5;
1917
1918 // LTE network
1919 NETWORK_TYPE_LTE = 6;
1920
1921 // NR network
1922 NETWORK_TYPE_NR = 7;
1923 }
1924
xshua33726e2018-09-24 15:02:23 -07001925 // Absolute milliseconds from device boot when these stats were sampled
1926 optional int64 time_stamp_ms = 1;
1927
1928 // The RSSI at the sample time
1929 optional int32 rssi = 2;
1930
1931 // Link speed at the sample time in Mbps
1932 optional int32 link_speed_mbps = 3;
1933
1934 // The total number of tx success counted from the last radio chip reset
1935 optional int64 total_tx_success = 4;
1936
1937 // The total number of MPDU data packet retries counted from the last radio chip reset
1938 optional int64 total_tx_retries = 5;
1939
1940 // The total number of tx bad counted from the last radio chip reset
1941 optional int64 total_tx_bad = 6;
1942
1943 // The total number of rx success counted from the last radio chip reset
1944 optional int64 total_rx_success = 7;
1945
1946 // The total time the wifi radio is on in ms counted from the last radio chip reset
1947 optional int64 total_radio_on_time_ms = 8;
1948
1949 // The total time the wifi radio is doing tx in ms counted from the last radio chip reset
1950 optional int64 total_radio_tx_time_ms = 9;
1951
1952 // The total time the wifi radio is doing rx in ms counted from the last radio chip reset
1953 optional int64 total_radio_rx_time_ms = 10;
1954
1955 // The total time spent on all types of scans in ms counted from the last radio chip reset
1956 optional int64 total_scan_time_ms = 11;
1957
1958 // The total time spent on nan scans in ms counted from the last radio chip reset
1959 optional int64 total_nan_scan_time_ms = 12;
1960
1961 // The total time spent on background scans in ms counted from the last radio chip reset
1962 optional int64 total_background_scan_time_ms = 13;
1963
1964 // The total time spent on roam scans in ms counted from the last radio chip reset
1965 optional int64 total_roam_scan_time_ms = 14;
1966
1967 // The total time spent on pno scans in ms counted from the last radio chip reset
1968 optional int64 total_pno_scan_time_ms = 15;
1969
1970 // The total time spent on hotspot2.0 scans and GAS exchange in ms counted from the last radio
1971 // chip reset
1972 optional int64 total_hotspot_2_scan_time_ms = 16;
Mingguang Xuca2aab12019-01-12 23:40:42 -08001973
1974 // Internal framework Wifi score
1975 optional int32 wifi_score = 17;
1976
1977 // Wifi usability score provided by external system app
1978 optional int32 wifi_usability_score = 18;
1979
1980 // Sequence number from external system app to framework
1981 optional int32 seq_num_to_framework = 19;
Mingguang Xu86833142019-01-09 13:54:29 -08001982
1983 // The total time CCA is on busy status on the current frequency in ms
1984 // counted from the last radio chip reset
1985 optional int64 total_cca_busy_freq_time_ms = 20;
1986
1987 // The total radio on time of the current frequency from the last radio
1988 // chip reset
1989 optional int64 total_radio_on_freq_time_ms = 21;
1990
1991 // The total number of beacons received from the last radio chip reset
1992 optional int64 total_beacon_rx = 22;
Mingguang Xue7e344a2019-01-21 16:26:45 -08001993
1994 // Prediction horizon (in second) of Wifi usability score provided by external
1995 // system app
1996 optional int32 prediction_horizon_sec = 23;
Mingguang Xubed08852019-01-24 23:00:10 -08001997
1998 // The link probe status since last stats update
1999 optional LinkProbeStatus probe_status_since_last_update = 24;
2000
2001 // The elapsed time of the most recent link probe since last stats update;
Mingguang Xue77cabc2019-03-08 09:58:23 -08002002 optional int32 probe_elapsed_time_since_last_update_ms = 25;
Mingguang Xubed08852019-01-24 23:00:10 -08002003
2004 // The MCS rate of the most recent link probe since last stats update
2005 optional int32 probe_mcs_rate_since_last_update = 26;
2006
2007 // Rx link speed at the sample time in Mbps
2008 optional int32 rx_link_speed_mbps = 27;
Mingguang Xu96bcabe2019-01-30 22:36:07 -08002009
2010 // Sequence number generated by framework
2011 optional int32 seq_num_inside_framework = 28;
2012
2013 // Whether current entry is for the same BSSID on the same frequency compared
2014 // to last entry
2015 optional bool is_same_bssid_and_freq = 29;
Kai Shidfef3832019-02-26 14:55:09 -08002016
2017 // Cellular data network type currently in use on the device for data transmission
2018 optional CellularDataNetworkType cellular_data_network_type = 30;
2019
2020 // Cellular signal strength in dBm, NR: CsiRsrp, LTE: Rsrp, WCDMA/TDSCDMA: Rscp,
2021 // CDMA: Rssi, EVDO: Rssi, GSM: Rssi
2022 optional int32 cellular_signal_strength_dbm = 31;
2023
2024 // Cellular signal strength in dB, NR: CsiSinr, LTE: Rsrq, WCDMA: EcNo, TDSCDMA: invalid,
2025 // CDMA: Ecio, EVDO: SNR, GSM: invalid */
2026 optional int32 cellular_signal_strength_db = 32;
2027
2028 // Whether the primary registered cell of current entry is same as that of previous entry
2029 optional bool is_same_registered_cell = 33;
Mingguang Xu4225eae2019-03-27 11:13:58 -07002030
2031 // The device mobility state
2032 optional DeviceMobilityStatePnoScanStats.DeviceMobilityState
2033 device_mobility_state = 34;
xshua33726e2018-09-24 15:02:23 -07002034}
2035
2036message WifiUsabilityStats {
2037 enum Label {
2038 // Default label
2039 LABEL_UNKNOWN = 0;
2040
2041 // Wifi is usable
2042 LABEL_GOOD = 1;
2043
2044 // Wifi is unusable
2045 LABEL_BAD = 2;
2046 }
2047
Mingguang Xuf69fa672019-01-28 14:32:36 -08002048 enum UsabilityStatsTriggerType {
2049 // Default/Invalid event
2050 TYPE_UNKNOWN = 0;
2051
2052 // There is a data stall from tx failures
2053 TYPE_DATA_STALL_BAD_TX = 1;
2054
2055 // There is a data stall from rx failures
2056 TYPE_DATA_STALL_TX_WITHOUT_RX = 2;
2057
2058 // There is a data stall from both tx and rx failures
2059 TYPE_DATA_STALL_BOTH = 3;
2060
2061 // Firmware generated an alert
2062 TYPE_FIRMWARE_ALERT = 4;
Mingguang Xucd53d0b2019-03-15 15:42:07 -07002063
2064 // IP Manager lost reachability to network neighbors
2065 TYPE_IP_REACHABILITY_LOST = 5;
Mingguang Xuf69fa672019-01-28 14:32:36 -08002066 }
2067
xshua33726e2018-09-24 15:02:23 -07002068 // The current wifi usability state
2069 optional Label label = 1;
2070
2071 // The list of timestamped wifi usability stats
2072 repeated WifiUsabilityStatsEntry stats = 2;
Mingguang Xuf69fa672019-01-28 14:32:36 -08002073
2074 // What event triggered WifiUsabilityStats.
2075 optional UsabilityStatsTriggerType trigger_type = 3;
Mingguang Xu8424b292019-03-27 15:26:02 -07002076
2077 // Firmware alert code. Only valid when the stats was triggered by a firmware
2078 // alert, otherwise -1.
2079 optional int32 firmware_alert_code = 4 [default = -1];
David Su367bdff2018-12-13 13:39:11 -08002080}
2081
2082message DeviceMobilityStatePnoScanStats {
2083 // see WifiManager.DEVICE_MOBILITY_STATE_* constants
2084 enum DeviceMobilityState {
2085 // Unknown mobility
2086 UNKNOWN = 0;
2087
2088 // High movement
2089 HIGH_MVMT = 1;
2090
2091 // Low movement
2092 LOW_MVMT = 2;
2093
2094 // Stationary
2095 STATIONARY = 3;
2096 }
2097
2098 // The device mobility state
2099 optional DeviceMobilityState device_mobility_state = 1;
2100
2101 // The number of times that this state was entered
2102 optional int32 num_times_entered_state = 2;
2103
2104 // The total duration elapsed while in this mobility state, in ms
2105 optional int64 total_duration_ms = 3;
2106
2107 // the total duration elapsed while in this mobility state with PNO scans running, in ms
2108 optional int64 pno_duration_ms = 4;
2109}
Jimmy Chen0142e8b2018-11-23 16:25:57 +08002110
2111// The information about the Wifi P2p events.
2112message WifiP2pStats {
2113
2114 // Group event list tracking sessions and client counts in tethered mode.
2115 repeated GroupEvent group_event = 1;
2116
2117 // Session information that gets logged for every Wifi P2p connection.
2118 repeated P2pConnectionEvent connection_event = 2;
2119
2120 // Number of persistent group in the user profile.
2121 optional int32 num_persistent_group = 3;
2122
2123 // Number of peer scan.
2124 optional int32 num_total_peer_scans = 4;
2125
2126 // Number of service scan.
2127 optional int32 num_total_service_scans = 5;
2128}
2129
2130message P2pConnectionEvent {
2131
2132 enum ConnectionType {
2133
2134 // fresh new connection.
2135 CONNECTION_FRESH = 0;
2136
2137 // reinvoke a group.
2138 CONNECTION_REINVOKE = 1;
2139
2140 // create a group with the current device as the group owner locally.
2141 CONNECTION_LOCAL = 2;
2142
2143 // create a group or join a group with config.
2144 CONNECTION_FAST = 3;
2145 }
2146
2147 enum ConnectivityLevelFailure {
2148
2149 // Failure is unknown.
2150 CLF_UNKNOWN = 0;
2151
2152 // No failure.
2153 CLF_NONE = 1;
2154
2155 // Timeout for current connecting request.
2156 CLF_TIMEOUT = 2;
2157
2158 // The connecting request is canceled by the user.
2159 CLF_CANCEL = 3;
2160
2161 // Provision discovery failure, e.g. no pin code, timeout, rejected by the peer.
2162 CLF_PROV_DISC_FAIL = 4;
2163
2164 // Invitation failure, e.g. rejected by the peer.
2165 CLF_INVITATION_FAIL = 5;
2166
2167 // Incoming request is rejected by the user.
2168 CLF_USER_REJECT = 6;
2169
2170 // New connection request is issued before ending previous connecting request.
2171 CLF_NEW_CONNECTION_ATTEMPT = 7;
2172 }
2173
2174 // WPS method.
2175 enum WpsMethod {
2176 // WPS is skipped for Group Reinvoke.
2177 WPS_NA = -1;
2178
2179 // Push button configuration.
2180 WPS_PBC = 0;
2181
2182 // Display pin method configuration - pin is generated and displayed on device.
2183 WPS_DISPLAY = 1;
2184
2185 // Keypad pin method configuration - pin is entered on device.
2186 WPS_KEYPAD = 2;
2187
2188 // Label pin method configuration - pin is labelled on device.
2189 WPS_LABEL = 3;
2190 }
2191
2192 // Start time of the connection.
2193 optional int64 start_time_millis = 1;
2194
2195 // Type of the connection.
2196 optional ConnectionType connection_type = 2;
2197
2198 // WPS method.
2199 optional WpsMethod wps_method = 3 [default = WPS_NA];
2200
2201 // Duration to connect.
2202 optional int32 duration_taken_to_connect_millis = 4;
2203
2204 // Failures that happen at the connectivity layer.
2205 optional ConnectivityLevelFailure connectivity_level_failure_code = 5;
2206}
2207
2208// GroupEvent tracking group information from GroupStarted to GroupRemoved.
2209message GroupEvent {
2210
2211 enum GroupRole {
2212
2213 GROUP_OWNER = 0;
2214
2215 GROUP_CLIENT = 1;
2216 }
2217
2218 // The ID of network in supplicant for this group.
2219 optional int32 net_id = 1;
2220
2221 // Start time of the group.
2222 optional int64 start_time_millis = 2;
2223
2224 // Channel frequency used for Group.
2225 optional int32 channel_frequency = 3;
2226
2227 // Is group owner or group client.
2228 optional GroupRole group_role = 5;
2229
2230 // Number of connected clients.
2231 optional int32 num_connected_clients = 6;
2232
2233 // Cumulative number of connected clients.
2234 optional int32 num_cumulative_clients = 7;
2235
2236 // The session duration.
2237 optional int32 session_duration_millis = 8;
2238
2239 // The idle duration. A group without any client is in idle.
2240 optional int32 idle_duration_millis = 9;
2241}
Hai Shaloma18c32c2019-01-22 10:01:09 -08002242
2243// Easy Connect (DPP)
2244message WifiDppLog {
David Su8e835f62019-02-14 16:45:09 -08002245 reserved 6;
2246
Hai Shaloma18c32c2019-01-22 10:01:09 -08002247 // Number of Configurator-Initiator requests
2248 optional int32 num_dpp_configurator_initiator_requests = 1;
2249
2250 // Number of Enrollee-Initiator requests
2251 optional int32 num_dpp_enrollee_initiator_requests = 2;
2252
2253 // Easy Connect (DPP) Enrollee success
2254 optional int32 num_dpp_enrollee_success = 3;
2255
2256 // Easy Connect (DPP) Configurator success code bucket
2257 repeated DppConfiguratorSuccessStatusHistogramBucket dpp_configurator_success_code = 4;
2258
2259 // Easy Connect (DPP) failure code bucket
2260 repeated DppFailureStatusHistogramBucket dpp_failure_code = 5;
2261
2262 // Easy Connect (DPP) operation time bucket
David Su8e835f62019-02-14 16:45:09 -08002263 repeated HistogramBucketInt32 dpp_operation_time = 7;
Hai Shaloma18c32c2019-01-22 10:01:09 -08002264
2265 // Histogram bucket for Wi-Fi DPP configurator success
2266 message DppConfiguratorSuccessStatusHistogramBucket {
2267 // status type defining the bucket
2268 optional DppConfiguratorSuccessCode dpp_status_type = 1;
2269
2270 // number of samples in the bucket
2271 optional int32 count = 2;
2272 }
2273
2274 // Histogram bucket for Wi-Fi DPP failures
2275 message DppFailureStatusHistogramBucket {
2276 // status type defining the bucket
2277 optional DppFailureCode dpp_status_type = 1;
2278
2279 // number of samples in the bucket
2280 optional int32 count = 2;
2281 }
2282
Hai Shaloma18c32c2019-01-22 10:01:09 -08002283 enum DppConfiguratorSuccessCode {
2284 // Unknown success code
2285 EASY_CONNECT_EVENT_SUCCESS_UNKNOWN = 0;
2286
2287 // Easy Connect Configurator success event: Configuration sent to enrollee
2288 EASY_CONNECT_EVENT_SUCCESS_CONFIGURATION_SENT = 1;
2289 }
2290
2291 enum DppFailureCode {
2292 // Unknown failure
2293 EASY_CONNECT_EVENT_FAILURE_UNKNOWN = 0;
2294
2295 // Easy Connect Failure event: Scanned QR code is either not a Easy Connect URI, or the Easy
2296 // Connect URI has errors.
2297 EASY_CONNECT_EVENT_FAILURE_INVALID_URI = 1;
2298
2299 // Easy Connect Failure event: Bootstrapping/Authentication initialization process failure.
2300 EASY_CONNECT_EVENT_FAILURE_AUTHENTICATION = 2;
2301
2302 // Easy Connect Failure event: Both devices are implementing the same role and are
2303 // incompatible.
2304 EASY_CONNECT_EVENT_FAILURE_NOT_COMPATIBLE = 3;
2305
2306 // Easy Connect Failure event: Configuration process has failed due to malformed message.
2307 EASY_CONNECT_EVENT_FAILURE_CONFIGURATION = 4;
2308
2309 // Easy Connect Failure event: Easy Connect request while in another Easy Connect exchange.
2310 EASY_CONNECT_EVENT_FAILURE_BUSY = 5;
2311
2312 // Easy Connect Failure event: No response from the peer.
2313 EASY_CONNECT_EVENT_FAILURE_TIMEOUT = 6;
2314
2315 // Easy Connect Failure event: General protocol failure.
2316 EASY_CONNECT_EVENT_FAILURE_GENERIC = 7;
2317
2318 // Easy Connect Failure event: Feature or option is not supported.
2319 EASY_CONNECT_EVENT_FAILURE_NOT_SUPPORTED = 8;
2320
2321 // Easy Connect Failure event: Invalid network provided to Easy Connect configurator.
2322 // Network must either be WPA3-Personal (SAE) or WPA2-Personal (PSK).
2323 EASY_CONNECT_EVENT_FAILURE_INVALID_NETWORK = 9;
2324 }
2325}
Roshan Pius89b233d2019-01-31 10:15:22 -08002326
2327// WifiConfigStore read/write metrics.
2328message WifiConfigStoreIO {
2329 // Histogram of config store read durations.
2330 repeated DurationBucket read_durations = 1;
2331
2332 // Histogram of config store write durations.
2333 repeated DurationBucket write_durations = 2;
2334
2335 // Total Number of instances of write/read duration in this duration bucket.
2336 message DurationBucket {
2337 // Bucket covers duration : [range_start_ms, range_end_ms)
2338 // The (inclusive) lower bound of read/write duration represented by this bucket
2339 optional int32 range_start_ms = 1;
2340
2341 // The (exclusive) upper bound of read/write duration represented by this bucket
2342 optional int32 range_end_ms = 2;
2343
2344 // Number of read/write durations that fit into this bucket
2345 optional int32 count = 3;
2346 }
2347}
David Su44306932019-02-12 16:53:46 -08002348
2349// Histogram bucket counting with int32. Range is [start, end)
2350message HistogramBucketInt32 {
2351 // lower range of the bucket (inclusive)
2352 optional int32 start = 1;
2353
2354 // upper range of the bucket (exclusive)
2355 optional int32 end = 2;
2356
2357 // number of samples in the bucket
2358 optional int32 count = 3;
2359}
2360
David Suf6e4d4e2019-03-08 13:18:21 -08002361// Counts occurrences of a int32 key
2362message Int32Count {
David Su44306932019-02-12 16:53:46 -08002363 // the key
2364 optional int32 key = 1;
2365
David Suf6e4d4e2019-03-08 13:18:21 -08002366 // the count
2367 optional int32 count = 2;
David Su44306932019-02-12 16:53:46 -08002368}
2369
2370message LinkProbeStats {
2371 enum LinkProbeFailureReason {
2372 // unknown reason
2373 LINK_PROBE_FAILURE_REASON_UNKNOWN = 0;
2374
2375 // Specified MCS rate when it is unsupported by the driver.
2376 LINK_PROBE_FAILURE_REASON_MCS_UNSUPPORTED = 1;
2377
2378 // Driver reported that no ACK was received for the transmitted probe.
2379 LINK_PROBE_FAILURE_REASON_NO_ACK = 2;
2380
2381 // Driver failed to report on the status of the transmitted probe within the timeout.
2382 LINK_PROBE_FAILURE_REASON_TIMEOUT = 3;
2383
2384 // An existing link probe is in progress.
2385 LINK_PROBE_FAILURE_REASON_ALREADY_STARTED = 4;
2386 }
2387
2388 // Counts the number of failures for each failure reason.
2389 message LinkProbeFailureReasonCount {
2390 // The failure reason.
2391 optional LinkProbeFailureReason failure_reason = 1;
2392
2393 // The number of occurrences for this failure reason.
2394 optional int32 count = 2;
2395 }
2396
2397 // Counts the occurrences of RSSI values when a link probe succeeds.
David Suf6e4d4e2019-03-08 13:18:21 -08002398 repeated Int32Count success_rssi_counts = 1;
David Su44306932019-02-12 16:53:46 -08002399
2400 // Counts the occurrences of RSSI values when a link probe fails.
David Suf6e4d4e2019-03-08 13:18:21 -08002401 repeated Int32Count failure_rssi_counts = 2;
David Su44306932019-02-12 16:53:46 -08002402
2403 // Counts the occurrences of Link Speed values when a link probe succeeds.
David Suf6e4d4e2019-03-08 13:18:21 -08002404 repeated Int32Count success_link_speed_counts = 3;
David Su44306932019-02-12 16:53:46 -08002405
2406 // Counts the occurrences of Link Speed values when a link probe fails.
David Suf6e4d4e2019-03-08 13:18:21 -08002407 repeated Int32Count failure_link_speed_counts = 4;
David Su44306932019-02-12 16:53:46 -08002408
2409 // Histogram for the number of seconds since the last TX success when a link probe succeeds.
2410 repeated HistogramBucketInt32 success_seconds_since_last_tx_success_histogram = 5;
2411
2412 // Histogram for the number of seconds since the last TX success when a link probe fails.
2413 repeated HistogramBucketInt32 failure_seconds_since_last_tx_success_histogram = 6;
2414
2415 // Histogram for the elapsed time of successful link probes, in ms.
2416 repeated HistogramBucketInt32 success_elapsed_time_ms_histogram = 7;
2417
2418 // Counts the occurrences of error codes for failed link probes.
2419 repeated LinkProbeFailureReasonCount failure_reason_counts = 8;
2420}
David Sua04f5052019-02-20 17:42:28 -08002421
2422// Stores the decisions that were made by a experiment when compared against another experiment
2423message NetworkSelectionExperimentDecisions {
2424 // the id of one experiment
2425 optional int32 experiment1_id = 1;
2426
2427 // the id of the other experiment
2428 optional int32 experiment2_id = 2;
2429
2430 // Counts occurrences of the number of network choices there were when experiment1 makes the
2431 // same network selection as experiment2.
2432 // The keys are the number of network choices, and the values are the number of occurrences of
2433 // this number of network choices when exp1 and exp2 make the same network selection.
David Suf6e4d4e2019-03-08 13:18:21 -08002434 repeated Int32Count same_selection_num_choices_counter = 3;
David Sua04f5052019-02-20 17:42:28 -08002435
2436 // Counts occurrences of the number of network choices there were when experiment1 makes the
2437 // same network selection as experiment2.
2438 // The keys are the number of network choices, and the values are the number of occurrences of
2439 // this number of network choices when exp1 and exp2 make different network selections.
2440 // Note that it is possible for the network selection to be different even when there only exists
2441 // a single network choice, since choosing not to connect to that network is a valid choice.
David Suf6e4d4e2019-03-08 13:18:21 -08002442 repeated Int32Count different_selection_num_choices_counter = 4;
David Sua04f5052019-02-20 17:42:28 -08002443}
Roshan Pius3f30ba82019-02-08 11:55:55 -08002444
2445// NetworkRequest API metrics.
2446message WifiNetworkRequestApiLog {
2447 // Number of requests via this API surface.
2448 optional int32 num_request = 1;
2449
2450 // Histogram of requests via this API surface to number of networks matched in scan results.
Roshan Piusbebb5ab2019-02-28 11:04:00 -08002451 repeated HistogramBucketInt32 network_match_size_histogram = 2;
Roshan Pius3f30ba82019-02-08 11:55:55 -08002452
2453 // Number of successful network connection from this API.
2454 optional int32 num_connect_success = 3;
2455
2456 // Number of requests via this API surface that bypassed user approval.
2457 optional int32 num_user_approval_bypass = 4;
2458
2459 // Number of requests via this API surface that was rejected by the user.
2460 optional int32 num_user_reject = 5;
2461
2462 // Number of unique apps using this API surface.
2463 optional int32 num_apps = 6;
2464}
2465
2466// NetworkSuggestion API metrics.
2467message WifiNetworkSuggestionApiLog {
2468 // Number of modifications to their suggestions by apps.
2469 optional int32 num_modification = 1;
2470
2471 // Number of successful network connection from app suggestions.
2472 optional int32 num_connect_success = 2;
2473
2474 // Number of network connection failures from app suggestions.
2475 optional int32 num_connect_failure = 3;
2476
2477 // Histogram for size of the network lists provided by various apps on the device.
2478 repeated HistogramBucketInt32 network_list_size_histogram = 4;
2479}
Ahmed ElArabawy048e1482019-03-25 10:42:04 -07002480
2481// WifiLock metrics
2482message WifiLockStats {
2483 // Amount of time wifi is actively in HIGH_PERF mode (ms)
2484 // This means the lock takes effect and the device takes the actions required for this mode
2485 optional int64 high_perf_active_time_ms = 1;
2486
2487 // Amount of time wifi is actively in LOW_LATENCY mode (ms)
2488 // This means the lock takes effect and the device takes the actions required for this mode
2489 optional int64 low_latency_active_time_ms = 2;
2490
2491 // Histogram of HIGH_PERF lock acquisition duration (seconds)
2492 // Note that acquiring the lock does not necessarily mean that device is actively in that mode
2493 repeated HistogramBucketInt32 high_perf_lock_acq_duration_sec_histogram = 3;
2494
2495 // Histogram of LOW_LATENCY lock acquisition duration (seconds)
2496 // Note that acquiring the lock does not necessarily mean that device is actively in that mode
2497 repeated HistogramBucketInt32 low_latency_lock_acq_duration_sec_histogram = 4;
2498
2499 // Histogram of HIGH_PERF active session duration (seconds)
2500 // This means the lock takes effect and the device takes the actions required for this mode
2501 repeated HistogramBucketInt32 high_perf_active_session_duration_sec_histogram = 5;
2502
2503 // Histogram of LOW_LATENCY active session duration (seconds)
2504 // This means the lock takes effect and the device takes the actions required for this mode
2505 repeated HistogramBucketInt32 low_latency_active_session_duration_sec_histogram = 6;
2506}
xshu08c67382019-04-04 17:39:33 -07002507
2508// Stats on number of times Wi-Fi is turned on/off though the WifiManager#setWifiEnabled API
2509message WifiToggleStats {
2510 // Number of time Wi-Fi is turned on by privileged apps
2511 optional int32 num_toggle_on_privileged = 1;
2512
2513 // Number of time Wi-Fi is turned off by privileged apps
2514 optional int32 num_toggle_off_privileged = 2;
2515
2516 // Number of time Wi-Fi is turned on by normal apps
2517 optional int32 num_toggle_on_normal = 3;
2518
2519 // Number of time Wi-Fi is turned off by normal apps
2520 optional int32 num_toggle_off_normal = 4;
2521}