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