blob: 8ad24894a1b93b68b4cbe140c7c8d9e74d75fb7d [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
Siddharth Ray191b10b2018-08-10 17:36:17 -0700477 // Hardware revision (EVT, DVT, PVT etc.)
478 optional string hardware_revision = 124;
xshu0e0dea42018-09-17 17:30:15 -0700479
480 // Total wifi link layer usage data over the logging duration in ms.
481 optional WifiLinkLayerUsageStats wifi_link_layer_usage_stats = 125;
xshua33726e2018-09-24 15:02:23 -0700482
483 // Multiple lists of timestamped link layer stats with labels to represent whether wifi is usable
484 repeated WifiUsabilityStats wifi_usability_stats_list = 126;
Mingguang Xuca2aab12019-01-12 23:40:42 -0800485
486 // Counts the occurrences of each Wifi usability score provided by external app
487 repeated WifiUsabilityScoreCount wifi_usability_score_count = 127;
David Su367bdff2018-12-13 13:39:11 -0800488
489 // List of PNO scan stats, one element for each mobility state
490 repeated DeviceMobilityStatePnoScanStats mobility_state_pno_stats_list = 128;
Jimmy Chen0142e8b2018-11-23 16:25:57 +0800491
492 // Wifi p2p statistics
493 optional WifiP2pStats wifi_p2p_stats = 129;
Hai Shaloma18c32c2019-01-22 10:01:09 -0800494
495 // Easy Connect (DPP) metrics
496 optional WifiDppLog wifi_dpp_log = 130;
Hai Shalom808ceb32019-01-25 13:49:49 -0800497
498 // Number of Enhanced Open (OWE) networks in the saved networks.
499 optional int32 num_enhanced_open_networks = 131;
500
501 // Number of WPA3-Personal networks.
502 optional int32 num_wpa3_personal_networks = 132;
503
504 // Number of WPA3-Enterprise networks.
505 optional int32 num_wpa3_enterprise_networks = 133;
506
507 // Total number of scan results for Enhanced open networks
508 optional int32 num_enhanced_open_network_scan_results = 134;
509
510 // Total number of scan results for WPA3-Personal networks
511 optional int32 num_wpa3_personal_network_scan_results = 135;
512
513 // Total number of scan results for WPA3-Enterprise networks
514 optional int32 num_wpa3_enterprise_network_scan_results = 136;
Roshan Pius89b233d2019-01-31 10:15:22 -0800515
516 // WifiConfigStore read/write metrics.
517 optional WifiConfigStoreIO wifi_config_store_io = 137;
xshuaeabbb72019-02-08 13:27:17 -0800518
519 // Total number of saved networks with mac randomization enabled.
520 optional int32 num_saved_networks_with_mac_randomization = 138;
David Su44306932019-02-12 16:53:46 -0800521
522 // Link Probe metrics
523 optional LinkProbeStats link_probe_stats = 139;
David Sua04f5052019-02-20 17:42:28 -0800524
525 // List of NetworkSelectionExperimentDecisions stats for each experiment
526 repeated NetworkSelectionExperimentDecisions network_selection_experiment_decisions_list = 140;
Roshan Pius3f30ba82019-02-08 11:55:55 -0800527
528 // Network Request API surface metrics.
529 optional WifiNetworkRequestApiLog wifi_network_request_api_log = 141;
530
531 // Network Suggestion API surface metrics.
532 optional WifiNetworkSuggestionApiLog wifi_network_suggestion_api_log = 142;
Ahmed ElArabawy048e1482019-03-25 10:42:04 -0700533
534 // WifiLock statistics
535 optional WifiLockStats wifi_lock_stats = 143;
xshu08c67382019-04-04 17:39:33 -0700536
537 // Stats on number of times Wi-Fi is turned on/off though the WifiManager#setWifiEnabled API
538 optional WifiToggleStats wifi_toggle_stats = 144;
539
540 // Number of times WifiManager#addOrUpdateNetwork is called.
541 optional int32 num_add_or_update_network_calls = 145;
542
543 // Number of times WifiManager#enableNetwork is called.
544 optional int32 num_enable_network_calls = 146;
hsuvictor17510162019-03-27 15:13:03 +0800545
546 // Passpoint provison metrics
547 optional PasspointProvisionStats passpoint_provision_stats = 147;
hsuvictorc0106142019-04-09 20:15:05 +0800548
549 // Histogram of the EAP method type of all installed Passpoint profiles for R1
550 repeated PasspointProfileTypeCount installed_passpoint_profile_type_for_r1 = 123;
551
552 // Histogram of the EAP method type of all installed Passpoint profiles for R2
553 repeated PasspointProfileTypeCount installed_passpoint_profile_type_for_r2 = 148;
Kai Shi026e5442019-07-18 15:50:55 -0700554
555 // Histogram of Tx link speed at 2G
556 repeated Int32Count tx_link_speed_count_2g = 149;
557
558 // Histogram of Tx link speed at 5G low band
559 repeated Int32Count tx_link_speed_count_5g_low = 150;
560
561 // Histogram of Tx link speed at 5G middle band
562 repeated Int32Count tx_link_speed_count_5g_mid = 151;
563
564 // Histogram of Tx link speed at 5G high band
565 repeated Int32Count tx_link_speed_count_5g_high = 152;
566
567 // Histogram of Rx link speed at 2G
568 repeated Int32Count rx_link_speed_count_2g = 153;
569
570 // Histogram of Rx link speed at 5G low band
571 repeated Int32Count rx_link_speed_count_5g_low = 154;
572
573 // Histogram of Rx link speed at 5G middle band
574 repeated Int32Count rx_link_speed_count_5g_mid = 155;
575
576 // Histogram of Rx link speed at 5G high band
577 repeated Int32Count rx_link_speed_count_5g_high = 156;
Glen Kuhne94814572016-10-25 12:40:35 -0700578}
579
580// Information that gets logged for every WiFi connection.
581message RouterFingerPrint {
582
583 enum RoamType {
584
585 // Type is unknown.
586 ROAM_TYPE_UNKNOWN = 0;
587
588 // No roaming - usually happens on a single band (2.4 GHz) router.
589 ROAM_TYPE_NONE = 1;
590
591 // Enterprise router.
592 ROAM_TYPE_ENTERPRISE = 2;
593
594 // DBDC => Dual Band Dual Concurrent essentially a router that
595 // supports both 2.4 GHz and 5 GHz bands.
596 ROAM_TYPE_DBDC = 3;
597 }
598
599 enum Auth {
600
601 // Auth is unknown.
602 AUTH_UNKNOWN = 0;
603
604 // No authentication.
605 AUTH_OPEN = 1;
606
607 // If the router uses a personal authentication.
608 AUTH_PERSONAL = 2;
609
610 // If the router is setup for enterprise authentication.
611 AUTH_ENTERPRISE = 3;
612 }
613
614 enum RouterTechnology {
615
616 // Router is unknown.
617 ROUTER_TECH_UNKNOWN = 0;
618
619 // Router Channel A.
620 ROUTER_TECH_A = 1;
621
622 // Router Channel B.
623 ROUTER_TECH_B = 2;
624
625 // Router Channel G.
626 ROUTER_TECH_G = 3;
627
628 // Router Channel N.
629 ROUTER_TECH_N = 4;
630
631 // Router Channel AC.
632 ROUTER_TECH_AC = 5;
633
634 // When the channel is not one of the above.
635 ROUTER_TECH_OTHER = 6;
636 }
637
638 optional RoamType roam_type = 1;
639
640 // Channel on which the connection takes place.
641 optional int32 channel_info = 2;
642
643 // DTIM setting of the router.
644 optional int32 dtim = 3;
645
646 // Authentication scheme of the router.
647 optional Auth authentication = 4;
648
649 // If the router is hidden.
650 optional bool hidden = 5;
651
652 // Channel information.
653 optional RouterTechnology router_technology = 6;
654
655 // whether ipv6 is supported.
656 optional bool supports_ipv6 = 7;
657
658 // If the router is a passpoint / hotspot 2.0 network
659 optional bool passpoint = 8;
660}
661
662message ConnectionEvent {
663
664 // Roam Type.
665 enum RoamType {
666
667 // Type is unknown.
668 ROAM_UNKNOWN = 0;
669
670 // No roaming.
Hai Shaloma18c32c2019-01-22 10:01:09 -0800671 ROAM_NONE = 1;
Glen Kuhne94814572016-10-25 12:40:35 -0700672
673 // DBDC roaming.
674 ROAM_DBDC = 2;
675
676 // Enterprise roaming.
677 ROAM_ENTERPRISE = 3;
678
679 // User selected roaming.
680 ROAM_USER_SELECTED = 4;
681
682 // Unrelated.
683 ROAM_UNRELATED = 5;
684 }
685
686 // Connectivity Level Failure.
687 enum ConnectivityLevelFailure {
688
689 // Failure is unknown.
690 HLF_UNKNOWN = 0;
691
692 // No failure.
693 HLF_NONE = 1;
694
695 // DHCP failure.
696 HLF_DHCP = 2;
697
698 // No internet connection.
699 HLF_NO_INTERNET = 3;
700
701 // No internet connection.
702 HLF_UNWANTED = 4;
703 }
704
Mingguang Xu7d2adc12019-02-12 09:07:35 -0800705 // Level 2 failure reason.
706 enum Level2FailureReason {
707
708 // Unknown default
709 FAILURE_REASON_UNKNOWN = 0;
710
711 // The reason code if there is no error during authentication. It could
712 // also imply that there no authentication in progress.
713 AUTH_FAILURE_NONE = 1;
714
715 // The reason code if there was a timeout authenticating.
716 AUTH_FAILURE_TIMEOUT = 2;
717
718 // The reason code if there was a wrong password while authenticating.
719 AUTH_FAILURE_WRONG_PSWD = 3;
720
721 // The reason code if there was EAP failure while authenticating.
722 AUTH_FAILURE_EAP_FAILURE = 4;
723 }
724
David Su21709bc2019-02-24 15:26:50 -0800725 // Entity that recommended connecting to this network.
726 enum ConnectionNominator {
727 // Unknown nominator
728 NOMINATOR_UNKNOWN = 0;
729
730 // User selected network manually
731 NOMINATOR_MANUAL = 1;
732
733 // Saved network
734 NOMINATOR_SAVED = 2;
735
736 // Suggestion API
737 NOMINATOR_SUGGESTION = 3;
738
739 // Passpoint
740 NOMINATOR_PASSPOINT = 4;
741
742 // Carrier suggestion
743 NOMINATOR_CARRIER = 5;
744
745 // External scorer
746 NOMINATOR_EXTERNAL_SCORED = 6;
747
David Sua75b6392019-03-21 20:34:22 -0700748 // Network Specifier
749 NOMINATOR_SPECIFIER = 7;
David Su21709bc2019-02-24 15:26:50 -0800750
751 // User connected choice override
752 NOMINATOR_SAVED_USER_CONNECT_CHOICE = 8;
753
754 // Open Network Available Pop-up
755 NOMINATOR_OPEN_NETWORK_AVAILABLE = 9;
756 }
757
Glen Kuhne94814572016-10-25 12:40:35 -0700758 // Start time of the connection.
759 optional int64 start_time_millis = 1;// [(datapol.semantic_type) = ST_TIMESTAMP];
760
761 // Duration to connect.
762 optional int32 duration_taken_to_connect_millis = 2;
763
764 // Router information.
765 optional RouterFingerPrint router_fingerprint = 3;
766
767 // RSSI at the start of the connection.
768 optional int32 signal_strength = 4;
769
770 // Roam Type.
771 optional RoamType roam_type = 5;
772
773 // Result of the connection.
774 optional int32 connection_result = 6;
775
776 // Reasons for level 2 failure (needs to be coordinated with wpa-supplicant).
777 optional int32 level_2_failure_code = 7;
778
779 // Failures that happen at the connectivity layer.
780 optional ConnectivityLevelFailure connectivity_level_failure_code = 8;
781
782 // Has bug report been taken.
783 optional bool automatic_bug_report_taken = 9;
xshu483a45b2019-02-08 13:24:02 -0800784
785 // Connection is using locally generated random MAC address.
786 optional bool use_randomized_mac = 10 [default = false];
David Su21709bc2019-02-24 15:26:50 -0800787
788 // Who chose to connect.
789 optional ConnectionNominator connection_nominator = 11;
790
791 // The currently running network selector when this connection event occurred.
792 optional int32 network_selector_experiment_id = 12;
Mingguang Xu7d2adc12019-02-12 09:07:35 -0800793
794 // Breakdown of level_2_failure_code with more detailed reason.
795 optional Level2FailureReason level_2_failure_reason = 13
796 [default = FAILURE_REASON_UNKNOWN];
Glen Kuhne94814572016-10-25 12:40:35 -0700797}
798
799// Number of occurrences of a specific RSSI poll rssi value
800message RssiPollCount {
801 // RSSI
802 optional int32 rssi = 1;
803
804 // Number of RSSI polls with 'rssi'
805 optional int32 count = 2;
xshu122886e2018-05-16 15:38:49 -0700806
807 // Beacon frequency of the channel in MHz
808 optional int32 frequency = 3;
Glen Kuhne94814572016-10-25 12:40:35 -0700809}
810
811// Number of occurrences of a specific alert reason value
812message AlertReasonCount {
813 // Alert reason
814 optional int32 reason = 1;
815
816 // Number of alerts with |reason|.
817 optional int32 count = 2;
818}
819
820// Counts the number of instances of a specific Wifi Score calculated by WifiScoreReport
821message WifiScoreCount {
822 // Wifi Score
823 optional int32 score = 1;
824
825 // Number of Wifi score reports with this score
826 optional int32 count = 2;
827}
828
Mingguang Xuca2aab12019-01-12 23:40:42 -0800829// Counts the number of instances of a specific Wifi Usability Score
830message WifiUsabilityScoreCount {
831 // Wifi Usability Score
832 optional int32 score = 1;
833
834 // Number of Wifi score reports with this score
835 optional int32 count = 2;
836}
837
Jong Wook Kime4aa37f2018-04-23 11:18:24 -0700838// Number of occurrences of a specific link speed (Mbps)
839// and sum of rssi (dBm) and rssi^2 (dBm^2)
840message LinkSpeedCount {
841 // Link speed (Mbps)
842 optional int32 link_speed_mbps = 1;
843
844 // Number of RSSI polls with link_speed
845 optional int32 count = 2;
846
847 // Sum of absolute values of rssi values (dBm)
848 optional int32 rssi_sum_dbm = 3;
849
850 // Sum of squares of rssi values (dBm^2)
851 optional int64 rssi_sum_of_squares_dbm_sq = 4;
852}
853
Kai Shi026e5442019-07-18 15:50:55 -0700854
Glen Kuhne94814572016-10-25 12:40:35 -0700855// Number of occurrences of Soft AP session durations
856message SoftApDurationBucket {
857 // Bucket covers duration : [duration_sec, duration_sec + bucket_size_sec)
858 // The (inclusive) lower bound of Soft AP session duration represented by this bucket
859 optional int32 duration_sec = 1;
860
861 // The size of this bucket
862 optional int32 bucket_size_sec = 2;
863
864 // Number of soft AP session durations that fit into this bucket
865 optional int32 count = 3;
866}
867
868// Number of occurrences of a soft AP session return code
869message SoftApReturnCodeCount {
Rebecca Silberstein28d9de22017-01-24 10:42:59 -0800870
871 enum SoftApStartResult {
872
873 // SoftApManager return code unknown
874 SOFT_AP_RETURN_CODE_UNKNOWN = 0;
875
876 // SoftAp started successfully
877 SOFT_AP_STARTED_SUCCESSFULLY = 1;
878
879 // Catch all for failures with no specific failure reason
880 SOFT_AP_FAILED_GENERAL_ERROR = 2;
881
882 // SoftAp failed to start due to NO_CHANNEL error
883 SOFT_AP_FAILED_NO_CHANNEL = 3;
884 }
885
886 // Historical, no longer used for writing as of 01/2017.
887 optional int32 return_code = 1 [deprecated = true];
Glen Kuhne94814572016-10-25 12:40:35 -0700888
889 // Occurrences of this soft AP return code
890 optional int32 count = 2;
Rebecca Silberstein28d9de22017-01-24 10:42:59 -0800891
892 // Result of attempt to start SoftAp
893 optional SoftApStartResult start_result = 3;
Glen Kuhne94814572016-10-25 12:40:35 -0700894}
Glen Kuhne8ce9a1c2017-03-28 14:02:48 -0700895
896message StaEvent {
897 message ConfigInfo {
898 // The set of key management protocols supported by this configuration.
899 optional uint32 allowed_key_management = 1 [default = 0];
900
901 // The set of security protocols supported by this configuration.
902 optional uint32 allowed_protocols = 2 [default = 0];
903
904 // The set of authentication protocols supported by this configuration.
905 optional uint32 allowed_auth_algorithms = 3 [default = 0];
906
907 // The set of pairwise ciphers for WPA supported by this configuration.
908 optional uint32 allowed_pairwise_ciphers = 4 [default = 0];
909
910 // The set of group ciphers supported by this configuration.
911 optional uint32 allowed_group_ciphers = 5;
912
913 // Is this a 'hidden network'
914 optional bool hidden_ssid = 6;
915
916 // Is this a Hotspot 2.0 / passpoint network
917 optional bool is_passpoint = 7;
918
919 // Is this an 'ephemeral' network (Not in saved network list, recommended externally)
920 optional bool is_ephemeral = 8;
921
922 // Has a successful connection ever been established using this WifiConfiguration
923 optional bool has_ever_connected = 9;
924
925 // RSSI of the scan result candidate associated with this WifiConfiguration
926 optional int32 scan_rssi = 10 [default = -127];
927
928 // Frequency of the scan result candidate associated with this WifiConfiguration
929 optional int32 scan_freq = 11 [default = -1];
930 }
931
932 enum EventType {
933 // Default/Invalid event
934 TYPE_UNKNOWN = 0;
935
936 // Supplicant Association Rejection event. Code contains the 802.11
937 TYPE_ASSOCIATION_REJECTION_EVENT = 1;
938
939 // Supplicant L2 event,
940 TYPE_AUTHENTICATION_FAILURE_EVENT = 2;
941
942 // Supplicant L2 event
943 TYPE_NETWORK_CONNECTION_EVENT = 3;
944
945 // Supplicant L2 event
946 TYPE_NETWORK_DISCONNECTION_EVENT = 4;
947
948 // Supplicant L2 event
949 TYPE_SUPPLICANT_STATE_CHANGE_EVENT = 5;
950
951 // Supplicant L2 event
952 TYPE_CMD_ASSOCIATED_BSSID = 6;
953
954 // IP Manager successfully completed IP Provisioning
955 TYPE_CMD_IP_CONFIGURATION_SUCCESSFUL = 7;
956
957 // IP Manager failed to complete IP Provisioning
958 TYPE_CMD_IP_CONFIGURATION_LOST = 8;
959
960 // IP Manager lost reachability to network neighbors
961 TYPE_CMD_IP_REACHABILITY_LOST = 9;
962
963 // Indicator that Supplicant is targeting a BSSID for roam/connection
964 TYPE_CMD_TARGET_BSSID = 10;
965
966 // Wifi framework is initiating a connection attempt
967 TYPE_CMD_START_CONNECT = 11;
968
969 // Wifi framework is initiating a roaming connection attempt
970 TYPE_CMD_START_ROAM = 12;
971
972 // SystemAPI connect() command, Settings App
973 TYPE_CONNECT_NETWORK = 13;
974
975 // Network Agent has validated the internet connection (Captive Portal Check success, or user
976 // validation)
977 TYPE_NETWORK_AGENT_VALID_NETWORK = 14;
978
979 // Framework initiated disconnect. Sometimes generated to give an extra reason for a disconnect
980 // Should typically be followed by a NETWORK_DISCONNECTION_EVENT with a local_gen = true
981 TYPE_FRAMEWORK_DISCONNECT = 15;
Michael Plassbb367b62017-10-06 10:29:51 -0700982
983 // The NetworkAgent score for wifi has changed in a way that may impact
984 // connectivity
985 TYPE_SCORE_BREACH = 16;
Jong Wook Kim01ad38b2018-04-09 10:14:11 -0700986
987 // Framework changed Sta interface MAC address
988 TYPE_MAC_CHANGE = 17;
Jong Wook Kimb56979f2018-08-08 14:50:18 -0700989
990 // Wifi is turned on
991 TYPE_WIFI_ENABLED = 18;
992
993 // Wifi is turned off
994 TYPE_WIFI_DISABLED = 19;
Mingguang Xuca2aab12019-01-12 23:40:42 -0800995
996 // The NetworkAgent Wifi usability score has changed in a way that may
997 // impact connectivity
998 TYPE_WIFI_USABILITY_SCORE_BREACH = 20;
David Sua847e582019-04-02 17:45:58 -0700999
1000 // Link probe was performed
1001 TYPE_LINK_PROBE = 21;
Glen Kuhne8ce9a1c2017-03-28 14:02:48 -07001002 }
1003
1004 enum FrameworkDisconnectReason {
1005 // default/none/unknown value
1006 DISCONNECT_UNKNOWN = 0;
1007
1008 // API DISCONNECT
1009 DISCONNECT_API = 1;
1010
1011 // Some framework internal reason (generic)
1012 DISCONNECT_GENERIC = 2;
1013
1014 // Network Agent network validation failed, user signaled network unwanted
1015 DISCONNECT_UNWANTED = 3;
1016
1017 // Roaming timed out
1018 DISCONNECT_ROAM_WATCHDOG_TIMER = 4;
1019
1020 // P2P service requested wifi disconnect
1021 DISCONNECT_P2P_DISCONNECT_WIFI_REQUEST = 5;
1022
1023 // SIM was removed while using a SIM config
1024 DISCONNECT_RESET_SIM_NETWORKS = 6;
1025 }
1026
1027 // Authentication Failure reasons as reported through the API.
1028 enum AuthFailureReason {
1029 // Unknown default
1030 AUTH_FAILURE_UNKNOWN = 0;
1031
1032 // The reason code if there is no error during authentication. It could also imply that there no
1033 // authentication in progress,
1034 AUTH_FAILURE_NONE = 1;
1035
1036 // The reason code if there was a timeout authenticating.
1037 AUTH_FAILURE_TIMEOUT = 2;
1038
1039 // The reason code if there was a wrong password while authenticating.
1040 AUTH_FAILURE_WRONG_PSWD = 3;
1041
1042 // The reason code if there was EAP failure while authenticating.
1043 AUTH_FAILURE_EAP_FAILURE = 4;
1044 }
1045
1046 // What event was this
1047 optional EventType type = 1;
1048
1049 // 80211 death reason code, relevant to NETWORK_DISCONNECTION_EVENTs
1050 optional int32 reason = 2 [default = -1];
1051
1052 // 80211 Association Status code, relevant to ASSOCIATION_REJECTION_EVENTs
1053 optional int32 status = 3 [default = -1];
1054
1055 // Designates whether a NETWORK_DISCONNECT_EVENT was by the STA or AP
1056 optional bool local_gen = 4 [default = false];
1057
1058 // Network information from the WifiConfiguration of a framework initiated connection attempt
1059 optional ConfigInfo config_info = 5;
1060
1061 // RSSI from the last rssi poll (Only valid for active connections)
1062 optional int32 last_rssi = 6 [default = -127];
1063
1064 // Link speed from the last rssi poll (Only valid for active connections)
1065 optional int32 last_link_speed = 7 [default = -1];
1066
1067 // Frequency from the last rssi poll (Only valid for active connections)
1068 optional int32 last_freq = 8 [default = -1];
1069
1070 // Enum used to define bit positions in the supplicant_state_change_bitmask
1071 // See {@code frameworks/base/wifi/java/android/net/wifi/SupplicantState.java} for documentation
1072 enum SupplicantState {
1073 STATE_DISCONNECTED = 0;
1074
1075 STATE_INTERFACE_DISABLED = 1;
1076
1077 STATE_INACTIVE = 2;
1078
1079 STATE_SCANNING = 3;
1080
1081 STATE_AUTHENTICATING = 4;
1082
1083 STATE_ASSOCIATING = 5;
1084
1085 STATE_ASSOCIATED = 6;
1086
1087 STATE_FOUR_WAY_HANDSHAKE = 7;
1088
1089 STATE_GROUP_HANDSHAKE = 8;
1090
1091 STATE_COMPLETED = 9;
1092
1093 STATE_DORMANT = 10;
1094
1095 STATE_UNINITIALIZED = 11;
1096
1097 STATE_INVALID = 12;
1098 }
1099
Jong Wook Kim411cab92018-04-26 15:09:23 -07001100 // Bit mask of all supplicant state changes that occurred since the last event
Glen Kuhne8ce9a1c2017-03-28 14:02:48 -07001101 optional uint32 supplicant_state_changes_bitmask = 9 [default = 0];
1102
1103 // The number of milliseconds that have elapsed since the device booted
1104 optional int64 start_time_millis = 10 [default = 0];
1105
1106 optional FrameworkDisconnectReason framework_disconnect_reason = 11 [default = DISCONNECT_UNKNOWN];
1107
Jong Wook Kim411cab92018-04-26 15:09:23 -07001108 // Flag which indicates if an association rejection event occurred due to a timeout
Glen Kuhne8ce9a1c2017-03-28 14:02:48 -07001109 optional bool association_timed_out = 12 [default = false];
1110
1111 // Authentication failure reason, as reported by WifiManager (calculated from state & deauth code)
1112 optional AuthFailureReason auth_failure_reason = 13 [default = AUTH_FAILURE_UNKNOWN];
Michael Plassbb367b62017-10-06 10:29:51 -07001113
1114 // NetworkAgent score of connected wifi
1115 optional int32 last_score = 14 [default = -1];
Mingguang Xuca2aab12019-01-12 23:40:42 -08001116
1117 // NetworkAgent Wifi usability score of connected wifi
1118 optional int32 last_wifi_usability_score = 15 [default = -1];
Mingguang Xue7e344a2019-01-21 16:26:45 -08001119
1120 // Prediction horizon (in second) of Wifi usability score provided by external
1121 // system app
1122 optional int32 last_prediction_horizon_sec = 16 [default = -1];
David Sua847e582019-04-02 17:45:58 -07001123
1124 // Only valid if event type == TYPE_LINK_PROBE.
1125 // true if link probe succeeded, false otherwise.
1126 optional bool link_probe_was_success = 17;
1127
1128 // Only valid if event type == TYPE_LINK_PROBE and link_probe_was_success == true.
1129 // Elapsed time, in milliseconds, of a successful link probe.
1130 optional int32 link_probe_success_elapsed_time_ms = 18;
1131
1132 // Only valid if event type == TYPE_LINK_PROBE and link_probe_was_success == false.
1133 // Failure reason for an unsuccessful link probe.
1134 optional LinkProbeStats.LinkProbeFailureReason link_probe_failure_reason = 19;
Glen Kuhne8ce9a1c2017-03-28 14:02:48 -07001135}
Etan Cohen737addc2017-04-26 08:01:57 -07001136
1137// Wi-Fi Aware metrics
1138message WifiAwareLog {
1139 // total number of unique apps that used Aware (measured on attach)
1140 optional int32 num_apps = 1;
1141
1142 // total number of unique apps that used an identity callback when attaching
1143 optional int32 num_apps_using_identity_callback = 2;
1144
1145 // maximum number of attaches for an app
1146 optional int32 max_concurrent_attach_sessions_in_app = 3;
1147
1148 // histogram of attach request results
1149 repeated NanStatusHistogramBucket histogram_attach_session_status = 4;
1150
1151 // maximum number of concurrent publish sessions in a single app
1152 optional int32 max_concurrent_publish_in_app = 5;
1153
1154 // maximum number of concurrent subscribe sessions in a single app
1155 optional int32 max_concurrent_subscribe_in_app = 6;
1156
1157 // maximum number of concurrent discovery (publish+subscribe) sessions in a single app
1158 optional int32 max_concurrent_discovery_sessions_in_app = 7;
1159
1160 // maximum number of concurrent publish sessions in the system
1161 optional int32 max_concurrent_publish_in_system = 8;
1162
1163 // maximum number of concurrent subscribe sessions in the system
1164 optional int32 max_concurrent_subscribe_in_system = 9;
1165
1166 // maximum number of concurrent discovery (publish+subscribe) sessions in the system
1167 optional int32 max_concurrent_discovery_sessions_in_system = 10;
1168
1169 // histogram of publish request results
1170 repeated NanStatusHistogramBucket histogram_publish_status = 11;
1171
1172 // histogram of subscribe request results
1173 repeated NanStatusHistogramBucket histogram_subscribe_status = 12;
1174
1175 // number of unique apps which experienced a discovery session creation failure due to lack of
1176 // resources
1177 optional int32 num_apps_with_discovery_session_failure_out_of_resources = 13;
1178
1179 // histogram of create ndp request results
1180 repeated NanStatusHistogramBucket histogram_request_ndp_status = 14;
1181
1182 // histogram of create ndp out-of-band (OOB) request results
1183 repeated NanStatusHistogramBucket histogram_request_ndp_oob_status = 15;
1184
1185 // maximum number of concurrent active data-interfaces (NDI) in a single app
1186 optional int32 max_concurrent_ndi_in_app = 19;
1187
1188 // maximum number of concurrent active data-interfaces (NDI) in the system
1189 optional int32 max_concurrent_ndi_in_system = 20;
1190
1191 // maximum number of concurrent data-paths (NDP) in a single app
1192 optional int32 max_concurrent_ndp_in_app = 21;
1193
1194 // maximum number of concurrent data-paths (NDP) in the system
1195 optional int32 max_concurrent_ndp_in_system = 22;
1196
1197 // maximum number of concurrent secure data-paths (NDP) in a single app
1198 optional int32 max_concurrent_secure_ndp_in_app = 23;
1199
1200 // maximum number of concurrent secure data-paths (NDP) in the system
1201 optional int32 max_concurrent_secure_ndp_in_system = 24;
1202
1203 // maximum number of concurrent data-paths (NDP) per data-interface (NDI)
1204 optional int32 max_concurrent_ndp_per_ndi = 25;
1205
1206 // histogram of durations of Aware being available
1207 repeated HistogramBucket histogram_aware_available_duration_ms = 26;
1208
1209 // histogram of durations of Aware being enabled
1210 repeated HistogramBucket histogram_aware_enabled_duration_ms = 27;
1211
1212 // histogram of duration (in ms) of attach sessions
1213 repeated HistogramBucket histogram_attach_duration_ms = 28;
1214
1215 // histogram of duration (in ms) of publish sessions
1216 repeated HistogramBucket histogram_publish_session_duration_ms = 29;
1217
1218 // histogram of duration (in ms) of subscribe sessions
1219 repeated HistogramBucket histogram_subscribe_session_duration_ms = 30;
1220
1221 // histogram of duration (in ms) of data-paths (NDP)
1222 repeated HistogramBucket histogram_ndp_session_duration_ms = 31;
1223
1224 // histogram of usage (in MB) of data-paths (NDP)
1225 repeated HistogramBucket histogram_ndp_session_data_usage_mb = 32;
1226
1227 // histogram of usage (in MB) of data-path creation time (in ms) measured as request -> confirm
1228 repeated HistogramBucket histogram_ndp_creation_time_ms = 33;
1229
1230 // statistics for data-path (NDP) creation time (in ms) measured as request -> confirm: minimum
1231 optional int64 ndp_creation_time_ms_min = 34;
1232
1233 // statistics for data-path (NDP) creation time (in ms) measured as request -> confirm: maximum
1234 optional int64 ndp_creation_time_ms_max = 35;
1235
1236 // statistics for data-path (NDP) creation time (in ms) measured as request -> confirm: sum
1237 optional int64 ndp_creation_time_ms_sum = 36;
1238
1239 // statistics for data-path (NDP) creation time (in ms) measured as request -> confirm: sum of sq
1240 optional int64 ndp_creation_time_ms_sum_of_sq = 37;
1241
1242 // statistics for data-path (NDP) creation time (in ms) measured as request -> confirm: number of
1243 // samples
1244 optional int64 ndp_creation_time_ms_num_samples = 38;
1245
1246 // total time within the logging window that aware was available
1247 optional int64 available_time_ms = 39;
1248
1249 // total time within the logging window that aware was enabled
1250 optional int64 enabled_time_ms = 40;
1251
Etan Cohenfa723572018-03-13 07:25:50 -07001252 // maximum number of concurrent publish sessions enabling ranging in a single app
1253 optional int32 max_concurrent_publish_with_ranging_in_app = 41;
1254
1255 // maximum number of concurrent subscribe sessions specifying a geofence in a single app
1256 optional int32 max_concurrent_subscribe_with_ranging_in_app = 42;
1257
1258 // maximum number of concurrent publish sessions enabling ranging in the system
1259 optional int32 max_concurrent_publish_with_ranging_in_system = 43;
1260
1261 // maximum number of concurrent subscribe sessions specifying a geofence in the system
1262 optional int32 max_concurrent_subscribe_with_ranging_in_system = 44;
1263
1264 // histogram of subscribe session geofence minimum (only when specified)
1265 repeated HistogramBucket histogram_subscribe_geofence_min = 45;
1266
1267 // histogram of subscribe session geofence maximum (only when specified)
1268 repeated HistogramBucket histogram_subscribe_geofence_max = 46;
1269
1270 // total number of subscribe sessions which enabled ranging
1271 optional int32 num_subscribes_with_ranging = 47;
1272
1273 // total number of matches (service discovery indication) with ranging provided
1274 optional int32 num_matches_with_ranging = 48;
1275
1276 // total number of matches (service discovery indication) for service discovery with ranging
1277 // enabled which did not trigger ranging
1278 optional int32 num_matches_without_ranging_for_ranging_enabled_subscribes = 49;
1279
Etan Cohen737addc2017-04-26 08:01:57 -07001280 // Histogram bucket for Wi-Fi Aware logs. Range is [start, end)
1281 message HistogramBucket {
1282 // lower range of the bucket (inclusive)
1283 optional int64 start = 1;
1284
1285 // upper range of the bucket (exclusive)
1286 optional int64 end = 2;
1287
1288 // number of samples in the bucket
1289 optional int32 count = 3;
1290 }
1291
1292 // Status of various NAN operations
1293 enum NanStatusTypeEnum {
1294 // constant to be used by proto
1295 UNKNOWN = 0;
1296
1297 // NAN operation succeeded
1298 SUCCESS = 1;
1299
1300 // NAN Discovery Engine/Host driver failures
1301 INTERNAL_FAILURE = 2;
1302
1303 // NAN OTA failures
1304 PROTOCOL_FAILURE = 3;
1305
1306 // The publish/subscribe discovery session id is invalid
1307 INVALID_SESSION_ID = 4;
1308
1309 // Out of resources to fufill request
1310 NO_RESOURCES_AVAILABLE = 5;
1311
1312 // Invalid arguments passed
1313 INVALID_ARGS = 6;
1314
1315 // Invalid peer id
1316 INVALID_PEER_ID = 7;
1317
1318 // Invalid NAN data-path (ndp) id
1319 INVALID_NDP_ID = 8;
1320
1321 // Attempting to enable NAN when not available, e.g. wifi is disabled
1322 NAN_NOT_ALLOWED = 9;
1323
1324 // Over the air ACK not received
1325 NO_OTA_ACK = 10;
1326
1327 // Attempting to enable NAN when already enabled
1328 ALREADY_ENABLED = 11;
1329
1330 // Can't queue tx followup message foor transmission
1331 FOLLOWUP_TX_QUEUE_FULL = 12;
1332
1333 // Unsupported concurrency of NAN and another feature - NAN disabled
1334 UNSUPPORTED_CONCURRENCY_NAN_DISABLED = 13;
1335
1336 // Unknown NanStatusType
1337 UNKNOWN_HAL_STATUS = 14;
1338 }
1339
1340 // Histogram bucket for Wi-Fi Aware (NAN) status.
1341 message NanStatusHistogramBucket {
1342 // status type defining the bucket
1343 optional NanStatusTypeEnum nan_status_type = 1;
1344
1345 // number of samples in the bucket
1346 optional int32 count = 2;
1347 }
1348}
1349
Glen Kuhnee2d67c02017-04-25 13:08:29 -07001350// Data point used to build 'Number of Connectable Network' histograms
1351message NumConnectableNetworksBucket {
1352 // Number of connectable networks seen in a scan result
1353 optional int32 num_connectable_networks = 1 [default = 0];
1354
1355 // Number of scan results with num_connectable_networks
1356 optional int32 count = 2 [default = 0];
1357}
Mehdi Alizadehd9163cf2017-08-10 18:20:25 -07001358
1359// Pno scan metrics
1360// Here "Pno Scan" refers to the session of offloaded scans, these metrics count the result of a
1361// single session, and not the individual scans within that session.
1362message PnoScanMetrics {
1363 // Total number of attempts to offload pno scans
1364 optional int32 num_pno_scan_attempts = 1;
1365
1366 // Total number of pno scans failed
1367 optional int32 num_pno_scan_failed = 2;
1368
1369 // Number of pno scans started successfully over offload
1370 optional int32 num_pno_scan_started_over_offload = 3;
1371
1372 // Number of pno scans failed over offload
1373 optional int32 num_pno_scan_failed_over_offload = 4;
1374
1375 // Total number of pno scans that found any network
1376 optional int32 num_pno_found_network_events = 5;
1377}
Stephen Chenfc0facb2017-09-14 14:35:15 -07001378
1379// Number of occurrences for a particular "Connect to Network" Notification or
1380// notification Action.
1381message ConnectToNetworkNotificationAndActionCount {
1382
1383 // "Connect to Network" notifications
1384 enum Notification {
1385
1386 // Default
1387 NOTIFICATION_UNKNOWN = 0;
1388
1389 // Initial notification with a recommended network.
1390 NOTIFICATION_RECOMMEND_NETWORK = 1;
1391
1392 // Notification when connecting to the recommended network.
1393 NOTIFICATION_CONNECTING_TO_NETWORK = 2;
1394
1395 // Notification when successfully connected to the network.
1396 NOTIFICATION_CONNECTED_TO_NETWORK = 3;
1397
1398 // Notification when failed to connect to network.
1399 NOTIFICATION_FAILED_TO_CONNECT = 4;
1400 }
1401
1402 // "Connect to Network" notification actions
1403 enum Action {
1404
1405 // Default
1406 ACTION_UNKNOWN = 0;
1407
1408 // User dismissed the "Connect to Network" notification.
1409 ACTION_USER_DISMISSED_NOTIFICATION = 1;
1410
1411 // User tapped action button to connect to recommended network.
1412 ACTION_CONNECT_TO_NETWORK = 2;
1413
1414 // User tapped action button to open Wi-Fi Settings.
1415 ACTION_PICK_WIFI_NETWORK = 3;
1416
1417 // User tapped "Failed to connect" notification to open Wi-Fi Settings.
1418 ACTION_PICK_WIFI_NETWORK_AFTER_CONNECT_FAILURE = 4;
1419 }
1420
1421 // Recommenders of the "Connect to Network" notification
1422 enum Recommender {
1423
1424 // Default.
1425 RECOMMENDER_UNKNOWN = 0;
1426
1427 // Open Network Available recommender.
1428 RECOMMENDER_OPEN = 1;
1429 }
1430
1431 // Notification Type.
1432 optional Notification notification = 1;
1433
1434 // Action Type.
1435 optional Action action = 2;
1436
1437 // Recommender Type.
1438 optional Recommender recommender = 3;
1439
1440 // Occurrences of this action.
1441 optional int32 count = 4;
1442}
Mehdi Alizadeh2a59c52ca2017-10-18 15:42:35 -07001443
1444// SoftAP event tracking sessions and client counts
1445message SoftApConnectedClientsEvent {
1446
1447 // Soft AP event Types
1448 enum SoftApEventType {
1449
1450 // Soft AP is Up and ready for use
1451 SOFT_AP_UP = 0;
1452
1453 // Soft AP is Down
1454 SOFT_AP_DOWN = 1;
1455
1456 // Number of connected soft AP clients has changed
1457 NUM_CLIENTS_CHANGED = 2;
1458 }
1459
Mehdi Alizadeh24498192018-03-15 13:02:51 -07001460 // Soft AP channel bandwidth types
1461 enum ChannelBandwidth {
1462
1463 BANDWIDTH_INVALID = 0;
1464
1465 BANDWIDTH_20_NOHT = 1;
1466
1467 BANDWIDTH_20 = 2;
1468
1469 BANDWIDTH_40 = 3;
1470
1471 BANDWIDTH_80 = 4;
1472
1473 BANDWIDTH_80P80 = 5;
1474
1475 BANDWIDTH_160 = 6;
1476 }
1477
Mehdi Alizadeh2a59c52ca2017-10-18 15:42:35 -07001478 // Type of event being recorded
1479 optional SoftApEventType event_type = 1;
1480
Mehdi Alizadeh24498192018-03-15 13:02:51 -07001481 // Time passed since last boot in milliseconds
Mehdi Alizadeh2a59c52ca2017-10-18 15:42:35 -07001482 optional int64 time_stamp_millis = 2;
1483
1484 // Number of connected clients if event_type is NUM_CLIENTS_CHANGED, otherwise zero.
1485 optional int32 num_connected_clients = 3;
Mehdi Alizadeh24498192018-03-15 13:02:51 -07001486
1487 // Channel frequency used for Soft AP
1488 optional int32 channel_frequency = 4;
1489
1490 // Channel bandwidth used for Soft AP
1491 optional ChannelBandwidth channel_bandwidth = 5;
Jong Wook Kim72c49ee2017-10-26 13:16:36 -07001492}
1493
1494// Wps connection metrics
1495// Keeps track of Wi-Fi Protected Setup usage
1496message WpsMetrics {
1497 // Total number of wps connection attempts
1498 optional int32 num_wps_attempts = 1;
1499
1500 // Total number of wps connection successes
1501 optional int32 num_wps_success = 2;
1502
1503 // Total number of wps failures on start
1504 optional int32 num_wps_start_failure = 3;
1505
1506 // Total number of wps overlap failure
1507 optional int32 num_wps_overlap_failure = 4;
1508
1509 // Total number of wps timeout failure
1510 optional int32 num_wps_timeout_failure = 5;
1511
1512 // Total number of other wps failure during connection
1513 optional int32 num_wps_other_connection_failure = 6;
1514
1515 // Total number of supplicant failure after wps
1516 optional int32 num_wps_supplicant_failure = 7;
1517
1518 // Total number of wps cancellation
1519 optional int32 num_wps_cancellation = 8;
1520}
Siddharth Rayac8b69a2018-01-27 18:05:44 -08001521
1522// Power stats for Wifi
1523message WifiPowerStats {
1524
1525 // Duration of log (ms)
1526 optional int64 logging_duration_ms = 1;
1527
1528 // Energy consumed by wifi (mAh)
1529 optional double energy_consumed_mah = 2;
1530
1531 // Amount of time wifi is in idle (ms)
1532 optional int64 idle_time_ms = 3;
1533
1534 // Amount of time wifi is in rx (ms)
1535 optional int64 rx_time_ms = 4;
1536
1537 // Amount of time wifi is in tx (ms)
1538 optional int64 tx_time_ms = 5;
Blake Kragten354c83d2018-12-04 16:28:44 -08001539
1540 // Amount of time kernel is active because of wifi data (ms)
1541 optional int64 wifi_kernel_active_time_ms = 6;
1542
1543 // Number of packets sent (tx)
1544 optional int64 num_packets_tx = 7;
1545
1546 // Number of bytes sent (tx)
1547 optional int64 num_bytes_tx = 8;
1548
1549 // Number of packets received (rx)
1550 optional int64 num_packets_rx = 9;
1551
1552 // Number of bytes sent (rx)
1553 optional int64 num_bytes_rx = 10;
1554
1555 // Amount of time wifi is in sleep (ms)
1556 optional int64 sleep_time_ms = 11;
1557
1558 // Amount of time wifi is scanning (ms)
1559 optional int64 scan_time_ms = 12;
Blake Kragten0f8aa762019-01-31 16:05:15 -08001560
1561 // Actual monitored rail energy consumed by wifi (mAh)
1562 optional double monitored_rail_energy_consumed_mah = 13;
Ningyuan Wang72886332017-12-20 16:17:33 -08001563}
Eric Schwarzenbach9f941f92018-02-16 11:10:30 -08001564
1565// Metrics for Wifi Wake
1566message WifiWakeStats {
1567 // An individual session for Wifi Wake
1568 message Session {
1569 // A Wifi Wake lifecycle event
1570 message Event {
1571 // Elapsed time in milliseconds since start of session.
1572 optional int64 elapsed_time_millis = 1;
1573
1574 // Number of scans that have occurred since start of session.
1575 optional int32 elapsed_scans = 2;
1576 }
1577
1578 // Start time of session in milliseconds.
1579 optional int64 start_time_millis = 1;
1580
Eric Schwarzenbach3cad6242018-03-26 10:23:40 -07001581 // The number of networks the lock was provided with at start.
Eric Schwarzenbach9f941f92018-02-16 11:10:30 -08001582 optional int32 locked_networks_at_start = 2;
1583
Eric Schwarzenbach3cad6242018-03-26 10:23:40 -07001584 // The number of networks in the lock at the time of the initialize event. Only valid if
1585 // initialize_event is recorded.
1586 optional int32 locked_networks_at_initialize = 6;
1587
1588 // Event for fully initializing the WakeupLock (i.e. WakeupLock is "locked").
1589 optional Event initialize_event = 7;
1590
Eric Schwarzenbach9f941f92018-02-16 11:10:30 -08001591 // Event for unlocking the WakeupLock. Does not occur if lock was initialized with 0 networks.
1592 optional Event unlock_event = 3;
1593
1594 // Event for triggering wakeup.
1595 optional Event wakeup_event = 4;
1596
1597 // Event for WifiWake reset event. This event marks the end of a session.
1598 optional Event reset_event = 5;
1599 }
1600
1601 // Total number of sessions for Wifi Wake.
1602 optional int32 num_sessions = 1;
1603
1604 // Session information for every Wifi Wake session (up to a maximum of 10).
1605 repeated Session sessions = 2;
Eric Schwarzenbach3cad6242018-03-26 10:23:40 -07001606
1607 // Number of ignored calls to start (due to WakeupController already being active).
1608 optional int32 num_ignored_starts = 3;
1609
1610 // Number of Wifi Wake sessions that have recorded wakeup events.
1611 optional int32 num_wakeups = 4;
Eric Schwarzenbach9f941f92018-02-16 11:10:30 -08001612}
Etan Cohen4ec8dd32018-03-16 09:43:01 -07001613
1614// Metrics for Wi-Fi RTT
1615message WifiRttLog {
1616 // Number of RTT request API calls
1617 optional int32 num_requests = 1;
1618
1619 // Histogram of RTT operation overall status
1620 repeated RttOverallStatusHistogramBucket histogram_overall_status = 2;
1621
1622 // RTT to Access Points metrics
1623 optional RttToPeerLog rtt_to_ap = 3;
1624
1625 // RTT to Wi-Fi Aware peers metrics
1626 optional RttToPeerLog rtt_to_aware = 4;
1627
1628 // Metrics for a RTT to Peer (peer = AP or Wi-Fi Aware)
1629 message RttToPeerLog {
1630 // Total number of API calls
1631 optional int32 num_requests = 1;
1632
1633 // Total number of individual requests
1634 optional int32 num_individual_requests = 2;
1635
1636 // Total number of apps which requested RTT
1637 optional int32 num_apps = 3;
1638
1639 // Histogram of total number of RTT requests by an app (WifiRttManager#startRanging)
1640 repeated HistogramBucket histogram_num_requests_per_app = 4;
1641
1642 // Histogram of number of peers in a single RTT request (RangingRequest entries)
1643 repeated HistogramBucket histogram_num_peers_per_request = 5;
1644
1645 // Histogram of status of individual RTT operations (RangingResult entries)
1646 repeated RttIndividualStatusHistogramBucket histogram_individual_status = 6;
1647
1648 // Histogram of measured distances (RangingResult entries)
1649 repeated HistogramBucket histogram_distance = 7;
1650
1651 // Histogram of interval of RTT requests by an app (WifiRttManager#startRanging)
1652 repeated HistogramBucket histogram_request_interval_ms = 8;
1653 }
1654
Hai Shaloma18c32c2019-01-22 10:01:09 -08001655 // Histogram bucket for Wi-Fi RTT logs. Range is [start, end)
Etan Cohen4ec8dd32018-03-16 09:43:01 -07001656 message HistogramBucket {
1657 // lower range of the bucket (inclusive)
1658 optional int64 start = 1;
1659
1660 // upper range of the bucket (exclusive)
1661 optional int64 end = 2;
1662
1663 // number of samples in the bucket
1664 optional int32 count = 3;
1665 }
1666
1667 // Status codes for overall RTT operation
1668 enum RttOverallStatusTypeEnum {
1669 // constant to be used by proto
1670 OVERALL_UNKNOWN = 0;
1671
1672 // RTT operation succeeded (individual results may still fail)
1673 OVERALL_SUCCESS = 1;
1674
1675 // RTT operation failed (unspecified reason)
1676 OVERALL_FAIL = 2;
1677
1678 // RTT operation failed since RTT was not available (e.g. Airplane mode)
1679 OVERALL_RTT_NOT_AVAILABLE = 3;
1680
1681 // RTT operation timed-out: didn't receive response from HAL in expected time
1682 OVERALL_TIMEOUT = 4;
1683
1684 // RTT operation aborted since the app is spamming the service
1685 OVERALL_THROTTLE = 5;
1686
1687 // RTT request to HAL received immediate failure
1688 OVERALL_HAL_FAILURE = 6;
1689
1690 // RTT to Wi-Fi Aware peer using PeerHandle failed to get a MAC address translation
1691 OVERALL_AWARE_TRANSLATION_FAILURE = 7;
1692
1693 // RTT operation failed due to missing Location permission (post execution)
1694 OVERALL_LOCATION_PERMISSION_MISSING = 8;
1695 }
1696
1697 // Status codes for individual RTT operation
1698 enum RttIndividualStatusTypeEnum {
1699 // constant to be used by proto
1700 UNKNOWN = 0;
1701
1702 // RTT operation succeeded
1703 SUCCESS = 1;
1704
1705 // RTT failure: generic reason (no further information)
1706 FAILURE = 2;
1707
1708 // Target STA does not respond to request
1709 FAIL_NO_RSP = 3;
1710
1711 // Request rejected. Applies to 2-sided RTT only
1712 FAIL_REJECTED = 4;
1713
1714 // Operation not scheduled
1715 FAIL_NOT_SCHEDULED_YET = 5;
1716
1717 // Timing measurement times out
1718 FAIL_TM_TIMEOUT = 6;
1719
1720 // Target on different channel, cannot range
1721 FAIL_AP_ON_DIFF_CHANNEL = 7;
1722
1723 // Ranging not supported
1724 FAIL_NO_CAPABILITY = 8;
1725
1726 // Request aborted for unknown reason
1727 ABORTED = 9;
1728
1729 // Invalid T1-T4 timestamp
1730 FAIL_INVALID_TS = 10;
1731
1732 // 11mc protocol failed
1733 FAIL_PROTOCOL = 11;
1734
1735 // Request could not be scheduled
1736 FAIL_SCHEDULE = 12;
1737
1738 // Responder cannot collaborate at time of request
1739 FAIL_BUSY_TRY_LATER = 13;
1740
1741 // Bad request args
1742 INVALID_REQ = 14;
1743
1744 // WiFi not enabled
1745 NO_WIFI = 15;
1746
1747 // Responder overrides param info, cannot range with new params
1748 FAIL_FTM_PARAM_OVERRIDE = 16;
1749
1750 // HAL did not provide a result to a framework request
1751 MISSING_RESULT = 17;
1752 }
1753
1754 // Histogram bucket for Wi-Fi RTT overall operation status
1755 message RttOverallStatusHistogramBucket {
1756 // status type defining the bucket
1757 optional RttOverallStatusTypeEnum status_type = 1;
1758
1759 // number of samples in the bucket
1760 optional int32 count = 2;
1761 }
1762
1763 // Histogram bucket for Wi-Fi RTT individual operation status
1764 message RttIndividualStatusHistogramBucket {
1765 // status type defining the bucket
1766 optional RttIndividualStatusTypeEnum status_type = 1;
1767
1768 // number of samples in the bucket
1769 optional int32 count = 2;
1770 }
1771}
xshub483b722018-05-22 15:46:26 -07001772
1773// Usage data for the wifi radio while device is running on battery.
1774message WifiRadioUsage {
1775 // Duration of log (ms)
1776 optional int64 logging_duration_ms = 1;
1777
1778 // Total time for which the radio is awake due to scan.
1779 optional int64 scan_time_ms = 2;
Jong Wook Kim411cab92018-04-26 15:09:23 -07001780}
1781
1782message ExperimentValues {
1783 // Indicates if we are logging WifiIsUnusableEvent in metrics
1784 optional bool wifi_is_unusable_logging_enabled = 1;
1785
1786 // Minimum number of txBad to trigger a data stall
1787 optional int32 wifi_data_stall_min_tx_bad = 2;
1788
1789 // Minimum number of txSuccess to trigger a data stall
1790 // when rxSuccess is 0
1791 optional int32 wifi_data_stall_min_tx_success_without_rx = 3;
Jong Wook Kime4aa37f2018-04-23 11:18:24 -07001792
1793 // Indicates if we are logging LinkSpeedCount in metrics
1794 optional bool link_speed_counts_logging_enabled = 4;
Jong Wook Kim411cab92018-04-26 15:09:23 -07001795}
1796
1797message WifiIsUnusableEvent {
1798 enum TriggerType {
1799 // Default/Invalid event
1800 TYPE_UNKNOWN = 0;
1801
1802 // There is a data stall from tx failures
1803 TYPE_DATA_STALL_BAD_TX = 1;
1804
1805 // There is a data stall from rx failures
1806 TYPE_DATA_STALL_TX_WITHOUT_RX = 2;
1807
1808 // There is a data stall from both tx and rx failures
1809 TYPE_DATA_STALL_BOTH = 3;
1810
1811 // Firmware generated an alert
1812 TYPE_FIRMWARE_ALERT = 4;
Mingguang Xucd53d0b2019-03-15 15:42:07 -07001813
1814 // IP Manager lost reachability to network neighbors
1815 TYPE_IP_REACHABILITY_LOST = 5;
Jong Wook Kim411cab92018-04-26 15:09:23 -07001816 }
1817
1818 // What event triggered WifiIsUnusableEvent.
1819 optional TriggerType type = 1;
1820
1821 // The timestamp at which this event occurred.
1822 // Measured in milliseconds that have elapsed since the device booted.
1823 optional int64 start_time_millis = 2;
1824
1825 // NetworkAgent score of connected wifi.
1826 // Defaults to -1 if the score was never set.
1827 optional int32 last_score = 3 [default = -1];
1828
1829 // Delta of successfully transmitted (ACKed) unicast data packets
1830 // between the last two WifiLinkLayerStats.
1831 optional int64 tx_success_delta = 4;
1832
1833 // Delta of transmitted unicast data retry packets
1834 // between the last two WifiLinkLayerStats.
1835 optional int64 tx_retries_delta = 5;
1836
1837 // Delta of lost (not ACKed) transmitted unicast data packets
1838 // between the last two WifiLinkLayerStats.
1839 optional int64 tx_bad_delta = 6;
1840
1841 // Delta of received unicast data packets
1842 // between the last two WifiLinkLayerStats.
1843 optional int64 rx_success_delta = 7;
1844
1845 // Time in millisecond between the last two WifiLinkLayerStats.
1846 optional int64 packet_update_time_delta = 8;
1847
1848 // The timestamp at which the last WifiLinkLayerStats was updated.
1849 // Measured in milliseconds that have elapsed since the device booted.
1850 optional int64 last_link_layer_stats_update_time = 9;
1851
1852 // Firmware alert code. Only valid when the event was triggered by a firmware alert, otherwise -1.
1853 optional int32 firmware_alert_code = 10 [default = -1];
Mingguang Xuca2aab12019-01-12 23:40:42 -08001854
1855 // NetworkAgent wifi usability score of connected wifi.
1856 // Defaults to -1 if the score was never set.
1857 optional int32 last_wifi_usability_score = 11 [default = -1];
Mingguang Xue7e344a2019-01-21 16:26:45 -08001858
1859 // Prediction horizon (in second) of Wifi usability score provided by external
1860 // system app
1861 optional int32 last_prediction_horizon_sec = 12 [default = -1];
Mingguang Xu7b6e1842019-02-27 21:29:00 -08001862
1863 // Whether screen status is on when WifiIsUnusableEvent happens.
1864 optional bool screen_on = 13 [default = false];
Ahmed ElArabawyba64b612018-06-15 09:17:45 -07001865}
Ecco Park5a403002018-07-23 15:53:10 -07001866
1867message PasspointProfileTypeCount {
1868 enum EapMethod {
1869 // Unknown Type
1870 TYPE_UNKNOWN = 0;
1871
1872 // EAP_TLS (13)
1873 TYPE_EAP_TLS = 1;
1874
1875 // EAP_TTLS (21)
1876 TYPE_EAP_TTLS = 2;
1877
1878 // EAP_SIM (18)
1879 TYPE_EAP_SIM = 3;
1880
1881 // EAP_AKA (23)
1882 TYPE_EAP_AKA = 4;
1883
1884 // EAP_AKA_PRIME (50)
1885 TYPE_EAP_AKA_PRIME = 5;
1886 }
1887
1888 // Eap method type set in Passpoint profile
1889 optional EapMethod eap_method_type = 1;
1890
1891 // Num of installed Passpoint profile with same eap method
1892 optional int32 count = 2;
xshu0e0dea42018-09-17 17:30:15 -07001893}
1894
1895message WifiLinkLayerUsageStats {
1896 // Total logging duration in ms.
1897 optional int64 logging_duration_ms = 1;
1898
1899 // Total time the wifi radio is on in ms over the logging duration.
1900 optional int64 radio_on_time_ms = 2;
1901
1902 // Total time the wifi radio is doing tx in ms over the logging duration.
1903 optional int64 radio_tx_time_ms = 3;
1904
1905 // Total time the wifi radio is doing rx in ms over the logging duration.
1906 optional int64 radio_rx_time_ms = 4;
1907
1908 // Total time the wifi radio is scanning in ms over the logging duration.
1909 optional int64 radio_scan_time_ms = 5;
xshu0f91dd62018-11-08 15:51:07 -08001910
1911 // Total time the wifi radio spent doing nan scans in ms over the logging duration.
1912 optional int64 radio_nan_scan_time_ms = 6;
1913
1914 // Total time the wifi radio spent doing background scans in ms over the logging duration.
1915 optional int64 radio_background_scan_time_ms = 7;
1916
1917 // Total time the wifi radio spent doing roam scans in ms over the logging duration.
1918 optional int64 radio_roam_scan_time_ms = 8;
1919
1920 // Total time the wifi radio spent doing pno scans in ms over the logging duration.
1921 optional int64 radio_pno_scan_time_ms = 9;
1922
1923 // Total time the wifi radio spent doing hotspot 2.0 scans and GAS exchange
1924 // in ms over the logging duration.
1925 optional int64 radio_hs20_scan_time_ms = 10;
xshua33726e2018-09-24 15:02:23 -07001926}
1927
1928message WifiUsabilityStatsEntry {
Mingguang Xubed08852019-01-24 23:00:10 -08001929 // Status codes for link probe status
1930 enum LinkProbeStatus {
1931 // Link probe status is unknown
1932 PROBE_STATUS_UNKNOWN = 0;
1933
1934 // Link probe is not triggered
1935 PROBE_STATUS_NO_PROBE = 1;
1936
1937 // Link probe is triggered and the result is success
1938 PROBE_STATUS_SUCCESS = 2;
1939
1940 // Link probe is triggered and the result is failure
1941 PROBE_STATUS_FAILURE = 3;
1942 }
1943
Kai Shidfef3832019-02-26 14:55:09 -08001944 // Codes for cellular data network type
1945 enum CellularDataNetworkType {
1946 // Unknown network
1947 NETWORK_TYPE_UNKNOWN = 0;
1948
1949 // GSM network
1950 NETWORK_TYPE_GSM = 1;
1951
1952 // CDMA network
1953 NETWORK_TYPE_CDMA = 2;
1954
1955 // CDMA EVDO network
1956 NETWORK_TYPE_EVDO_0 = 3;
1957
1958 // WCDMA network
1959 NETWORK_TYPE_UMTS = 4;
1960
1961 // TDSCDMA network
1962 NETWORK_TYPE_TD_SCDMA = 5;
1963
1964 // LTE network
1965 NETWORK_TYPE_LTE = 6;
1966
1967 // NR network
1968 NETWORK_TYPE_NR = 7;
1969 }
1970
xshua33726e2018-09-24 15:02:23 -07001971 // Absolute milliseconds from device boot when these stats were sampled
1972 optional int64 time_stamp_ms = 1;
1973
1974 // The RSSI at the sample time
1975 optional int32 rssi = 2;
1976
1977 // Link speed at the sample time in Mbps
1978 optional int32 link_speed_mbps = 3;
1979
1980 // The total number of tx success counted from the last radio chip reset
1981 optional int64 total_tx_success = 4;
1982
1983 // The total number of MPDU data packet retries counted from the last radio chip reset
1984 optional int64 total_tx_retries = 5;
1985
1986 // The total number of tx bad counted from the last radio chip reset
1987 optional int64 total_tx_bad = 6;
1988
1989 // The total number of rx success counted from the last radio chip reset
1990 optional int64 total_rx_success = 7;
1991
1992 // The total time the wifi radio is on in ms counted from the last radio chip reset
1993 optional int64 total_radio_on_time_ms = 8;
1994
1995 // The total time the wifi radio is doing tx in ms counted from the last radio chip reset
1996 optional int64 total_radio_tx_time_ms = 9;
1997
1998 // The total time the wifi radio is doing rx in ms counted from the last radio chip reset
1999 optional int64 total_radio_rx_time_ms = 10;
2000
2001 // The total time spent on all types of scans in ms counted from the last radio chip reset
2002 optional int64 total_scan_time_ms = 11;
2003
2004 // The total time spent on nan scans in ms counted from the last radio chip reset
2005 optional int64 total_nan_scan_time_ms = 12;
2006
2007 // The total time spent on background scans in ms counted from the last radio chip reset
2008 optional int64 total_background_scan_time_ms = 13;
2009
2010 // The total time spent on roam scans in ms counted from the last radio chip reset
2011 optional int64 total_roam_scan_time_ms = 14;
2012
2013 // The total time spent on pno scans in ms counted from the last radio chip reset
2014 optional int64 total_pno_scan_time_ms = 15;
2015
2016 // The total time spent on hotspot2.0 scans and GAS exchange in ms counted from the last radio
2017 // chip reset
2018 optional int64 total_hotspot_2_scan_time_ms = 16;
Mingguang Xuca2aab12019-01-12 23:40:42 -08002019
2020 // Internal framework Wifi score
2021 optional int32 wifi_score = 17;
2022
2023 // Wifi usability score provided by external system app
2024 optional int32 wifi_usability_score = 18;
2025
2026 // Sequence number from external system app to framework
2027 optional int32 seq_num_to_framework = 19;
Mingguang Xu86833142019-01-09 13:54:29 -08002028
2029 // The total time CCA is on busy status on the current frequency in ms
2030 // counted from the last radio chip reset
2031 optional int64 total_cca_busy_freq_time_ms = 20;
2032
2033 // The total radio on time of the current frequency from the last radio
2034 // chip reset
2035 optional int64 total_radio_on_freq_time_ms = 21;
2036
2037 // The total number of beacons received from the last radio chip reset
2038 optional int64 total_beacon_rx = 22;
Mingguang Xue7e344a2019-01-21 16:26:45 -08002039
2040 // Prediction horizon (in second) of Wifi usability score provided by external
2041 // system app
2042 optional int32 prediction_horizon_sec = 23;
Mingguang Xubed08852019-01-24 23:00:10 -08002043
2044 // The link probe status since last stats update
2045 optional LinkProbeStatus probe_status_since_last_update = 24;
2046
2047 // The elapsed time of the most recent link probe since last stats update;
Mingguang Xue77cabc2019-03-08 09:58:23 -08002048 optional int32 probe_elapsed_time_since_last_update_ms = 25;
Mingguang Xubed08852019-01-24 23:00:10 -08002049
2050 // The MCS rate of the most recent link probe since last stats update
2051 optional int32 probe_mcs_rate_since_last_update = 26;
2052
2053 // Rx link speed at the sample time in Mbps
2054 optional int32 rx_link_speed_mbps = 27;
Mingguang Xu96bcabe2019-01-30 22:36:07 -08002055
2056 // Sequence number generated by framework
2057 optional int32 seq_num_inside_framework = 28;
2058
2059 // Whether current entry is for the same BSSID on the same frequency compared
2060 // to last entry
2061 optional bool is_same_bssid_and_freq = 29;
Kai Shidfef3832019-02-26 14:55:09 -08002062
2063 // Cellular data network type currently in use on the device for data transmission
2064 optional CellularDataNetworkType cellular_data_network_type = 30;
2065
2066 // Cellular signal strength in dBm, NR: CsiRsrp, LTE: Rsrp, WCDMA/TDSCDMA: Rscp,
2067 // CDMA: Rssi, EVDO: Rssi, GSM: Rssi
2068 optional int32 cellular_signal_strength_dbm = 31;
2069
2070 // Cellular signal strength in dB, NR: CsiSinr, LTE: Rsrq, WCDMA: EcNo, TDSCDMA: invalid,
2071 // CDMA: Ecio, EVDO: SNR, GSM: invalid */
2072 optional int32 cellular_signal_strength_db = 32;
2073
2074 // Whether the primary registered cell of current entry is same as that of previous entry
2075 optional bool is_same_registered_cell = 33;
Mingguang Xu4225eae2019-03-27 11:13:58 -07002076
2077 // The device mobility state
2078 optional DeviceMobilityStatePnoScanStats.DeviceMobilityState
2079 device_mobility_state = 34;
xshua33726e2018-09-24 15:02:23 -07002080}
2081
2082message WifiUsabilityStats {
2083 enum Label {
2084 // Default label
2085 LABEL_UNKNOWN = 0;
2086
2087 // Wifi is usable
2088 LABEL_GOOD = 1;
2089
2090 // Wifi is unusable
2091 LABEL_BAD = 2;
2092 }
2093
Mingguang Xuf69fa672019-01-28 14:32:36 -08002094 enum UsabilityStatsTriggerType {
2095 // Default/Invalid event
2096 TYPE_UNKNOWN = 0;
2097
2098 // There is a data stall from tx failures
2099 TYPE_DATA_STALL_BAD_TX = 1;
2100
2101 // There is a data stall from rx failures
2102 TYPE_DATA_STALL_TX_WITHOUT_RX = 2;
2103
2104 // There is a data stall from both tx and rx failures
2105 TYPE_DATA_STALL_BOTH = 3;
2106
2107 // Firmware generated an alert
2108 TYPE_FIRMWARE_ALERT = 4;
Mingguang Xucd53d0b2019-03-15 15:42:07 -07002109
2110 // IP Manager lost reachability to network neighbors
2111 TYPE_IP_REACHABILITY_LOST = 5;
Mingguang Xuf69fa672019-01-28 14:32:36 -08002112 }
2113
xshua33726e2018-09-24 15:02:23 -07002114 // The current wifi usability state
2115 optional Label label = 1;
2116
2117 // The list of timestamped wifi usability stats
2118 repeated WifiUsabilityStatsEntry stats = 2;
Mingguang Xuf69fa672019-01-28 14:32:36 -08002119
2120 // What event triggered WifiUsabilityStats.
2121 optional UsabilityStatsTriggerType trigger_type = 3;
Mingguang Xu8424b292019-03-27 15:26:02 -07002122
2123 // Firmware alert code. Only valid when the stats was triggered by a firmware
2124 // alert, otherwise -1.
2125 optional int32 firmware_alert_code = 4 [default = -1];
Mingguang Xu3e5d63a2019-04-19 13:59:56 -07002126
2127 // Absolute milliseconds from device boot when these stats were sampled
2128 optional int64 time_stamp_ms = 5;
David Su367bdff2018-12-13 13:39:11 -08002129}
2130
2131message DeviceMobilityStatePnoScanStats {
2132 // see WifiManager.DEVICE_MOBILITY_STATE_* constants
2133 enum DeviceMobilityState {
2134 // Unknown mobility
2135 UNKNOWN = 0;
2136
2137 // High movement
2138 HIGH_MVMT = 1;
2139
2140 // Low movement
2141 LOW_MVMT = 2;
2142
2143 // Stationary
2144 STATIONARY = 3;
2145 }
2146
2147 // The device mobility state
2148 optional DeviceMobilityState device_mobility_state = 1;
2149
2150 // The number of times that this state was entered
2151 optional int32 num_times_entered_state = 2;
2152
2153 // The total duration elapsed while in this mobility state, in ms
2154 optional int64 total_duration_ms = 3;
2155
2156 // the total duration elapsed while in this mobility state with PNO scans running, in ms
2157 optional int64 pno_duration_ms = 4;
2158}
Jimmy Chen0142e8b2018-11-23 16:25:57 +08002159
2160// The information about the Wifi P2p events.
2161message WifiP2pStats {
2162
2163 // Group event list tracking sessions and client counts in tethered mode.
2164 repeated GroupEvent group_event = 1;
2165
2166 // Session information that gets logged for every Wifi P2p connection.
2167 repeated P2pConnectionEvent connection_event = 2;
2168
2169 // Number of persistent group in the user profile.
2170 optional int32 num_persistent_group = 3;
2171
2172 // Number of peer scan.
2173 optional int32 num_total_peer_scans = 4;
2174
2175 // Number of service scan.
2176 optional int32 num_total_service_scans = 5;
2177}
2178
2179message P2pConnectionEvent {
2180
2181 enum ConnectionType {
2182
2183 // fresh new connection.
2184 CONNECTION_FRESH = 0;
2185
2186 // reinvoke a group.
2187 CONNECTION_REINVOKE = 1;
2188
2189 // create a group with the current device as the group owner locally.
2190 CONNECTION_LOCAL = 2;
2191
2192 // create a group or join a group with config.
2193 CONNECTION_FAST = 3;
2194 }
2195
2196 enum ConnectivityLevelFailure {
2197
2198 // Failure is unknown.
2199 CLF_UNKNOWN = 0;
2200
2201 // No failure.
2202 CLF_NONE = 1;
2203
2204 // Timeout for current connecting request.
2205 CLF_TIMEOUT = 2;
2206
2207 // The connecting request is canceled by the user.
2208 CLF_CANCEL = 3;
2209
2210 // Provision discovery failure, e.g. no pin code, timeout, rejected by the peer.
2211 CLF_PROV_DISC_FAIL = 4;
2212
2213 // Invitation failure, e.g. rejected by the peer.
2214 CLF_INVITATION_FAIL = 5;
2215
2216 // Incoming request is rejected by the user.
2217 CLF_USER_REJECT = 6;
2218
2219 // New connection request is issued before ending previous connecting request.
2220 CLF_NEW_CONNECTION_ATTEMPT = 7;
2221 }
2222
2223 // WPS method.
2224 enum WpsMethod {
2225 // WPS is skipped for Group Reinvoke.
2226 WPS_NA = -1;
2227
2228 // Push button configuration.
2229 WPS_PBC = 0;
2230
2231 // Display pin method configuration - pin is generated and displayed on device.
2232 WPS_DISPLAY = 1;
2233
2234 // Keypad pin method configuration - pin is entered on device.
2235 WPS_KEYPAD = 2;
2236
2237 // Label pin method configuration - pin is labelled on device.
2238 WPS_LABEL = 3;
2239 }
2240
2241 // Start time of the connection.
2242 optional int64 start_time_millis = 1;
2243
2244 // Type of the connection.
2245 optional ConnectionType connection_type = 2;
2246
2247 // WPS method.
2248 optional WpsMethod wps_method = 3 [default = WPS_NA];
2249
2250 // Duration to connect.
2251 optional int32 duration_taken_to_connect_millis = 4;
2252
2253 // Failures that happen at the connectivity layer.
2254 optional ConnectivityLevelFailure connectivity_level_failure_code = 5;
2255}
2256
2257// GroupEvent tracking group information from GroupStarted to GroupRemoved.
2258message GroupEvent {
2259
2260 enum GroupRole {
2261
2262 GROUP_OWNER = 0;
2263
2264 GROUP_CLIENT = 1;
2265 }
2266
2267 // The ID of network in supplicant for this group.
2268 optional int32 net_id = 1;
2269
2270 // Start time of the group.
2271 optional int64 start_time_millis = 2;
2272
2273 // Channel frequency used for Group.
2274 optional int32 channel_frequency = 3;
2275
2276 // Is group owner or group client.
2277 optional GroupRole group_role = 5;
2278
2279 // Number of connected clients.
2280 optional int32 num_connected_clients = 6;
2281
2282 // Cumulative number of connected clients.
2283 optional int32 num_cumulative_clients = 7;
2284
2285 // The session duration.
2286 optional int32 session_duration_millis = 8;
2287
2288 // The idle duration. A group without any client is in idle.
2289 optional int32 idle_duration_millis = 9;
2290}
Hai Shaloma18c32c2019-01-22 10:01:09 -08002291
2292// Easy Connect (DPP)
2293message WifiDppLog {
David Su8e835f62019-02-14 16:45:09 -08002294 reserved 6;
2295
Hai Shaloma18c32c2019-01-22 10:01:09 -08002296 // Number of Configurator-Initiator requests
2297 optional int32 num_dpp_configurator_initiator_requests = 1;
2298
2299 // Number of Enrollee-Initiator requests
2300 optional int32 num_dpp_enrollee_initiator_requests = 2;
2301
2302 // Easy Connect (DPP) Enrollee success
2303 optional int32 num_dpp_enrollee_success = 3;
2304
2305 // Easy Connect (DPP) Configurator success code bucket
2306 repeated DppConfiguratorSuccessStatusHistogramBucket dpp_configurator_success_code = 4;
2307
2308 // Easy Connect (DPP) failure code bucket
2309 repeated DppFailureStatusHistogramBucket dpp_failure_code = 5;
2310
2311 // Easy Connect (DPP) operation time bucket
David Su8e835f62019-02-14 16:45:09 -08002312 repeated HistogramBucketInt32 dpp_operation_time = 7;
Hai Shaloma18c32c2019-01-22 10:01:09 -08002313
2314 // Histogram bucket for Wi-Fi DPP configurator success
2315 message DppConfiguratorSuccessStatusHistogramBucket {
2316 // status type defining the bucket
2317 optional DppConfiguratorSuccessCode dpp_status_type = 1;
2318
2319 // number of samples in the bucket
2320 optional int32 count = 2;
2321 }
2322
2323 // Histogram bucket for Wi-Fi DPP failures
2324 message DppFailureStatusHistogramBucket {
2325 // status type defining the bucket
2326 optional DppFailureCode dpp_status_type = 1;
2327
2328 // number of samples in the bucket
2329 optional int32 count = 2;
2330 }
2331
Hai Shaloma18c32c2019-01-22 10:01:09 -08002332 enum DppConfiguratorSuccessCode {
2333 // Unknown success code
2334 EASY_CONNECT_EVENT_SUCCESS_UNKNOWN = 0;
2335
2336 // Easy Connect Configurator success event: Configuration sent to enrollee
2337 EASY_CONNECT_EVENT_SUCCESS_CONFIGURATION_SENT = 1;
2338 }
2339
2340 enum DppFailureCode {
2341 // Unknown failure
2342 EASY_CONNECT_EVENT_FAILURE_UNKNOWN = 0;
2343
2344 // Easy Connect Failure event: Scanned QR code is either not a Easy Connect URI, or the Easy
2345 // Connect URI has errors.
2346 EASY_CONNECT_EVENT_FAILURE_INVALID_URI = 1;
2347
2348 // Easy Connect Failure event: Bootstrapping/Authentication initialization process failure.
2349 EASY_CONNECT_EVENT_FAILURE_AUTHENTICATION = 2;
2350
2351 // Easy Connect Failure event: Both devices are implementing the same role and are
2352 // incompatible.
2353 EASY_CONNECT_EVENT_FAILURE_NOT_COMPATIBLE = 3;
2354
2355 // Easy Connect Failure event: Configuration process has failed due to malformed message.
2356 EASY_CONNECT_EVENT_FAILURE_CONFIGURATION = 4;
2357
2358 // Easy Connect Failure event: Easy Connect request while in another Easy Connect exchange.
2359 EASY_CONNECT_EVENT_FAILURE_BUSY = 5;
2360
2361 // Easy Connect Failure event: No response from the peer.
2362 EASY_CONNECT_EVENT_FAILURE_TIMEOUT = 6;
2363
2364 // Easy Connect Failure event: General protocol failure.
2365 EASY_CONNECT_EVENT_FAILURE_GENERIC = 7;
2366
2367 // Easy Connect Failure event: Feature or option is not supported.
2368 EASY_CONNECT_EVENT_FAILURE_NOT_SUPPORTED = 8;
2369
2370 // Easy Connect Failure event: Invalid network provided to Easy Connect configurator.
2371 // Network must either be WPA3-Personal (SAE) or WPA2-Personal (PSK).
2372 EASY_CONNECT_EVENT_FAILURE_INVALID_NETWORK = 9;
2373 }
2374}
Roshan Pius89b233d2019-01-31 10:15:22 -08002375
2376// WifiConfigStore read/write metrics.
2377message WifiConfigStoreIO {
2378 // Histogram of config store read durations.
2379 repeated DurationBucket read_durations = 1;
2380
2381 // Histogram of config store write durations.
2382 repeated DurationBucket write_durations = 2;
2383
2384 // Total Number of instances of write/read duration in this duration bucket.
2385 message DurationBucket {
2386 // Bucket covers duration : [range_start_ms, range_end_ms)
2387 // The (inclusive) lower bound of read/write duration represented by this bucket
2388 optional int32 range_start_ms = 1;
2389
2390 // The (exclusive) upper bound of read/write duration represented by this bucket
2391 optional int32 range_end_ms = 2;
2392
2393 // Number of read/write durations that fit into this bucket
2394 optional int32 count = 3;
2395 }
2396}
David Su44306932019-02-12 16:53:46 -08002397
2398// Histogram bucket counting with int32. Range is [start, end)
2399message HistogramBucketInt32 {
2400 // lower range of the bucket (inclusive)
2401 optional int32 start = 1;
2402
2403 // upper range of the bucket (exclusive)
2404 optional int32 end = 2;
2405
2406 // number of samples in the bucket
2407 optional int32 count = 3;
2408}
2409
David Suf6e4d4e2019-03-08 13:18:21 -08002410// Counts occurrences of a int32 key
2411message Int32Count {
David Su44306932019-02-12 16:53:46 -08002412 // the key
2413 optional int32 key = 1;
2414
David Suf6e4d4e2019-03-08 13:18:21 -08002415 // the count
2416 optional int32 count = 2;
David Su44306932019-02-12 16:53:46 -08002417}
2418
2419message LinkProbeStats {
2420 enum LinkProbeFailureReason {
2421 // unknown reason
2422 LINK_PROBE_FAILURE_REASON_UNKNOWN = 0;
2423
2424 // Specified MCS rate when it is unsupported by the driver.
2425 LINK_PROBE_FAILURE_REASON_MCS_UNSUPPORTED = 1;
2426
2427 // Driver reported that no ACK was received for the transmitted probe.
2428 LINK_PROBE_FAILURE_REASON_NO_ACK = 2;
2429
2430 // Driver failed to report on the status of the transmitted probe within the timeout.
2431 LINK_PROBE_FAILURE_REASON_TIMEOUT = 3;
2432
2433 // An existing link probe is in progress.
2434 LINK_PROBE_FAILURE_REASON_ALREADY_STARTED = 4;
2435 }
2436
2437 // Counts the number of failures for each failure reason.
2438 message LinkProbeFailureReasonCount {
2439 // The failure reason.
2440 optional LinkProbeFailureReason failure_reason = 1;
2441
2442 // The number of occurrences for this failure reason.
2443 optional int32 count = 2;
2444 }
2445
David Su36da81f2019-04-21 13:09:05 -07002446 // Counts the number of link probes for each experiment.
2447 message ExperimentProbeCounts {
2448 // The experiment ID.
2449 optional string experiment_id = 1;
2450
2451 // The number of link probes triggered for this experiment.
2452 optional int32 probe_count = 2;
2453 }
2454
David Su44306932019-02-12 16:53:46 -08002455 // Counts the occurrences of RSSI values when a link probe succeeds.
David Suf6e4d4e2019-03-08 13:18:21 -08002456 repeated Int32Count success_rssi_counts = 1;
David Su44306932019-02-12 16:53:46 -08002457
2458 // Counts the occurrences of RSSI values when a link probe fails.
David Suf6e4d4e2019-03-08 13:18:21 -08002459 repeated Int32Count failure_rssi_counts = 2;
David Su44306932019-02-12 16:53:46 -08002460
2461 // Counts the occurrences of Link Speed values when a link probe succeeds.
David Suf6e4d4e2019-03-08 13:18:21 -08002462 repeated Int32Count success_link_speed_counts = 3;
David Su44306932019-02-12 16:53:46 -08002463
2464 // Counts the occurrences of Link Speed values when a link probe fails.
David Suf6e4d4e2019-03-08 13:18:21 -08002465 repeated Int32Count failure_link_speed_counts = 4;
David Su44306932019-02-12 16:53:46 -08002466
2467 // Histogram for the number of seconds since the last TX success when a link probe succeeds.
2468 repeated HistogramBucketInt32 success_seconds_since_last_tx_success_histogram = 5;
2469
2470 // Histogram for the number of seconds since the last TX success when a link probe fails.
2471 repeated HistogramBucketInt32 failure_seconds_since_last_tx_success_histogram = 6;
2472
2473 // Histogram for the elapsed time of successful link probes, in ms.
2474 repeated HistogramBucketInt32 success_elapsed_time_ms_histogram = 7;
2475
2476 // Counts the occurrences of error codes for failed link probes.
2477 repeated LinkProbeFailureReasonCount failure_reason_counts = 8;
David Su36da81f2019-04-21 13:09:05 -07002478
2479 // Counts the number of link probes for each experiment.
2480 repeated ExperimentProbeCounts experiment_probe_counts = 9;
David Su44306932019-02-12 16:53:46 -08002481}
David Sua04f5052019-02-20 17:42:28 -08002482
2483// Stores the decisions that were made by a experiment when compared against another experiment
2484message NetworkSelectionExperimentDecisions {
2485 // the id of one experiment
2486 optional int32 experiment1_id = 1;
2487
2488 // the id of the other experiment
2489 optional int32 experiment2_id = 2;
2490
2491 // Counts occurrences of the number of network choices there were when experiment1 makes the
2492 // same network selection as experiment2.
2493 // The keys are the number of network choices, and the values are the number of occurrences of
2494 // this number of network choices when exp1 and exp2 make the same network selection.
David Suf6e4d4e2019-03-08 13:18:21 -08002495 repeated Int32Count same_selection_num_choices_counter = 3;
David Sua04f5052019-02-20 17:42:28 -08002496
2497 // Counts occurrences of the number of network choices there were when experiment1 makes the
2498 // same network selection as experiment2.
2499 // The keys are the number of network choices, and the values are the number of occurrences of
2500 // this number of network choices when exp1 and exp2 make different network selections.
2501 // Note that it is possible for the network selection to be different even when there only exists
2502 // a single network choice, since choosing not to connect to that network is a valid choice.
David Suf6e4d4e2019-03-08 13:18:21 -08002503 repeated Int32Count different_selection_num_choices_counter = 4;
David Sua04f5052019-02-20 17:42:28 -08002504}
Roshan Pius3f30ba82019-02-08 11:55:55 -08002505
2506// NetworkRequest API metrics.
2507message WifiNetworkRequestApiLog {
2508 // Number of requests via this API surface.
2509 optional int32 num_request = 1;
2510
2511 // Histogram of requests via this API surface to number of networks matched in scan results.
Roshan Piusbebb5ab2019-02-28 11:04:00 -08002512 repeated HistogramBucketInt32 network_match_size_histogram = 2;
Roshan Pius3f30ba82019-02-08 11:55:55 -08002513
2514 // Number of successful network connection from this API.
2515 optional int32 num_connect_success = 3;
2516
2517 // Number of requests via this API surface that bypassed user approval.
2518 optional int32 num_user_approval_bypass = 4;
2519
2520 // Number of requests via this API surface that was rejected by the user.
2521 optional int32 num_user_reject = 5;
2522
2523 // Number of unique apps using this API surface.
2524 optional int32 num_apps = 6;
2525}
2526
2527// NetworkSuggestion API metrics.
2528message WifiNetworkSuggestionApiLog {
2529 // Number of modifications to their suggestions by apps.
2530 optional int32 num_modification = 1;
2531
2532 // Number of successful network connection from app suggestions.
2533 optional int32 num_connect_success = 2;
2534
2535 // Number of network connection failures from app suggestions.
2536 optional int32 num_connect_failure = 3;
2537
2538 // Histogram for size of the network lists provided by various apps on the device.
2539 repeated HistogramBucketInt32 network_list_size_histogram = 4;
2540}
Ahmed ElArabawy048e1482019-03-25 10:42:04 -07002541
2542// WifiLock metrics
2543message WifiLockStats {
2544 // Amount of time wifi is actively in HIGH_PERF mode (ms)
2545 // This means the lock takes effect and the device takes the actions required for this mode
2546 optional int64 high_perf_active_time_ms = 1;
2547
2548 // Amount of time wifi is actively in LOW_LATENCY mode (ms)
2549 // This means the lock takes effect and the device takes the actions required for this mode
2550 optional int64 low_latency_active_time_ms = 2;
2551
2552 // Histogram of HIGH_PERF lock acquisition duration (seconds)
2553 // Note that acquiring the lock does not necessarily mean that device is actively in that mode
2554 repeated HistogramBucketInt32 high_perf_lock_acq_duration_sec_histogram = 3;
2555
2556 // Histogram of LOW_LATENCY lock acquisition duration (seconds)
2557 // Note that acquiring the lock does not necessarily mean that device is actively in that mode
2558 repeated HistogramBucketInt32 low_latency_lock_acq_duration_sec_histogram = 4;
2559
2560 // Histogram of HIGH_PERF active session duration (seconds)
2561 // This means the lock takes effect and the device takes the actions required for this mode
2562 repeated HistogramBucketInt32 high_perf_active_session_duration_sec_histogram = 5;
2563
2564 // Histogram of LOW_LATENCY active session duration (seconds)
2565 // This means the lock takes effect and the device takes the actions required for this mode
2566 repeated HistogramBucketInt32 low_latency_active_session_duration_sec_histogram = 6;
2567}
xshu08c67382019-04-04 17:39:33 -07002568
2569// Stats on number of times Wi-Fi is turned on/off though the WifiManager#setWifiEnabled API
2570message WifiToggleStats {
2571 // Number of time Wi-Fi is turned on by privileged apps
2572 optional int32 num_toggle_on_privileged = 1;
2573
2574 // Number of time Wi-Fi is turned off by privileged apps
2575 optional int32 num_toggle_off_privileged = 2;
2576
2577 // Number of time Wi-Fi is turned on by normal apps
2578 optional int32 num_toggle_on_normal = 3;
2579
2580 // Number of time Wi-Fi is turned off by normal apps
2581 optional int32 num_toggle_off_normal = 4;
hsuvictor17510162019-03-27 15:13:03 +08002582}
2583
2584// Information about the Passpoint provision metrics.
2585message PasspointProvisionStats {
2586 enum ProvisionFailureCode {
2587 // provisioning failure for unknown reason.
2588 OSU_FAILURE_UNKNOWN = 0;
2589
2590 // The reason code for Provisioning Failure due to connection failure to OSU AP.
2591 OSU_FAILURE_AP_CONNECTION = 1;
2592
2593 // The reason code for invalid server URL address.
2594 OSU_FAILURE_SERVER_URL_INVALID = 2;
2595
2596 // The reason code for provisioning failure due to connection failure to the server.
2597 OSU_FAILURE_SERVER_CONNECTION = 3;
2598
2599 // The reason code for provisioning failure due to invalid server certificate.
2600 OSU_FAILURE_SERVER_VALIDATION = 4;
2601
2602 // The reason code for provisioning failure due to invalid service provider.
2603 OSU_FAILURE_SERVICE_PROVIDER_VERIFICATION = 5;
2604
2605 // The reason code for provisioning failure when a provisioning flow is aborted.
2606 OSU_FAILURE_PROVISIONING_ABORTED = 6;
2607
2608 // The reason code for provisioning failure when a provisioning flow is not possible.
2609 OSU_FAILURE_PROVISIONING_NOT_AVAILABLE = 7;
2610
2611 // The reason code for provisioning failure due to invalid web url format for an OSU web page.
2612 OSU_FAILURE_INVALID_URL_FORMAT_FOR_OSU = 8;
2613
2614 // The reason code for provisioning failure when a command received is not the expected command
2615 // type.
2616 OSU_FAILURE_UNEXPECTED_COMMAND_TYPE = 9;
2617
2618 // The reason code for provisioning failure when a SOAP message is not the expected message
2619 // type.
2620 OSU_FAILURE_UNEXPECTED_SOAP_MESSAGE_TYPE = 10;
2621
2622 // The reason code for provisioning failure when a SOAP message exchange fails.
2623 OSU_FAILURE_SOAP_MESSAGE_EXCHANGE = 11;
2624
2625 // The reason code for provisioning failure when a redirect listener fails to start.
2626 OSU_FAILURE_START_REDIRECT_LISTENER = 12;
2627
2628 // The reason code for provisioning failure when a redirect listener timed out to receive a HTTP
2629 // redirect response.
2630 OSU_FAILURE_TIMED_OUT_REDIRECT_LISTENER = 13;
2631
2632 // The reason code for provisioning failure when there is no OSU activity to listen to intent.
2633 OSU_FAILURE_NO_OSU_ACTIVITY_FOUND = 14;
2634
2635 // The reason code for provisioning failure when the status of a SOAP message is not the
2636 // expected message status.
2637 OSU_FAILURE_UNEXPECTED_SOAP_MESSAGE_STATUS = 15;
2638
2639 // The reason code for provisioning failure when there is no PPS MO.
2640 OSU_FAILURE_NO_PPS_MO = 16;
2641
2642 // The reason code for provisioning failure when there is no AAAServerTrustRoot node in a PPS
2643 // MO.
2644 OSU_FAILURE_NO_AAA_SERVER_TRUST_ROOT_NODE = 17;
2645
2646 // The reason code for provisioning failure when there is no TrustRoot node for remediation
2647 // server in a PPS MO.
2648 OSU_FAILURE_NO_REMEDIATION_SERVER_TRUST_ROOT_NODE = 18;
2649
2650 // The reason code for provisioning failure when there is no TrustRoot node for policy server in
2651 // a PPS MO.
2652 OSU_FAILURE_NO_POLICY_SERVER_TRUST_ROOT_NODE = 19;
2653
2654 // The reason code for provisioning failure when failing to retrieve trust root certificates
2655 // used for validating server certificate for AAA, Remediation and Policy server.
2656 OSU_FAILURE_RETRIEVE_TRUST_ROOT_CERTIFICATES = 20;
2657
2658 // The reason code for provisioning failure when there is no trust root certificate for AAA
2659 // server.
2660 OSU_FAILURE_NO_AAA_TRUST_ROOT_CERTIFICATE = 21;
2661
2662 // The reason code for provisioning failure when a {@link PasspointConfiguration} is failed to
2663 // install.
2664 OSU_FAILURE_ADD_PASSPOINT_CONFIGURATION = 22;
2665
2666 // The reason code for provisioning failure when an {@link OsuProvider} is not found for
2667 // provisioning.
2668 OSU_FAILURE_OSU_PROVIDER_NOT_FOUND = 23;
2669 }
2670
2671 // Number of passpoint provisioning success
2672 optional int32 num_provision_success = 1;
2673
2674 // Count for passpoint provisioning failure
2675 repeated ProvisionFailureCount provision_failure_count = 2;
2676
2677 // Number of occurrences of a specific passpoint provision failure code
2678 message ProvisionFailureCount {
2679 // Failure code
2680 optional ProvisionFailureCode failure_code = 1;
2681
2682 // Number of failure for the failure_code.
2683 optional int32 count = 2;
2684 }
2685}