merged alex_diff + ProcessCollectorArgs

Author: alexandraBara

nodescraper/cli/cli.py

@@ -326,11 +326,12 @@ def main(arg_input: Optional[list[str]] = None):
         top_level_args, plugin_arg_map = process_args(arg_input, list(plugin_subparser_map.keys()))
 
         parsed_args = parser.parse_args(top_level_args)
+        system_info = get_system_info(parsed_args)
 
         if parsed_args.log_path and parsed_args.subcmd not in ["gen-plugin-config", "describe"]:
             log_path = os.path.join(
                 parsed_args.log_path,
-                f"scraper_logs_{datetime.datetime.now().strftime('%Y_%m_%d-%I_%M_%S_%p')}",
+                f"scraper_logs_{system_info.name}_{datetime.datetime.now().strftime('%Y_%m_%d-%I_%M_%S_%p')}",
             )
             os.makedirs(log_path)
         else:
@@ -386,7 +387,6 @@ def main(arg_input: Optional[list[str]] = None):
             plugin_subparser_map=plugin_subparser_map,
         )
 
-        system_info = get_system_info(parsed_args)
         log_system_info(log_path, system_info, logger)
     except Exception as e:
         parser.error(str(e))

nodescraper/cli/helper.py

@@ -34,7 +34,7 @@
 from nodescraper.cli.inputargtypes import ModelArgHandler
 from nodescraper.configbuilder import ConfigBuilder
 from nodescraper.configregistry import ConfigRegistry
-from nodescraper.enums import SystemInteractionLevel, SystemLocation
+from nodescraper.enums import ExecutionStatus, SystemInteractionLevel, SystemLocation
 from nodescraper.models import PluginConfig, PluginResult, SystemInfo, TaskResult
 from nodescraper.pluginexecutor import PluginExecutor
 from nodescraper.pluginregistry import PluginRegistry
@@ -300,12 +300,23 @@ def generate_reference_config(
     plugin_config = PluginConfig()
     plugins = {}
     for obj in results:
+        if obj.result_data.collection_result.status != ExecutionStatus.OK:
+            logger.warning(
+                "Plugin: %s result status is %, skipping",
+                obj.source,
+                obj.result_data.collection_result.status,
+            )
+            continue
+
         data_model = obj.result_data.system_data
+        if data_model is None:
+            logger.warning("Plugin: %s data model not found: %s, skipping", obj.source)
+            continue
 
         plugin = plugin_reg.plugins.get(obj.source)
         if not plugin.ANALYZER_ARGS:
             logger.warning(
-                "Plugin: %s does not support reference config creation. No analyzer args defined.",
+                "Plugin: %s does not support reference config creation. No analyzer args defined, skipping.",
                 obj.source,
             )
             continue

nodescraper/models/__init__.py

@@ -24,6 +24,7 @@
 #
 ###############################################################################
 from .analyzerargs import AnalyzerArgs
+from .collectorargs import CollectorArgs
 from .datamodel import DataModel
 from .datapluginresult import DataPluginResult
 from .event import Event
@@ -35,6 +36,7 @@
 
 __all__ = [
     "AnalyzerArgs",
+    "CollectorArgs",
     "DataModel",
     "TaskResult",
     "Event",

nodescraper/models/analyzerargs.py

@@ -23,12 +23,10 @@
 # SOFTWARE.
 #
 ###############################################################################
-from abc import ABC
-
 from pydantic import BaseModel
 
 
-class AnalyzerArgs(BaseModel, ABC):
+class AnalyzerArgs(BaseModel):
     model_config = {"extra": "forbid", "exclude_none": True}
 
     @classmethod

nodescraper/models/collectorargs.py

@@ -0,0 +1,32 @@
+###############################################################################
+#
+# MIT License
+#
+# Copyright (c) 2025 Advanced Micro Devices, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#
+###############################################################################
+from abc import ABC
+
+from pydantic import BaseModel
+
+
+class CollectorArgs(BaseModel, ABC):
+    model_config = {"extra": "forbid", "exclude_none": True}

nodescraper/plugins/inband/dmesg/analyzer_args.py

@@ -26,24 +26,8 @@
 from typing import Optional
 
 from nodescraper.models import TimeRangeAnalysisArgs
-from nodescraper.plugins.inband.dmesg.dmesgdata import DmesgData
 
 
 class DmesgAnalyzerArgs(TimeRangeAnalysisArgs):
     check_unknown_dmesg_errors: Optional[bool] = True
     exclude_category: Optional[set[str]] = None
-
-    @classmethod
-    def build_from_model(cls, datamodel: DmesgData) -> "TimeRangeAnalysisArgs":
-        """build analyzer args from data model
-
-        Args:
-            datamodel (DmesgDataModel): data model for plugin
-
-        Raises:
-            NotImplementedError: does not implement abstract function
-
-        Returns:
-            TimeRangeAnalysisArgs: instance of analyzer args class
-        """
-        raise NotImplementedError("Dmesg does not support reference config creation")

nodescraper/plugins/inband/process/collector_args.py

@@ -23,8 +23,9 @@
 # SOFTWARE.
 #
 ###############################################################################
-from pydantic import BaseModel
 
+from nodescraper.models import CollectorArgs
 
-class ProcessCollectorArgs(BaseModel):
+
+class ProcessCollectorArgs(CollectorArgs):
     top_n_process: int = 10

nodescraper/plugins/inband/process/process_plugin.py

@@ -42,3 +42,5 @@ class ProcessPlugin(InBandDataPlugin[ProcessDataModel, ProcessCollectorArgs, Pro
     ANALYZER = ProcessAnalyzer
 
     ANALYZER_ARGS = ProcessAnalyzerArgs
+
+    COLLECTOR_ARGS = ProcessCollectorArgs

test/unit/framework/common/shared_utils.py

@@ -26,11 +26,9 @@
 from typing import Optional
 from unittest.mock import MagicMock
 
-from pydantic import BaseModel
-
 from nodescraper.enums import ExecutionStatus
 from nodescraper.interfaces import ConnectionManager, PluginInterface
-from nodescraper.models import PluginResult, TaskResult
+from nodescraper.models import AnalyzerArgs, PluginResult, TaskResult
 from nodescraper.models.datamodel import DataModel
 
 
@@ -69,12 +67,12 @@ def disconnect(self):
         pass
 
 
-class TestModelArg(BaseModel):
+class TestModelArg(AnalyzerArgs):
     model_attr: int = 123
 
     @classmethod
     def build_from_model(cls, model):
-        return cls()
+        return cls(model_attr=int(model.some_version))
 
 
 class DummyDataModel(DataModel):

test/unit/framework/test_analyzerargs.py

@@ -13,8 +13,7 @@ def build_from_model(cls, datamodel):
 
 def test_build_from_model(dummy_data_model):
     dummy = dummy_data_model(foo=1)
-    args = MyArgs(args_foo=1)
-    args = args.build_from_model(dummy)
+    args = MyArgs.build_from_model(dummy)
     assert isinstance(args, MyArgs)
     assert args.args_foo == dummy.foo
     dump = args.model_dump(mode="json", exclude_none=True)