Enum TelemetryEvent 

pub enum TelemetryEvent {
    QueryStatus {
        sender: Sender<QueryStatusResult>,
    },
    StartEstablishConnection {
        reset_start_time: bool,
    },
    ClearEstablishConnectionStartTime,
    ActiveScanRequested {
        num_ssids_requested: usize,
    },
    ActiveScanRequestedViaApi {
        num_ssids_requested: usize,
    },
    NetworkSelectionDecision {
        network_selection_type: NetworkSelectionType,
        num_candidates: Result<usize, ()>,
        selected_count: usize,
    },
    ConnectResult {
        iface_id: u16,
        policy_connect_reason: Option<ConnectReason>,
        result: ConnectResult,
        multiple_bss_candidates: bool,
        ap_state: ApState,
        network_is_likely_hidden: bool,
    },
    PolicyInitiatedRoamResult {
        iface_id: u16,
        result: RoamResult,
        updated_ap_state: ApState,
        original_ap_state: ApState,
        request: PolicyRoamRequest,
        request_time: MonotonicInstant,
        result_time: MonotonicInstant,
    },
    Disconnected {
        track_subsequent_downtime: bool,
        info: Option<DisconnectInfo>,
    },
    OnSignalReport {
        ind: SignalReportIndication,
    },
    OnSignalVelocityUpdate {
        rssi_velocity: f64,
    },
    OnChannelSwitched {
        info: ChannelSwitchInfo,
    },
    PolicyRoamScan {
        reasons: Vec<RoamReason>,
    },
    PolicyRoamAttempt {
        request: PolicyRoamRequest,
        connected_duration: MonotonicDuration,
    },
    WouldRoamConnect,
    SavedNetworkCount {
        saved_network_count: usize,
        config_count_per_saved_network: Vec<usize>,
    },
    NetworkSelectionScanInterval {
        time_since_last_scan: MonotonicDuration,
    },
    ConnectionSelectionScanResults {
        saved_network_count: usize,
        bss_count_per_saved_network: Vec<usize>,
        saved_network_count_found_by_active_scan: usize,
    },
    PostConnectionSignals {
        connect_time: MonotonicInstant,
        signal_at_connect: Signal,
        signals: HistoricalList<TimestampedSignal>,
    },
    StartClientConnectionsRequest,
    StopClientConnectionsRequest,
    StopAp {
        enabled_duration: MonotonicDuration,
    },
    IfaceCreationResult(Result<(), ()>),
    IfaceDestructionResult(Result<(), ()>),
    StartApResult(Result<(), ()>),
    ScanRequestFulfillmentTime {
        duration: MonotonicDuration,
        reason: ScanReason,
    },
    ScanQueueStatistics {
        fulfilled_requests: usize,
        remaining_requests: usize,
    },
    BssSelectionResult {
        reason: ConnectReason,
        scored_candidates: Vec<(ScannedCandidate, i16)>,
        selected_candidate: Option<(ScannedCandidate, i16)>,
    },
    ScanEvent {
        inspect_data: ScanEventInspectData,
        scan_defects: Vec<ScanIssue>,
    },
    LongDurationSignals {
        signals: Vec<TimestampedSignal>,
    },
    RecoveryEvent {
        reason: RecoveryReason,
    },
    GetTimeSeries {
        sender: Sender<Arc<Mutex<TimeSeriesStats>>>,
    },
    SmeTimeout {
        source: TimeoutSource,
    },
}

Variants

QueryStatus

Request telemetry for the latest status

Fields

sender: Sender<QueryStatusResult>

StartEstablishConnection

Notify the telemetry event loop that the process of establishing connection is started

Fields

reset_start_time: bool

If set to true, use the current time as the start time of the establish connection process. If set to false, then use the start time initialized from the previous StartEstablishConnection event, or use the current time if there isn’t an existing start time.

ClearEstablishConnectionStartTime

Clear any existing start time of establish connection process tracked by telemetry.

ActiveScanRequested

Notify the telemetry event loop of an active scan being requested.

Fields

num_ssids_requested: usize

ActiveScanRequestedViaApi

Notify the telemetry event loop of an active scan being requested via Policy API.

Fields

num_ssids_requested: usize

NetworkSelectionDecision

Notify the telemetry event loop that network selection is complete.

Fields

network_selection_type: NetworkSelectionType

Type of network selection. If it’s undirected and no candidate network is found, telemetry will toggle the “no saved neighbor” flag.

num_candidates: Result<usize, ()>

