Merge branch 'development' into alex_build_from_model

Author: alexandraBara

.github/workflows/update-plugin-docs.yml

@@ -1,9 +1,10 @@
-# Workflow to run plugin documentation generation then commit the updated changes
+# Workflow to run plugin documentation generation then create a PR with the updated changes
 
 name: Plugin Documentation Generator
 
 permissions:
   contents: write
+  pull-requests: write
 
 on:
   workflow_dispatch:
@@ -15,8 +16,15 @@ jobs:
     runs-on: [ self-hosted ]
     # To disable this workflow, set DISABLE_AUTO_DOCS to 'true' in repository variables
     if: vars.DISABLE_AUTO_DOCS != 'true'
+    env:
+      HOME: /tmp/github-actions-home
 
     steps:
+    - name: Setup HOME directory
+      run: |
+        mkdir -p /tmp/github-actions-home
+        export HOME=/tmp/github-actions-home
+
     - name: Checkout repository
       uses: actions/checkout@v4
       with:
@@ -37,10 +45,18 @@ jobs:
         source venv/bin/activate
         pre-commit run --files docs/PLUGIN_DOC.md || true
 
-    - name: Commit and push changes
-      run: |
-        git config user.name "github-actions[bot]"
-        git config user.email "github-actions[bot]@users.noreply.github.com"
-        git add docs/PLUGIN_DOC.md
-        git diff --staged --quiet || git commit --no-verify -m "docs: Update plugin documentation [automated]"
-        git push
+    - name: Create Pull Request
+      uses: peter-evans/create-pull-request@v6
+      with:
+        token: ${{ secrets.GITHUB_TOKEN }}
+        commit-message: "docs: Update plugin documentation [automated]"
+        committer: "github-actions[bot] <github-actions[bot]@users.noreply.github.com>"
+        author: "github-actions[bot] <github-actions[bot]@users.noreply.github.com>"
+        branch: automated-plugin-docs-update
+        delete-branch: true
+        title: "docs: Update plugin documentation [automated]"
+        body: |
+          Automated plugin documentation update generated by workflow.
+
+          This PR was automatically created by the Plugin Documentation Generator workflow.
+        labels: documentation,automated

docs/PLUGIN_DOC.md

@@ -4,7 +4,7 @@
 
 | Plugin | Collection | Analysis | DataModel | Collector | Analyzer |
 | --- | --- | --- | --- | --- | --- |
