+
+
+ Figure 6: Sequence diagram for displaying the current memory statistics configuration in ConfigDB using the CLI
+
+
+
+
+
+## SAI API
+
+No SAI API change or addition is needed for this HLD.
+
+## Configuration and Management
+
+### **Daemon Configuration Management**
+
+
+The `memorystatsd` process will dynamically manage its configuration with the help of `hostcfgd`. The design ensures reliable behavior by utilizing both a predefined configuration file and the ConfigDB for real-time updates.
+
+- **Read Configuration at Startup**: Upon startup, the `memorystatsd` process reads its default configuration from a predefined config file. This guarantees that in the event of a restart—whether due to a crash or manual intervention—the daemon will always return to a known, consistent state.
+
+- **Monitor ConfigDB for Changes**: During runtime, `hostcfgd` monitors the `MEMORY_STATISTICS` table in ConfigDB for any configuration changes made via the CLI, such as adjustments to retention periods, sampling intervals, or enabling/disabling the daemon.
+
+- **Signal Daemon to Reload Configuration**: When a configuration change is detected in ConfigDB, `hostcfgd` signals the `memorystatsd` process using the `SIGHUP` signal to reload its configuration without restarting the process. This ensures the changes are applied dynamically during runtime.
+
+- **Graceful Shutdown with SIGTERM**: The `memorystatsd` process is designed to handle the `SIGTERM` signal for a graceful shutdown, allowing it to safely terminate and clean up resources. This ensures any related processes or files are properly handled before the daemon stops.
+
+- **Revert to Default on Restart**: While the daemon can reload configuration from ConfigDB during runtime, upon any restart (whether triggered by a crash or other factors), it will always revert to the default settings defined in the configuration file. This separation between startup defaults and runtime updates ensures predictable and safe behavior in the event of a failure.
+
+- **Default Disabled State**: By default, the `memorystatsd` process will be **disabled**. The user must manually enable it using the CLI before it starts collecting memory statistics. This provides control over when the daemon begins its operations.
+
+### **Workflow for Configuration Management**:
+
+1. **Initial Setup**: Default settings, including retention periods and sampling intervals, are written to the config file during deployment. Optionally, these settings may also be written to ConfigDB.
+
+2. **Daemon Startup**: On startup, `memorystatsd` reads its configuration from the predefined config file, initializing the necessary parameters such as retention period and sampling interval. However, it will start in a **disabled state** by default, requiring manual activation.
+
+3. **Enable Daemon Manually**: Administrators need to manually enable the `memorystatsd` process via the CLI before it starts collecting memory statistics.
+
+4. **Runtime Configuration Changes**: Administrators can modify settings like retention periods or sampling intervals via the CLI. These changes are written directly to the `MEMORY_STATISTICS` in ConfigDB.
+
+5. **Monitor ConfigDB for Changes**: `hostcfgd` continuously monitors ConfigDB for updates to the `MEMORY_STATISTICS`.
+
+6. **Signal Daemon to Reload Configuration**: Upon detecting changes in ConfigDB, `hostcfgd` sends a `SIGHUP` signal to the `memorystatsd` daemon, prompting it to reload its configuration without restarting.
+
+7. **Reload Daemon**: The `memorystatsd` process applies the new settings from ConfigDB dynamically, allowing the daemon to continue operating with updated parameters during runtime.
+
+8. **Handling Crashes and Restarts**: In case of a crash or restart, the `memorystatsd` daemon will always reload its default settings from the config file, ensuring a consistent startup state. Runtime-configured values from ConfigDB are only applied during runtime and not retained after a restart unless manually reloaded.
+
+9. **Graceful Shutdown**: When the daemon needs to be stopped, the `SIGTERM` signal ensures a graceful shutdown, where the daemon cleans up resources and terminates smoothly.
+
+### Config DB Enhancements
+
+A new table, `MEMORY_STATISTICS`, will be introduced in `ConfigDB` to store the configuration settings of the Memory Statistics feature. This table will allow for management of data collection frequency, retention period, and enable/disable status. The relevant configuration parameters and the schema for this table are detailed below.
+
+**MEMORY_STATS Configuration Parameters**
+
+| Parameter | Type | Description |
+|---------------------|-------------|----------------------------------------------------------------|
+| enabled | boolean | Enable or disable memory statistics collection. |
+| sampling_interval | unit8 | Interval for memory data collection. |
+| retention_period | unit8 | Duration for which memory data is retained. |
+
+**Config DB Schema**
+```json
+
+MEMORY_STATISTICS: {
+ "memory_statistics": {
+ "enabled": "true",
+ "sampling_interval": "5",
+ "retention_period": "15"
+ }
+}
+```
+
+
+### CLI/YANG Model Enhancements
+
+#### CLI Commands
+
+**Enable/Disable Memory Statistics Monitoring**
+
+To enable or disable the memory statistics monitoring feature, use the following command:
+
+ admin@sonic:~$ config memory-stats enable/disable
+ By default, it is disabled.
+
+**Set the Frequency of Memory Data Collection**
+
+To configure the interval for memory data collection, use the following command:
+
+ admin@sonic:~$ config memory-stats sampling-interval
+ Default sampling-interval is 5 minutes
+
+**Adjust the Data Retention Period**
+
+To set how long the memory data should be retained, use the following command:
+
+ admin@sonic:~$ config memory-stats retention-period
+ Default retention-period is 15 days
+
+**View Memory Usage**
+
+To display memory usage statistics, use the following command with optional parameters for time range and specific metrics:
+
+ admin@sonic:~$ show memory-stats [--from ] [--to ] [--select ]
+
+**Command Definition**
+ - **show memory-stats:** Display basic memory usage statistics
+ - **--from :** Display memory statistics from the specified start date-time.
+ - **--to :** Display memory statistics up to the specified end date-time.
+ - **--select :** Display specific memory statistics, such as total memory.
+
+ **Sample Output for Memory Usage**
+
+Below is an example of the Memory Statistics output as it appears in the CLI. This display provides a summary of system memory metrics over a default time period, ideal for routine monitoring and analysis:
+
+
+ admin@sonic:~$ show memory-stats
+
+
+ Codes: M - minutes, H - hours, D - days
+ --------------------------------------------------------------------------------
+ Report Generated: 2024-06-15 09:00:00
+ Analysis Period: From 2024-06-01 09:00:00 to 2024-06-15 09:00:00
+ Interval: 2 days
+ --------------------------------------------------------------------------------
+ Metric Current High Low D1-D3 D3-D5 D5-D7 D7-D9 D9-D11 D11-D13 D13-D15
+ Value Value Value 01Jun24 03Jun24 05Jun24 07Jun24 09Jun24 11Jun24 13Jun24
+ -------------- -------- -------- -------- --------- --------- --------- --------- --------- --------- ---------
+ Total Memory 15.6G 15.6G 15.1G 15.1G 15.2G 15.3G 15.3G 15.4G 15.5G 15.5G
+ Used Memory 2.3G 2.5G 2.0G 2.1G 2.2G 2.2G 2.3G 2.4G 2.3G 2.2G
+ Free Memory 11.9G 12.4G 10.6G 11.0G 11.2G 11.4G 11.5G 11.7G 11.8G 11.9G
+ Available Memory 13.0G 14.3G 12.4G 12.6G 12.7G 12.8G 12.9G 13.0G 13.1G 13.2G
+ Cached Memory 1.2G 1.5G 1.0G 1.1G 1.2G 1.3G 1.4G 1.3G 1.4G 1.2G
+ Buffer Memory 0.3G 0.4G 0.2G 0.2G 0.3G 0.3G 0.4G 0.3G 0.3G 0.4G
+ Shared Memory 0.5G 0.6G 0.4G 0.5G 0.5G 0.5G 0.4G 0.5G 0.5G 0.5G
+
+
+**View Memory Statistics Configuration**
+
+To display the current configuration parameters such as data collection frequency, retention period, and enable/disable status in the MEMORY_STATISTICS_TABLE, use the following command:
+
+ admin@sonic:~$ show memory-stats config
+
+**Sample Output for Memory Statistics Configuration**
+
+Below is an example of the Memory Statistics Configuration output as it appears in the CLI. This display provides a snapshot of the current configuration settings for memory statistics monitoring in confgdb:
+
+ admin@sonic:~$ show memory-stats config
+
+ Memory Statistics Configuration:
+ --------------------------------
+ Enabled: true
+ Sampling Interval: 5
+ Retention Period: 15
+
+ #### YANG Model Enhancements
+
+A new YANG Model for sonic-memory-stats will be added.
+
+```
+module sonic-memory-statistics {
+ yang-version 1.1;
+
+ namespace "http://github.com/sonic-net/sonic-memory-statistics";
+ prefix mem;
+
+ import sonic-types {
+ prefix stypes;
+ }
+
+ description "YANG module for configuring memory statistics in SONiC-based OS.";
+
+ revision 2024-07-22 {
+ description "First Revision";
+ }
+
+ container sonic-memory-statistics {
+ container MEMORY_STATISTICS {
+ description "Memory statistics configuration parameters.";
+ container memory_statistics{
+ leaf enabled {
+ type boolean;
+ default false;
+ description "Flag to enable or disable memory statistics collection. If set to false, the memory statistics collection will stop.";
+ }
+
+ leaf sampling_interval {
+ type uint8 {
+ range "3..15";
+ }
+ units "minutes";
+ default 5;
+ description "Time interval in minutes for sampling memory statistics. Valid range, is between 3 minutes to 30 minutes.";
+ }
+
+ leaf retention_period {
+ type uint8 {
+ range "1..30";
+ }
+ units "days";
+ default 15;
+ description "Retention period for memory statistics data, defined in days. Valid range is from 1 day to 30 days.";
+ }
+ }
+ }
+ }
+}
+
+ ```
+
+
+
+## Warmboot and Fastboot Design Impact
+
+There is no impact on warmboot/fastboot functionalities by this HLD.
+
+## Testing Requirements/Design
+
+### Unit Test Cases
+
+| Test Case ID | Test Case Description |
+|--------------|----------------------------------------------------------------------------------------------|
+| UT1 | Verify CLI to show default memory statistics for the last 15 days |
+| UT2 | Verify CLI to show memory data for a custom time range using --from and --to options |
+| UT3 | Verify CLI to show selective memory metrics using the --select option |
+| UT4 | Verify CLI for error handling with incorrect syntax or invalid parameters |
+| UT5 | Verify CLI to reject future dates in --from or --to options |
+| UT6 | Verify CLI to reject cases where --from date is later than --to date |
+| UT7 | Verify CLI to configure memory data collection frequency using config memory-stats sampling-interval |
+| UT8 | Verify CLI to configure memory data retention period using config memory-stats retention-period |
+| UT9 | Verify CLI to enable memory statistics monitoring using config memory-stats enable |
+| UT10 | Verify CLI to disable memory statistics monitoring using config memory-stats disable |
+
+### System Test Cases
+
+| Test Case ID | Test Case Description |
+|--------------|------------------------------------------------------------------------------------------------------------|
+| ST1 | Validate the end-to-end functionality of the memory statistics daemon process, ensuring proper configuration reading, restart on update, data collection, and data retention |
+
+## Future Work
+
+- Implement an alert system to notify administrators of significant memory usage anomalies or thresholds to enhance proactive maintenance capabilities.
+- Expand the feature to collect additional memory metrics.
+ 
+ 
+ 
+ 
+ 
+