Implementation for full energibridge logging with self-measure

Author: mhkarsten

examples/measure-self-profiling/README.md

@@ -23,13 +23,14 @@ Optionally set self_measure_bin to the path of your executable.
 From the root directory of the repo, run the following command:
 
 ```bash
-python experiment-runner/ examples/energibridge-profiling/RunnerConfig.py
+python experiment-runner/ examples/measure-self-profiling/RunnerConfig.py
 ```
 
 ## Results
 
-The results are generated in the `examples/energibridge-profiling/experiments` folder.
+The results are generated in the `examples/measure-self-profiling/experiments` folder, and are added to your run table model.
+A log file can be specified to additionally save the full energibridge logs to a separate file.
 
-**!!! WARNING !!!**: COLUMNS IN THE `energibridge.csv` FILES CAN BE DIFFERENT ACROSS MACHINES.
-ADJUST THE DATAFRAME COLUMN NAMES ACCORDINGLY.
+**!!! WARNING !!!**: COLUMNS IN THE `energibridge.log` FILES CAN BE DIFFERENT ACROSS MACHINES.
+ADJUST YOUR ANALYSIS OF THE RESULTS ACCORDINGLY.
 

examples/measure-self-profiling/RunnerConfig.py

@@ -31,7 +31,7 @@ class RunnerConfig:
     time_between_runs_in_ms:    int             = 1000
 
     """
-    Whether EnergiBridge should be used to measure the energy consumption of the entire system durring
+    Whether EnergiBridge should be used to measure the energy consumption of the entire system during
     the experiment. 
 
     This parameter is optional and defaults to False
@@ -40,11 +40,19 @@ class RunnerConfig:
 
     """
     Where the EnergiBridge executable is located. As its not a package on linux distros, and must be 
-    installed manually install location can vary.
+    installed manually, the install location can vary.
 
     This parameter is optional and defaults to /usr/local/bin/energibridge
     """
     self_measure_bin:           Path            = "/usr/local/bin/energibridge"
+    
+    """
+    Where to save the full log files for energibridge. If specified, log files are saved to context.run_dir/<self_measure_logfile>.
+    If self_measure_logfile is None, then no log file is generated.
+
+    This parameter is optional and defaults to None, where only summary results will be saved in the run table.
+    """
+    self_measure_logfile:       Path            = "energibridge.log"
 
     # Dynamic configurations can be one-time satisfied here before the program takes the config as-is
     # e.g. Setting some variable based on some criteria

experiment-runner/ConfigValidator/Config/Validation/ConfigValidator.py

@@ -24,7 +24,7 @@ def __check_expression(name, value, expected, expression):
 
     # Verifies that an energybridge executable is present, and can be executed without error
     @staticmethod
-    def __validate_energibridge(measure_enabled, eb_path):
+    def __validate_energibridge(measure_enabled, eb_path, eb_logfile):
         # Do nothing if its not enabled
         if not measure_enabled:
             return
@@ -36,7 +36,13 @@ def __validate_energibridge(measure_enabled, eb_path):
             ConfigValidator.error_found = True
             ConfigValidator \
             .config_values_or_exception_dict["EnergiBridge"] = "EnergiBridge executable was not present or valid"
-
+        
+        if  eb_logfile \
+            and not is_path_exists_or_creatable_portable(eb_logfile):
+            ConfigValidator.error_found = True
+            ConfigValidator \
+            .config_values_or_exception_dict["EnergiBridge"] = f"EnergiBridge logfile ({eb_logfile}) was not a valid path"
+        
         # Test run to see if energibridge works
         try:
             eb_args = [eb_path, "--summary", "-o", "/dev/null", "--", "sleep", "0.5"]
@@ -70,13 +76,17 @@ def validate_config(config: RunnerConfig):
         if '~' in str(config.experiment_path):
             config.experiment_path = config.experiment_path.expanduser()
 
-        # Set defaults to support configs without the self_measure parameter
+        # Set defaults to support configs without the self_measure parameter and friends
         if not hasattr(config, "self_measure"):
             config.self_measure = False
 
-        if config.self_measure and not hasattr(config, "self_measure_bin"):
-            config.self_measure_bin = "/usr/local/bin/energibridge" # This is spesific to linux, might work for osx as well
-
+        if config.self_measure:
+            if not hasattr(config, "self_measure_bin"):
+                config.self_measure_bin = "/usr/local/bin/energibridge" # This is spesific to linux, might work for osx as well
+            
+            if not hasattr(config, "self_measure_logfile"):
+                config.self_measure_logfile = None
+            
         # Convert class to dictionary with utility method
         ConfigValidator.config_values_or_exception_dict = class_to_dict(config)
 
@@ -102,7 +112,10 @@ def validate_config(config: RunnerConfig):
                             (lambda a, b: is_path_exists_or_creatable_portable(a))
                         )
 
-        ConfigValidator.__validate_energibridge(config.self_measure, config.self_measure_bin)
+        ConfigValidator.__validate_energibridge(config.self_measure, 
+                                                config.self_measure_bin, 
+                                                config.self_measure_logfile
+                        )
 
         # Display config in user-friendly manner, including potential errors found
         print(

experiment-runner/ExperimentOrchestrator/Experiment/Run/RunController.py

@@ -1,4 +1,5 @@
 import subprocess
+import os
 
 from ProgressManager.RunTable.Models.RunProgress import RunProgress
 from EventManager.Models.RunnerEvents import RunnerEvents
@@ -13,8 +14,15 @@ def start_eb(self):
         if not self.config.self_measure:
             return
 
-        eb_args = [self.config.self_measure_bin, "--summary",
-                   "-o", "/dev/null", "--", "sleep", "1000000"]
+        eb_args = [self.config.self_measure_bin, "--summary"]
+
+        if self.config.self_measure_logfile:
+            eb_args += ["--output", 
+                        os.path.join(self.run_context.run_dir.resolve(), self.config.self_measure_logfile)]
+        else:
+            eb_args += ["-o", "/dev/null"]
+
+        eb_args += ["--", "sleep", "1000000"]
 
         try:
             self.eb_proc = subprocess.Popen(eb_args, stdout=subprocess.PIPE,