use crate::{TelemetrySettings, ZED_SECRET_CLIENT_TOKEN, ZED_SERVER_URL}; use gpui::{serde_json, AppContext, AppMetadata, BackgroundExecutor, Task}; use lazy_static::lazy_static; use parking_lot::Mutex; use serde::Serialize; use settings::Settings; use std::{env, io::Write, mem, path::PathBuf, sync::Arc, time::Duration}; use sysinfo::{ CpuRefreshKind, Pid, PidExt, ProcessExt, ProcessRefreshKind, RefreshKind, System, SystemExt, }; use tempfile::NamedTempFile; use util::http::HttpClient; use util::{channel::ReleaseChannel, TryFutureExt}; pub struct Telemetry { http_client: Arc, executor: BackgroundExecutor, state: Mutex, } struct TelemetryState { metrics_id: Option>, // Per logged-in user installation_id: Option>, // Per app installation (different for dev, preview, and stable) session_id: Option>, // Per app launch release_channel: Option<&'static str>, app_metadata: AppMetadata, architecture: &'static str, clickhouse_events_queue: Vec, flush_clickhouse_events_task: Option>, log_file: Option, is_staff: Option, } const CLICKHOUSE_EVENTS_URL_PATH: &'static str = "/api/events"; lazy_static! { static ref CLICKHOUSE_EVENTS_URL: String = format!("{}{}", *ZED_SERVER_URL, CLICKHOUSE_EVENTS_URL_PATH); } #[derive(Serialize, Debug)] struct ClickhouseEventRequestBody { token: &'static str, installation_id: Option>, session_id: Option>, is_staff: Option, app_version: Option, os_name: &'static str, os_version: Option, architecture: &'static str, release_channel: Option<&'static str>, events: Vec, } #[derive(Serialize, Debug)] struct ClickhouseEventWrapper { signed_in: bool, #[serde(flatten)] event: ClickhouseEvent, } #[derive(Serialize, Debug)] #[serde(rename_all = "snake_case")] pub enum AssistantKind { Panel, Inline, } #[derive(Serialize, Debug)] #[serde(tag = "type")] pub enum ClickhouseEvent { Editor { operation: &'static str, file_extension: Option, vim_mode: bool, copilot_enabled: bool, copilot_enabled_for_language: bool, }, Copilot { suggestion_id: Option, suggestion_accepted: bool, file_extension: Option, }, Call { operation: &'static str, room_id: Option, channel_id: Option, }, Assistant { conversation_id: Option, kind: AssistantKind, model: &'static str, }, Cpu { usage_as_percentage: f32, core_count: u32, }, Memory { memory_in_bytes: u64, virtual_memory_in_bytes: u64, }, } #[cfg(debug_assertions)] const MAX_QUEUE_LEN: usize = 1; #[cfg(not(debug_assertions))] const MAX_QUEUE_LEN: usize = 10; #[cfg(debug_assertions)] const DEBOUNCE_INTERVAL: Duration = Duration::from_secs(1); #[cfg(not(debug_assertions))] const DEBOUNCE_INTERVAL: Duration = Duration::from_secs(30); impl Telemetry { pub fn new(client: Arc, cx: &AppContext) -> Arc { let release_channel = if cx.has_global::() { Some(cx.global::().display_name()) } else { None }; // TODO: Replace all hardware stuff with nested SystemSpecs json let this = Arc::new(Self { http_client: client, executor: cx.background_executor().clone(), state: Mutex::new(TelemetryState { app_metadata: cx.app_metadata(), architecture: env::consts::ARCH, release_channel, installation_id: None, metrics_id: None, session_id: None, clickhouse_events_queue: Default::default(), flush_clickhouse_events_task: Default::default(), log_file: None, is_staff: None, }), }); this } pub fn log_file_path(&self) -> Option { Some(self.state.lock().log_file.as_ref()?.path().to_path_buf()) } pub fn start( self: &Arc, installation_id: Option, session_id: String, cx: &mut AppContext, ) { let mut state = self.state.lock(); state.installation_id = installation_id.map(|id| id.into()); state.session_id = Some(session_id.into()); let has_clickhouse_events = !state.clickhouse_events_queue.is_empty(); drop(state); if has_clickhouse_events { self.flush_clickhouse_events(); } let this = self.clone(); cx.spawn(|cx| async move { // Avoiding calling `System::new_all()`, as there have been crashes related to it let refresh_kind = RefreshKind::new() .with_memory() // For memory usage .with_processes(ProcessRefreshKind::everything()) // For process usage .with_cpu(CpuRefreshKind::everything()); // For core count let mut system = System::new_with_specifics(refresh_kind); // Avoiding calling `refresh_all()`, just update what we need system.refresh_specifics(refresh_kind); loop { // Waiting some amount of time before the first query is important to get a reasonable value // https://docs.rs/sysinfo/0.29.10/sysinfo/trait.ProcessExt.html#tymethod.cpu_usage const DURATION_BETWEEN_SYSTEM_EVENTS: Duration = Duration::from_secs(60); smol::Timer::after(DURATION_BETWEEN_SYSTEM_EVENTS).await; system.refresh_specifics(refresh_kind); let current_process = Pid::from_u32(std::process::id()); let Some(process) = system.processes().get(¤t_process) else { let process = current_process; log::error!("Failed to find own process {process:?} in system process table"); // TODO: Fire an error telemetry event return; }; let memory_event = ClickhouseEvent::Memory { memory_in_bytes: process.memory(), virtual_memory_in_bytes: process.virtual_memory(), }; let cpu_event = ClickhouseEvent::Cpu { usage_as_percentage: process.cpu_usage(), core_count: system.cpus().len() as u32, }; let telemetry_settings = if let Ok(telemetry_settings) = cx.update(|cx| *TelemetrySettings::get_global(cx)) { telemetry_settings } else { break; }; this.report_clickhouse_event(memory_event, telemetry_settings); this.report_clickhouse_event(cpu_event, telemetry_settings); } }) .detach(); } pub fn set_authenticated_user_info( self: &Arc, metrics_id: Option, is_staff: bool, cx: &AppContext, ) { if !TelemetrySettings::get_global(cx).metrics { return; } let mut state = self.state.lock(); let metrics_id: Option> = metrics_id.map(|id| id.into()); state.metrics_id = metrics_id.clone(); state.is_staff = Some(is_staff); drop(state); } pub fn report_clickhouse_event( self: &Arc, event: ClickhouseEvent, telemetry_settings: TelemetrySettings, ) { if !telemetry_settings.metrics { return; } let mut state = self.state.lock(); let signed_in = state.metrics_id.is_some(); state .clickhouse_events_queue .push(ClickhouseEventWrapper { signed_in, event }); if state.installation_id.is_some() { if state.clickhouse_events_queue.len() >= MAX_QUEUE_LEN { drop(state); self.flush_clickhouse_events(); } else { let this = self.clone(); let executor = self.executor.clone(); state.flush_clickhouse_events_task = Some(self.executor.spawn(async move { executor.timer(DEBOUNCE_INTERVAL).await; this.flush_clickhouse_events(); })); } } } pub fn metrics_id(self: &Arc) -> Option> { self.state.lock().metrics_id.clone() } pub fn installation_id(self: &Arc) -> Option> { self.state.lock().installation_id.clone() } pub fn is_staff(self: &Arc) -> Option { self.state.lock().is_staff } fn flush_clickhouse_events(self: &Arc) { let mut state = self.state.lock(); let mut events = mem::take(&mut state.clickhouse_events_queue); state.flush_clickhouse_events_task.take(); drop(state); let this = self.clone(); self.executor .spawn( async move { let mut json_bytes = Vec::new(); if let Some(file) = &mut this.state.lock().log_file { let file = file.as_file_mut(); for event in &mut events { json_bytes.clear(); serde_json::to_writer(&mut json_bytes, event)?; file.write_all(&json_bytes)?; file.write(b"\n")?; } } { let state = this.state.lock(); let request_body = ClickhouseEventRequestBody { token: ZED_SECRET_CLIENT_TOKEN, installation_id: state.installation_id.clone(), session_id: state.session_id.clone(), is_staff: state.is_staff.clone(), app_version: state .app_metadata .app_version .map(|version| version.to_string()), os_name: state.app_metadata.os_name, os_version: state .app_metadata .os_version .map(|version| version.to_string()), architecture: state.architecture, release_channel: state.release_channel, events, }; json_bytes.clear(); serde_json::to_writer(&mut json_bytes, &request_body)?; } this.http_client .post_json(CLICKHOUSE_EVENTS_URL.as_str(), json_bytes.into()) .await?; anyhow::Ok(()) } .log_err(), ) .detach(); } }