-| AmdSmiPlugin | amd-smi firmware --json<br>amd-smi list --json<br>amd-smi partition --json<br>amd-smi process --json<br>amd-smi static -g all --json<br>amd-smi version --json | **Analyzer Args:**<br>- `check_static_data`: bool<br>- `expected_gpu_processes`: Optional[int]<br>- `expected_max_power`: Optional[int]<br>- `expected_driver_version`: Optional[str]<br>- `expected_memory_partition_mode`: Optional[str]<br>- `expected_compute_partition_mode`: Optional[str]<br>- `expected_pldm_version`: Optional[str]<br>- `l0_to_recovery_count_error_threshold`: Optional[int]<br>- `l0_to_recovery_count_warning_threshold`: Optional[int]<br>- `vendorid_ep`: Optional[str]<br>- `vendorid_ep_vf`: Optional[str]<br>- `devid_ep`: Optional[str]<br>- `devid_ep_vf`: Optional[str]<br>- `sku_name`: Optional[str] | [AmdSmiDataModel](#AmdSmiDataModel-Model) | [AmdSmiCollector](#Collector-Class-AmdSmiCollector) | [AmdSmiAnalyzer](#Data-Analyzer-Class-AmdSmiAnalyzer) |
+| AmdSmiPlugin | firmware --json<br>list --json<br>partition --json<br>process --json<br>ras --cper --folder={folder}<br>static -g all --json<br>static -g {gpu_id} --json<br>version --json | **Analyzer Args:**<br>- `check_static_data`: bool<br>- `expected_gpu_processes`: Optional[int]<br>- `expected_max_power`: Optional[int]<br>- `expected_driver_version`: Optional[str]<br>- `expected_memory_partition_mode`: Optional[str]<br>- `expected_compute_partition_mode`: Optional[str]<br>- `expected_pldm_version`: Optional[str]<br>- `l0_to_recovery_count_error_threshold`: Optional[int]<br>- `l0_to_recovery_count_warning_threshold`: Optional[int]<br>- `vendorid_ep`: Optional[str]<br>- `vendorid_ep_vf`: Optional[str]<br>- `devid_ep`: Optional[str]<br>- `devid_ep_vf`: Optional[str]<br>- `sku_name`: Optional[str]<br>- `expected_xgmi_speed`: Optional[list[float]]<br>- `analysis_range_start`: Optional[datetime.datetime]<br>- `analysis_range_end`: Optional[datetime.datetime] | [AmdSmiDataModel](#AmdSmiDataModel-Model) | [AmdSmiCollector](#Collector-Class-AmdSmiCollector) | [AmdSmiAnalyzer](#Data-Analyzer-Class-AmdSmiAnalyzer) |
 | BiosPlugin | sh -c 'cat /sys/devices/virtual/dmi/id/bios_version'<br>wmic bios get SMBIOSBIOSVersion /Value | **Analyzer Args:**<br>- `exp_bios_version`: list[str]<br>- `regex_match`: bool | [BiosDataModel](#BiosDataModel-Model) | [BiosCollector](#Collector-Class-BiosCollector) | [BiosAnalyzer](#Data-Analyzer-Class-BiosAnalyzer) |
 | CmdlinePlugin | cat /proc/cmdline | **Analyzer Args:**<br>- `required_cmdline`: Union[str, list]<br>- `banned_cmdline`: Union[str, list] | [CmdlineDataModel](#CmdlineDataModel-Model) | [CmdlineCollector](#Collector-Class-CmdlineCollector) | [CmdlineAnalyzer](#Data-Analyzer-Class-CmdlineAnalyzer) |
 | DeviceEnumerationPlugin | lscpu \| grep Socket \| awk '{ print $2 }'<br>powershell -Command "(Get-WmiObject -Class Win32_Processor \| Measure-Object).Count"<br>lspci -d {vendorid_ep}: \| grep -i 'VGA\\|Display\\|3D' \| wc -l<br>powershell -Command "(wmic path win32_VideoController get name \| findstr AMD \| Measure-Object).Count"<br>lspci -d {vendorid_ep}: \| grep -i 'Virtual Function' \| wc -l<br>powershell -Command "(Get-VMHostPartitionableGpu \| Measure-Object).Count" | **Analyzer Args:**<br>- `cpu_count`: Optional[list[int]]<br>- `gpu_count`: Optional[list[int]]<br>- `vf_count`: Optional[list[int]] | [DeviceEnumerationDataModel](#DeviceEnumerationDataModel-Model) | [DeviceEnumerationCollector](#Collector-Class-DeviceEnumerationCollector) | [DeviceEnumerationAnalyzer](#Data-Analyzer-Class-DeviceEnumerationAnalyzer) |
@@ -14,11 +14,11 @@
 | JournalPlugin | journalctl --no-pager --system --output=short-iso | - | [JournalData](#JournalData-Model) | [JournalCollector](#Collector-Class-JournalCollector) | - |
 | KernelPlugin | sh -c 'uname -a'<br>wmic os get Version /Value | **Analyzer Args:**<br>- `exp_kernel`: Union[str, list]<br>- `regex_match`: bool | [KernelDataModel](#KernelDataModel-Model) | [KernelCollector](#Collector-Class-KernelCollector) | [KernelAnalyzer](#Data-Analyzer-Class-KernelAnalyzer) |
 | KernelModulePlugin | cat /proc/modules<br>wmic os get Version /Value | **Analyzer Args:**<br>- `kernel_modules`: dict[str, dict]<br>- `regex_filter`: list[str] | [KernelModuleDataModel](#KernelModuleDataModel-Model) | [KernelModuleCollector](#Collector-Class-KernelModuleCollector) | [KernelModuleAnalyzer](#Data-Analyzer-Class-KernelModuleAnalyzer) |
-| MemoryPlugin | free -b<br>wmic OS get FreePhysicalMemory /Value; wmic ComputerSystem get TotalPhysicalMemory /Value | - | [MemoryDataModel](#MemoryDataModel-Model) | [MemoryCollector](#Collector-Class-MemoryCollector) | [MemoryAnalyzer](#Data-Analyzer-Class-MemoryAnalyzer) |
+| MemoryPlugin | free -b<br>/usr/bin/lsmem<br>wmic OS get FreePhysicalMemory /Value; wmic ComputerSystem get TotalPhysicalMemory /Value | - | [MemoryDataModel](#MemoryDataModel-Model) | [MemoryCollector](#Collector-Class-MemoryCollector) | [MemoryAnalyzer](#Data-Analyzer-Class-MemoryAnalyzer) |
 | NvmePlugin | nvme smart-log {dev}<br>nvme error-log {dev} --log-entries=256<br>nvme id-ctrl {dev}<br>nvme id-ns {dev}{ns}<br>nvme fw-log {dev}<br>nvme self-test-log {dev}<br>nvme get-log {dev} --log-id=6 --log-len=512<br>nvme telemetry-log {dev} --output-file={dev}_{f_name} | - | [NvmeDataModel](#NvmeDataModel-Model) | [NvmeCollector](#Collector-Class-NvmeCollector) | - |
 | OsPlugin | sh -c '( lsb_release -ds \|\| (cat /etc/*release \| grep PRETTY_NAME) \|\| uname -om ) 2>/dev/null \| head -n1'<br>cat /etc/*release \| grep VERSION_ID<br>wmic os get Version /value<br>wmic os get Caption /Value | **Analyzer Args:**<br>- `exp_os`: Union[str, list]<br>- `exact_match`: bool | [OsDataModel](#OsDataModel-Model) | [OsCollector](#Collector-Class-OsCollector) | [OsAnalyzer](#Data-Analyzer-Class-OsAnalyzer) |
-| PackagePlugin | dnf list --installed<br>dpkg-query -W<br>pacman -Q<br>cat /etc/*release<br>wmic product get name,version | **Analyzer Args:**<br>- `exp_package_ver`: Dict[str, Optional[str]]<br>- `regex_match`: bool | [PackageDataModel](#PackageDataModel-Model) | [PackageCollector](#Collector-Class-PackageCollector) | [PackageAnalyzer](#Data-Analyzer-Class-PackageAnalyzer) |
-| PciePlugin | lspci -d {vendor_id}: -nn<br>lspci -x<br>lspci -xxxx<br>lspci -PP<br>lspci -PP -d {vendor_id}:{dev_id}<br>lspci -vt<br>lspci -vvv | **Analyzer Args:**<br>- `exp_speed`: int<br>- `exp_width`: int<br>- `exp_sriov_count`: int<br>- `exp_gpu_count_override`: Optional[int]<br>- `exp_max_payload_size`: Union[Dict[int, int], int, NoneType]<br>- `exp_max_rd_req_size`: Union[Dict[int, int], int, NoneType]<br>- `exp_ten_bit_tag_req_en`: Union[Dict[int, int], int, NoneType] | [PcieDataModel](#PcieDataModel-Model) | [PcieCollector](#Collector-Class-PcieCollector) | [PcieAnalyzer](#Data-Analyzer-Class-PcieAnalyzer) |
+| PackagePlugin | dnf list --installed<br>dpkg-query -W<br>pacman -Q<br>cat /etc/*release<br>wmic product get name,version | **Analyzer Args:**<br>- `exp_package_ver`: Dict[str, Optional[str]]<br>- `regex_match`: bool<br>- `rocm_regex`: Optional[str]<br>- `enable_rocm_regex`: bool | [PackageDataModel](#PackageDataModel-Model) | [PackageCollector](#Collector-Class-PackageCollector) | [PackageAnalyzer](#Data-Analyzer-Class-PackageAnalyzer) |
+| PciePlugin | lspci -d {vendor_id}: -nn<br>lspci -x<br>lspci -xxxx<br>lspci -PP<br>lspci -PP -d {vendor_id}:{dev_id}<br>lspci -vvv<br>lspci -vvvt | **Analyzer Args:**<br>- `exp_speed`: int<br>- `exp_width`: int<br>- `exp_sriov_count`: int<br>- `exp_gpu_count_override`: Optional[int]<br>- `exp_max_payload_size`: Union[Dict[int, int], int, NoneType]<br>- `exp_max_rd_req_size`: Union[Dict[int, int], int, NoneType]<br>- `exp_ten_bit_tag_req_en`: Union[Dict[int, int], int, NoneType] | [PcieDataModel](#PcieDataModel-Model) | [PcieCollector](#Collector-Class-PcieCollector) | [PcieAnalyzer](#Data-Analyzer-Class-PcieAnalyzer) |
 | ProcessPlugin | top -b -n 1<br>rocm-smi --showpids<br>top -b -n 1 -o %CPU  | **Analyzer Args:**<br>- `max_kfd_processes`: int<br>- `max_cpu_usage`: float | [ProcessDataModel](#ProcessDataModel-Model) | [ProcessCollector](#Collector-Class-ProcessCollector) | [ProcessAnalyzer](#Data-Analyzer-Class-ProcessAnalyzer) |
 | RocmPlugin | {rocm_path}/opencl/bin/*/clinfo<br>env \| grep -Ei 'rocm\|hsa\|hip\|mpi\|openmp\|ucx\|miopen'<br>ls /sys/class/kfd/kfd/proc/<br>grep -i -E 'rocm' /etc/ld.so.conf.d/*<br>{rocm_path}/bin/rocminfo<br>ls -v -d /opt/rocm*<br>ls -v -d /opt/rocm-[3-7]* \| tail -1<br>ldconfig -p \| grep -i -E 'rocm'<br>/opt/rocm/.info/version-rocm<br>/opt/rocm/.info/version | **Analyzer Args:**<br>- `exp_rocm`: Union[str, list]<br>- `exp_rocm_latest`: str | [RocmDataModel](#RocmDataModel-Model) | [RocmCollector](#Collector-Class-RocmCollector) | [RocmAnalyzer](#Data-Analyzer-Class-RocmAnalyzer) |
 | StoragePlugin | sh -c 'df -lH -B1 \| grep -v 'boot''<br>wmic LogicalDisk Where DriveType="3" Get DeviceId,Size,FreeSpace | - | [StorageDataModel](#StorageDataModel-Model) | [StorageCollector](#Collector-Class-StorageCollector) | [StorageAnalyzer](#Data-Analyzer-Class-StorageAnalyzer) |
@@ -42,25 +42,29 @@ Class for collection of inband tool amd-smi data.
 
 - **AMD_SMI_EXE**: `amd-smi`
 - **SUPPORTED_OS_FAMILY**: `{<OSFamily.LINUX: 3>}`
-- **CMD_VERSION**: `amd-smi version --json`
-- **CMD_LIST**: `amd-smi list --json`
-- **CMD_PROCESS**: `amd-smi process --json`
-- **CMD_PARTITION**: `amd-smi partition --json`
-- **CMD_FIRMWARE**: `amd-smi firmware --json`
-- **CMD_STATIC**: `amd-smi static -g all --json`
+- **CMD_VERSION**: `version --json`
+- **CMD_LIST**: `list --json`
+- **CMD_PROCESS**: `process --json`
+- **CMD_PARTITION**: `partition --json`
+- **CMD_FIRMWARE**: `firmware --json`
+- **CMD_STATIC**: `static -g all --json`
+- **CMD_STATIC_GPU**: `static -g {gpu_id} --json`
+- **CMD_RAS**: `ras --cper --folder={folder}`
 
 ### Provides Data
 
 AmdSmiDataModel
 
 ### Commands
 
-- amd-smi firmware --json
-- amd-smi list --json
-- amd-smi partition --json
-- amd-smi process --json
-- amd-smi static -g all --json
-- amd-smi version --json
+- firmware --json
+- list --json
+- partition --json
+- process --json
+- ras --cper --folder={folder}
+- static -g all --json
+- static -g {gpu_id} --json
+- version --json
 
 ## Collector Class BiosCollector
 
@@ -300,6 +304,7 @@ Collect memory usage details
 
 - **CMD_WINDOWS**: `wmic OS get FreePhysicalMemory /Value; wmic ComputerSystem get TotalPhysicalMemory /Value`
 - **CMD**: `free -b`
+- **CMD_LSMEM**: `/usr/bin/lsmem`
 
 ### Provides Data
 
@@ -308,6 +313,7 @@ MemoryDataModel
 ### Commands
 
 - free -b
+- /usr/bin/lsmem
 - wmic OS get FreePhysicalMemory /Value; wmic ComputerSystem get TotalPhysicalMemory /Value
 
 ## Collector Class NvmeCollector
@@ -422,7 +428,7 @@ class for collection of PCIe data only supports Linux OS type.
 
     This class will collect important PCIe data from the system running the commands
     - `lspci -vvv` : Verbose collection of PCIe data
-    - `lspci -vt`: Tree view of PCIe data
+    - `lspci -vvvt`: Verbose tree view of PCIe data
     - `lspci -PP`: Path view of PCIe data for the GPUs
     - If system interaction level is set to STANDARD or higher, the following commands will be run with sudo:
         - `lspci -xxxx`: Hex view of PCIe data for the GPUs
@@ -442,7 +448,7 @@ class for collection of PCIe data only supports Linux OS type.
 
 - **SUPPORTED_OS_FAMILY**: `{<OSFamily.LINUX: 3>}`
 - **CMD_LSPCI_VERBOSE**: `lspci -vvv`
-- **CMD_LSPCI_TREE**: `lspci -vt`
+- **CMD_LSPCI_VERBOSE_TREE**: `lspci -vvvt`
 - **CMD_LSPCI_PATH**: `lspci -PP`
 - **CMD_LSPCI_HEX_SUDO**: `lspci -xxxx`
 - **CMD_LSPCI_HEX**: `lspci -x`
@@ -460,8 +466,8 @@ PcieDataModel
 - lspci -xxxx
 - lspci -PP
 - lspci -PP -d {vendor_id}:{dev_id}
-- lspci -vt
 - lspci -vvv
+- lspci -vvvt
 
 ## Collector Class ProcessCollector
 
@@ -646,10 +652,15 @@ Data model for amd-smi data.
 - **gpu_list**: `Optional[list[nodescraper.plugins.inband.amdsmi.amdsmidata.AmdSmiListItem]]`
 - **partition**: `Optional[nodescraper.plugins.inband.amdsmi.amdsmidata.Partition]`
 - **process**: `Optional[list[nodescraper.plugins.inband.amdsmi.amdsmidata.Processes]]`
+- **topology**: `Optional[list[nodescraper.plugins.inband.amdsmi.amdsmidata.Topo]]`
 - **firmware**: `Optional[list[nodescraper.plugins.inband.amdsmi.amdsmidata.Fw]]`
 - **bad_pages**: `Optional[list[nodescraper.plugins.inband.amdsmi.amdsmidata.BadPages]]`
 - **static**: `Optional[list[nodescraper.plugins.inband.amdsmi.amdsmidata.AmdSmiStatic]]`
 - **metric**: `Optional[list[nodescraper.plugins.inband.amdsmi.amdsmidata.AmdSmiMetric]]`
+- **xgmi_metric**: `Optional[list[nodescraper.plugins.inband.amdsmi.amdsmidata.XgmiMetrics]]`
+- **xgmi_link**: `Optional[list[nodescraper.plugins.inband.amdsmi.amdsmidata.XgmiLinks]]`
+- **cper_data**: `Optional[list[nodescraper.models.datamodel.FileModel]]`
+- **amdsmitst_data**: `nodescraper.plugins.inband.amdsmi.amdsmidata.AmdSmiTstData`
 
 ## BiosDataModel Model
 
@@ -763,6 +774,7 @@ Data model for journal logs
 
 - **mem_free**: `str`
 - **mem_total**: `str`
+- **lsmem_output**: `Optional[dict]`
 
 ## NvmeDataModel Model
 
@@ -798,6 +810,8 @@ Pacakge data contains the package data for the system
 ### Model annotations and fields
 
 - **version_info**: `dict[str, str]`
+- **rocm_regex**: `str`
+- **enable_rocm_regex**: `bool`
 
 ## PcieDataModel Model
 
@@ -915,7 +929,11 @@ Data model for in band syslog logs
 
 ## Data Analyzer Class AmdSmiAnalyzer
 
-**Bases**: ['DataAnalyzer']
+### Description
+
+Check AMD SMI Application data for PCIe, ECC errors, CPER data, and analyze amdsmitst metrics
+
+**Bases**: ['CperAnalysisTaskMixin', 'DataAnalyzer']
 
 **Link to code**: [amdsmi_analyzer.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/amdsmi/amdsmi_analyzer.py)
 
@@ -1213,6 +1231,9 @@ Check sysctl matches expected sysctl details
 - **devid_ep**: `Optional[str]`
 - **devid_ep_vf**: `Optional[str]`
 - **sku_name**: `Optional[str]`
+- **expected_xgmi_speed**: `Optional[list[float]]`
+- **analysis_range_start**: `Optional[datetime.datetime]`
+- **analysis_range_end**: `Optional[datetime.datetime]`
 
 ## Analyzer Args Class BiosAnalyzerArgs
 
@@ -1303,6 +1324,8 @@ Check sysctl matches expected sysctl details
 
 - **exp_package_ver**: `Dict[str, Optional[str]]`
 - **regex_match**: `bool`
+- **rocm_regex**: `Optional[str]`
+- **enable_rocm_regex**: `bool`
 
 ## Analyzer Args Class PcieAnalyzerArgs
 

nodescraper/cli/cli.py

@@ -334,6 +334,7 @@ def process_args(
         plugin_arg_index = -1
 
     plugin_arg_map = {}
+    invalid_plugins = []
     if plugin_arg_index != -1 and plugin_arg_index != len(raw_arg_input) - 1:
         top_level_args = raw_arg_input[: plugin_arg_index + 1]
         plugin_args = raw_arg_input[plugin_arg_index + 1 :]
@@ -344,12 +345,26 @@ def process_args(
         else:
             cur_plugin = None
             for arg in plugin_args:
-                if arg in plugin_names:
+                # Handle comma-separated plugin names (but not arguments)
+                if not arg.startswith("-") and "," in arg:
+                    # Split comma-separated plugin names
+                    for potential_plugin in arg.split(","):
+                        potential_plugin = potential_plugin.strip()
+                        if potential_plugin in plugin_names:
+                            plugin_arg_map[potential_plugin] = []
+                            cur_plugin = potential_plugin
+                        elif potential_plugin:
+                            # Track invalid plugin names to log event later
+                            invalid_plugins.append(potential_plugin)
+                elif arg in plugin_names:
                     plugin_arg_map[arg] = []
                     cur_plugin = arg
                 elif cur_plugin:
                     plugin_arg_map[cur_plugin].append(arg)
-    return (top_level_args, plugin_arg_map)
+                elif not arg.startswith("-"):
+                    # Track invalid plugin names to log event later
+                    invalid_plugins.append(arg)
+    return (top_level_args, plugin_arg_map, invalid_plugins)
 
 
 def main(arg_input: Optional[list[str]] = None):
@@ -367,7 +382,9 @@ def main(arg_input: Optional[list[str]] = None):
     parser, plugin_subparser_map = build_parser(plugin_reg, config_reg)
 
     try:
-        top_level_args, plugin_arg_map = process_args(arg_input, list(plugin_subparser_map.keys()))
+        top_level_args, plugin_arg_map, invalid_plugins = process_args(
+            arg_input, list(plugin_subparser_map.keys())
+        )
 
         parsed_args = parser.parse_args(top_level_args)
         system_info = get_system_info(parsed_args)
@@ -387,6 +404,13 @@ def main(arg_input: Optional[list[str]] = None):
         if log_path:
             logger.info("Log path: %s", log_path)
 
+        # Log warning if invalid plugin names were provided
+        if invalid_plugins:
+            logger.warning(
+                "Invalid plugin name(s) ignored: %s. Use 'describe plugin' to list available plugins.",
+                ", ".join(invalid_plugins),
+            )
+
         if parsed_args.subcmd == "summary":
             generate_summary(parsed_args.search_path, parsed_args.output_path, logger)
             sys.exit(0)

nodescraper/interfaces/task.py

@@ -107,6 +107,8 @@ def _build_event(
             data = {"task_name": self.__class__.__name__, "task_type": self.TASK_TYPE}
 
         else:
+            # Copy to avoid mutating the caller's dict
+            data = copy.copy(data)
             data["task_name"] = self.__class__.__name__
             data["task_type"] = self.TASK_TYPE