Memory Statistics Config and Show Commands

config/memory_statistics.py

@@ -0,0 +1,114 @@
+import click
+from swsscommon.swsscommon import ConfigDBConnector
+# from utilities_common.cli import AbbreviationGroup
+
+
+class AbbreviationGroup(click.Group):
+    def get_command(self, ctx, cmd_name):
+        return super().get_command(ctx, cmd_name)
+
+
+@click.group(cls=AbbreviationGroup, name="memory-statistics")
+def memory_statistics():
+    """Configure the Memory Statistics feature"""
+    pass
+
+
+def check_memory_statistics_table_existence(memory_statistics_table):
+    """Checks whether the 'MEMORY_STATISTICS' table is configured in Config DB."""
+    if not memory_statistics_table:
+        click.echo("Unable to retrieve 'MEMORY_STATISTICS' table from Config DB.", err=True)
+        return False
+
+    if "memory_statistics" not in memory_statistics_table:
+        click.echo("Unable to retrieve key 'memory_statistics' from MEMORY_STATISTICS table.", err=True)
+        return False
+
+    return True
+
+
+def get_memory_statistics_table(db):
+    """Get the MEMORY_STATISTICS table from the database."""
+    return db.get_table("MEMORY_STATISTICS")
+
+
+@memory_statistics.command(name="enable", short_help="Enable the Memory Statistics feature")
+def memory_statistics_enable():
+    """Enable the Memory Statistics feature"""
+    db = ConfigDBConnector()
+    db.connect()
+
+    memory_statistics_table = get_memory_statistics_table(db)
+    if not check_memory_statistics_table_existence(memory_statistics_table):
+        return  # Exit gracefully on error
+
+    try:
+        db.mod_entry("MEMORY_STATISTICS", "memory_statistics", {"enabled": "true", "disabled": "false"})
+        click.echo("Memory Statistics feature enabled.")
+    except Exception as e:
+        click.echo(f"Error enabling Memory Statistics feature: {str(e)}", err=True)
+
+    click.echo("Save SONiC configuration using 'config save' to persist the changes.")
+
+
+@memory_statistics.command(name="disable", short_help="Disable the Memory Statistics feature")
+def memory_statistics_disable():
+    """Disable the Memory Statistics feature"""
+    db = ConfigDBConnector()
+    db.connect()
+
+    memory_statistics_table = get_memory_statistics_table(db)
+    if not check_memory_statistics_table_existence(memory_statistics_table):
+        return  # Exit gracefully on error
+
+    try:
+        db.mod_entry("MEMORY_STATISTICS", "memory_statistics", {"enabled": "false", "disabled": "true"})
+        click.echo("Memory Statistics feature disabled.")
+    except Exception as e:
+        click.echo(f"Error disabling Memory Statistics feature: {str(e)}", err=True)
+
+    click.echo("Save SONiC configuration using 'config save' to persist the changes.")
+
+
+@memory_statistics.command(name="retention-period", short_help="Configure the retention period for Memory Statistics")
+@click.argument('retention_period', metavar='<retention_period>', required=True, type=int)
+def memory_statistics_retention_period(retention_period):
+    """Set the retention period for Memory Statistics"""
+    db = ConfigDBConnector()
+    db.connect()
+
+    memory_statistics_table = get_memory_statistics_table(db)
+    if not check_memory_statistics_table_existence(memory_statistics_table):
+        return  # Exit gracefully on error
+
+    try:
+        db.mod_entry("MEMORY_STATISTICS", "memory_statistics", {"retention_period": retention_period})
+        click.echo(f"Memory Statistics retention period set to {retention_period} days.")
+    except Exception as e:
+        click.echo(f"Error setting retention period: {str(e)}", err=True)
+
+    click.echo("Save SONiC configuration using 'config save' to persist the changes.")
+
+
+@memory_statistics.command(name="sampling-interval", short_help="Configure the sampling interval for Memory Statistics")
+@click.argument('sampling_interval', metavar='<sampling_interval>', required=True, type=int)
+def memory_statistics_sampling_interval(sampling_interval):
+    """Set the sampling interval for Memory Statistics"""
+    db = ConfigDBConnector()
+    db.connect()
+
+    memory_statistics_table = get_memory_statistics_table(db)
+    if not check_memory_statistics_table_existence(memory_statistics_table):
+        return  # Exit gracefully on error
+
+    try:
+        db.mod_entry("MEMORY_STATISTICS", "memory_statistics", {"sampling_interval": sampling_interval})
+        click.echo(f"Memory Statistics sampling interval set to {sampling_interval} minutes.")
+    except Exception as e:
+        click.echo(f"Error setting sampling interval: {str(e)}", err=True)
+
+    click.echo("Save SONiC configuration using 'config save' to persist the changes.")
+
+
+if __name__ == "__main__":
+    memory_statistics()

