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