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