wlan_telemetry/
lib.rs

1// Copyright 2024 The Fuchsia Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4use anyhow::{Context as _, Error, format_err};
5use fidl_fuchsia_power_battery as fidl_battery;
6use fidl_fuchsia_wlan_ieee80211 as fidl_ieee80211;
7use fidl_fuchsia_wlan_internal as fidl_internal;
8use fuchsia_async as fasync;
9use fuchsia_inspect::Node as InspectNode;
10use futures::channel::mpsc;
11use futures::{Future, StreamExt, select};
12use log::error;
13use std::boxed::Box;
14use windowed_stats::experimental::inspect::TimeMatrixClient;
15use wlan_common::bss::BssDescription;
16use wlan_legacy_metrics_registry as metrics;
17
18mod processors;
19pub(crate) mod util;
20pub use crate::processors::connect_disconnect::DisconnectInfo;
21pub use crate::processors::power::{IfacePowerLevel, UnclearPowerDemand};
22pub use crate::processors::scan::ScanResult;
23pub use crate::processors::toggle_events::ClientConnectionsToggleEvent;
24pub use util::sender::TelemetrySender;
25#[cfg(test)]
26mod testing;
27
28#[derive(Debug)]
29pub enum TelemetryEvent {
30    ConnectResult {
31        result: fidl_ieee80211::StatusCode,
32        bss: Box<BssDescription>,
33        is_credential_rejected: bool,
34    },
35    Disconnect {
36        info: DisconnectInfo,
37    },
38    // We should maintain docstrings if we can see any possibility of ambiguity for an enum
39    /// Client connections enabled or disabled
40    ClientConnectionsToggle {
41        event: ClientConnectionsToggleEvent,
42    },
43    ClientIfaceCreated {
44        iface_id: u16,
45    },
46    ClientIfaceDestroyed {
47        iface_id: u16,
48    },
49    IfaceCreationFailure,
50    IfaceDestructionFailure,
51    ScanStart,
52    ScanResult {
53        result: ScanResult,
54    },
55    IfacePowerLevelChanged {
56        iface_power_level: IfacePowerLevel,
57        iface_id: u16,
58    },
59    /// System suspension imminent
60    SuspendImminent,
61    /// Unclear power level requested by policy layer
62    UnclearPowerDemand(UnclearPowerDemand),
63    BatteryChargeStatus(fidl_battery::ChargeStatus),
64    RecoveryEvent {
65        result: Result<(), ()>,
66    },
67    SmeTimeout,
68    ChipPowerUpFailure,
69    ResetTxPowerScenario,
70    SetTxPowerScenario {
71        scenario: fidl_internal::TxPowerScenario,
72    },
73}
74
75/// Attempts to connect to the Cobalt service.
76pub async fn setup_cobalt_proxy()
77-> Result<fidl_fuchsia_metrics::MetricEventLoggerProxy, anyhow::Error> {
78    let cobalt_svc = fuchsia_component::client::connect_to_protocol::<
79        fidl_fuchsia_metrics::MetricEventLoggerFactoryMarker,
80    >()
81    .context("failed to connect to metrics service")?;
82
83    let (cobalt_proxy, cobalt_server) =
84        fidl::endpoints::create_proxy::<fidl_fuchsia_metrics::MetricEventLoggerMarker>();
85
86    let project_spec = fidl_fuchsia_metrics::ProjectSpec {
87        customer_id: Some(metrics::CUSTOMER_ID),
88        project_id: Some(metrics::PROJECT_ID),
89        ..Default::default()
90    };
91
92    match cobalt_svc.create_metric_event_logger(&project_spec, cobalt_server).await {
93        Ok(_) => Ok(cobalt_proxy),
94        Err(err) => Err(format_err!("failed to create metrics event logger: {:?}", err)),
95    }
96}
97
98/// Attempts to create a disconnected FIDL channel with types matching the Cobalt service. This
99/// allows for a fallback with a uniform code path in case of a failure to connect to Cobalt.
100pub fn setup_disconnected_cobalt_proxy()
101-> Result<fidl_fuchsia_metrics::MetricEventLoggerProxy, anyhow::Error> {
102    // Create a disconnected proxy
103    Ok(fidl::endpoints::create_proxy::<fidl_fuchsia_metrics::MetricEventLoggerMarker>().0)
104}
105
106/// How often to refresh time series stats. Also how often to request packet counters.
107const TELEMETRY_QUERY_INTERVAL: zx::MonotonicDuration = zx::MonotonicDuration::from_seconds(10);
108
109pub fn serve_telemetry(
110    cobalt_proxy: fidl_fuchsia_metrics::MetricEventLoggerProxy,
111    monitor_svc_proxy: fidl_fuchsia_wlan_device_service::DeviceMonitorProxy,
112    inspect_node: InspectNode,
113    inspect_path: &str,
114) -> (TelemetrySender, impl Future<Output = Result<(), Error>> + use<>) {
115    let (sender, mut receiver) =
116        mpsc::channel::<TelemetryEvent>(util::sender::TELEMETRY_EVENT_BUFFER_SIZE);
117    let sender = TelemetrySender::new(sender);
118
119    // Inspect nodes to hold time series and metadata for other nodes
120    const METADATA_NODE_NAME: &str = "metadata";
121    let inspect_metadata_node = inspect_node.create_child(METADATA_NODE_NAME);
122    let inspect_metadata_path = format!("{inspect_path}/{METADATA_NODE_NAME}");
123    let inspect_time_series_node = inspect_node.create_child("time_series");
124    let driver_specific_time_series_node = inspect_time_series_node.create_child("driver_specific");
125    let driver_counters_time_series_node =
126        driver_specific_time_series_node.create_child("counters");
127    let driver_gauges_time_series_node = driver_specific_time_series_node.create_child("gauges");
128
129    let time_matrix_client = TimeMatrixClient::new(inspect_time_series_node.clone_weak());
130    let driver_counters_time_series_client =
131        TimeMatrixClient::new(driver_counters_time_series_node.clone_weak());
132    let driver_gauges_time_series_client =
133        TimeMatrixClient::new(driver_gauges_time_series_node.clone_weak());
134
135    // Create and initialize modules
136    let connect_disconnect = processors::connect_disconnect::ConnectDisconnectLogger::new(
137        cobalt_proxy.clone(),
138        &inspect_node,
139        &inspect_metadata_node,
140        &inspect_metadata_path,
141        &time_matrix_client,
142    );
143    let iface_logger = processors::iface::IfaceLogger::new(cobalt_proxy.clone());
144    let power_logger = processors::power::PowerLogger::new(cobalt_proxy.clone(), &inspect_node);
145    let recovery_logger = processors::recovery::RecoveryLogger::new(cobalt_proxy.clone());
146    let mut scan_logger =
147        processors::scan::ScanLogger::new(cobalt_proxy.clone(), &time_matrix_client);
148    let sme_timeout_logger = processors::sme_timeout::SmeTimeoutLogger::new(cobalt_proxy.clone());
149    let mut toggle_logger =
150        processors::toggle_events::ToggleLogger::new(cobalt_proxy.clone(), &inspect_node);
151    let tx_power_scenario_logger =
152        processors::tx_power_scenario::TxPowerScenarioLogger::new(cobalt_proxy.clone());
153
154    let client_iface_counters_logger =
155        processors::client_iface_counters::ClientIfaceCountersLogger::new(
156            cobalt_proxy,
157            monitor_svc_proxy,
158            &inspect_metadata_node,
159            &inspect_metadata_path,
160            &time_matrix_client,
161            driver_counters_time_series_client,
162            driver_gauges_time_series_client,
163        );
164
165    let fut = async move {
166        // Prevent the inspect nodes from being dropped while the loop is running.
167        let _inspect_node = inspect_node;
168        let _inspect_metadata_node = inspect_metadata_node;
169        let _inspect_time_series_node = inspect_time_series_node;
170        let _driver_specific_time_series_node = driver_specific_time_series_node;
171        let _driver_counters_time_series_node = driver_counters_time_series_node;
172        let _driver_gauges_time_series_node = driver_gauges_time_series_node;
173
174        let mut telemetry_interval = fasync::Interval::new(TELEMETRY_QUERY_INTERVAL);
175        loop {
176            select! {
177                event = receiver.next() => {
178                    let Some(event) = event else {
179                        error!("Telemetry event stream unexpectedly terminated.");
180                        return Err(format_err!("Telemetry event stream unexpectedly terminated."));
181                    };
182                    use TelemetryEvent::*;
183                    match event {
184                        ConnectResult { result, bss, is_credential_rejected } => {
185                            connect_disconnect.handle_connect_attempt(result, &bss, is_credential_rejected).await;
186                        }
187                        Disconnect { info } => {
188                            connect_disconnect.log_disconnect(&info).await;
189                            power_logger.handle_iface_disconnect(info.iface_id).await;
190                        }
191                        ClientConnectionsToggle { event } => {
192                            connect_disconnect.handle_client_connections_toggle(&event).await;
193                            toggle_logger.handle_toggle_event(event).await;
194                        }
195                        ClientIfaceCreated { iface_id } => {
196                            client_iface_counters_logger.handle_iface_created(iface_id).await;
197                        }
198                        ClientIfaceDestroyed { iface_id } => {
199                            connect_disconnect.handle_iface_destroyed().await;
200                            client_iface_counters_logger.handle_iface_destroyed(iface_id).await;
201                            power_logger.handle_iface_destroyed(iface_id).await;
202                        }
203                        IfaceCreationFailure => {
204                            iface_logger.handle_iface_creation_failure().await;
205                        }
206                        IfaceDestructionFailure => {
207                            iface_logger.handle_iface_destruction_failure().await;
208                        }
209                        ScanStart => {
210                            scan_logger.handle_scan_start().await;
211                        }
212                        ScanResult { result } => {
213                            scan_logger.handle_scan_result(result).await;
214                        }
215                        IfacePowerLevelChanged { iface_power_level, iface_id } => {
216                            power_logger.log_iface_power_event(iface_power_level, iface_id).await;
217                        }
218                        // TODO(b/340921554): either watch for suspension directly in the library,
219                        // or plumb this from callers once suspend mechanisms are integrated
220                        SuspendImminent => {
221                            power_logger.handle_suspend_imminent().await;
222                            connect_disconnect.handle_suspend_imminent().await;
223                        }
224                        UnclearPowerDemand(demand) => {
225                            power_logger.handle_unclear_power_demand(demand).await;
226                        }
227                        ChipPowerUpFailure => {
228                            power_logger.handle_chip_power_up_failure().await;
229                        }
230                        BatteryChargeStatus(charge_status) => {
231                            scan_logger.handle_battery_charge_status(charge_status).await;
232                            toggle_logger.handle_battery_charge_status(charge_status).await;
233                        }
234                        RecoveryEvent { result } => {
235                            recovery_logger.handle_recovery_event(result).await;
236                        }
237                        SmeTimeout => {
238                            sme_timeout_logger.handle_sme_timeout_event().await;
239                        }
240                        ResetTxPowerScenario => {
241                            tx_power_scenario_logger.handle_sar_reset().await;
242                        }
243                        SetTxPowerScenario {scenario} => {
244                            tx_power_scenario_logger.handle_set_sar(scenario).await;
245                        }
246                    }
247                }
248                _ = telemetry_interval.next() => {
249                    connect_disconnect.handle_periodic_telemetry().await;
250                    client_iface_counters_logger.handle_periodic_telemetry().await;
251                }
252            }
253        }
254    };
255    (sender, fut)
256}
wlan_telemetry/lib.rs

wlan_telemetry/
lib.rs
