blob: 7bf37ff379c9e382d0e2188daea2feed8de35394 [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
David Su21709bc2019-02-24 15:26:50 -0800657 // Entity that recommended connecting to this network.
658 enum ConnectionNominator {
659 // Unknown nominator
660 NOMINATOR_UNKNOWN = 0;
661
662 // User selected network manually
663 NOMINATOR_MANUAL = 1;
664
665 // Saved network
666 NOMINATOR_SAVED = 2;
667
668 // Suggestion API
669 NOMINATOR_SUGGESTION = 3;
670
671 // Passpoint
672 NOMINATOR_PASSPOINT = 4;
673
674 // Carrier suggestion
675 NOMINATOR_CARRIER = 5;
676
677 // External scorer
678 NOMINATOR_EXTERNAL_SCORED = 6;
679
680 // Netrec
681 NOMINATOR_NETREC = 7;
682
683 // User connected choice override
684 NOMINATOR_SAVED_USER_CONNECT_CHOICE = 8;
685
686 // Open Network Available Pop-up
687 NOMINATOR_OPEN_NETWORK_AVAILABLE = 9;
688 }
689
Glen Kuhne94814572016-10-25 12:40:35 -0700690 // Start time of the connection.
691 optional int64 start_time_millis = 1;// [(datapol.semantic_type) = ST_TIMESTAMP];
692
693 // Duration to connect.
694 optional int32 duration_taken_to_connect_millis = 2;
695
696 // Router information.
697 optional RouterFingerPrint router_fingerprint = 3;
698
699 // RSSI at the start of the connection.
700 optional int32 signal_strength = 4;
701
702 // Roam Type.
703 optional RoamType roam_type = 5;
704
705 // Result of the connection.
706 optional int32 connection_result = 6;
707
708 // Reasons for level 2 failure (needs to be coordinated with wpa-supplicant).
709 optional int32 level_2_failure_code = 7;
710
711 // Failures that happen at the connectivity layer.
712 optional ConnectivityLevelFailure connectivity_level_failure_code = 8;
713
714 // Has bug report been taken.
715 optional bool automatic_bug_report_taken = 9;
xshu483a45b2019-02-08 13:24:02 -0800716
717 // Connection is using locally generated random MAC address.
718 optional bool use_randomized_mac = 10 [default = false];
David Su21709bc2019-02-24 15:26:50 -0800719
720 // Who chose to connect.
721 optional ConnectionNominator connection_nominator = 11;
722
723 // The currently running network selector when this connection event occurred.
724 optional int32 network_selector_experiment_id = 12;
Glen Kuhne94814572016-10-25 12:40:35 -0700725}
726
727// Number of occurrences of a specific RSSI poll rssi value
728message RssiPollCount {
729 // RSSI
730 optional int32 rssi = 1;
731
732 // Number of RSSI polls with 'rssi'
733 optional int32 count = 2;
xshu122886e2018-05-16 15:38:49 -0700734
735 // Beacon frequency of the channel in MHz
736 optional int32 frequency = 3;
Glen Kuhne94814572016-10-25 12:40:35 -0700737}
738
739// Number of occurrences of a specific alert reason value
740message AlertReasonCount {
741 // Alert reason
742 optional int32 reason = 1;
743
744 // Number of alerts with |reason|.
745 optional int32 count = 2;
746}
747
748// Counts the number of instances of a specific Wifi Score calculated by WifiScoreReport
749message WifiScoreCount {
750 // Wifi Score
751 optional int32 score = 1;
752
753 // Number of Wifi score reports with this score
754 optional int32 count = 2;
755}
756
Mingguang Xuca2aab12019-01-12 23:40:42 -0800757// Counts the number of instances of a specific Wifi Usability Score
758message WifiUsabilityScoreCount {
759 // Wifi Usability Score
760 optional int32 score = 1;
761
762 // Number of Wifi score reports with this score
763 optional int32 count = 2;
764}
765
Jong Wook Kime4aa37f2018-04-23 11:18:24 -0700766// Number of occurrences of a specific link speed (Mbps)
767// and sum of rssi (dBm) and rssi^2 (dBm^2)
768message LinkSpeedCount {
769 // Link speed (Mbps)
770 optional int32 link_speed_mbps = 1;
771
772 // Number of RSSI polls with link_speed
773 optional int32 count = 2;
774
775 // Sum of absolute values of rssi values (dBm)
776 optional int32 rssi_sum_dbm = 3;
777
778 // Sum of squares of rssi values (dBm^2)
779 optional int64 rssi_sum_of_squares_dbm_sq = 4;
780}
781
Glen Kuhne94814572016-10-25 12:40:35 -0700782// Number of occurrences of Soft AP session durations
783message SoftApDurationBucket {
784 // Bucket covers duration : [duration_sec, duration_sec + bucket_size_sec)
785 // The (inclusive) lower bound of Soft AP session duration represented by this bucket
786 optional int32 duration_sec = 1;
787
788 // The size of this bucket
789 optional int32 bucket_size_sec = 2;
790
791 // Number of soft AP session durations that fit into this bucket
792 optional int32 count = 3;
793}
794
795// Number of occurrences of a soft AP session return code
796message SoftApReturnCodeCount {
Rebecca Silberstein28d9de22017-01-24 10:42:59 -0800797
798 enum SoftApStartResult {
799
800 // SoftApManager return code unknown
801 SOFT_AP_RETURN_CODE_UNKNOWN = 0;
802
803 // SoftAp started successfully
804 SOFT_AP_STARTED_SUCCESSFULLY = 1;
805
806 // Catch all for failures with no specific failure reason
807 SOFT_AP_FAILED_GENERAL_ERROR = 2;
808
809 // SoftAp failed to start due to NO_CHANNEL error
810 SOFT_AP_FAILED_NO_CHANNEL = 3;
811 }
812
813 // Historical, no longer used for writing as of 01/2017.
814 optional int32 return_code = 1 [deprecated = true];
Glen Kuhne94814572016-10-25 12:40:35 -0700815
816 // Occurrences of this soft AP return code
817 optional int32 count = 2;
Rebecca Silberstein28d9de22017-01-24 10:42:59 -0800818
819 // Result of attempt to start SoftAp
820 optional SoftApStartResult start_result = 3;
Glen Kuhne94814572016-10-25 12:40:35 -0700821}
Glen Kuhne8ce9a1c2017-03-28 14:02:48 -0700822
823message StaEvent {
824 message ConfigInfo {
825 // The set of key management protocols supported by this configuration.
826 optional uint32 allowed_key_management = 1 [default = 0];
827
828 // The set of security protocols supported by this configuration.
829 optional uint32 allowed_protocols = 2 [default = 0];
830
831 // The set of authentication protocols supported by this configuration.
832 optional uint32 allowed_auth_algorithms = 3 [default = 0];
833
834 // The set of pairwise ciphers for WPA supported by this configuration.
835 optional uint32 allowed_pairwise_ciphers = 4 [default = 0];
836
837 // The set of group ciphers supported by this configuration.
838 optional uint32 allowed_group_ciphers = 5;
839
840 // Is this a 'hidden network'
841 optional bool hidden_ssid = 6;
842
843 // Is this a Hotspot 2.0 / passpoint network
844 optional bool is_passpoint = 7;
845
846 // Is this an 'ephemeral' network (Not in saved network list, recommended externally)
847 optional bool is_ephemeral = 8;
848
849 // Has a successful connection ever been established using this WifiConfiguration
850 optional bool has_ever_connected = 9;
851
852 // RSSI of the scan result candidate associated with this WifiConfiguration
853 optional int32 scan_rssi = 10 [default = -127];
854
855 // Frequency of the scan result candidate associated with this WifiConfiguration
856 optional int32 scan_freq = 11 [default = -1];
857 }
858
859 enum EventType {
860 // Default/Invalid event
861 TYPE_UNKNOWN = 0;
862
863 // Supplicant Association Rejection event. Code contains the 802.11
864 TYPE_ASSOCIATION_REJECTION_EVENT = 1;
865
866 // Supplicant L2 event,
867 TYPE_AUTHENTICATION_FAILURE_EVENT = 2;
868
869 // Supplicant L2 event
870 TYPE_NETWORK_CONNECTION_EVENT = 3;
871
872 // Supplicant L2 event
873 TYPE_NETWORK_DISCONNECTION_EVENT = 4;
874
875 // Supplicant L2 event
876 TYPE_SUPPLICANT_STATE_CHANGE_EVENT = 5;
877
878 // Supplicant L2 event
879 TYPE_CMD_ASSOCIATED_BSSID = 6;
880
881 // IP Manager successfully completed IP Provisioning
882 TYPE_CMD_IP_CONFIGURATION_SUCCESSFUL = 7;
883
884 // IP Manager failed to complete IP Provisioning
885 TYPE_CMD_IP_CONFIGURATION_LOST = 8;
886
887 // IP Manager lost reachability to network neighbors
888 TYPE_CMD_IP_REACHABILITY_LOST = 9;
889
890 // Indicator that Supplicant is targeting a BSSID for roam/connection
891 TYPE_CMD_TARGET_BSSID = 10;
892
893 // Wifi framework is initiating a connection attempt
894 TYPE_CMD_START_CONNECT = 11;
895
896 // Wifi framework is initiating a roaming connection attempt
897 TYPE_CMD_START_ROAM = 12;
898
899 // SystemAPI connect() command, Settings App
900 TYPE_CONNECT_NETWORK = 13;
901
902 // Network Agent has validated the internet connection (Captive Portal Check success, or user
903 // validation)
904 TYPE_NETWORK_AGENT_VALID_NETWORK = 14;
905
906 // Framework initiated disconnect. Sometimes generated to give an extra reason for a disconnect
907 // Should typically be followed by a NETWORK_DISCONNECTION_EVENT with a local_gen = true
908 TYPE_FRAMEWORK_DISCONNECT = 15;
Michael Plassbb367b62017-10-06 10:29:51 -0700909
910 // The NetworkAgent score for wifi has changed in a way that may impact
911 // connectivity
912 TYPE_SCORE_BREACH = 16;
Jong Wook Kim01ad38b2018-04-09 10:14:11 -0700913
914 // Framework changed Sta interface MAC address
915 TYPE_MAC_CHANGE = 17;
Jong Wook Kimb56979f2018-08-08 14:50:18 -0700916
917 // Wifi is turned on
918 TYPE_WIFI_ENABLED = 18;
919
920 // Wifi is turned off
921 TYPE_WIFI_DISABLED = 19;
Mingguang Xuca2aab12019-01-12 23:40:42 -0800922
923 // The NetworkAgent Wifi usability score has changed in a way that may
924 // impact connectivity
925 TYPE_WIFI_USABILITY_SCORE_BREACH = 20;
Glen Kuhne8ce9a1c2017-03-28 14:02:48 -0700926 }
927
928 enum FrameworkDisconnectReason {
929 // default/none/unknown value
930 DISCONNECT_UNKNOWN = 0;
931
932 // API DISCONNECT
933 DISCONNECT_API = 1;
934
935 // Some framework internal reason (generic)
936 DISCONNECT_GENERIC = 2;
937
938 // Network Agent network validation failed, user signaled network unwanted
939 DISCONNECT_UNWANTED = 3;
940
941 // Roaming timed out
942 DISCONNECT_ROAM_WATCHDOG_TIMER = 4;
943
944 // P2P service requested wifi disconnect
945 DISCONNECT_P2P_DISCONNECT_WIFI_REQUEST = 5;
946
947 // SIM was removed while using a SIM config
948 DISCONNECT_RESET_SIM_NETWORKS = 6;
949 }
950
951 // Authentication Failure reasons as reported through the API.
952 enum AuthFailureReason {
953 // Unknown default
954 AUTH_FAILURE_UNKNOWN = 0;
955
956 // The reason code if there is no error during authentication. It could also imply that there no
957 // authentication in progress,
958 AUTH_FAILURE_NONE = 1;
959
960 // The reason code if there was a timeout authenticating.
961 AUTH_FAILURE_TIMEOUT = 2;
962
963 // The reason code if there was a wrong password while authenticating.
964 AUTH_FAILURE_WRONG_PSWD = 3;
965
966 // The reason code if there was EAP failure while authenticating.
967 AUTH_FAILURE_EAP_FAILURE = 4;
968 }
969
970 // What event was this
971 optional EventType type = 1;
972
973 // 80211 death reason code, relevant to NETWORK_DISCONNECTION_EVENTs
974 optional int32 reason = 2 [default = -1];
975
976 // 80211 Association Status code, relevant to ASSOCIATION_REJECTION_EVENTs
977 optional int32 status = 3 [default = -1];
978
979 // Designates whether a NETWORK_DISCONNECT_EVENT was by the STA or AP
980 optional bool local_gen = 4 [default = false];
981
982 // Network information from the WifiConfiguration of a framework initiated connection attempt
983 optional ConfigInfo config_info = 5;
984
985 // RSSI from the last rssi poll (Only valid for active connections)
986 optional int32 last_rssi = 6 [default = -127];
987
988 // Link speed from the last rssi poll (Only valid for active connections)
989 optional int32 last_link_speed = 7 [default = -1];
990
991 // Frequency from the last rssi poll (Only valid for active connections)
992 optional int32 last_freq = 8 [default = -1];
993
994 // Enum used to define bit positions in the supplicant_state_change_bitmask
995 // See {@code frameworks/base/wifi/java/android/net/wifi/SupplicantState.java} for documentation
996 enum SupplicantState {
997 STATE_DISCONNECTED = 0;
998
999 STATE_INTERFACE_DISABLED = 1;
1000
1001 STATE_INACTIVE = 2;
1002
1003 STATE_SCANNING = 3;
1004
1005 STATE_AUTHENTICATING = 4;
1006
1007 STATE_ASSOCIATING = 5;
1008
1009 STATE_ASSOCIATED = 6;
1010
1011 STATE_FOUR_WAY_HANDSHAKE = 7;
1012
1013 STATE_GROUP_HANDSHAKE = 8;
1014
1015 STATE_COMPLETED = 9;
1016
1017 STATE_DORMANT = 10;
1018
1019 STATE_UNINITIALIZED = 11;
1020
1021 STATE_INVALID = 12;
1022 }
1023
Jong Wook Kim411cab92018-04-26 15:09:23 -07001024 // Bit mask of all supplicant state changes that occurred since the last event
Glen Kuhne8ce9a1c2017-03-28 14:02:48 -07001025 optional uint32 supplicant_state_changes_bitmask = 9 [default = 0];
1026
1027 // The number of milliseconds that have elapsed since the device booted
1028 optional int64 start_time_millis = 10 [default = 0];
1029
1030 optional FrameworkDisconnectReason framework_disconnect_reason = 11 [default = DISCONNECT_UNKNOWN];
1031
Jong Wook Kim411cab92018-04-26 15:09:23 -07001032 // Flag which indicates if an association rejection event occurred due to a timeout
Glen Kuhne8ce9a1c2017-03-28 14:02:48 -07001033 optional bool association_timed_out = 12 [default = false];
1034
1035 // Authentication failure reason, as reported by WifiManager (calculated from state & deauth code)
1036 optional AuthFailureReason auth_failure_reason = 13 [default = AUTH_FAILURE_UNKNOWN];
Michael Plassbb367b62017-10-06 10:29:51 -07001037
1038 // NetworkAgent score of connected wifi
1039 optional int32 last_score = 14 [default = -1];
Mingguang Xuca2aab12019-01-12 23:40:42 -08001040
1041 // NetworkAgent Wifi usability score of connected wifi
1042 optional int32 last_wifi_usability_score = 15 [default = -1];
Mingguang Xue7e344a2019-01-21 16:26:45 -08001043
1044 // Prediction horizon (in second) of Wifi usability score provided by external
1045 // system app
1046 optional int32 last_prediction_horizon_sec = 16 [default = -1];
Glen Kuhne8ce9a1c2017-03-28 14:02:48 -07001047}
Etan Cohen737addc2017-04-26 08:01:57 -07001048
1049// Wi-Fi Aware metrics
1050message WifiAwareLog {
1051 // total number of unique apps that used Aware (measured on attach)
1052 optional int32 num_apps = 1;
1053
1054 // total number of unique apps that used an identity callback when attaching
1055 optional int32 num_apps_using_identity_callback = 2;
1056
1057 // maximum number of attaches for an app
1058 optional int32 max_concurrent_attach_sessions_in_app = 3;
1059
1060 // histogram of attach request results
1061 repeated NanStatusHistogramBucket histogram_attach_session_status = 4;
1062
1063 // maximum number of concurrent publish sessions in a single app
1064 optional int32 max_concurrent_publish_in_app = 5;
1065
1066 // maximum number of concurrent subscribe sessions in a single app
1067 optional int32 max_concurrent_subscribe_in_app = 6;
1068
1069 // maximum number of concurrent discovery (publish+subscribe) sessions in a single app
1070 optional int32 max_concurrent_discovery_sessions_in_app = 7;
1071
1072 // maximum number of concurrent publish sessions in the system
1073 optional int32 max_concurrent_publish_in_system = 8;
1074
1075 // maximum number of concurrent subscribe sessions in the system
1076 optional int32 max_concurrent_subscribe_in_system = 9;
1077
1078 // maximum number of concurrent discovery (publish+subscribe) sessions in the system
1079 optional int32 max_concurrent_discovery_sessions_in_system = 10;
1080
1081 // histogram of publish request results
1082 repeated NanStatusHistogramBucket histogram_publish_status = 11;
1083
1084 // histogram of subscribe request results
1085 repeated NanStatusHistogramBucket histogram_subscribe_status = 12;
1086
1087 // number of unique apps which experienced a discovery session creation failure due to lack of
1088 // resources
1089 optional int32 num_apps_with_discovery_session_failure_out_of_resources = 13;
1090
1091 // histogram of create ndp request results
1092 repeated NanStatusHistogramBucket histogram_request_ndp_status = 14;
1093
1094 // histogram of create ndp out-of-band (OOB) request results
1095 repeated NanStatusHistogramBucket histogram_request_ndp_oob_status = 15;
1096
1097 // maximum number of concurrent active data-interfaces (NDI) in a single app
1098 optional int32 max_concurrent_ndi_in_app = 19;
1099
1100 // maximum number of concurrent active data-interfaces (NDI) in the system
1101 optional int32 max_concurrent_ndi_in_system = 20;
1102
1103 // maximum number of concurrent data-paths (NDP) in a single app
1104 optional int32 max_concurrent_ndp_in_app = 21;
1105
1106 // maximum number of concurrent data-paths (NDP) in the system
1107 optional int32 max_concurrent_ndp_in_system = 22;
1108
1109 // maximum number of concurrent secure data-paths (NDP) in a single app
1110 optional int32 max_concurrent_secure_ndp_in_app = 23;
1111
1112 // maximum number of concurrent secure data-paths (NDP) in the system
1113 optional int32 max_concurrent_secure_ndp_in_system = 24;
1114
1115 // maximum number of concurrent data-paths (NDP) per data-interface (NDI)
1116 optional int32 max_concurrent_ndp_per_ndi = 25;
1117
1118 // histogram of durations of Aware being available
1119 repeated HistogramBucket histogram_aware_available_duration_ms = 26;
1120
1121 // histogram of durations of Aware being enabled
1122 repeated HistogramBucket histogram_aware_enabled_duration_ms = 27;
1123
1124 // histogram of duration (in ms) of attach sessions
1125 repeated HistogramBucket histogram_attach_duration_ms = 28;
1126
1127 // histogram of duration (in ms) of publish sessions
1128 repeated HistogramBucket histogram_publish_session_duration_ms = 29;
1129
1130 // histogram of duration (in ms) of subscribe sessions
1131 repeated HistogramBucket histogram_subscribe_session_duration_ms = 30;
1132
1133 // histogram of duration (in ms) of data-paths (NDP)
1134 repeated HistogramBucket histogram_ndp_session_duration_ms = 31;
1135
1136 // histogram of usage (in MB) of data-paths (NDP)
1137 repeated HistogramBucket histogram_ndp_session_data_usage_mb = 32;
1138
1139 // histogram of usage (in MB) of data-path creation time (in ms) measured as request -> confirm
1140 repeated HistogramBucket histogram_ndp_creation_time_ms = 33;
1141
1142 // statistics for data-path (NDP) creation time (in ms) measured as request -> confirm: minimum
1143 optional int64 ndp_creation_time_ms_min = 34;
1144
1145 // statistics for data-path (NDP) creation time (in ms) measured as request -> confirm: maximum
1146 optional int64 ndp_creation_time_ms_max = 35;
1147
1148 // statistics for data-path (NDP) creation time (in ms) measured as request -> confirm: sum
1149 optional int64 ndp_creation_time_ms_sum = 36;
1150
1151 // statistics for data-path (NDP) creation time (in ms) measured as request -> confirm: sum of sq
1152 optional int64 ndp_creation_time_ms_sum_of_sq = 37;
1153
1154 // statistics for data-path (NDP) creation time (in ms) measured as request -> confirm: number of
1155 // samples
1156 optional int64 ndp_creation_time_ms_num_samples = 38;
1157
1158 // total time within the logging window that aware was available
1159 optional int64 available_time_ms = 39;
1160
1161 // total time within the logging window that aware was enabled
1162 optional int64 enabled_time_ms = 40;
1163
Etan Cohenfa723572018-03-13 07:25:50 -07001164 // maximum number of concurrent publish sessions enabling ranging in a single app
1165 optional int32 max_concurrent_publish_with_ranging_in_app = 41;
1166
1167 // maximum number of concurrent subscribe sessions specifying a geofence in a single app
1168 optional int32 max_concurrent_subscribe_with_ranging_in_app = 42;
1169
1170 // maximum number of concurrent publish sessions enabling ranging in the system
1171 optional int32 max_concurrent_publish_with_ranging_in_system = 43;
1172
1173 // maximum number of concurrent subscribe sessions specifying a geofence in the system
1174 optional int32 max_concurrent_subscribe_with_ranging_in_system = 44;
1175
1176 // histogram of subscribe session geofence minimum (only when specified)
1177 repeated HistogramBucket histogram_subscribe_geofence_min = 45;
1178
1179 // histogram of subscribe session geofence maximum (only when specified)
1180 repeated HistogramBucket histogram_subscribe_geofence_max = 46;
1181
1182 // total number of subscribe sessions which enabled ranging
1183 optional int32 num_subscribes_with_ranging = 47;
1184
1185 // total number of matches (service discovery indication) with ranging provided
1186 optional int32 num_matches_with_ranging = 48;
1187
1188 // total number of matches (service discovery indication) for service discovery with ranging
1189 // enabled which did not trigger ranging
1190 optional int32 num_matches_without_ranging_for_ranging_enabled_subscribes = 49;
1191
Etan Cohen737addc2017-04-26 08:01:57 -07001192 // Histogram bucket for Wi-Fi Aware logs. Range is [start, end)
1193 message HistogramBucket {
1194 // lower range of the bucket (inclusive)
1195 optional int64 start = 1;
1196
1197 // upper range of the bucket (exclusive)
1198 optional int64 end = 2;
1199
1200 // number of samples in the bucket
1201 optional int32 count = 3;
1202 }
1203
1204 // Status of various NAN operations
1205 enum NanStatusTypeEnum {
1206 // constant to be used by proto
1207 UNKNOWN = 0;
1208
1209 // NAN operation succeeded
1210 SUCCESS = 1;
1211
1212 // NAN Discovery Engine/Host driver failures
1213 INTERNAL_FAILURE = 2;
1214
1215 // NAN OTA failures
1216 PROTOCOL_FAILURE = 3;
1217
1218 // The publish/subscribe discovery session id is invalid
1219 INVALID_SESSION_ID = 4;
1220
1221 // Out of resources to fufill request
1222 NO_RESOURCES_AVAILABLE = 5;
1223
1224 // Invalid arguments passed
1225 INVALID_ARGS = 6;
1226
1227 // Invalid peer id
1228 INVALID_PEER_ID = 7;
1229
1230 // Invalid NAN data-path (ndp) id
1231 INVALID_NDP_ID = 8;
1232
1233 // Attempting to enable NAN when not available, e.g. wifi is disabled
1234 NAN_NOT_ALLOWED = 9;
1235
1236 // Over the air ACK not received
1237 NO_OTA_ACK = 10;
1238
1239 // Attempting to enable NAN when already enabled
1240 ALREADY_ENABLED = 11;
1241
1242 // Can't queue tx followup message foor transmission
1243 FOLLOWUP_TX_QUEUE_FULL = 12;
1244
1245 // Unsupported concurrency of NAN and another feature - NAN disabled
1246 UNSUPPORTED_CONCURRENCY_NAN_DISABLED = 13;
1247
1248 // Unknown NanStatusType
1249 UNKNOWN_HAL_STATUS = 14;
1250 }
1251
1252 // Histogram bucket for Wi-Fi Aware (NAN) status.
1253 message NanStatusHistogramBucket {
1254 // status type defining the bucket
1255 optional NanStatusTypeEnum nan_status_type = 1;
1256
1257 // number of samples in the bucket
1258 optional int32 count = 2;
1259 }
1260}
1261
Glen Kuhnee2d67c02017-04-25 13:08:29 -07001262// Data point used to build 'Number of Connectable Network' histograms
1263message NumConnectableNetworksBucket {
1264 // Number of connectable networks seen in a scan result
1265 optional int32 num_connectable_networks = 1 [default = 0];
1266
1267 // Number of scan results with num_connectable_networks
1268 optional int32 count = 2 [default = 0];
1269}
Mehdi Alizadehd9163cf2017-08-10 18:20:25 -07001270
1271// Pno scan metrics
1272// Here "Pno Scan" refers to the session of offloaded scans, these metrics count the result of a
1273// single session, and not the individual scans within that session.
1274message PnoScanMetrics {
1275 // Total number of attempts to offload pno scans
1276 optional int32 num_pno_scan_attempts = 1;
1277
1278 // Total number of pno scans failed
1279 optional int32 num_pno_scan_failed = 2;
1280
1281 // Number of pno scans started successfully over offload
1282 optional int32 num_pno_scan_started_over_offload = 3;
1283
1284 // Number of pno scans failed over offload
1285 optional int32 num_pno_scan_failed_over_offload = 4;
1286
1287 // Total number of pno scans that found any network
1288 optional int32 num_pno_found_network_events = 5;
1289}
Stephen Chenfc0facb2017-09-14 14:35:15 -07001290
1291// Number of occurrences for a particular "Connect to Network" Notification or
1292// notification Action.
1293message ConnectToNetworkNotificationAndActionCount {
1294
1295 // "Connect to Network" notifications
1296 enum Notification {
1297
1298 // Default
1299 NOTIFICATION_UNKNOWN = 0;
1300
1301 // Initial notification with a recommended network.
1302 NOTIFICATION_RECOMMEND_NETWORK = 1;
1303
1304 // Notification when connecting to the recommended network.
1305 NOTIFICATION_CONNECTING_TO_NETWORK = 2;
1306
1307 // Notification when successfully connected to the network.
1308 NOTIFICATION_CONNECTED_TO_NETWORK = 3;
1309
1310 // Notification when failed to connect to network.
1311 NOTIFICATION_FAILED_TO_CONNECT = 4;
1312 }
1313
1314 // "Connect to Network" notification actions
1315 enum Action {
1316
1317 // Default
1318 ACTION_UNKNOWN = 0;
1319
1320 // User dismissed the "Connect to Network" notification.
1321 ACTION_USER_DISMISSED_NOTIFICATION = 1;
1322
1323 // User tapped action button to connect to recommended network.
1324 ACTION_CONNECT_TO_NETWORK = 2;
1325
1326 // User tapped action button to open Wi-Fi Settings.
1327 ACTION_PICK_WIFI_NETWORK = 3;
1328
1329 // User tapped "Failed to connect" notification to open Wi-Fi Settings.
1330 ACTION_PICK_WIFI_NETWORK_AFTER_CONNECT_FAILURE = 4;
1331 }
1332
1333 // Recommenders of the "Connect to Network" notification
1334 enum Recommender {
1335
1336 // Default.
1337 RECOMMENDER_UNKNOWN = 0;
1338
1339 // Open Network Available recommender.
1340 RECOMMENDER_OPEN = 1;
1341 }
1342
1343 // Notification Type.
1344 optional Notification notification = 1;
1345
1346 // Action Type.
1347 optional Action action = 2;
1348
1349 // Recommender Type.
1350 optional Recommender recommender = 3;
1351
1352 // Occurrences of this action.
1353 optional int32 count = 4;
1354}
Mehdi Alizadeh2a59c52ca2017-10-18 15:42:35 -07001355
1356// SoftAP event tracking sessions and client counts
1357message SoftApConnectedClientsEvent {
1358
1359 // Soft AP event Types
1360 enum SoftApEventType {
1361
1362 // Soft AP is Up and ready for use
1363 SOFT_AP_UP = 0;
1364
1365 // Soft AP is Down
1366 SOFT_AP_DOWN = 1;
1367
1368 // Number of connected soft AP clients has changed
1369 NUM_CLIENTS_CHANGED = 2;
1370 }
1371
Mehdi Alizadeh24498192018-03-15 13:02:51 -07001372 // Soft AP channel bandwidth types
1373 enum ChannelBandwidth {
1374
1375 BANDWIDTH_INVALID = 0;
1376
1377 BANDWIDTH_20_NOHT = 1;
1378
1379 BANDWIDTH_20 = 2;
1380
1381 BANDWIDTH_40 = 3;
1382
1383 BANDWIDTH_80 = 4;
1384
1385 BANDWIDTH_80P80 = 5;
1386
1387 BANDWIDTH_160 = 6;
1388 }
1389
Mehdi Alizadeh2a59c52ca2017-10-18 15:42:35 -07001390 // Type of event being recorded
1391 optional SoftApEventType event_type = 1;
1392
Mehdi Alizadeh24498192018-03-15 13:02:51 -07001393 // Time passed since last boot in milliseconds
Mehdi Alizadeh2a59c52ca2017-10-18 15:42:35 -07001394 optional int64 time_stamp_millis = 2;
1395
1396 // Number of connected clients if event_type is NUM_CLIENTS_CHANGED, otherwise zero.
1397 optional int32 num_connected_clients = 3;
Mehdi Alizadeh24498192018-03-15 13:02:51 -07001398
1399 // Channel frequency used for Soft AP
1400 optional int32 channel_frequency = 4;
1401
1402 // Channel bandwidth used for Soft AP
1403 optional ChannelBandwidth channel_bandwidth = 5;
Jong Wook Kim72c49ee2017-10-26 13:16:36 -07001404}
1405
1406// Wps connection metrics
1407// Keeps track of Wi-Fi Protected Setup usage
1408message WpsMetrics {
1409 // Total number of wps connection attempts
1410 optional int32 num_wps_attempts = 1;
1411
1412 // Total number of wps connection successes
1413 optional int32 num_wps_success = 2;
1414
1415 // Total number of wps failures on start
1416 optional int32 num_wps_start_failure = 3;
1417
1418 // Total number of wps overlap failure
1419 optional int32 num_wps_overlap_failure = 4;
1420
1421 // Total number of wps timeout failure
1422 optional int32 num_wps_timeout_failure = 5;
1423
1424 // Total number of other wps failure during connection
1425 optional int32 num_wps_other_connection_failure = 6;
1426
1427 // Total number of supplicant failure after wps
1428 optional int32 num_wps_supplicant_failure = 7;
1429
1430 // Total number of wps cancellation
1431 optional int32 num_wps_cancellation = 8;
1432}
Siddharth Rayac8b69a2018-01-27 18:05:44 -08001433
1434// Power stats for Wifi
1435message WifiPowerStats {
1436
1437 // Duration of log (ms)
1438 optional int64 logging_duration_ms = 1;
1439
1440 // Energy consumed by wifi (mAh)
1441 optional double energy_consumed_mah = 2;
1442
1443 // Amount of time wifi is in idle (ms)
1444 optional int64 idle_time_ms = 3;
1445
1446 // Amount of time wifi is in rx (ms)
1447 optional int64 rx_time_ms = 4;
1448
1449 // Amount of time wifi is in tx (ms)
1450 optional int64 tx_time_ms = 5;
Blake Kragten354c83d2018-12-04 16:28:44 -08001451
1452 // Amount of time kernel is active because of wifi data (ms)
1453 optional int64 wifi_kernel_active_time_ms = 6;
1454
1455 // Number of packets sent (tx)
1456 optional int64 num_packets_tx = 7;
1457
1458 // Number of bytes sent (tx)
1459 optional int64 num_bytes_tx = 8;
1460
1461 // Number of packets received (rx)
1462 optional int64 num_packets_rx = 9;
1463
1464 // Number of bytes sent (rx)
1465 optional int64 num_bytes_rx = 10;
1466
1467 // Amount of time wifi is in sleep (ms)
1468 optional int64 sleep_time_ms = 11;
1469
1470 // Amount of time wifi is scanning (ms)
1471 optional int64 scan_time_ms = 12;
Blake Kragten0f8aa762019-01-31 16:05:15 -08001472
1473 // Actual monitored rail energy consumed by wifi (mAh)
1474 optional double monitored_rail_energy_consumed_mah = 13;
Ningyuan Wang72886332017-12-20 16:17:33 -08001475}
Eric Schwarzenbach9f941f92018-02-16 11:10:30 -08001476
1477// Metrics for Wifi Wake
1478message WifiWakeStats {
1479 // An individual session for Wifi Wake
1480 message Session {
1481 // A Wifi Wake lifecycle event
1482 message Event {
1483 // Elapsed time in milliseconds since start of session.
1484 optional int64 elapsed_time_millis = 1;
1485
1486 // Number of scans that have occurred since start of session.
1487 optional int32 elapsed_scans = 2;
1488 }
1489
1490 // Start time of session in milliseconds.
1491 optional int64 start_time_millis = 1;
1492
Eric Schwarzenbach3cad6242018-03-26 10:23:40 -07001493 // The number of networks the lock was provided with at start.
Eric Schwarzenbach9f941f92018-02-16 11:10:30 -08001494 optional int32 locked_networks_at_start = 2;
1495
Eric Schwarzenbach3cad6242018-03-26 10:23:40 -07001496 // The number of networks in the lock at the time of the initialize event. Only valid if
1497 // initialize_event is recorded.
1498 optional int32 locked_networks_at_initialize = 6;
1499
1500 // Event for fully initializing the WakeupLock (i.e. WakeupLock is "locked").
1501 optional Event initialize_event = 7;
1502
Eric Schwarzenbach9f941f92018-02-16 11:10:30 -08001503 // Event for unlocking the WakeupLock. Does not occur if lock was initialized with 0 networks.
1504 optional Event unlock_event = 3;
1505
1506 // Event for triggering wakeup.
1507 optional Event wakeup_event = 4;
1508
1509 // Event for WifiWake reset event. This event marks the end of a session.
1510 optional Event reset_event = 5;
1511 }
1512
1513 // Total number of sessions for Wifi Wake.
1514 optional int32 num_sessions = 1;
1515
1516 // Session information for every Wifi Wake session (up to a maximum of 10).
1517 repeated Session sessions = 2;
Eric Schwarzenbach3cad6242018-03-26 10:23:40 -07001518
1519 // Number of ignored calls to start (due to WakeupController already being active).
1520 optional int32 num_ignored_starts = 3;
1521
1522 // Number of Wifi Wake sessions that have recorded wakeup events.
1523 optional int32 num_wakeups = 4;
Eric Schwarzenbach9f941f92018-02-16 11:10:30 -08001524}
Etan Cohen4ec8dd32018-03-16 09:43:01 -07001525
1526// Metrics for Wi-Fi RTT
1527message WifiRttLog {
1528 // Number of RTT request API calls
1529 optional int32 num_requests = 1;
1530
1531 // Histogram of RTT operation overall status
1532 repeated RttOverallStatusHistogramBucket histogram_overall_status = 2;
1533
1534 // RTT to Access Points metrics
1535 optional RttToPeerLog rtt_to_ap = 3;
1536
1537 // RTT to Wi-Fi Aware peers metrics
1538 optional RttToPeerLog rtt_to_aware = 4;
1539
1540 // Metrics for a RTT to Peer (peer = AP or Wi-Fi Aware)
1541 message RttToPeerLog {
1542 // Total number of API calls
1543 optional int32 num_requests = 1;
1544
1545 // Total number of individual requests
1546 optional int32 num_individual_requests = 2;
1547
1548 // Total number of apps which requested RTT
1549 optional int32 num_apps = 3;
1550
1551 // Histogram of total number of RTT requests by an app (WifiRttManager#startRanging)
1552 repeated HistogramBucket histogram_num_requests_per_app = 4;
1553
1554 // Histogram of number of peers in a single RTT request (RangingRequest entries)
1555 repeated HistogramBucket histogram_num_peers_per_request = 5;
1556
1557 // Histogram of status of individual RTT operations (RangingResult entries)
1558 repeated RttIndividualStatusHistogramBucket histogram_individual_status = 6;
1559
1560 // Histogram of measured distances (RangingResult entries)
1561 repeated HistogramBucket histogram_distance = 7;
1562
1563 // Histogram of interval of RTT requests by an app (WifiRttManager#startRanging)
1564 repeated HistogramBucket histogram_request_interval_ms = 8;
1565 }
1566
Hai Shaloma18c32c2019-01-22 10:01:09 -08001567 // Histogram bucket for Wi-Fi RTT logs. Range is [start, end)
Etan Cohen4ec8dd32018-03-16 09:43:01 -07001568 message HistogramBucket {
1569 // lower range of the bucket (inclusive)
1570 optional int64 start = 1;
1571
1572 // upper range of the bucket (exclusive)
1573 optional int64 end = 2;
1574
1575 // number of samples in the bucket
1576 optional int32 count = 3;
1577 }
1578
1579 // Status codes for overall RTT operation
1580 enum RttOverallStatusTypeEnum {
1581 // constant to be used by proto
1582 OVERALL_UNKNOWN = 0;
1583
1584 // RTT operation succeeded (individual results may still fail)
1585 OVERALL_SUCCESS = 1;
1586
1587 // RTT operation failed (unspecified reason)
1588 OVERALL_FAIL = 2;
1589
1590 // RTT operation failed since RTT was not available (e.g. Airplane mode)
1591 OVERALL_RTT_NOT_AVAILABLE = 3;
1592
1593 // RTT operation timed-out: didn't receive response from HAL in expected time
1594 OVERALL_TIMEOUT = 4;
1595
1596 // RTT operation aborted since the app is spamming the service
1597 OVERALL_THROTTLE = 5;
1598
1599 // RTT request to HAL received immediate failure
1600 OVERALL_HAL_FAILURE = 6;
1601
1602 // RTT to Wi-Fi Aware peer using PeerHandle failed to get a MAC address translation
1603 OVERALL_AWARE_TRANSLATION_FAILURE = 7;
1604
1605 // RTT operation failed due to missing Location permission (post execution)
1606 OVERALL_LOCATION_PERMISSION_MISSING = 8;
1607 }
1608
1609 // Status codes for individual RTT operation
1610 enum RttIndividualStatusTypeEnum {
1611 // constant to be used by proto
1612 UNKNOWN = 0;
1613
1614 // RTT operation succeeded
1615 SUCCESS = 1;
1616
1617 // RTT failure: generic reason (no further information)
1618 FAILURE = 2;
1619
1620 // Target STA does not respond to request
1621 FAIL_NO_RSP = 3;
1622
1623 // Request rejected. Applies to 2-sided RTT only
1624 FAIL_REJECTED = 4;
1625
1626 // Operation not scheduled
1627 FAIL_NOT_SCHEDULED_YET = 5;
1628
1629 // Timing measurement times out
1630 FAIL_TM_TIMEOUT = 6;
1631
1632 // Target on different channel, cannot range
1633 FAIL_AP_ON_DIFF_CHANNEL = 7;
1634
1635 // Ranging not supported
1636 FAIL_NO_CAPABILITY = 8;
1637
1638 // Request aborted for unknown reason
1639 ABORTED = 9;
1640
1641 // Invalid T1-T4 timestamp
1642 FAIL_INVALID_TS = 10;
1643
1644 // 11mc protocol failed
1645 FAIL_PROTOCOL = 11;
1646
1647 // Request could not be scheduled
1648 FAIL_SCHEDULE = 12;
1649
1650 // Responder cannot collaborate at time of request
1651 FAIL_BUSY_TRY_LATER = 13;
1652
1653 // Bad request args
1654 INVALID_REQ = 14;
1655
1656 // WiFi not enabled
1657 NO_WIFI = 15;
1658
1659 // Responder overrides param info, cannot range with new params
1660 FAIL_FTM_PARAM_OVERRIDE = 16;
1661
1662 // HAL did not provide a result to a framework request
1663 MISSING_RESULT = 17;
1664 }
1665
1666 // Histogram bucket for Wi-Fi RTT overall operation status
1667 message RttOverallStatusHistogramBucket {
1668 // status type defining the bucket
1669 optional RttOverallStatusTypeEnum status_type = 1;
1670
1671 // number of samples in the bucket
1672 optional int32 count = 2;
1673 }
1674
1675 // Histogram bucket for Wi-Fi RTT individual operation status
1676 message RttIndividualStatusHistogramBucket {
1677 // status type defining the bucket
1678 optional RttIndividualStatusTypeEnum status_type = 1;
1679
1680 // number of samples in the bucket
1681 optional int32 count = 2;
1682 }
1683}
xshub483b722018-05-22 15:46:26 -07001684
1685// Usage data for the wifi radio while device is running on battery.
1686message WifiRadioUsage {
1687 // Duration of log (ms)
1688 optional int64 logging_duration_ms = 1;
1689
1690 // Total time for which the radio is awake due to scan.
1691 optional int64 scan_time_ms = 2;
Jong Wook Kim411cab92018-04-26 15:09:23 -07001692}
1693
1694message ExperimentValues {
1695 // Indicates if we are logging WifiIsUnusableEvent in metrics
1696 optional bool wifi_is_unusable_logging_enabled = 1;
1697
1698 // Minimum number of txBad to trigger a data stall
1699 optional int32 wifi_data_stall_min_tx_bad = 2;
1700
1701 // Minimum number of txSuccess to trigger a data stall
1702 // when rxSuccess is 0
1703 optional int32 wifi_data_stall_min_tx_success_without_rx = 3;
Jong Wook Kime4aa37f2018-04-23 11:18:24 -07001704
1705 // Indicates if we are logging LinkSpeedCount in metrics
1706 optional bool link_speed_counts_logging_enabled = 4;
Jong Wook Kim411cab92018-04-26 15:09:23 -07001707}
1708
1709message WifiIsUnusableEvent {
1710 enum TriggerType {
1711 // Default/Invalid event
1712 TYPE_UNKNOWN = 0;
1713
1714 // There is a data stall from tx failures
1715 TYPE_DATA_STALL_BAD_TX = 1;
1716
1717 // There is a data stall from rx failures
1718 TYPE_DATA_STALL_TX_WITHOUT_RX = 2;
1719
1720 // There is a data stall from both tx and rx failures
1721 TYPE_DATA_STALL_BOTH = 3;
1722
1723 // Firmware generated an alert
1724 TYPE_FIRMWARE_ALERT = 4;
1725 }
1726
1727 // What event triggered WifiIsUnusableEvent.
1728 optional TriggerType type = 1;
1729
1730 // The timestamp at which this event occurred.
1731 // Measured in milliseconds that have elapsed since the device booted.
1732 optional int64 start_time_millis = 2;
1733
1734 // NetworkAgent score of connected wifi.
1735 // Defaults to -1 if the score was never set.
1736 optional int32 last_score = 3 [default = -1];
1737
1738 // Delta of successfully transmitted (ACKed) unicast data packets
1739 // between the last two WifiLinkLayerStats.
1740 optional int64 tx_success_delta = 4;
1741
1742 // Delta of transmitted unicast data retry packets
1743 // between the last two WifiLinkLayerStats.
1744 optional int64 tx_retries_delta = 5;
1745
1746 // Delta of lost (not ACKed) transmitted unicast data packets
1747 // between the last two WifiLinkLayerStats.
1748 optional int64 tx_bad_delta = 6;
1749
1750 // Delta of received unicast data packets
1751 // between the last two WifiLinkLayerStats.
1752 optional int64 rx_success_delta = 7;
1753
1754 // Time in millisecond between the last two WifiLinkLayerStats.
1755 optional int64 packet_update_time_delta = 8;
1756
1757 // The timestamp at which the last WifiLinkLayerStats was updated.
1758 // Measured in milliseconds that have elapsed since the device booted.
1759 optional int64 last_link_layer_stats_update_time = 9;
1760
1761 // Firmware alert code. Only valid when the event was triggered by a firmware alert, otherwise -1.
1762 optional int32 firmware_alert_code = 10 [default = -1];
Mingguang Xuca2aab12019-01-12 23:40:42 -08001763
1764 // NetworkAgent wifi usability score of connected wifi.
1765 // Defaults to -1 if the score was never set.
1766 optional int32 last_wifi_usability_score = 11 [default = -1];
Mingguang Xue7e344a2019-01-21 16:26:45 -08001767
1768 // Prediction horizon (in second) of Wifi usability score provided by external
1769 // system app
1770 optional int32 last_prediction_horizon_sec = 12 [default = -1];
Ahmed ElArabawyba64b612018-06-15 09:17:45 -07001771}
Ecco Park5a403002018-07-23 15:53:10 -07001772
1773message PasspointProfileTypeCount {
1774 enum EapMethod {
1775 // Unknown Type
1776 TYPE_UNKNOWN = 0;
1777
1778 // EAP_TLS (13)
1779 TYPE_EAP_TLS = 1;
1780
1781 // EAP_TTLS (21)
1782 TYPE_EAP_TTLS = 2;
1783
1784 // EAP_SIM (18)
1785 TYPE_EAP_SIM = 3;
1786
1787 // EAP_AKA (23)
1788 TYPE_EAP_AKA = 4;
1789
1790 // EAP_AKA_PRIME (50)
1791 TYPE_EAP_AKA_PRIME = 5;
1792 }
1793
1794 // Eap method type set in Passpoint profile
1795 optional EapMethod eap_method_type = 1;
1796
1797 // Num of installed Passpoint profile with same eap method
1798 optional int32 count = 2;
xshu0e0dea42018-09-17 17:30:15 -07001799}
1800
1801message WifiLinkLayerUsageStats {
1802 // Total logging duration in ms.
1803 optional int64 logging_duration_ms = 1;
1804
1805 // Total time the wifi radio is on in ms over the logging duration.
1806 optional int64 radio_on_time_ms = 2;
1807
1808 // Total time the wifi radio is doing tx in ms over the logging duration.
1809 optional int64 radio_tx_time_ms = 3;
1810
1811 // Total time the wifi radio is doing rx in ms over the logging duration.
1812 optional int64 radio_rx_time_ms = 4;
1813
1814 // Total time the wifi radio is scanning in ms over the logging duration.
1815 optional int64 radio_scan_time_ms = 5;
xshu0f91dd62018-11-08 15:51:07 -08001816
1817 // Total time the wifi radio spent doing nan scans in ms over the logging duration.
1818 optional int64 radio_nan_scan_time_ms = 6;
1819
1820 // Total time the wifi radio spent doing background scans in ms over the logging duration.
1821 optional int64 radio_background_scan_time_ms = 7;
1822
1823 // Total time the wifi radio spent doing roam scans in ms over the logging duration.
1824 optional int64 radio_roam_scan_time_ms = 8;
1825
1826 // Total time the wifi radio spent doing pno scans in ms over the logging duration.
1827 optional int64 radio_pno_scan_time_ms = 9;
1828
1829 // Total time the wifi radio spent doing hotspot 2.0 scans and GAS exchange
1830 // in ms over the logging duration.
1831 optional int64 radio_hs20_scan_time_ms = 10;
xshua33726e2018-09-24 15:02:23 -07001832}
1833
1834message WifiUsabilityStatsEntry {
Mingguang Xubed08852019-01-24 23:00:10 -08001835 // Status codes for link probe status
1836 enum LinkProbeStatus {
1837 // Link probe status is unknown
1838 PROBE_STATUS_UNKNOWN = 0;
1839
1840 // Link probe is not triggered
1841 PROBE_STATUS_NO_PROBE = 1;
1842
1843 // Link probe is triggered and the result is success
1844 PROBE_STATUS_SUCCESS = 2;
1845
1846 // Link probe is triggered and the result is failure
1847 PROBE_STATUS_FAILURE = 3;
1848 }
1849
xshua33726e2018-09-24 15:02:23 -07001850 // Absolute milliseconds from device boot when these stats were sampled
1851 optional int64 time_stamp_ms = 1;
1852
1853 // The RSSI at the sample time
1854 optional int32 rssi = 2;
1855
1856 // Link speed at the sample time in Mbps
1857 optional int32 link_speed_mbps = 3;
1858
1859 // The total number of tx success counted from the last radio chip reset
1860 optional int64 total_tx_success = 4;
1861
1862 // The total number of MPDU data packet retries counted from the last radio chip reset
1863 optional int64 total_tx_retries = 5;
1864
1865 // The total number of tx bad counted from the last radio chip reset
1866 optional int64 total_tx_bad = 6;
1867
1868 // The total number of rx success counted from the last radio chip reset
1869 optional int64 total_rx_success = 7;
1870
1871 // The total time the wifi radio is on in ms counted from the last radio chip reset
1872 optional int64 total_radio_on_time_ms = 8;
1873
1874 // The total time the wifi radio is doing tx in ms counted from the last radio chip reset
1875 optional int64 total_radio_tx_time_ms = 9;
1876
1877 // The total time the wifi radio is doing rx in ms counted from the last radio chip reset
1878 optional int64 total_radio_rx_time_ms = 10;
1879
1880 // The total time spent on all types of scans in ms counted from the last radio chip reset
1881 optional int64 total_scan_time_ms = 11;
1882
1883 // The total time spent on nan scans in ms counted from the last radio chip reset
1884 optional int64 total_nan_scan_time_ms = 12;
1885
1886 // The total time spent on background scans in ms counted from the last radio chip reset
1887 optional int64 total_background_scan_time_ms = 13;
1888
1889 // The total time spent on roam scans in ms counted from the last radio chip reset
1890 optional int64 total_roam_scan_time_ms = 14;
1891
1892 // The total time spent on pno scans in ms counted from the last radio chip reset
1893 optional int64 total_pno_scan_time_ms = 15;
1894
1895 // The total time spent on hotspot2.0 scans and GAS exchange in ms counted from the last radio
1896 // chip reset
1897 optional int64 total_hotspot_2_scan_time_ms = 16;
Mingguang Xuca2aab12019-01-12 23:40:42 -08001898
1899 // Internal framework Wifi score
1900 optional int32 wifi_score = 17;
1901
1902 // Wifi usability score provided by external system app
1903 optional int32 wifi_usability_score = 18;
1904
1905 // Sequence number from external system app to framework
1906 optional int32 seq_num_to_framework = 19;
Mingguang Xu86833142019-01-09 13:54:29 -08001907
1908 // The total time CCA is on busy status on the current frequency in ms
1909 // counted from the last radio chip reset
1910 optional int64 total_cca_busy_freq_time_ms = 20;
1911
1912 // The total radio on time of the current frequency from the last radio
1913 // chip reset
1914 optional int64 total_radio_on_freq_time_ms = 21;
1915
1916 // The total number of beacons received from the last radio chip reset
1917 optional int64 total_beacon_rx = 22;
Mingguang Xue7e344a2019-01-21 16:26:45 -08001918
1919 // Prediction horizon (in second) of Wifi usability score provided by external
1920 // system app
1921 optional int32 prediction_horizon_sec = 23;
Mingguang Xubed08852019-01-24 23:00:10 -08001922
1923 // The link probe status since last stats update
1924 optional LinkProbeStatus probe_status_since_last_update = 24;
1925
1926 // The elapsed time of the most recent link probe since last stats update;
1927 optional int32 probe_elapsed_time_ms_since_last_update = 25;
1928
1929 // The MCS rate of the most recent link probe since last stats update
1930 optional int32 probe_mcs_rate_since_last_update = 26;
1931
1932 // Rx link speed at the sample time in Mbps
1933 optional int32 rx_link_speed_mbps = 27;
Mingguang Xu96bcabe2019-01-30 22:36:07 -08001934
1935 // Sequence number generated by framework
1936 optional int32 seq_num_inside_framework = 28;
1937
1938 // Whether current entry is for the same BSSID on the same frequency compared
1939 // to last entry
1940 optional bool is_same_bssid_and_freq = 29;
xshua33726e2018-09-24 15:02:23 -07001941}
1942
1943message WifiUsabilityStats {
1944 enum Label {
1945 // Default label
1946 LABEL_UNKNOWN = 0;
1947
1948 // Wifi is usable
1949 LABEL_GOOD = 1;
1950
1951 // Wifi is unusable
1952 LABEL_BAD = 2;
1953 }
1954
Mingguang Xuf69fa672019-01-28 14:32:36 -08001955 enum UsabilityStatsTriggerType {
1956 // Default/Invalid event
1957 TYPE_UNKNOWN = 0;
1958
1959 // There is a data stall from tx failures
1960 TYPE_DATA_STALL_BAD_TX = 1;
1961
1962 // There is a data stall from rx failures
1963 TYPE_DATA_STALL_TX_WITHOUT_RX = 2;
1964
1965 // There is a data stall from both tx and rx failures
1966 TYPE_DATA_STALL_BOTH = 3;
1967
1968 // Firmware generated an alert
1969 TYPE_FIRMWARE_ALERT = 4;
1970 }
1971
xshua33726e2018-09-24 15:02:23 -07001972 // The current wifi usability state
1973 optional Label label = 1;
1974
1975 // The list of timestamped wifi usability stats
1976 repeated WifiUsabilityStatsEntry stats = 2;
Mingguang Xuf69fa672019-01-28 14:32:36 -08001977
1978 // What event triggered WifiUsabilityStats.
1979 optional UsabilityStatsTriggerType trigger_type = 3;
David Su367bdff2018-12-13 13:39:11 -08001980}
1981
1982message DeviceMobilityStatePnoScanStats {
1983 // see WifiManager.DEVICE_MOBILITY_STATE_* constants
1984 enum DeviceMobilityState {
1985 // Unknown mobility
1986 UNKNOWN = 0;
1987
1988 // High movement
1989 HIGH_MVMT = 1;
1990
1991 // Low movement
1992 LOW_MVMT = 2;
1993
1994 // Stationary
1995 STATIONARY = 3;
1996 }
1997
1998 // The device mobility state
1999 optional DeviceMobilityState device_mobility_state = 1;
2000
2001 // The number of times that this state was entered
2002 optional int32 num_times_entered_state = 2;
2003
2004 // The total duration elapsed while in this mobility state, in ms
2005 optional int64 total_duration_ms = 3;
2006
2007 // the total duration elapsed while in this mobility state with PNO scans running, in ms
2008 optional int64 pno_duration_ms = 4;
2009}
Jimmy Chen0142e8b2018-11-23 16:25:57 +08002010
2011// The information about the Wifi P2p events.
2012message WifiP2pStats {
2013
2014 // Group event list tracking sessions and client counts in tethered mode.
2015 repeated GroupEvent group_event = 1;
2016
2017 // Session information that gets logged for every Wifi P2p connection.
2018 repeated P2pConnectionEvent connection_event = 2;
2019
2020 // Number of persistent group in the user profile.
2021 optional int32 num_persistent_group = 3;
2022
2023 // Number of peer scan.
2024 optional int32 num_total_peer_scans = 4;
2025
2026 // Number of service scan.
2027 optional int32 num_total_service_scans = 5;
2028}
2029
2030message P2pConnectionEvent {
2031
2032 enum ConnectionType {
2033
2034 // fresh new connection.
2035 CONNECTION_FRESH = 0;
2036
2037 // reinvoke a group.
2038 CONNECTION_REINVOKE = 1;
2039
2040 // create a group with the current device as the group owner locally.
2041 CONNECTION_LOCAL = 2;
2042
2043 // create a group or join a group with config.
2044 CONNECTION_FAST = 3;
2045 }
2046
2047 enum ConnectivityLevelFailure {
2048
2049 // Failure is unknown.
2050 CLF_UNKNOWN = 0;
2051
2052 // No failure.
2053 CLF_NONE = 1;
2054
2055 // Timeout for current connecting request.
2056 CLF_TIMEOUT = 2;
2057
2058 // The connecting request is canceled by the user.
2059 CLF_CANCEL = 3;
2060
2061 // Provision discovery failure, e.g. no pin code, timeout, rejected by the peer.
2062 CLF_PROV_DISC_FAIL = 4;
2063
2064 // Invitation failure, e.g. rejected by the peer.
2065 CLF_INVITATION_FAIL = 5;
2066
2067 // Incoming request is rejected by the user.
2068 CLF_USER_REJECT = 6;
2069
2070 // New connection request is issued before ending previous connecting request.
2071 CLF_NEW_CONNECTION_ATTEMPT = 7;
2072 }
2073
2074 // WPS method.
2075 enum WpsMethod {
2076 // WPS is skipped for Group Reinvoke.
2077 WPS_NA = -1;
2078
2079 // Push button configuration.
2080 WPS_PBC = 0;
2081
2082 // Display pin method configuration - pin is generated and displayed on device.
2083 WPS_DISPLAY = 1;
2084
2085 // Keypad pin method configuration - pin is entered on device.
2086 WPS_KEYPAD = 2;
2087
2088 // Label pin method configuration - pin is labelled on device.
2089 WPS_LABEL = 3;
2090 }
2091
2092 // Start time of the connection.
2093 optional int64 start_time_millis = 1;
2094
2095 // Type of the connection.
2096 optional ConnectionType connection_type = 2;
2097
2098 // WPS method.
2099 optional WpsMethod wps_method = 3 [default = WPS_NA];
2100
2101 // Duration to connect.
2102 optional int32 duration_taken_to_connect_millis = 4;
2103
2104 // Failures that happen at the connectivity layer.
2105 optional ConnectivityLevelFailure connectivity_level_failure_code = 5;
2106}
2107
2108// GroupEvent tracking group information from GroupStarted to GroupRemoved.
2109message GroupEvent {
2110
2111 enum GroupRole {
2112
2113 GROUP_OWNER = 0;
2114
2115 GROUP_CLIENT = 1;
2116 }
2117
2118 // The ID of network in supplicant for this group.
2119 optional int32 net_id = 1;
2120
2121 // Start time of the group.
2122 optional int64 start_time_millis = 2;
2123
2124 // Channel frequency used for Group.
2125 optional int32 channel_frequency = 3;
2126
2127 // Is group owner or group client.
2128 optional GroupRole group_role = 5;
2129
2130 // Number of connected clients.
2131 optional int32 num_connected_clients = 6;
2132
2133 // Cumulative number of connected clients.
2134 optional int32 num_cumulative_clients = 7;
2135
2136 // The session duration.
2137 optional int32 session_duration_millis = 8;
2138
2139 // The idle duration. A group without any client is in idle.
2140 optional int32 idle_duration_millis = 9;
2141}
Hai Shaloma18c32c2019-01-22 10:01:09 -08002142
2143// Easy Connect (DPP)
2144message WifiDppLog {
David Su8e835f62019-02-14 16:45:09 -08002145 reserved 6;
2146
Hai Shaloma18c32c2019-01-22 10:01:09 -08002147 // Number of Configurator-Initiator requests
2148 optional int32 num_dpp_configurator_initiator_requests = 1;
2149
2150 // Number of Enrollee-Initiator requests
2151 optional int32 num_dpp_enrollee_initiator_requests = 2;
2152
2153 // Easy Connect (DPP) Enrollee success
2154 optional int32 num_dpp_enrollee_success = 3;
2155
2156 // Easy Connect (DPP) Configurator success code bucket
2157 repeated DppConfiguratorSuccessStatusHistogramBucket dpp_configurator_success_code = 4;
2158
2159 // Easy Connect (DPP) failure code bucket
2160 repeated DppFailureStatusHistogramBucket dpp_failure_code = 5;
2161
2162 // Easy Connect (DPP) operation time bucket
David Su8e835f62019-02-14 16:45:09 -08002163 repeated HistogramBucketInt32 dpp_operation_time = 7;
Hai Shaloma18c32c2019-01-22 10:01:09 -08002164
2165 // Histogram bucket for Wi-Fi DPP configurator success
2166 message DppConfiguratorSuccessStatusHistogramBucket {
2167 // status type defining the bucket
2168 optional DppConfiguratorSuccessCode dpp_status_type = 1;
2169
2170 // number of samples in the bucket
2171 optional int32 count = 2;
2172 }
2173
2174 // Histogram bucket for Wi-Fi DPP failures
2175 message DppFailureStatusHistogramBucket {
2176 // status type defining the bucket
2177 optional DppFailureCode dpp_status_type = 1;
2178
2179 // number of samples in the bucket
2180 optional int32 count = 2;
2181 }
2182
Hai Shaloma18c32c2019-01-22 10:01:09 -08002183 enum DppConfiguratorSuccessCode {
2184 // Unknown success code
2185 EASY_CONNECT_EVENT_SUCCESS_UNKNOWN = 0;
2186
2187 // Easy Connect Configurator success event: Configuration sent to enrollee
2188 EASY_CONNECT_EVENT_SUCCESS_CONFIGURATION_SENT = 1;
2189 }
2190
2191 enum DppFailureCode {
2192 // Unknown failure
2193 EASY_CONNECT_EVENT_FAILURE_UNKNOWN = 0;
2194
2195 // Easy Connect Failure event: Scanned QR code is either not a Easy Connect URI, or the Easy
2196 // Connect URI has errors.
2197 EASY_CONNECT_EVENT_FAILURE_INVALID_URI = 1;
2198
2199 // Easy Connect Failure event: Bootstrapping/Authentication initialization process failure.
2200 EASY_CONNECT_EVENT_FAILURE_AUTHENTICATION = 2;
2201
2202 // Easy Connect Failure event: Both devices are implementing the same role and are
2203 // incompatible.
2204 EASY_CONNECT_EVENT_FAILURE_NOT_COMPATIBLE = 3;
2205
2206 // Easy Connect Failure event: Configuration process has failed due to malformed message.
2207 EASY_CONNECT_EVENT_FAILURE_CONFIGURATION = 4;
2208
2209 // Easy Connect Failure event: Easy Connect request while in another Easy Connect exchange.
2210 EASY_CONNECT_EVENT_FAILURE_BUSY = 5;
2211
2212 // Easy Connect Failure event: No response from the peer.
2213 EASY_CONNECT_EVENT_FAILURE_TIMEOUT = 6;
2214
2215 // Easy Connect Failure event: General protocol failure.
2216 EASY_CONNECT_EVENT_FAILURE_GENERIC = 7;
2217
2218 // Easy Connect Failure event: Feature or option is not supported.
2219 EASY_CONNECT_EVENT_FAILURE_NOT_SUPPORTED = 8;
2220
2221 // Easy Connect Failure event: Invalid network provided to Easy Connect configurator.
2222 // Network must either be WPA3-Personal (SAE) or WPA2-Personal (PSK).
2223 EASY_CONNECT_EVENT_FAILURE_INVALID_NETWORK = 9;
2224 }
2225}
Roshan Pius89b233d2019-01-31 10:15:22 -08002226
2227// WifiConfigStore read/write metrics.
2228message WifiConfigStoreIO {
2229 // Histogram of config store read durations.
2230 repeated DurationBucket read_durations = 1;
2231
2232 // Histogram of config store write durations.
2233 repeated DurationBucket write_durations = 2;
2234
2235 // Total Number of instances of write/read duration in this duration bucket.
2236 message DurationBucket {
2237 // Bucket covers duration : [range_start_ms, range_end_ms)
2238 // The (inclusive) lower bound of read/write duration represented by this bucket
2239 optional int32 range_start_ms = 1;
2240
2241 // The (exclusive) upper bound of read/write duration represented by this bucket
2242 optional int32 range_end_ms = 2;
2243
2244 // Number of read/write durations that fit into this bucket
2245 optional int32 count = 3;
2246 }
2247}
David Su44306932019-02-12 16:53:46 -08002248
2249// Histogram bucket counting with int32. Range is [start, end)
2250message HistogramBucketInt32 {
2251 // lower range of the bucket (inclusive)
2252 optional int32 start = 1;
2253
2254 // upper range of the bucket (exclusive)
2255 optional int32 end = 2;
2256
2257 // number of samples in the bucket
2258 optional int32 count = 3;
2259}
2260
2261// Single entry in a map from int32 => int32
2262message MapEntryInt32Int32 {
2263 // the key
2264 optional int32 key = 1;
2265
2266 // the value
2267 optional int32 value = 2;
2268}
2269
2270message LinkProbeStats {
2271 enum LinkProbeFailureReason {
2272 // unknown reason
2273 LINK_PROBE_FAILURE_REASON_UNKNOWN = 0;
2274
2275 // Specified MCS rate when it is unsupported by the driver.
2276 LINK_PROBE_FAILURE_REASON_MCS_UNSUPPORTED = 1;
2277
2278 // Driver reported that no ACK was received for the transmitted probe.
2279 LINK_PROBE_FAILURE_REASON_NO_ACK = 2;
2280
2281 // Driver failed to report on the status of the transmitted probe within the timeout.
2282 LINK_PROBE_FAILURE_REASON_TIMEOUT = 3;
2283
2284 // An existing link probe is in progress.
2285 LINK_PROBE_FAILURE_REASON_ALREADY_STARTED = 4;
2286 }
2287
2288 // Counts the number of failures for each failure reason.
2289 message LinkProbeFailureReasonCount {
2290 // The failure reason.
2291 optional LinkProbeFailureReason failure_reason = 1;
2292
2293 // The number of occurrences for this failure reason.
2294 optional int32 count = 2;
2295 }
2296
2297 // Counts the occurrences of RSSI values when a link probe succeeds.
2298 repeated MapEntryInt32Int32 success_rssi_counts = 1;
2299
2300 // Counts the occurrences of RSSI values when a link probe fails.
2301 repeated MapEntryInt32Int32 failure_rssi_counts = 2;
2302
2303 // Counts the occurrences of Link Speed values when a link probe succeeds.
2304 repeated MapEntryInt32Int32 success_link_speed_counts = 3;
2305
2306 // Counts the occurrences of Link Speed values when a link probe fails.
2307 repeated MapEntryInt32Int32 failure_link_speed_counts = 4;
2308
2309 // Histogram for the number of seconds since the last TX success when a link probe succeeds.
2310 repeated HistogramBucketInt32 success_seconds_since_last_tx_success_histogram = 5;
2311
2312 // Histogram for the number of seconds since the last TX success when a link probe fails.
2313 repeated HistogramBucketInt32 failure_seconds_since_last_tx_success_histogram = 6;
2314
2315 // Histogram for the elapsed time of successful link probes, in ms.
2316 repeated HistogramBucketInt32 success_elapsed_time_ms_histogram = 7;
2317
2318 // Counts the occurrences of error codes for failed link probes.
2319 repeated LinkProbeFailureReasonCount failure_reason_counts = 8;
2320}
David Sua04f5052019-02-20 17:42:28 -08002321
2322// Stores the decisions that were made by a experiment when compared against another experiment
2323message NetworkSelectionExperimentDecisions {
2324 // the id of one experiment
2325 optional int32 experiment1_id = 1;
2326
2327 // the id of the other experiment
2328 optional int32 experiment2_id = 2;
2329
2330 // Counts occurrences of the number of network choices there were when experiment1 makes the
2331 // same network selection as experiment2.
2332 // The keys are the number of network choices, and the values are the number of occurrences of
2333 // this number of network choices when exp1 and exp2 make the same network selection.
2334 repeated MapEntryInt32Int32 same_selection_num_choices_counter = 3;
2335
2336 // Counts occurrences of the number of network choices there were when experiment1 makes the
2337 // same network selection as experiment2.
2338 // The keys are the number of network choices, and the values are the number of occurrences of
2339 // this number of network choices when exp1 and exp2 make different network selections.
2340 // Note that it is possible for the network selection to be different even when there only exists
2341 // a single network choice, since choosing not to connect to that network is a valid choice.
2342 repeated MapEntryInt32Int32 different_selection_num_choices_counter = 4;
2343}