Merge pull request #346 from powerapi-ng/feat/socketdb-host-parameter

feat(database/socket): Allow the socket listen address to be configurable

Author: gfieni

src/powerapi/cli/common_cli_parsing_manager.py

@@ -118,7 +118,10 @@ def __init__(self):
 
         subparser_socket_input = SubgroupConfigParsingManager("socket")
         subparser_socket_input.add_argument(
-            "p", "port", argument_type=int, help_text="specify port to bind the socket"
+            "h", "host", help_text="Specify the host the socket should listen on", default_value='127.0.0.1'
+        )
+        subparser_socket_input.add_argument(
+            "p", "port", help_text="Specify the port the socket should listen on", argument_type=int, default_value=9080,
         )
         subparser_socket_input.add_argument(
             "n", "name", help_text="specify puller name", default_value="puller_socket"

src/powerapi/cli/generator.py

@@ -172,7 +172,7 @@ def __init__(self, component_group_name: str):
         self.db_factory = {
             'mongodb': lambda db_config: MongoDB(report_type=db_config['model'], uri=db_config['uri'],
                                                  db_name=db_config['db'], collection_name=db_config['collection']),
-            'socket': lambda db_config: SocketDB(report_type=db_config['model'], port=db_config['port']),
+            'socket': lambda db_config: SocketDB(db_config['model'], db_config['host'], db_config['port']),
             'csv': lambda db_config: CsvDB(report_type=db_config['model'], tags=gen_tag_list(db_config),
                                            current_path=os.getcwd() if 'directory' not in db_config else db_config[
                                                'directory'],

src/powerapi/database/socket_db.py

@@ -68,9 +68,10 @@ class SocketDB(BaseDB):
     Database that act as a server that expose a socket where data source will push data
     """
 
-    def __init__(self, report_type: Type[Report], port: int):
+    def __init__(self, report_type: Type[Report], host: str, port: int):
         BaseDB.__init__(self, report_type, is_async=True)
         self.queue = None
+        self.host = host
         self.port = port
         self.server = None
 
@@ -79,7 +80,7 @@ async def connect(self):
         Connect to the socket database.
         """
         self.queue = asyncio.Queue()
-        self.server = await asyncio.start_server(self._gen_server_callback(), host='127.0.0.1', port=self.port)
+        self.server = await asyncio.start_server(self._gen_server_callback(), host=self.host, port=self.port)
 
     async def disconnect(self):
         """

src/powerapi/report/report.py

@@ -109,15 +109,23 @@ def to_json(report: Report) -> Dict:
 
     @staticmethod
     def _extract_timestamp(ts):
+        # Unix timestamp format (in milliseconds)
+        if isinstance(ts, int):
+            return datetime.fromtimestamp(ts / 1000)
+
+        # datetime object
+        if isinstance(ts, datetime):
+            return ts
+
         if isinstance(ts, str):
             try:
+                # ISO 8601 date format
                 return datetime.strptime(ts, "%Y-%m-%dT%H:%M:%S.%f")
             except ValueError:
+                # Unix timestamp format (in milliseconds)
                 return datetime.fromtimestamp(int(ts) / 1000)
-        if isinstance(ts, datetime):
-            return ts
 
-        raise ValueError('timestamp must be a datetime.datetime or a string')
+        raise ValueError('Invalid timestamp format')
 
     @staticmethod
     def create_empty_report():

tests/utils/cli/several_inputs_outputs_stream_mode_enabled_configuration.json

@@ -19,6 +19,7 @@
       "puller3": {
           "model": "HWPCReport",
           "type": "socket",
+          "host": "localhost",
           "port": 1111,
           "name": "puller3"
       }