runmat 0.4.5

High-performance MATLAB/Octave syntax mathematical runtime
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

mod client;
mod transport;

use once_cell::sync::OnceCell;
use runmat_config::TelemetryConfig as RuntimeTelemetryConfig;
use runmat_core::TelemetrySink;
use std::sync::Arc;

pub use runmat_telemetry::{ProviderSnapshot, RuntimeExecutionCounters, TelemetryRunKind};

use self::client::TelemetryClient;

static CLIENT: OnceCell<Arc<TelemetryClient>> = OnceCell::new();

/// Initialize the CLI telemetry transport sink (host-only).
pub fn init(config: &RuntimeTelemetryConfig) {
    if !config.enabled {
        return;
    }
    let options = client::TelemetryOptions::from(config);
    if !options.enabled {
        return;
    }
    let client = Arc::new(TelemetryClient::new(options));
    let _ = CLIENT.set(client);
}

/// Returns the configured telemetry sink for `runmat-core`, if enabled.
pub fn sink() -> Option<Arc<dyn TelemetrySink>> {
    CLIENT
        .get()
        .map(|client| client.clone() as Arc<dyn TelemetrySink>)
}

/// Drain any queued telemetry before the process exits.
pub fn shutdown() {
    if let Some(client) = CLIENT.get() {
        client.shutdown();
    }
}

/// Capture the current acceleration provider snapshot, if one is registered.
pub fn capture_provider_snapshot() -> Option<ProviderSnapshot> {
    runmat_accelerate_api::provider().map(|provider| ProviderSnapshot {
        device: provider.device_info_struct(),
        telemetry: provider.telemetry_snapshot(),
    })
}

/// Surface the stable client id used for analytics so other components can reuse it.
pub fn telemetry_client_id() -> Option<String> {
    transport::stable_client_id()
}