Merge pull request #649 from powerapi-ng/refactor/database-reports-transformer

feat: Improve reports input/output

Author: gfieni

src/powerapi/actor/actor.py

@@ -146,7 +146,10 @@ def term_handler(signum, _):
             signame = signal.Signals(signum).name
             self.logger.debug("Received signal %s (%s), terminating actor...", signame, signum)
 
-            self.state.alive = False
+            msg = PoisonPillMessage(soft=False)
+            handler = self.state.get_corresponding_handler(msg)
+            handler.handle(msg)
+
             self._kill_process()
             sys.exit(0)
 

src/powerapi/cli/common_cli_parsing_manager.py

@@ -32,8 +32,6 @@
 from powerapi.cli.parsing_manager import RootConfigParsingManager, SubgroupConfigParsingManager
 from powerapi.cli.config_parser import store_true, extract_file_names
 from powerapi.cli.config_parser import MissingValueException
-from powerapi.database.prometheus.prometheus_db import DEFAULT_METRIC_DESCRIPTION, DEFAULT_MODEL_VALUE, DEFAULT_PUSHER_NAME, \
-    DEFAULT_ADDRESS
 from powerapi.exception import BadTypeException, BadContextException, UnknownArgException
 
 POWERAPI_ENVIRONMENT_VARIABLE_PREFIX = 'POWERAPI_'
@@ -42,8 +40,6 @@
 POWERAPI_PRE_PROCESSOR_ENVIRONMENT_VARIABLE_PREFIX = POWERAPI_ENVIRONMENT_VARIABLE_PREFIX + 'PRE_PROCESSOR_'
 POWERAPI_POST_PROCESSOR_ENVIRONMENT_VARIABLE_PREFIX = POWERAPI_ENVIRONMENT_VARIABLE_PREFIX + 'POST_PROCESSOR'
 
-TAGS_ARGUMENT_HELP_TEXT = 'specify report tags'
-
 
 class CommonCLIParsingManager(RootConfigParsingManager):
     """
@@ -143,7 +139,7 @@ def __init__(self):
             "files",
             help_text="specify input csv files with this format : file1,file2,file3",
             action=extract_file_names,
-            default_value=[],
+            is_mandatory=True
         )
         subparser_csv_input.add_argument(
             "m",
@@ -159,6 +155,12 @@ def __init__(self):
             subgroup_parser=subparser_csv_input
         )
 
+        subparser_json_input = SubgroupConfigParsingManager("json")
+        subparser_json_input.add_argument("n", "name", help_text="Name of the puller", default_value="puller_json")
+        subparser_json_input.add_argument("m", "model", help_text="Expected report type")
+        subparser_json_input.add_argument("f", "filepath", help_text="Input file path")
+        self.add_subgroup_parser("input", subparser_json_input)
+
         subparser_mongo_output = SubgroupConfigParsingManager("mongodb")
         subparser_mongo_output.add_argument("u", "uri", help_text="specify MongoDB uri")
         subparser_mongo_output.add_argument(
@@ -183,30 +185,40 @@ def __init__(self):
         )
 
         subparser_prometheus_output = SubgroupConfigParsingManager("prometheus")
-        subparser_prometheus_output.add_argument("t", "tags", help_text=TAGS_ARGUMENT_HELP_TEXT)
-        subparser_prometheus_output.add_argument("u", "uri", help_text="specify server uri",
-                                                 default_value=DEFAULT_ADDRESS)
         subparser_prometheus_output.add_argument(
-            "p", "port", help_text="specify server port", argument_type=int
+            "n", "name",
+            help_text="Name of the pusher",
+            default_value="pusher_prometheus"
         )
         subparser_prometheus_output.add_argument(
-            "M", "metric-name", help_text="specify metric name"
+            "m", "model",
+            help_text="Input report type",
+            default_value="PowerReport"
         )
         subparser_prometheus_output.add_argument(
-            "d",
-            "metric-description",
-            help_text="specify metric description",
-            default_value=DEFAULT_METRIC_DESCRIPTION
+            "u", "addr",
+            help_text="Address the HTTP server should listen on",
+            default_value="localhost"
         )
-
         subparser_prometheus_output.add_argument(
-            "m",
-            "model",
-            help_text="specify data type that will be stored in the database",
-            default_value=DEFAULT_MODEL_VALUE,
+            "p", "port",
+            help_text="Port number the HTTP server should listen on",
+            argument_type=int,
+            default_value=8000
+        )
+        subparser_prometheus_output.add_argument(
+            "M", "metric-name",
+            help_text="Exposed metric name",
+            default_value="power_estimation_watts"
         )
         subparser_prometheus_output.add_argument(
-            "n", "name", help_text="specify pusher name", default_value=DEFAULT_PUSHER_NAME
+            "d", "metric-description",
+            help_text="Set the exposed metric short description",
+            default_value="Estimated power consumption of the target"
+        )
+        subparser_prometheus_output.add_argument(
+            "t", "tags",
+            help_text="List of metadata tags that will be exposed with the metrics"
         )
         self.add_subgroup_parser(
             subgroup_name="output",
@@ -218,6 +230,7 @@ def __init__(self):
             "d",
             "directory",
             help_text="specify directory where where output  csv files will be writen",
+            is_mandatory=True
         )
         subparser_csv_output.add_argument(
             "m",
@@ -226,7 +239,7 @@ def __init__(self):
             default_value="PowerReport",
         )
 
-        subparser_csv_output.add_argument("t", "tags", help_text=TAGS_ARGUMENT_HELP_TEXT)
+        subparser_csv_output.add_argument("t", "tags", help_text="List of tags that should be kept")
         subparser_csv_output.add_argument(
             "n", "name", help_text="specify pusher name", default_value="pusher_csv"
         )
@@ -235,6 +248,12 @@ def __init__(self):
             subgroup_parser=subparser_csv_output
         )
 
+        subparser_json_output = SubgroupConfigParsingManager("json")
+        subparser_json_output.add_argument("n", "name", help_text="Name of the pusher", default_value="pusher_json")
+        subparser_json_output.add_argument("m", "model", help_text="Report type to be exported")
+        subparser_json_output.add_argument("f", "filepath", help_text="Output file path")
+        self.add_subgroup_parser("output", subparser_json_output)
+
         subparser_opentsdb_output = SubgroupConfigParsingManager("opentsdb")
         subparser_opentsdb_output.add_argument("u", "uri", help_text="specify openTSDB host")
         subparser_opentsdb_output.add_argument(
@@ -260,14 +279,14 @@ def __init__(self):
 
         subparser_influx2_output = SubgroupConfigParsingManager("influxdb2")
         subparser_influx2_output.add_argument("u", "uri", help_text="specify InfluxDB uri")
-        subparser_influx2_output.add_argument("t", "tags", help_text=TAGS_ARGUMENT_HELP_TEXT)
+        subparser_influx2_output.add_argument("t", "tags", help_text="List of tags that should be kept")
         subparser_influx2_output.add_argument("k", "token",
                                               help_text="specify token for accessing the database")
         subparser_influx2_output.add_argument("g", "org",
                                               help_text="specify organisation for accessing the database")
 
         subparser_influx2_output.add_argument(
-            "d", "db", help_text="specify InfluxDB database name"
+            "b", "bucket", help_text="specify InfluxDB database name"
         )
         subparser_influx2_output.add_argument(
             "p", "port", help_text="specify InfluxDB connection port", argument_type=int