Memory Statistics Config and Show Commands #3575

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 · 2024-12-26T09:23:43Z

/azp run

azure-pipelines · 2024-12-26T09:23:53Z

Azure Pipelines successfully started running 1 pipeline(s).

Arham-Nasir · 2024-12-26T10:23:40Z

Hi @xincunli-sonic , all suggested changes have been addressed. kindly review and help merge this PR. Thank you!

Arham-Nasir · 2024-12-27T06:56:09Z

Hi @FengPan-Frank , kindly review and help merge this PR. Thank you!

zbud-msft · 2024-12-27T21:30:34Z

config/memory_statistics.py

+    syslog.syslog(level, message)
+
+
+def get_db_connection():


Seems like every command we are creating a new connection to config db. Perhaps we can create a class variable and create only one connection and reuse?

Hi @zbud-msft ,Thanks for the feedback. I have implemented a Singleton pattern for the database connection, ensuring a single connection is reused across all commands.

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

mssonicbld · 2024-12-30T12:15:53Z

/azp run

azure-pipelines · 2024-12-30T12:16:03Z

Azure Pipelines successfully started running 1 pipeline(s).

xincunli-sonic · 2025-01-06T18:42:12Z

config/memory_statistics.py

+        level (int): The syslog log level.
+    """
+    syslog.openlog("memory_statistics", syslog.LOG_PID | syslog.LOG_CONS, syslog.LOG_USER)
+    syslog.syslog(level, message)


syslog

Suggest to close the log after msg being logged.

def log_message(...):
try:
syslog.openlog(...)
syslog.syslog(...)
finally:
syslog.closelog()

Thank you for the suggestion. I have added a try-finally block to ensure syslog.closelog() is always called after logging the message. Please let me know if there is anything else you’d like me to adjust.

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

mssonicbld · 2025-01-07T10:06:57Z

/azp run

azure-pipelines · 2025-01-07T10:07:09Z

Azure Pipelines successfully started running 1 pipeline(s).

FengPan-Frank

LGTM

wajahatrazi · 2025-01-09T07:42:45Z

@qiluo-msft

This PR has been approved with the latest updates and modifications, kindly help merge this into the SONiC master.

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

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?

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?

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?

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?

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.

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.

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?

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

zbud-msft reviewed Dec 27, 2024

View reviewed changes

Implement single DB connection for config commands

c47b61b

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

xincunli-sonic reviewed Jan 6, 2025

View reviewed changes

add closelog to ensure that connection is closed

cf7f6d0

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

FengPan-Frank previously approved these changes Jan 7, 2025

View reviewed changes

xincunli-sonic previously approved these changes Jan 7, 2025

View reviewed changes

update and restructure CLI documentation

dab65d4

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

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 approved these changes Jan 21, 2025

View reviewed changes

qiluo-msft reviewed Jan 21, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Memory Statistics Config and Show Commands #3575

Memory Statistics Config and Show Commands #3575

kanza-latif commented Oct 14, 2024 •

edited

Loading

ridahanif96 commented Oct 22, 2024

kanza-latif commented Oct 23, 2024

mssonicbld commented Oct 23, 2024

azure-pipelines bot commented Oct 23, 2024

ridahanif96 commented Oct 25, 2024

FengPan-Frank commented Oct 28, 2024

kanza-latif commented Oct 28, 2024

FengPan-Frank commented Oct 28, 2024

kanza-latif commented Oct 28, 2024

FengPan-Frank commented Nov 5, 2024

mssonicbld commented Dec 26, 2024

azure-pipelines bot commented Dec 26, 2024

Arham-Nasir commented Dec 26, 2024

Arham-Nasir commented Dec 27, 2024

zbud-msft Dec 27, 2024

Arham-Nasir Dec 30, 2024 •

edited

Loading

mssonicbld commented Dec 30, 2024

azure-pipelines bot commented Dec 30, 2024

xincunli-sonic Jan 6, 2025

Arham-Nasir Jan 7, 2025

mssonicbld commented Jan 7, 2025

azure-pipelines bot commented Jan 7, 2025

FengPan-Frank left a comment

wajahatrazi commented Jan 9, 2025

mssonicbld commented Jan 14, 2025

azure-pipelines bot commented Jan 14, 2025

zhangyanzhao commented Jan 21, 2025

qiluo-msft Jan 21, 2025

qiluo-msft Jan 21, 2025

qiluo-msft Jan 21, 2025

qiluo-msft Jan 21, 2025

qiluo-msft Jan 21, 2025

qiluo-msft Jan 21, 2025

qiluo-msft Jan 21, 2025

Memory Statistics Config and Show Commands #3575

Are you sure you want to change the base?

Memory Statistics Config and Show Commands #3575

Conversation

kanza-latif commented Oct 14, 2024 • edited Loading

What I did

How I did it

How to verify it

ridahanif96 commented Oct 22, 2024

kanza-latif commented Oct 23, 2024

mssonicbld commented Oct 23, 2024

azure-pipelines bot commented Oct 23, 2024

ridahanif96 commented Oct 25, 2024

FengPan-Frank commented Oct 28, 2024

kanza-latif commented Oct 28, 2024

FengPan-Frank commented Oct 28, 2024

kanza-latif commented Oct 28, 2024

FengPan-Frank commented Nov 5, 2024

mssonicbld commented Dec 26, 2024

azure-pipelines bot commented Dec 26, 2024

Arham-Nasir commented Dec 26, 2024

Arham-Nasir commented Dec 27, 2024

Choose a reason for hiding this comment

Arham-Nasir Dec 30, 2024 • edited Loading

Choose a reason for hiding this comment

mssonicbld commented Dec 30, 2024

azure-pipelines bot commented Dec 30, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mssonicbld commented Jan 7, 2025

azure-pipelines bot commented Jan 7, 2025

FengPan-Frank left a comment

Choose a reason for hiding this comment

wajahatrazi commented Jan 9, 2025

mssonicbld commented Jan 14, 2025

azure-pipelines bot commented Jan 14, 2025

zhangyanzhao commented Jan 21, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kanza-latif commented Oct 14, 2024 •

edited

Loading

Arham-Nasir Dec 30, 2024 •

edited

Loading