amd-node-scraper 0.0.1__py3-none-any.whl

nodescraper/plugins/inband/dmesg/dmesg_collector.py

@@ -0,0 +1,164 @@
+###############################################################################
+#
+# 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 typing import Optional
+
+from nodescraper.base import InBandDataCollector
+from nodescraper.connection.inband import TextFileArtifact
+from nodescraper.enums import EventCategory, EventPriority, ExecutionStatus, OSFamily
+from nodescraper.models import TaskResult
+from nodescraper.utils import nice_rotated_name, shell_quote
+
+from .collector_args import DmesgCollectorArgs
+from .dmesgdata import DmesgData
+
+
+class DmesgCollector(InBandDataCollector[DmesgData, DmesgCollectorArgs]):
+    """Read dmesg log"""
+
+    SUPPORTED_OS_FAMILY = {OSFamily.LINUX}
+
+    DATA_MODEL = DmesgData
+
+    CMD = "dmesg --time-format iso -x"
+
+    CMD_LOGS = (
+        r"ls -1 /var/log/dmesg* 2>/dev/null | grep -E '^/var/log/dmesg(\.[0-9]+(\.gz)?)?$' || true"
+    )
+
+    def _collect_dmesg_rotations(self):
+        """Collect dmesg logs"""
+        list_res = self._run_sut_cmd(self.CMD_LOGS, sudo=True)
+        paths = [p.strip() for p in (list_res.stdout or "").splitlines() if p.strip()]
+        if not paths:
+            self._log_event(
+                category=EventCategory.OS,
+                description="No /var/log/dmesg files found (including rotations).",
+                data={"list_exit_code": list_res.exit_code},
+                priority=EventPriority.WARNING,
+            )
+            return 0
+
+        collected_logs, failed_logs = [], []
+        for p in paths:
+            qp = shell_quote(p)
+            if p.endswith(".gz"):
+                cmd = f"gzip -dc {qp} 2>/dev/null || zcat {qp} 2>/dev/null"
+                res = self._run_sut_cmd(cmd, sudo=True, log_artifact=False)
+                if res.exit_code == 0 and res.stdout is not None:
+                    fname = nice_rotated_name(p, "dmesg")
+                    self.logger.info("Collected dmesg log: %s", fname)
+                    self.result.artifacts.append(
+                        TextFileArtifact(filename=fname, contents=res.stdout)
+                    )
+                    collected_logs.append(
+                        {"path": p, "as": fname, "bytes": len(res.stdout.encode("utf-8", "ignore"))}
+                    )
+                else:
+                    failed_logs.append(
+                        {"path": p, "exit_code": res.exit_code, "stderr": res.stderr, "cmd": cmd}
+                    )
+            else:
+                cmd = f"cat {qp}"
+                res = self._run_sut_cmd(cmd, sudo=True, log_artifact=False)
+                if res.exit_code == 0 and res.stdout is not None:
+                    fname = nice_rotated_name(p, "dmesg")
+                    self.logger.info("Collected dmesg log: %s", fname)
+                    self.result.artifacts.append(
+                        TextFileArtifact(filename=fname, contents=res.stdout)
+                    )
+                    collected_logs.append(
+                        {"path": p, "as": fname, "bytes": len(res.stdout.encode("utf-8", "ignore"))}
+                    )
+                else:
+                    failed_logs.append(
+                        {"path": p, "exit_code": res.exit_code, "stderr": res.stderr, "cmd": cmd}
+                    )
+
+        if collected_logs:
+            self._log_event(
+                category=EventCategory.OS,
+                description="Collected dmesg rotated files",
+                data={"collected": collected_logs},
+                priority=EventPriority.INFO,
+            )
+            self.result.message = self.result.message or "dmesg rotated files collected"
+
+        if failed_logs:
+            self._log_event(
+                category=EventCategory.OS,
+                description="Some dmesg files could not be collected.",
+                data={"failed": failed_logs},
+                priority=EventPriority.WARNING,
+            )
+
+    def _get_dmesg_content(self) -> str:
+        """run dmesg command on system and return output
+
+        Returns:
+            str: dmesg output
+        """
+
+        self.logger.info("Running dmesg command on system")
+        res = self._run_sut_cmd(self.CMD, sudo=True, log_artifact=False)
+        if res.exit_code != 0:
+            self._log_event(
+                category=EventCategory.OS,
+                description="Error reading dmesg",
+                data={"command": res.command, "exit_code": res.exit_code},
+                priority=EventPriority.ERROR,
+                console_log=True,
+            )
+        return res.stdout
+
+    def collect_data(
+        self,
+        args: Optional[DmesgCollectorArgs] = None,
+    ) -> tuple[TaskResult, Optional[DmesgData]]:
+        """Collect dmesg data from the system
+
+        Returns:
+            tuple[TaskResult, Optional[DmesgData]]: tuple containing the result of the task and the dmesg data if available
+        """
+        if args is None:
+            args = DmesgCollectorArgs()
+
+        if args.skip_sudo:
+            self.result.message = "Skipping sudo plugin"
+            self.result.status = ExecutionStatus.NOT_RAN
+            return self.result, None
+
+        dmesg_content = self._get_dmesg_content()
+        if args.collect_rotated_logs:
+            self._collect_dmesg_rotations()
+
+        if dmesg_content:
+            dmesg_data = DmesgData(
+                dmesg_content=dmesg_content, skip_log_file=not args.log_dmesg_data
+            )
+            self.result.message = "Dmesg data collected"
+            return self.result, dmesg_data
+
+        return self.result, None

nodescraper/plugins/inband/dmesg/dmesg_plugin.py

@@ -0,0 +1,44 @@
+###############################################################################
+#
+# 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 nodescraper.base import InBandDataPlugin
+
+from .analyzer_args import DmesgAnalyzerArgs
+from .collector_args import DmesgCollectorArgs
+from .dmesg_analyzer import DmesgAnalyzer
+from .dmesg_collector import DmesgCollector
+from .dmesgdata import DmesgData
+
+
+class DmesgPlugin(InBandDataPlugin[DmesgData, DmesgCollectorArgs, DmesgAnalyzerArgs]):
+    """Plugin for collection and analysis of dmesg data"""
+
+    DATA_MODEL = DmesgData
+
+    COLLECTOR = DmesgCollector
+
+    ANALYZER = DmesgAnalyzer
+
+    COLLECTOR_ARGS = DmesgCollectorArgs

nodescraper/plugins/inband/dmesg/dmesgdata.py

@@ -0,0 +1,116 @@
+###############################################################################
+#
+# 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.
+#
+###############################################################################
+import os
+import re
+from typing import Union
+
+from nodescraper.models import DataModel
+from nodescraper.utils import get_unique_filename
+
+
+class DmesgData(DataModel):
+    """Data model for in band dmesg log"""
+
+    dmesg_content: str
+    skip_log_file: bool = False
+
+    @classmethod
+    def get_new_dmesg_lines(cls, current_dmesg: str, new_dmesg: str) -> str:
+        """Get new dmesg lines that are in one output but not another
+
+        Args:
+            current_dmesg (str): initial dmesg output
+            new_dmesg (str): updated dmesg output
+
+        Returns:
+            str: lines that are at the end of new_dmesg but not current_dmesg
+        """
+        new_lines = []
+        new_dmesg_lines = new_dmesg.splitlines()
+
+        # reverse since any new lines will be at the end, so we want to start looking from there
+        new_dmesg_lines.reverse()
+
+        for line in new_dmesg_lines:
+            date = re.search(r"(\d{4}-\d+-\d+T\d+:\d+:\d+),(\d+[+-]\d+:\d+)", line)
+            if date and line in current_dmesg:
+                # only break for lines with a date that already exist in current dmesg
+                # lines with a date will be unique
+                break
+
+            new_lines.append(line)
+
+        # put new lines back in correct order since we appended in reverse
+        new_lines.reverse()
+
+        return ("\n").join(new_lines)
+
+    def merge_data(self, input_data: "DmesgData"):
+        """Merge dmesg data with new input data
+
+        Args:
+            input_data (DmesgData): input dmesg data to merge with current dmesg data
+        """
+        new_lines = self.get_new_dmesg_lines(input_data.dmesg_content, self.dmesg_content)
+        merged_data = input_data.dmesg_content.strip() + f"\n{new_lines.strip()}"
+        self.dmesg_content = merged_data
+
+    def log_model(self, log_path: str):
+        """Log data model to a file
+
+        Args:
+            log_path (str): log path
+        """
+        if self.skip_log_file:
+            return
+        log_name = os.path.join(log_path, get_unique_filename(log_path, "dmesg.log"))
+        with open(log_name, "w", encoding="utf-8") as log_file:
+            log_file.write(self.dmesg_content)
+
+    @classmethod
+    def import_model(cls, model_input: Union[dict, str]) -> "DmesgData":
+        """Load dmesg data
+
+        Args:
+            model_input Union[dict, str]: dmesg file name or dmesg data dict
+
+        Raises:
+            ValueError: id model data has an invalid value
+
+        Returns:
+            DmesgDataModel: dmesg data model object
+        """
+
+        if isinstance(model_input, dict):
+            return cls(**model_input)
+
+        if isinstance(model_input, str):
+            with open(model_input, "r", encoding="utf-8") as input_file:
+                dmesg_data = input_file.read()
+
+            return cls(dmesg_content=dmesg_data)
+
+        raise ValueError("Invalid input for model data")

nodescraper/plugins/inband/fabrics/__init__.py

@@ -0,0 +1,28 @@
+###############################################################################
+#
+# 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 .fabrics_plugin import FabricsPlugin
+
+__all__ = ["FabricsPlugin"]