show/memory_statistics.py

@@ -0,0 +1,111 @@
+import click
+from tabulate import tabulate
+
+import utilities_common.cli as clicommon
+
+
+#
+# 'memory-statistics' group (show memory-statistics ...)
+#
+@click.group(cls=clicommon.AliasedGroup, name="memory-statistics")
+def memory_statistics():
+    """Show memory statistics configuration and logs"""
+    pass
+
+
+def get_memory_statistics_config(field_name, db_connector):
+    """Fetches the configuration of memory_statistics from `CONFIG_DB`.
+
+    Args:
+      field_name: A string containing the field name in the sub-table of 'memory_statistics'.
+      db_connector: The database connector.
+
+    Returns:
+      field_value: If field name was found, then returns the corresponding value.
+                   Otherwise, returns "Unknown".
+    """
+    field_value = "Unknown"
+    memory_statistics_table = db_connector.get_table("MEMORY_STATISTICS")
+    if (memory_statistics_table and
+            "memory_statistics" in memory_statistics_table and
+            field_name in memory_statistics_table["memory_statistics"]):
+        field_value = memory_statistics_table["memory_statistics"][field_name]
+
+    return field_value
+
+
+@memory_statistics.command(name="memory_statistics", short_help="Show the configuration of memory statistics")
+@click.pass_context
+def config(ctx):
+    """Show the configuration of memory statistics."""
+    db_connector = ctx.obj['db_connector']  # Get the database connector from the context
+    admin_mode = "Disabled"
+    admin_enabled = get_memory_statistics_config("enabled", db_connector)
+    if admin_enabled == "true":
+        admin_mode = "Enabled"
+
+    click.echo("Memory Statistics administrative mode: {}".format(admin_mode))
+
+    retention_time = get_memory_statistics_config("retention_period", db_connector)
+    click.echo("Memory Statistics retention time (days): {}".format(retention_time))
+
+    sampling_interval = get_memory_statistics_config("sampling_interval", db_connector)
+    click.echo("Memory Statistics sampling interval (minutes): {}".format(sampling_interval))
+
+
+def fetch_memory_statistics(starting_time=None, ending_time=None, additional_options=None, db_connector=None):
+    """Fetch memory statistics from the database.
+
+    Args:
+        starting_time: The starting time for filtering the statistics.
+        ending_time: The ending time for filtering the statistics.
+        additional_options: Any additional options for filtering or formatting.
+        db_connector: The database connector.
+
+    Returns:
+        A list of memory statistics entries.
+    """
+    memory_statistics_table = db_connector.get_table("MEMORY_STATISTICS")
+    filtered_statistics = []
+
+    # Ensure you access the right table structure
+    if "memory_statistics" in memory_statistics_table:
+        for key, entry in memory_statistics_table["memory_statistics"].items():
+            # Add filtering logic here based on starting_time, ending_time, and additional options
+            if (not starting_time or entry.get("time", "") >= starting_time) and \
+               (not ending_time or entry.get("time", "") <= ending_time):
+                filtered_statistics.append(entry)
+
+    return filtered_statistics
+
+
+@memory_statistics.command(name="logs", short_help="Show memory statistics logs with optional filtering")
+@click.argument('starting_time', required=False)
+@click.argument('ending_time', required=False)
+@click.argument('additional_options', required=False, nargs=-1)
+@click.pass_context
+def show_memory_statistics_logs(ctx, starting_time, ending_time, additional_options):
+    """Show memory statistics logs with optional filtering by time and additional options."""
+    db_connector = ctx.obj['db_connector']  # Get the database connector from the context
+
+    # Fetch memory statistics
+    memory_statistics = fetch_memory_statistics(
+        starting_time,
+        ending_time,
+        additional_options,
+        db_connector=db_connector
+    )
+    if not memory_statistics:
+        click.echo("No memory statistics available for the given parameters.")
+        return
+
+    # Display the memory statistics
+    headers = ["Time", "Statistic", "Value"]  # Adjust according to the actual fields
+    table_data = [
+        [
+            entry.get("time", "N/A"),
+            entry.get("statistic", "N/A"),
+            entry.get("value", "N/A"),
+            ] for entry in memory_statistics
+    ]
+    click.echo(tabulate(table_data, headers=headers, tablefmt="grid"))