From a1b1032abb634e483fc913aa2c0fed0829ec40e6 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Sat, 25 Apr 2026 00:16:08 +0000 Subject: [PATCH] docs: Update plugin documentation [automated] --- README.md | 6 ++- docs/PLUGIN_DOC.md | 92 ---------------------------------------------- 2 files changed, 4 insertions(+), 94 deletions(-) diff --git a/README.md b/README.md index dd739f25..27c14577 100644 --- a/README.md +++ b/README.md @@ -113,8 +113,10 @@ options: --sys-platform STRING Specify system platform (default: None) --plugin-configs LIST - Comma-separated built-in names and/or plugin config JSON - paths. Built-in: NodeStatus, AllPlugins (default: None) + Comma-separated built-in names and/or plugin config + JSON paths (e.g. --plugin- + configs=NodeStatus,/path/c.json). Built-ins: + NodeStatus, AllPlugins (default: None) --system-config STRING Path to system config json (default: None) --connection-config STRING diff --git a/docs/PLUGIN_DOC.md b/docs/PLUGIN_DOC.md index baa51d5a..5e84641c 100644 --- a/docs/PLUGIN_DOC.md +++ b/docs/PLUGIN_DOC.md @@ -1693,98 +1693,6 @@ Check RDMA statistics for errors (RoCE and other RDMA error counters). **Link to code**: [rdma_analyzer.py](https://github.com/amd/node-scraper/blob/HEAD/nodescraper/plugins/inband/rdma/rdma_analyzer.py) -### Class Variables - -- **ERROR_FIELDS**: `[ - recoverable_errors, - tx_roce_errors, - tx_roce_discards, - rx_roce_errors, - rx_roce_discards, - local_ack_timeout_err, - packet_seq_err, - max_retry_exceeded, - rnr_nak_retry_err, - implied_nak_seq_err, - unrecoverable_err, - bad_resp_err, - local_qp_op_err, - local_protection_err, - mem_mgmt_op_err, - req_remote_invalid_request, - req_remote_access_errors, - remote_op_err, - duplicate_request, - res_exceed_max, - resp_local_length_error, - res_exceeds_wqe, - res_opcode_err, - res_rx_invalid_rkey, - res_rx_domain_err, - res_rx_no_perm, - res_rx_range_err, - res_tx_invalid_rkey, - res_tx_domain_err, - res_tx_no_perm, - res_tx_range_err, - res_irrq_oflow, - res_unsup_opcode, - res_unaligned_atomic, - res_rem_inv_err, - res_mem_err, - res_srq_err, - res_cmp_err, - res_invalid_dup_rkey, - res_wqe_format_err, - res_cq_load_err, - res_srq_load_err, - res_tx_pci_err, - res_rx_pci_err, - out_of_buffer, - out_of_sequence, - req_cqe_error, - req_cqe_flush_error, - resp_cqe_error, - resp_cqe_flush_error, - resp_remote_access_errors, - req_rx_pkt_seq_err, - req_rx_rnr_retry_err, - req_rx_rmt_acc_err, - req_rx_rmt_req_err, - req_rx_oper_err, - req_rx_impl_nak_seq_err, - req_rx_cqe_err, - req_rx_cqe_flush, - req_rx_dup_response, - req_rx_inval_pkts, - req_tx_loc_acc_err, - req_tx_loc_oper_err, - req_tx_mem_mgmt_err, - req_tx_retry_excd_err, - req_tx_loc_sgl_inv_err, - resp_rx_dup_request, - resp_rx_outof_buf, - resp_rx_outouf_seq, - resp_rx_cqe_err, - resp_rx_cqe_flush, - resp_rx_loc_len_err, - resp_rx_inval_request, - resp_rx_loc_oper_err, - resp_rx_outof_atomic, - resp_tx_pkt_seq_err, - resp_tx_rmt_inval_req_err, - resp_tx_rmt_acc_err, - resp_tx_rmt_oper_err, - resp_tx_rnr_retry_err, - resp_tx_loc_sgl_inv_err, - resp_rx_s0_table_err, - resp_rx_ccl_cts_outouf_seq, - tx_rdma_ack_timeout, - tx_rdma_ccl_cts_ack_timeout, - rx_rdma_mtu_discard_pkts -]` -- **CRITICAL_ERROR_FIELDS**: `['unrecoverable_err', 'res_tx_pci_err', 'res_rx_pci_err', 'res_mem_err']` - ## Data Analyzer Class RocmAnalyzer ### Description