Memory Statistics Config and Show Commands by kanza-latif · Pull Request #3575 · sonic-net/sonic-utilities

kanza-latif · 2024-10-14T09:32:34Z

What I did

Provided support for the configuration and show commands of memory statistics feature.

How I did it

I added a new config file config/memory_statistics.py for the configuration commands of memory statistics feature.
Added a show file show/memory_statistics.py for the show commands of memory statistics feature.
Added a test file tests/memory_statistics_test.py to test the config and show commands of memory statistics feature

How to verify it

Cli support for config and show file is available

ridahanif96 · 2024-10-22T12:05:52Z

/azpw run Azure.sonic-utilities

kanza-latif · 2024-10-23T06:30:05Z

/azpw run

mssonicbld · 2024-10-23T06:30:07Z

/AzurePipelines run

azure-pipelines · 2024-10-23T06:30:18Z

Azure Pipelines successfully started running 1 pipeline(s).

ridahanif96 · 2024-10-25T10:12:10Z

@qiluo-msft @xincunli-sonic @zbud-msft @FengPan-Frank We have linked the code PRs. Please help review the feature.
Target 202411, please help with expedite review.

FengPan-Frank · 2024-10-28T07:39:26Z

pls fix pretest analysis failure. thanks

kanza-latif · 2024-10-28T11:30:56Z

@FengPan-Frank I've resolved it, kindly review.

FengPan-Frank · 2024-10-28T11:36:14Z

@FengPan-Frank I've resolved it, kindly review.

seems python test is failed. could you double check?

kanza-latif · 2024-10-28T11:45:07Z

@FengPan-Frank there are some test cases failing but those are not related to memory statistics feature. The memory_statistics_test have passed, could you guide what should i do

FengPan-Frank · 2024-11-05T02:30:14Z

@FengPan-Frank there are some test cases failing but those are not related to memory statistics feature. The memory_statistics_test have passed, could you guide what should i do
you can create dummy PR for verify if it's current pipeline issue or your code issue.

mssonicbld · 2025-01-14T13:13:57Z

/azp run

azure-pipelines · 2025-01-14T13:14:09Z

Azure Pipelines successfully started running 1 pipeline(s).

zhangyanzhao · 2025-01-21T04:03:10Z

Reviewers,
Can you please help to review this PR? Thanks.

qiluo-msft · 2025-01-21T23:34:42Z

config/memory_statistics.py

+        click.echo(msg)
+        log_to_syslog(msg)
+        return True, None
+    except Exception as e:


Exception

Could you except more specific exception type? #Closed

Thank you for your suggestion. I have updated the code to catch more specific exception types, such as KeyError, ValueError, and ConnectionError, instead of using a generic Exception.

Thanks for the new code! however, I still see the "except Exception as e" branch. Is it really needed?

Thanks for the feedback! I have now removed the except Exception as e branch, and only specific exceptions (e.g., KeyError, ConnectionError, RuntimeError, OSError, ValueError) are handled.

qiluo-msft · 2025-01-21T23:36:59Z

config/memory_statistics.py

+    the action and returns a tuple indicating whether the operation was successful.
+
+    Args:
+        status (str): The status to set for memory statistics ("true" or "false").


str

Is it better to use boolean type? #Closed

Thank you for your suggestion. I have modified the code to use a boolean type instead of a string when setting the memory statistics status. This ensures better type safety and improves code readability.

qiluo-msft · 2025-01-21T23:39:13Z

config/memory_statistics.py

+        click.echo(success_msg)
+        log_to_syslog(success_msg)
+        click.echo("Reminder: Please run 'config save' to persist changes.")
+    except Exception as e:


Exception

Could you except more specific exception type? #Closed

I have updated the exception handling to catch specific exceptions rather than using generic Exception handling.

Thanks for the new code! however, I still see the "except Exception as e" branch. Is it really needed?

