ethtool analyzer

nodescraper/plugins/inband/network/analyzer_args.py

@@ -0,0 +1,33 @@
+###############################################################################
+#
+# 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, Union
+
+from nodescraper.base.regexanalyzer import ErrorRegex
+from nodescraper.models import AnalyzerArgs
+
+
+class NetworkAnalyzerArgs(AnalyzerArgs):
+    error_regex: Optional[Union[list[ErrorRegex], list[dict]]] = None

nodescraper/plugins/inband/network/network_analyzer.py

@@ -0,0 +1,123 @@
+###############################################################################
+#
+# MIT License
+#
+# Copyright (c) 2026 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 re
+from typing import Optional
+
+from nodescraper.base.regexanalyzer import ErrorRegex, RegexAnalyzer
+from nodescraper.enums import EventCategory, EventPriority, ExecutionStatus
+from nodescraper.models import TaskResult
+
+from .analyzer_args import NetworkAnalyzerArgs
+from .networkdata import NetworkDataModel
+
+
+class NetworkAnalyzer(RegexAnalyzer[NetworkDataModel, NetworkAnalyzerArgs]):
+    """Check network statistics for errors (PFC and other network error counters)."""
+
+    DATA_MODEL = NetworkDataModel
+
+    # Regex patterns for error fields checked from network statistics
+    ERROR_REGEX: list[ErrorRegex] = [
+        ErrorRegex(
+            regex=re.compile(r"^tx_pfc_frames$"),
+            message="tx_pfc_frames is non-zero",
+            event_category=EventCategory.NETWORK,
+        ),
+        ErrorRegex(
+            regex=re.compile(r"^tx_pfc_ena_frames_pri\d+$"),
+            message="tx_pfc_ena_frames_pri* is non-zero",
+            event_category=EventCategory.NETWORK,
+        ),
+        ErrorRegex(
+            regex=re.compile(r"^pfc_pri\d+_tx_transitions$"),
+            message="pfc_pri*_tx_transitions is non-zero",
+            event_category=EventCategory.NETWORK,
+        ),
+    ]
+
+    def analyze_data(
+        self, data: NetworkDataModel, args: Optional[NetworkAnalyzerArgs] = None
+    ) -> TaskResult:
+        """Analyze network statistics for non-zero error counters.
+        Currently only checks ethtool -S statistics.
+
+        Args:
+            data: Network data model with ethtool_info containing interface statistics.
+            args: Optional analyzer arguments with custom error regex support.
+
+        Returns:
+            TaskResult with status OK if no errors, ERROR if any error counter > 0.
+        """
+        if not data.ethtool_info:
+            self.result.message = "No network devices found"
+            self.result.status = ExecutionStatus.WARNING
+            return self.result
+
+        if not args:
+            args = NetworkAnalyzerArgs()
+
+        final_error_regex = self._convert_and_extend_error_regex(args.error_regex, self.ERROR_REGEX)
+
+        error_state = False
+        for interface_name, ethtool_info in data.ethtool_info.items():
+            errors_on_interface = []  # (error_field, value)
+            # Loop through all statistics in the ethtool statistics dict
+            for stat_name, stat_value in ethtool_info.statistics.items():
+                # Check if this statistic matches any error field pattern
+                for error_regex_obj in final_error_regex:
+                    if error_regex_obj.regex.match(stat_name):
+                        # Try to convert string value to int
+                        try:
+                            value = int(stat_value)
+                        except (ValueError, TypeError):
+                            break  # Skip non-numeric values
+
+                        if value > 0:
+                            errors_on_interface.append((stat_name, value))
+                        break  # Stop checking patterns once we find a match
+
+            if errors_on_interface:
+                error_state = True
+                error_names = [e[0] for e in errors_on_interface]
+                errors_data = {field: value for field, value in errors_on_interface}
+                self._log_event(
+                    category=EventCategory.NETWORK,
+                    description=f"Network error detected on {interface_name}: [{', '.join(error_names)}]",
+                    data={
+                        "interface": interface_name,
+                        "errors": errors_data,
+                    },
+                    priority=EventPriority.ERROR,
+                    console_log=True,
+                )
+
+        if error_state:
+            self.result.message = "Network errors detected in statistics"
+            self.result.status = ExecutionStatus.ERROR
+        else:
+            self.result.message = "No network errors detected in statistics"
+            self.result.status = ExecutionStatus.OK
+        return self.result

nodescraper/plugins/inband/network/network_plugin.py

@@ -25,16 +25,22 @@
 ###############################################################################
 from nodescraper.base import InBandDataPlugin
 
+from .analyzer_args import NetworkAnalyzerArgs
 from .collector_args import NetworkCollectorArgs
+from .network_analyzer import NetworkAnalyzer
 from .network_collector import NetworkCollector
 from .networkdata import NetworkDataModel
 
 
-class NetworkPlugin(InBandDataPlugin[NetworkDataModel, NetworkCollectorArgs, None]):
+class NetworkPlugin(InBandDataPlugin[NetworkDataModel, NetworkCollectorArgs, NetworkAnalyzerArgs]):
     """Plugin for collection of network configuration data"""
 
     DATA_MODEL = NetworkDataModel
 
     COLLECTOR = NetworkCollector
 
     COLLECTOR_ARGS = NetworkCollectorArgs
+
+    ANALYZER = NetworkAnalyzer
+
+    ANALYZER_ARGS = NetworkAnalyzerArgs