diff --git a/docs/PLUGIN_DOC.md b/docs/PLUGIN_DOC.md index b2fbc0a..de1b241 100644 --- a/docs/PLUGIN_DOC.md +++ b/docs/PLUGIN_DOC.md @@ -4,7 +4,7 @@ | Plugin | Collection | Analysis | DataModel | Collector | Analyzer | | --- | --- | --- | --- | --- | --- | -| AmdSmiPlugin | firmware --json
list --json
partition --json
process --json
ras --cper --folder={folder}
static -g all --json
static -g {gpu_id} --json
version --json | **Analyzer Args:**
- `check_static_data`: bool
- `expected_gpu_processes`: Optional[int]
- `expected_max_power`: Optional[int]
- `expected_driver_version`: Optional[str]
- `expected_memory_partition_mode`: Optional[str]
- `expected_compute_partition_mode`: Optional[str]
- `expected_pldm_version`: Optional[str]
- `l0_to_recovery_count_error_threshold`: Optional[int]
- `l0_to_recovery_count_warning_threshold`: Optional[int]
- `vendorid_ep`: Optional[str]
- `vendorid_ep_vf`: Optional[str]
- `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] | [AmdSmiDataModel](#AmdSmiDataModel-Model) | [AmdSmiCollector](#Collector-Class-AmdSmiCollector) | [AmdSmiAnalyzer](#Data-Analyzer-Class-AmdSmiAnalyzer) | +| AmdSmiPlugin | firmware --json
list --json
partition --json
process --json
ras --cper --folder={folder}
ras --afid --cper-file {cper_file}
static -g all --json
static -g {gpu_id} --json
version --json | **Analyzer Args:**
- `check_static_data`: bool
- `expected_gpu_processes`: Optional[int]
- `expected_max_power`: Optional[int]
- `expected_driver_version`: Optional[str]
- `expected_memory_partition_mode`: Optional[str]
- `expected_compute_partition_mode`: Optional[str]
- `expected_pldm_version`: Optional[str]
- `l0_to_recovery_count_error_threshold`: Optional[int]
- `l0_to_recovery_count_warning_threshold`: Optional[int]
- `vendorid_ep`: Optional[str]
- `vendorid_ep_vf`: Optional[str]
- `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] | [AmdSmiDataModel](#AmdSmiDataModel-Model) | [AmdSmiCollector](#Collector-Class-AmdSmiCollector) | [AmdSmiAnalyzer](#Data-Analyzer-Class-AmdSmiAnalyzer) | | BiosPlugin | sh -c 'cat /sys/devices/virtual/dmi/id/bios_version'
wmic bios get SMBIOSBIOSVersion /Value | **Analyzer Args:**
- `exp_bios_version`: list[str]
- `regex_match`: bool | [BiosDataModel](#BiosDataModel-Model) | [BiosCollector](#Collector-Class-BiosCollector) | [BiosAnalyzer](#Data-Analyzer-Class-BiosAnalyzer) | | CmdlinePlugin | cat /proc/cmdline | **Analyzer Args:**
- `required_cmdline`: Union[str, List]
- `banned_cmdline`: Union[str, List]
- `os_overrides`: Dict[str, nodescraper.plugins.inband.cmdline.cmdlineconfig.OverrideConfig]
- `platform_overrides`: Dict[str, nodescraper.plugins.inband.cmdline.cmdlineconfig.OverrideConfig] | [CmdlineDataModel](#CmdlineDataModel-Model) | [CmdlineCollector](#Collector-Class-CmdlineCollector) | [CmdlineAnalyzer](#Data-Analyzer-Class-CmdlineAnalyzer) | | DeviceEnumerationPlugin | powershell -Command "(Get-WmiObject -Class Win32_Processor \| Measure-Object).Count"
lspci -d {vendorid_ep}: \| grep -i 'VGA\\|Display\\|3D' \| wc -l
powershell -Command "(wmic path win32_VideoController get name \| findstr AMD \| Measure-Object).Count"
lscpu
lshw
lspci -d {vendorid_ep}: \| grep -i 'Virtual Function' \| wc -l
powershell -Command "(Get-VMHostPartitionableGpu \| Measure-Object).Count" | **Analyzer Args:**
- `cpu_count`: Optional[list[int]]
- `gpu_count`: Optional[list[int]]
- `vf_count`: Optional[list[int]] | [DeviceEnumerationDataModel](#DeviceEnumerationDataModel-Model) | [DeviceEnumerationCollector](#Collector-Class-DeviceEnumerationCollector) | [DeviceEnumerationAnalyzer](#Data-Analyzer-Class-DeviceEnumerationAnalyzer) | @@ -52,6 +52,7 @@ Class for collection of inband tool amd-smi data. - **CMD_STATIC**: `static -g all --json` - **CMD_STATIC_GPU**: `static -g {gpu_id} --json` - **CMD_RAS**: `ras --cper --folder={folder}` +- **CMD_RAS_AFID**: `ras --afid --cper-file {cper_file}` ### Provides Data @@ -64,6 +65,7 @@ AmdSmiDataModel - partition --json - process --json - ras --cper --folder={folder} +- ras --afid --cper-file {cper_file} - static -g all --json - static -g {gpu_id} --json - version --json @@ -764,6 +766,7 @@ Data model for amd-smi data. - **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]]` +- **cper_afids**: `dict[str, int]` - **amdsmitst_data**: `nodescraper.plugins.inband.amdsmi.amdsmidata.AmdSmiTstData` ## BiosDataModel Model