Thanks for the feedback! I have now removed the except Exception as e branch, and only specific exceptions (e.g., KeyError, ConnectionError, RuntimeError, OSError, ValueError) are handled. Let me know if you have any further suggestions.

qiluo-msft · 2025-01-21T23:50:16Z

show/memory_statistics.py

+                self.config_db.connect()
+                syslog.syslog(syslog.LOG_INFO, "Successfully connected to SONiC config database")
+                return
+            except Exception as e:


Exception

Could you except more specific exception type? #Closed

Thank you for the suggestion. I have updated the exception handling to catch specific exceptions rather than using generic Exception handling.

qiluo-msft · 2025-01-21T23:52:09Z

show/memory_statistics.py

+                    syslog.syslog(syslog.LOG_WARNING,
+                                  f"Failed to connect to database"
+                                  f"(attempt {retries}/{max_retries}): {str(e)}")
+                    time.sleep(retry_delay)


sleep

Could you make except block minimal size? Normally there is no complex retry logic or sleep inside this block. #Closed

I have refactored the exception handling to keep the except block minimal. The retry logic and logging are now handled outside the exception block, ensuring cleaner code and better separation of concerns.

qiluo-msft · 2025-01-21T23:53:04Z

show/memory_statistics.py

+        except Exception as e:
+            error_msg = f"Error retrieving memory statistics configuration: {str(e)}"
+            syslog.syslog(syslog.LOG_ERR, error_msg)
+            raise RuntimeError(error_msg)


raise

lose the exception stack, which make debug harder. #Closed

Thank You your suggestion. To preserve the full exception stack trace, I have updated the code to use raise ... from e. This ensures that the original exception context is retained, making debugging easier by retaining full context while adding additional error messages when necessary.

qiluo-msft · 2025-01-21T23:59:41Z

show/memory_statistics.py

+
+                self.sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
+                self.sock.settimeout(Config.SOCKET_TIMEOUT)
+                self.sock.connect(self.socket_path)


socket_path

What is the socket file permission by design? If allow RO user read and write, is it possible to be exploited by malicious RO user? #Closed

Thank you for pointing this out.The socket file permissions are now explicitly set to 0o600 (read and write for the owner only), ensuring that unauthorized users cannot access or modify the socket. Additionally, ownership is restricted to the root user, preventing potential security risks.

…c, and enhance socket security. Signed-off-by: Arham-Nasir <[email protected]>

mssonicbld · 2025-02-10T06:12:41Z

/azp run

azure-pipelines · 2025-02-10T06:12:52Z

Azure Pipelines successfully started running 1 pipeline(s).

Arham-Nasir · 2025-02-10T11:43:25Z

Hi everyone, I have addressed all review comments and pushed the updated code. Some previous approvals were dismissed due to the new push. Kindly review the latest changes at your convenience. Thank you!

Signed-off-by: Arham-Nasir <[email protected]>

mssonicbld · 2025-02-12T13:10:54Z

/azp run

azure-pipelines · 2025-02-12T13:11:05Z

Azure Pipelines successfully started running 1 pipeline(s).

kanza-latif · 2025-02-21T07:19:04Z

@qiluo-msft We have incorporated all the suggested changes. Please help review and merge this

What I did Provided support for the configuration and show commands of memory statistics feature. How I did it I added a new config file config/memory_statistics.py for the configuration commands of memory statistics feature. Added a show file show/memory_statistics.py for the show commands of memory statistics feature. Added a test file tests/memory_statistics_test.py to test the config and show commands of memory statistics feature How to verify it Cli support for config and show file is available

kanza-latif added 3 commits October 14, 2024 14:30

added show and config commands

ac16864

resolved the errors

f4811d1

resolved the errors

b8d7274

kanza-latif changed the title ~~added show and config commands~~ Memory Statistics Config and Show Commands Oct 16, 2024

ridahanif96 mentioned this pull request Oct 17, 2024