When there’s a scan error, num_candidates should be Err. When num_candidates is Ok(0) for an undirected network selection, telemetry will toggle the “no saved neighbor” flag. If the event loop is tracking downtime, the subsequent downtime period will also be used to increment the, downtime_no_saved_neighbor_duration counter. This counter is used to adjust the raw downtime.

selected_count: usize

Count of number of networks selected. This will be 0 if there are no candidates selected including if num_candidates is Ok(0) or Err. However, this will only be logged to Cobalt is num_candidates is not Err and is greater than 0.

ConnectResult

Notify the telemetry event loop of connection result. If connection result is successful, telemetry will move its internal state to connected. Subsequently, the telemetry event loop will increment the connected_duration counter periodically.

Fields

iface_id: u16

policy_connect_reason: Option<ConnectReason>

result: ConnectResult

multiple_bss_candidates: bool

ap_state: ApState

network_is_likely_hidden: bool

PolicyInitiatedRoamResult

Notify the telemetry event loop of roam result. If roam result is unsuccessful, telemetry will move its internal state to disconnected.

Fields

iface_id: u16

result: RoamResult

updated_ap_state: ApState

original_ap_state: ApState

request: PolicyRoamRequest

request_time: MonotonicInstant

result_time: MonotonicInstant

Disconnected

Notify the telemetry event loop that the client has disconnected. Subsequently, the telemetry event loop will increment the downtime counters periodically if TelemetrySender has requested downtime to be tracked via track_subsequent_downtime flag.

Fields

track_subsequent_downtime: bool

Indicates whether subsequent period should be used to increment the downtime counters.

info: Option<DisconnectInfo>

OnSignalReport

Fields

ind: SignalReportIndication

OnSignalVelocityUpdate

Fields

rssi_velocity: f64

OnChannelSwitched

Fields

info: ChannelSwitchInfo

PolicyRoamScan

Notify telemetry that there was a decision to look for networks to roam to after evaluating the existing connection.

Fields

reasons: Vec<RoamReason>

PolicyRoamAttempt

Notify telemetry that the roam monitor has decided to attempt a roam to a candidate.

Fields

request: PolicyRoamRequest

connected_duration: MonotonicDuration

WouldRoamConnect

Proactive roams do not happen yet, but we want to analyze metrics for when they would happen. Roams are set up to log metrics when disconnects happen to roam, so this event covers when roams would happen but no actual disconnect happens.

SavedNetworkCount

Counts of saved networks and count of configurations for each of those networks, to be recorded periodically.

Fields

saved_network_count: usize

config_count_per_saved_network: Vec<usize>

NetworkSelectionScanInterval

Record the time since the last network selection scan

Fields

time_since_last_scan: MonotonicDuration

ConnectionSelectionScanResults

Statistics about networks observed in scan results for Connection Selection

Fields

saved_network_count: usize

bss_count_per_saved_network: Vec<usize>

saved_network_count_found_by_active_scan: usize

PostConnectionSignals

Fields

connect_time: MonotonicInstant

signal_at_connect: Signal

signals: HistoricalList<TimestampedSignal>

StartClientConnectionsRequest

Notify telemetry of an API request to start client connections.

StopClientConnectionsRequest

Notify telemetry of an API request to stop client connections.

StopAp

Notify telemetry of when AP is stopped, and how long it was started.

Fields

enabled_duration: MonotonicDuration

IfaceCreationResult(Result<(), ()>)

Notify telemetry of the result of a create iface request.

IfaceDestructionResult(Result<(), ()>)

Notify telemetry of the result of destroying an interface.

StartApResult(Result<(), ()>)

Notify telemetry of the result of a StartAp request.

ScanRequestFulfillmentTime

Record scan fulfillment time

Fields

duration: MonotonicDuration

reason: ScanReason

ScanQueueStatistics

Record scan queue length upon scan completion

Fields

fulfilled_requests: usize

remaining_requests: usize

BssSelectionResult

Record the results of a completed BSS selection

Fields

reason: ConnectReason

scored_candidates: Vec<(ScannedCandidate, i16)>

selected_candidate: Option<(ScannedCandidate, i16)>

ScanEvent

Fields

inspect_data: ScanEventInspectData

scan_defects: Vec<ScanIssue>

LongDurationSignals

Fields

signals: Vec<TimestampedSignal>

RecoveryEvent

Record recovery events and store recovery-related metadata so that the efficacy of the recovery mechanism can be evaluated later.

Fields

reason: RecoveryReason

GetTimeSeries

Get the TimeSeries held by telemetry loop. Intended for test only.

Fields

sender: Sender<Arc<Mutex<TimeSeriesStats>>>

SmeTimeout

Fields

source: TimeoutSource