feat: custom emissions file (#93)

Author: inimaz

README.md

@@ -90,6 +90,7 @@ This extension contributes the following settings:
 
 -   `codecarbon.launchOnStartup`: If true, the extension will start tracking the emissions when you open a new window. Defaults to true.
 -   `codecarbon.notifications`: Notification policy for popups. Use `default` to show start/stop info and recoverable warnings, or `minimal` to only show blocking errors.
+-   `codecarbon.emissionsFile`: Optional CSV destination path. Set an absolute path (for example in your home directory) to use one central `emissions.csv` across workspaces.
 
 ## Contributing
 

package.json

@@ -94,6 +94,11 @@
             "Only show blocking errors as popups. Use output logs for diagnostics.",
             "Show start/stop info popups and warnings for recoverable setup issues."
           ]
+        },
+        "codecarbon.emissionsFile": {
+          "default": "",
+          "description": "Optional path for emissions CSV output. Use an absolute path for a central file shared across workspaces, or a relative path resolved from the workspace.",
+          "type": "string"
         }
       }
     },
@@ -157,4 +162,4 @@
     "prettier": "^3.8.1",
     "typescript": "^5.9.3"
   }
-}
+}

src/scripts/tracker.py

@@ -5,17 +5,35 @@
 import time
 import signal
 import json
+import argparse
+import os
 from codecarbon import EmissionsTracker
 from metrics_utils import to_number
 
 
 # Redirect stderr to stdout
 sys.stderr = sys.stdout
 
-# Force single-run mode to prevent parallel trackers writing to the same outputs.
-tracker = EmissionsTracker(allow_multiple_runs=False)
+def create_tracker(emissions_file_path=None):
+    """Create tracker in single-run mode, optionally overriding CSV destination."""
+    if not emissions_file_path:
+        return EmissionsTracker(allow_multiple_runs=False)
+
+    normalized = os.path.abspath(os.path.expanduser(emissions_file_path))
+    output_dir = os.path.dirname(normalized)
+    output_file = os.path.basename(normalized)
+    if not output_dir:
+        output_dir = "."
+
+    return EmissionsTracker(
+        allow_multiple_runs=False,
+        output_dir=output_dir,
+        output_file=output_file,
+    )
+
 running = True  # Global variable to control the loop
 DEFAULT_UPDATE_INTERVAL = 5.0
+tracker = None
 
 
 def get_measure_power_secs():
@@ -143,6 +161,11 @@ def signal_handler(sig, frame):
     print("Starting the tracker...")
     command = sys.argv[1].lower()
     if command == "start":
+        parser = argparse.ArgumentParser(add_help=False)
+        parser.add_argument("--emissions-file", dest="emissions_file", default="")
+        args, _ = parser.parse_known_args(sys.argv[2:])
+        tracker = create_tracker(args.emissions_file or None)
+
         # Register the signal handlers for graceful shutdown
         signal.signal(signal.SIGINT, signal_handler)  # Handle Ctrl+C
         signal.signal(signal.SIGTERM, signal_handler)  # Handle termination signal

src/services/trackerService.ts

@@ -7,6 +7,7 @@ import { ChildProcess, spawn } from 'child_process';
 import * as vscode from 'vscode';
 import * as path from 'path';
 import * as fs from 'fs/promises';
+import * as os from 'os';
 import { LogService } from './logService';
 import { PythonService } from './pythonService';
 import { ConfigService } from '../utils/config';
@@ -59,10 +60,14 @@ export class TrackerService {
 
         const pythonPath = ConfigService.getPythonPath();
         const workspacePath = ConfigService.getWorkspaceFolderPath();
+        const emissionsFilePath = this.resolveEmissionsFilePath(ConfigService.getEmissionsFilePath(), workspacePath);
         if (workspacePath) {
             this.logService.log(`Using workspace as tracker cwd for CodeCarbon config discovery: ${workspacePath}`);
             await this.cleanupStaleWorkspaceTracker(workspacePath);
         }
+        if (emissionsFilePath) {
+            this.logService.log(`Using configured emissions CSV path: ${emissionsFilePath}`);
+        }
         this.logService.log('Run policy: single active CodeCarbon tracker per workspace (recommended).');
 
         try {
@@ -74,7 +79,11 @@ export class TrackerService {
 
             // Start the tracker process
             this.stoppingRequested = false;
-            this.pythonProcess = spawn(pythonPath, [TRACKER_SCRIPT, 'start'], workspacePath ? { cwd: workspacePath } : undefined);
+            const trackerArgs = [TRACKER_SCRIPT, 'start'];
+            if (emissionsFilePath) {
+                trackerArgs.push('--emissions-file', emissionsFilePath);
+            }
+            this.pythonProcess = spawn(pythonPath, trackerArgs, workspacePath ? { cwd: workspacePath } : undefined);
             if (workspacePath && this.pythonProcess.pid) {
                 await this.writePidFile(workspacePath, this.pythonProcess.pid);
             }
@@ -240,4 +249,21 @@ export class TrackerService {
             this.logService.parseLogs(routed.parsePayload);
         }
     }
+
+    private resolveEmissionsFilePath(configuredPath: string | undefined, workspacePath?: string): string | undefined {
+        if (!configuredPath) {
+            return undefined;
+        }
+        if (configuredPath.startsWith('~')) {
+            const withoutTilde = configuredPath.slice(1).replace(/^[/\\]/, '');
+            return path.resolve(os.homedir(), withoutTilde);
+        }
+        if (path.isAbsolute(configuredPath)) {
+            return configuredPath;
+        }
+        if (workspacePath) {
+            return path.resolve(workspacePath, configuredPath);
+        }
+        return path.resolve(configuredPath);
+    }
 }

src/utils/config.ts

@@ -53,6 +53,12 @@ export class ConfigService {
         return resolveNotificationMode((section, defaultValue) => config.get(section, defaultValue));
     }
 
+    public static getEmissionsFilePath(): string | undefined {
+        const config = this.getConfiguration();
+        const value = config.get<string>(CONFIGURATION_KEYS.EMISSIONS_FILE, '').trim();
+        return value || undefined;
+    }
+
     public static getWorkspaceFolderPath(): string | undefined {
         const folder = vscode.workspace.workspaceFolders?.[0];
         return folder?.uri.fsPath;

src/utils/constants.ts

@@ -21,6 +21,7 @@ export const CONFIGURATION_KEYS = {
     INSTALL_STRATEGY: 'installStrategy',
     CUSTOM_PIP_ARGS: 'customPipArgs',
     NOTIFICATIONS: 'notifications',
+    EMISSIONS_FILE: 'emissionsFile',
 } as const;
 
 export const MESSAGES = {

tests/python/test_tracker_policy.py

@@ -13,6 +13,14 @@ def test_tracker_disables_multiple_runs(self):
             "tracker.py must enforce allow_multiple_runs=False to prevent duplicate tracker sessions.",
         )
 
+    def test_tracker_supports_emissions_file_override(self):
+        tracker_script = pathlib.Path("src/scripts/tracker.py").read_text(encoding="utf-8")
+        self.assertIn(
+            '--emissions-file',
+            tracker_script,
+            "tracker.py should support overriding the CSV destination via --emissions-file.",
+        )
+
 
 if __name__ == "__main__":
     unittest.main()