HLD for Memory_Statistics sonic-net/SONiC#1760

Merged

added test filw

636f30a

kanza-latif added 2 commits October 23, 2024 14:06

updated test cases

81df5f0

updated test cases

1ad1222

kanza-latif added 2 commits October 28, 2024 11:38

updated the mock db

29afad4

removed pre-commit errors

aecbc72

kanza-latif added 8 commits October 28, 2024 12:52

resolivng pre-commit errors

2d066ee

resolivng pre-commit errors

0cf9043

added mock db in config file

52d7c0a

removed incomaptibilities from the config and test files

43f1f9c

removed incomaptibilities from the config and test files

b4716c3

updated the test file

b17f226

updated the test file

a6680d9

corrected the failing test case

732612f

kanza-latif added 2 commits November 5, 2024 11:35

added testfile for show commands

7b17295

added testfile for show commands

5e72f6b

Arham-Nasir dismissed stale reviews from xincunli-sonic and FengPan-Frank via dab65d4 January 14, 2025 13:13

zhangyanzhao requested a review from qiluo-msft January 21, 2025 04:02

xincunli-sonic previously approved these changes Jan 21, 2025

View reviewed changes

qiluo-msft reviewed Jan 21, 2025

View reviewed changes

Refactor exception handling, improve type safety, optimize retry logi…

9974f39

…c, and enhance socket security. Signed-off-by: Arham-Nasir <[email protected]>

Arham-Nasir dismissed xincunli-sonic’s stale review via 9974f39 February 10, 2025 06:12

xincunli-sonic previously approved these changes Feb 10, 2025

View reviewed changes

Remove generic except Exception and handle specific errors

b33678e

Signed-off-by: Arham-Nasir <[email protected]>

Arham-Nasir dismissed xincunli-sonic’s stale review via b33678e February 12, 2025 13:10

kanza-latif requested review from Arham-Nasir and qiluo-msft February 21, 2025 07:19

qiluo-msft approved these changes Feb 26, 2025

View reviewed changes

qiluo-msft merged commit 9f1eab4 into sonic-net:master Feb 27, 2025
7 checks passed

Conversation

kanza-latif commented Oct 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What I did

How I did it

How to verify it

Uh oh!

ridahanif96 commented Oct 22, 2024

Uh oh!

kanza-latif commented Oct 23, 2024

Uh oh!

mssonicbld commented Oct 23, 2024

Uh oh!

azure-pipelines bot commented Oct 23, 2024

Uh oh!

ridahanif96 commented Oct 25, 2024

Uh oh!

FengPan-Frank commented Oct 28, 2024

Uh oh!

kanza-latif commented Oct 28, 2024

Uh oh!

FengPan-Frank commented Oct 28, 2024

Uh oh!

kanza-latif commented Oct 28, 2024

Uh oh!

FengPan-Frank commented Nov 5, 2024

Uh oh!

mssonicbld commented Jan 14, 2025

Uh oh!

azure-pipelines bot commented Jan 14, 2025

Uh oh!

zhangyanzhao commented Jan 21, 2025

Uh oh!

qiluo-msft Jan 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Arham-Nasir Feb 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

qiluo-msft Jan 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

qiluo-msft Jan 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

qiluo-msft Jan 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

qiluo-msft Jan 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

qiluo-msft Jan 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

qiluo-msft Jan 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

kanza-latif commented Oct 14, 2024 •

edited

Loading

qiluo-msft Jan 21, 2025 •

edited

Loading

Arham-Nasir Feb 12, 2025 •

edited

Loading

qiluo-msft Jan 21, 2025 •

edited

Loading

qiluo-msft Jan 21, 2025 •

edited

Loading

qiluo-msft Jan 21, 2025 •

edited

Loading

qiluo-msft Jan 21, 2025 •

edited

Loading

qiluo-msft Jan 21, 2025 •

edited

Loading

qiluo-msft Jan 21, 2025 •

edited

Loading