Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Mellanox] enable the SDK api recording by default #19925

Merged
merged 1 commit into from
Oct 22, 2024

Conversation

yuazhe
Copy link
Contributor

@yuazhe yuazhe commented Aug 16, 2024

Why I did it

SDK sniffer will record the RPC calls from the SDK user API library to the sx_sdk task into a .pcap file. This .pcap file can be replayed afterward to get the exact same state on SDK and FW to reproduce and investigate issues.

SDK added cyclic mode of API sniffer, and previously, users could use config platform mlnx sniffer enable/disable to control the feature, now they must manually change the content of saiprofile. The old CLI entry point will be removed.

Depending on SAI 2405.28.0.45

Work item tracking
  • Microsoft ADO (number only):

How I did it

added relevant SAI keys in sai-common.profile
removed deprecated CLI in sonic-utilities sonic-net/sonic-utilities#3491

How to verify it

check the pcap file under /var/log/sdk_dbg

Which release branch to backport (provide reason below if selected)

  • 201811
  • 201911
  • 202006
  • 202012
  • 202106
  • 202111
  • 202205
  • 202211
  • 202305

Tested branch (Please provide the tested image version)

  • 202405

Description for the changelog

Link to config_db schema for YANG module changes

A picture of a cute animal (not mandatory but encouraged)

Signed-off-by: Yuanzhe, Liu <yualiu@nvidia.com>
@liushilongbuaa
Copy link
Contributor

/azpw ms_conflict -f

@liat-grozovik
Copy link
Collaborator

@yuazhe once this is enabled, what are the CLI commands that should not be used?
please have a PR that introduce the CLI removal as well.

@yuazhe
Copy link
Contributor Author

yuazhe commented Oct 21, 2024

@yuazhe once this is enabled, what are the CLI commands that should not be used? please have a PR that introduce the CLI removal as well.

@liat-grozovik at this time there is no new CLI available, user need to manually edit the SAI profile to control this feature. Regarding the CLI removal, the pr had been stated in the description sonic-net/sonic-utilities#3491

@bingwang-ms
Copy link
Contributor

Hi @yuazhe, I do have concern in enabling api recording by default. Particularly on some weak CPU platform (like SN2700). The sx_sdk is already consuming lot of memory and CPU.

@yuazhe
Copy link
Contributor Author

yuazhe commented Oct 22, 2024

Hi @yuazhe, I do have concern in enabling api recording by default. Particularly on some weak CPU platform (like SN2700). The sx_sdk is already consuming lot of memory and CPU.

Hi, @bingwang-ms Regarding the performance concern, we had run regression testing on all platforms including SN2700 and no degradation had been found. Besides, for every API, we expect less than 2% execution time increase when api recording enabled.

@liat-grozovik liat-grozovik merged commit dd395e3 into sonic-net:master Oct 22, 2024
12 checks passed
liat-grozovik pushed a commit to sonic-net/sonic-utilities that referenced this pull request Oct 22, 2024
…how techsupport (#3491)

- What I did
SDK had upgraded the way of api sniffer and this feature will be enabled by default sonic-net/sonic-buildimage#19925, so make relevant changes:

1. Remove deprecated sdk sniffer cli
2. Collect sdk dump in show techsupport
3. Update the command reference doc.

Signed-off-by: Yuanzhe, Liu <yualiu@nvidia.com>
@bingwang-ms
Copy link
Contributor

Hi @yuazhe, since this is an enhancement, I tend to leave it for next release (202411).

@yuazhe
Copy link
Contributor Author

yuazhe commented Nov 4, 2024

Hi @yuazhe, since this is an enhancement, I tend to leave it for next release (202411).

Hi, @bingwang-ms I would like to emphasis the advantage of this feature, as it can record sdk calling in the real time and if you still decide to put it to 2411, please also be aware that sonic-net/sonic-utilities#3491 is depend on this pr.

rkavitha-hcl pushed a commit to rkavitha-hcl/sonic-buildimage that referenced this pull request Nov 15, 2024
- Why I did it
SDK sniffer will record the RPC calls from the SDK user API library to the sx_sdk task into a .pcap file. This .pcap file can be replayed afterward to get the exact same state on SDK and FW to reproduce and investigate issues.

SDK added cyclic mode of API sniffer, and previously, users could use config platform mlnx sniffer enable/disable to control the feature, now they must manually change the content of saiprofile. The old CLI entry point will be removed.

- How I did it
Added relevant SAI keys in sai-common.profile
removed deprecated CLI in sonic-utilities sonic-net/sonic-utilities#3491

- How to verify it
Check the pcap file under /var/log/sdk_dbg

Signed-off-by: Yuanzhe, Liu <yualiu@nvidia.com>
aidan-gallagher pushed a commit to aidan-gallagher/sonic-buildimage that referenced this pull request Nov 16, 2024
- Why I did it
SDK sniffer will record the RPC calls from the SDK user API library to the sx_sdk task into a .pcap file. This .pcap file can be replayed afterward to get the exact same state on SDK and FW to reproduce and investigate issues.

SDK added cyclic mode of API sniffer, and previously, users could use config platform mlnx sniffer enable/disable to control the feature, now they must manually change the content of saiprofile. The old CLI entry point will be removed.

- How I did it
Added relevant SAI keys in sai-common.profile
removed deprecated CLI in sonic-utilities sonic-net/sonic-utilities#3491

- How to verify it
Check the pcap file under /var/log/sdk_dbg

Signed-off-by: Yuanzhe, Liu <yualiu@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants