re_viewer/viewer_analytics/
mod.rs

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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
//! Most analytics events collected by the Rerun Viewer are defined in this file.
//!
//! All events are defined in the `re_analytics` crate: <https://github.com/rerun-io/rerun/blob/main/crates/utils/re_analytics/src/event.rs>
//!
//! Analytics can be completely disabled with `rerun analytics disable`,
//! or by compiling rerun without the `analytics` feature flag.

#[cfg(feature = "analytics")]
mod event;

#[cfg(feature = "analytics")]
mod wsl;

use crate::AppEnvironment;
use crate::StartupOptions;

pub struct ViewerAnalytics {
    #[cfg(feature = "analytics")]
    app_env: AppEnvironment,

    // NOTE: Optional because it is possible to have the `analytics` feature flag enabled
    // while at the same time opting-out of analytics at run-time.
    #[cfg(feature = "analytics")]
    analytics: Option<re_analytics::Analytics>,
}

impl ViewerAnalytics {
    #[allow(unused_mut, clippy::let_and_return)]
    pub fn new(startup_options: &StartupOptions, app_env: AppEnvironment) -> Self {
        re_tracing::profile_function!();

        #[cfg(feature = "analytics")]
        {
            let analytics = {
                if startup_options.is_in_notebook {
                    None
                } else {
                    match re_analytics::Analytics::new(std::time::Duration::from_secs(2)) {
                        Ok(analytics) => Some(analytics),
                        Err(err) => {
                            re_log::error!(%err, "failed to initialize analytics SDK");
                            None
                        }
                    }
                }
            };
            Self { app_env, analytics }
        }

        #[cfg(not(feature = "analytics"))]
        {
            let _ = (startup_options, app_env);
            Self {}
        }
    }

    /// When the viewer is first started
    #[allow(unused_variables)]
    pub fn on_viewer_started(
        &self,
        build_info: re_build_info::BuildInfo,
        adapter_backend: wgpu::Backend,
        device_tier: re_renderer::device_caps::DeviceCapabilityTier,
    ) {
        re_tracing::profile_function!();

        #[cfg(feature = "analytics")]
        {
            let Some(analytics) = self.analytics.as_ref() else {
                return;
            };

            analytics.record(event::identify(
                analytics.config(),
                build_info,
                &self.app_env,
            ));
            analytics.record(event::viewer_started(
                &self.app_env,
                adapter_backend,
                device_tier,
            ));
        }
    }

    /// When we have loaded the start of a new recording.
    pub fn on_open_recording(&self, entity_db: &re_entity_db::EntityDb) {
        #[cfg(feature = "analytics")]
        {
            if entity_db.store_kind() != re_log_types::StoreKind::Recording {
                return;
            }

            let Some(analytics) = self.analytics.as_ref() else {
                return;
            };

            if let Some(event) = event::open_recording(&self.app_env, entity_db) {
                analytics.record(event);
            }
        }

        #[cfg(not(feature = "analytics"))]
        let _ = entity_db;
    }
}