feat(walltime): add samply profiler for macOS

Author: not-matthias

src/executor/wall_time/executor.rs

@@ -2,6 +2,7 @@ use super::helpers::validate_walltime_results;
 use super::isolation::wrap_with_isolation;
 use super::profiler::Profiler;
 use super::profiler::perf::PerfProfiler;
+use super::profiler::samply::SamplyProfiler;
 use crate::executor::Executor;
 use crate::executor::ExecutorConfig;
 use crate::executor::ToolStatus;
@@ -84,6 +85,8 @@ impl WallTimeExecutor {
     pub fn new() -> Self {
         let profiler: Option<Box<dyn Profiler>> = if cfg!(target_os = "linux") {
             Some(Box::new(PerfProfiler::new()))
+        } else if cfg!(target_os = "macos") {
+            Some(Box::new(SamplyProfiler::new()))
         } else {
             None
         };

src/executor/wall_time/profiler/mod.rs

@@ -5,6 +5,7 @@
 //! in the profile folder.
 
 pub mod perf;
+pub mod samply;
 
 const WALLTIME_METADATA_CURRENT_VERSION: u64 = 1;
 

src/executor/wall_time/profiler/samply/mod.rs

@@ -0,0 +1,102 @@
+//! Samply profiler integration.
+
+use crate::executor::ExecutorConfig;
+use crate::executor::helpers::command::CommandBuilder;
+use crate::executor::shared::fifo::FifoBenchmarkData;
+use crate::executor::wall_time::profiler::Profiler;
+use crate::prelude::*;
+use async_trait::async_trait;
+use runner_shared::artifacts::ArtifactExt;
+use runner_shared::artifacts::ExecutionTimestamps;
+use runner_shared::metadata::WalltimeMetadata;
+use std::path::Path;
+use std::path::PathBuf;
+
+use super::WALLTIME_METADATA_CURRENT_VERSION;
+
+const SAMPLY_OUTPUT_FILE_NAME: &str = "samply-profile.json.gz";
+const SAMPLY_RATE_HZ: &str = "997";
+
+pub struct SamplyProfiler {
+    /// Set by [`Profiler::wrap`]. Currently unused after `wrap` returns —
+    /// samply writes the file itself — but we hold onto it so future
+    /// `finalize` work (e.g. validation, conversion) has the path on hand.
+    output_path: Option<PathBuf>,
+}
+
+impl SamplyProfiler {
+    pub fn new() -> Self {
+        Self { output_path: None }
+    }
+}
+
+#[async_trait(?Send)]
+impl Profiler for SamplyProfiler {
+    async fn wrap(
+        &mut self,
+        mut cmd_builder: CommandBuilder,
+        _config: &ExecutorConfig,
+        profile_folder: &Path,
+    ) -> anyhow::Result<CommandBuilder> {
+        let output_path = profile_folder.join(SAMPLY_OUTPUT_FILE_NAME);
+
+        let mut samply_builder = CommandBuilder::new("samply");
+        samply_builder.args([
+            "record",
+            "--reuse-threads",
+            "--unstable-presymbolicate",
+            "--no-open",
+            "--save-only",
+            "--rate",
+            SAMPLY_RATE_HZ,
+        ]);
+        samply_builder.arg("-o");
+        samply_builder.arg(&output_path);
+        samply_builder.arg("--");
+
+        cmd_builder.wrap_with(samply_builder);
+        self.output_path = Some(output_path);
+        Ok(cmd_builder)
+    }
+
+    async fn finalize(
+        &mut self,
+        fifo_data: FifoBenchmarkData,
+        timestamps: ExecutionTimestamps,
+        profile_folder: &Path,
+    ) -> anyhow::Result<()> {
+        let Some(integration) = fifo_data.integration.clone() else {
+            warn!(
+                "Walltime profiling is enabled, but failed to detect benchmarks. If you wish to disable this warning, set CODSPEED_PROFILER_ENABLED=false"
+            );
+            return Ok(());
+        };
+
+        #[allow(deprecated)]
+        let metadata = WalltimeMetadata {
+            version: WALLTIME_METADATA_CURRENT_VERSION,
+            integration,
+            uri_by_ts: timestamps.uri_by_ts.clone(),
+            markers: timestamps.markers.clone(),
+
+            // These fields aren't required in samply, since we symbolicate client-side.
+            ignored_modules_by_pid: Default::default(),
+            debug_info: Default::default(),
+            mapped_process_debug_info_by_pid: Default::default(),
+            mapped_process_unwind_data_by_pid: Default::default(),
+            mapped_process_module_symbols: Default::default(),
+            path_key_to_path: Default::default(),
+
+            // Deprecated fields below are no longer used
+            debug_info_by_pid: Default::default(),
+            ignored_modules: Default::default(),
+        };
+        metadata.save_to(profile_folder).unwrap();
+
+        if let Err(e) = timestamps.save_to(profile_folder) {
+            warn!("Failed to save execution timestamps: {e:?}");
+        }
+
+        Ok(())
+    }
+}