CLI for Configuring PFC Historical Statistics

[peterbailey-arista]

What I did

Added support for configuring pfc statistical history through following commands:

• config pfcwd start --pfc-stat-history
• config pfcwd pfc_stat_history <enable|disable>
• show pfcwd config

These changes were made for the PFC Historical Statistics feature: sonic-net/SONiC#1904

How I did it

• Added to the PFCWD script with a pfc-stat-history flag for starting the watchdog with history enabled
• Added to the PFCWD script with a pfc_stat_history command for enabling/disabling history on selected ports

How to verify it

• Run the sonic-utilities unit tests
• Run config pfcwd start <ports> <detection-time> --pfc-stat-history on a switch, verify the configurations with show pfcwd config
• Run config pfcwd pfc_stat_history enable|disable <ports> on a switch, verify the configurations with show pfcwd config

New command output (if the output of a command-line utility has changed)

Example output of show pfcwd config:

Changed polling interval to 600ms
     PORT    ACTION    DETECTION TIME    RESTORATION TIME    HISTORY
---------  --------  ----------------  ------------------  ---------
Ethernet0   forward               102                 101    disable
Ethernet4      drop               600                 600     enable
Ethernet8      drop               600                 600    disable

[mssonicbld]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[maipbui]

can you move new config command to config directory? I don't think utilities_common is a place to add new config command

[peterbailey-arista]

Thank you for reviewing this as well.
The implementation has since changed to use the PFCWD orchagent so I have also changed the CLI to be configured through the PFCWD config and show commands instead.

[mssonicbld]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[mssonicbld]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[mssonicbld]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[mssonicbld]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[mssonicbld]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[vaibhavhd]

@peterbailey-arista I think this PR has introduced a test regression that is preventing submodule update PR from passing the PR tests.

I checked the failure logs and it seems like this PR from Arista is causing OA to not process the stats
Submodule update PR that is blocked - sonic-net/sonic-buildimage#23557

Example of the failed run - https://elastictest.org/scheduler/testplan/68c920ad288a03159090b019?testcase=generic_config_updater%2Ftest_pfcwd_status.py%7C%7C%7C2&type=console

Syslog errors from the failed run:

'2025 Sep 16 09:31:04.158401 vlab-01 ERR swss#orchagent: :- createEntry: Failed to parse PFC Watchdog Ethernet4 configuration. Unknown attribute pfc_stat_history.\n',
'2025 Sep 16 09:31:04.159063 vlab-01 ERR swss#orchagent: :- doTask: Failed to process PFC watchdog SET task, invalid entry\n',

There is another issue that I suspect here - None/ Null in the config that leads to config check failure:
extract_pfcwd_config = defaultdict(None, {'Ethernet4': {'action': 'drop', 'detect_time': '200', 'restore_time': '200'}

DEBUG:tests.conftest:core_dump_and_config_check failed, check_result:
"config_db_check": {"failed": true,
"inconsistent_config": {"vlab-01": {"null": {}}}}}

[peterbailey-arista]

@vaibhavhd I see that sonic-net/sonic-buildimage#23491 which contains submodule bump up with the orchagent change to process the pfc stat history param is also unmerged.

Thank you for bringing this to my attention, the fix for the syslog errors is for the swss change to merge first. Is that possible?

For the generic_config_updater test I see sonic-net/sonic-mgmt#20667 has already been made to handle the problem. So the fix should be to include this commit (70648ef) in the submodule bump up as well