feat(walltime): rename CODSPEED_PERF_ENABLED to CODSPEED_PROFILER_ENABLED

Introduce --enable-profiler / CODSPEED_PROFILER_ENABLED as the canonical
flag now that walltime profiling is profiler-agnostic. The legacy
--enable-perf / CODSPEED_PERF_ENABLED is kept as a hidden alias and
emits a deprecation warning when used, so existing configurations keep
working.

Author: not-matthias

src/cli/exec/mod.rs

@@ -78,7 +78,7 @@ fn build_orchestrator_config(
         modes,
         instruments: Instruments { mongodb: None }, // exec doesn't support MongoDB
         perf_unwinding_mode: args.shared.perf_run_args.perf_unwinding_mode,
-        enable_perf: args.shared.perf_run_args.enable_perf,
+        enable_profiler: args.shared.perf_run_args.resolve_enable_profiler(),
         simulation_tool: args.shared.simulation_tool.unwrap_or_default(),
         profile_folder: args.shared.profile_folder,
         skip_upload: args.shared.skip_upload,

src/cli/run/mod.rs

@@ -70,7 +70,8 @@ impl RunArgs {
                 show_full_output: false,
                 base: None,
                 perf_run_args: PerfRunArgs {
-                    enable_perf: false,
+                    enable_profiler: false,
+                    enable_perf: None,
                     perf_unwinding_mode: None,
                 },
                 experimental: ExperimentalArgs {
@@ -112,7 +113,7 @@ fn build_orchestrator_config(
         modes,
         instruments,
         perf_unwinding_mode: args.shared.perf_run_args.perf_unwinding_mode,
-        enable_perf: args.shared.perf_run_args.enable_perf,
+        enable_profiler: args.shared.perf_run_args.resolve_enable_profiler(),
         simulation_tool: args.shared.simulation_tool.unwrap_or_default(),
         profile_folder: args.shared.profile_folder,
         skip_upload: args.shared.skip_upload,

src/cli/shared.rs

@@ -152,16 +152,34 @@ pub enum UnwindingMode {
 
 #[derive(Args, Debug, Clone)]
 pub struct PerfRunArgs {
-    /// Enable the linux perf profiler to collect granular performance data.
+    /// Enable a profiler to collect granular performance data.
     /// This is only supported on Linux.
-    #[arg(long, env = "CODSPEED_PERF_ENABLED", default_value_t = true)]
-    pub enable_perf: bool,
+    #[arg(long, env = "CODSPEED_PROFILER_ENABLED", default_value_t = true)]
+    pub enable_profiler: bool,
+
+    /// Deprecated alias for --enable-profiler / CODSPEED_PROFILER_ENABLED.
+    #[arg(long, env = "CODSPEED_PERF_ENABLED", hide = true)]
+    pub enable_perf: Option<bool>,
 
     /// The unwinding mode that should be used with perf to collect the call stack.
     #[arg(long, env = "CODSPEED_PERF_UNWINDING_MODE")]
     pub perf_unwinding_mode: Option<UnwindingMode>,
 }
 
+impl PerfRunArgs {
+    /// Resolves the effective `enable_profiler` value, honoring the deprecated
+    /// `--enable-perf` / `CODSPEED_PERF_ENABLED` flag with a warning.
+    pub fn resolve_enable_profiler(&self) -> bool {
+        let Some(legacy) = self.enable_perf else {
+            return self.enable_profiler;
+        };
+        log::warn!(
+            "CODSPEED_PERF_ENABLED / --enable-perf is deprecated; use CODSPEED_PROFILER_ENABLED / --enable-profiler instead."
+        );
+        legacy
+    }
+}
+
 /// Parser for go-runner version that validates semver format
 fn parse_version(s: &str) -> Result<semver::Version, String> {
     semver::Version::parse(s).map_err(|e| format!("Invalid semantic version: {e}"))

src/executor/config.rs

@@ -59,7 +59,7 @@ pub struct OrchestratorConfig {
 
     pub modes: Vec<RunnerMode>,
     pub instruments: Instruments,
-    pub enable_perf: bool,
+    pub enable_profiler: bool,
     /// Stack unwinding mode for perf (if enabled)
     pub perf_unwinding_mode: Option<UnwindingMode>,
 
@@ -96,7 +96,7 @@ pub struct ExecutorConfig {
     pub command: String,
 
     pub instruments: Instruments,
-    pub enable_perf: bool,
+    pub enable_profiler: bool,
     /// Stack unwinding mode for perf (if enabled)
     pub perf_unwinding_mode: Option<UnwindingMode>,
 
@@ -181,7 +181,7 @@ impl OrchestratorConfig {
             working_directory: self.working_directory.clone(),
             command,
             instruments: self.instruments.clone(),
-            enable_perf: self.enable_perf,
+            enable_profiler: self.enable_profiler,
             perf_unwinding_mode: self.perf_unwinding_mode,
             simulation_tool: self.simulation_tool,
             skip_run: self.skip_run,
@@ -217,7 +217,7 @@ impl OrchestratorConfig {
             modes: vec![RunnerMode::Simulation],
             instruments: Instruments::test(),
             perf_unwinding_mode: None,
-            enable_perf: false,
+            enable_profiler: false,
             simulation_tool: SimulationTool::default(),
             profile_folder: None,
             skip_upload: false,

src/executor/tests.rs

@@ -239,21 +239,24 @@ mod walltime {
         (permit, WallTimeExecutor::new())
     }
 
-    fn walltime_config(command: &str, enable_perf: bool) -> ExecutorConfig {
+    fn walltime_config(command: &str, enable_profiler: bool) -> ExecutorConfig {
         ExecutorConfig {
             command: command.to_string(),
-            enable_perf,
+            enable_profiler,
             ..ExecutorConfig::test()
         }
     }
 
     #[apply(test_cases)]
     #[rstest::rstest]
     #[test_log::test(tokio::test)]
-    async fn test_walltime_executor(#[case] cmd: &str, #[values(false, true)] enable_perf: bool) {
+    async fn test_walltime_executor(
+        #[case] cmd: &str,
+        #[values(false, true)] enable_profiler: bool,
+    ) {
         let (_permit, mut executor) = get_walltime_executor().await;
 
-        let config = walltime_config(cmd, enable_perf);
+        let config = walltime_config(cmd, enable_profiler);
         // Unset GITHUB_ACTIONS to force LocalProvider which supports repository_override
         temp_env::async_with_vars(&[("GITHUB_ACTIONS", None::<&str>)], async {
             let (execution_context, _temp_dir) = create_test_setup(config).await;
@@ -267,7 +270,7 @@ mod walltime {
     #[test_log::test(tokio::test)]
     async fn test_walltime_executor_with_env(
         #[case] env_case: (&str, &str),
-        #[values(false, true)] enable_perf: bool,
+        #[values(false, true)] enable_profiler: bool,
     ) {
         let (_permit, mut executor) = get_walltime_executor().await;
 
@@ -276,7 +279,7 @@ mod walltime {
             &[(env_var, Some(env_value)), ("GITHUB_ACTIONS", None)],
             async {
                 let cmd = env_var_validation_script(env_var, env_value);
-                let config = walltime_config(&cmd, enable_perf);
+                let config = walltime_config(&cmd, enable_profiler);
                 let (execution_context, _temp_dir) = create_test_setup(config).await;
                 executor.run(&execution_context, &None).await.unwrap();
             },
@@ -287,7 +290,7 @@ mod walltime {
     // Ensure that the working directory is used correctly
     #[rstest::rstest]
     #[test_log::test(tokio::test)]
-    async fn test_walltime_executor_in_working_dir(#[values(false, true)] enable_perf: bool) {
+    async fn test_walltime_executor_in_working_dir(#[values(false, true)] enable_profiler: bool) {
         let (_permit, mut executor) = get_walltime_executor().await;
 
         let cmd = r#"
@@ -297,7 +300,7 @@ if [ "$(basename "$(pwd)")" != "within_sub_directory" ]; then
 fi
 "#;
 
-        let mut config = walltime_config(cmd, enable_perf);
+        let mut config = walltime_config(cmd, enable_profiler);
 
         let dir = TempDir::new().unwrap();
         config.working_directory = Some(
@@ -319,10 +322,10 @@ fi
     // Ensure that commands that fail actually fail
     #[rstest::rstest]
     #[test_log::test(tokio::test)]
-    async fn test_walltime_executor_fails(#[values(false, true)] enable_perf: bool) {
+    async fn test_walltime_executor_fails(#[values(false, true)] enable_profiler: bool) {
         let (_permit, mut executor) = get_walltime_executor().await;
 
-        let config = walltime_config("exit 1", enable_perf);
+        let config = walltime_config("exit 1", enable_profiler);
         // Unset GITHUB_ACTIONS to force LocalProvider which supports repository_override
         temp_env::async_with_vars(&[("GITHUB_ACTIONS", None::<&str>)], async {
             let (execution_context, _temp_dir) = create_test_setup(config).await;

src/executor/wall_time/executor.rs

@@ -159,7 +159,7 @@ impl Executor for WallTimeExecutor {
             WallTimeExecutor::walltime_bench_cmd(&execution_context.config, execution_context)?;
 
         let status = match self.profiler.as_mut() {
-            Some(profiler) if execution_context.config.enable_perf => {
+            Some(profiler) if execution_context.config.enable_profiler => {
                 run_with_profiler(
                     profiler.as_mut(),
                     cmd_builder,

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

@@ -237,7 +237,7 @@ impl Profiler for PerfProfiler {
             bench_data.save_to(profile_folder, perf_file_path).await
         {
             warn!(
-                "Perf is enabled, but failed to detect benchmarks. If you wish to disable this warning, set CODSPEED_PERF_ENABLED=false"
+                "Perf is enabled, but failed to detect benchmarks. If you wish to disable this warning, set CODSPEED_PROFILER_ENABLED=false"
             );
             return Ok(());
         }