Add multi ASIC support for syslog rate limit feature (#3235)

* Add multi ASIC support for syslog rate limit feature

* Update command ref

Author: Junchao-Mellanox

config/syslog.py

@@ -5,7 +5,9 @@
 import subprocess
 
 import utilities_common.cli as clicommon
+import utilities_common.multi_asic as multi_asic_util
 from sonic_py_common import logger
+from sonic_py_common import multi_asic
 from syslog_util import common as syslog_common
 
 
@@ -457,20 +459,46 @@ def delete(db, server_ip_address):
 def rate_limit_host(db, interval, burst):
     """ Configure syslog rate limit for host """
     syslog_common.rate_limit_validator(interval, burst)
-    syslog_common.save_rate_limit_to_db(db, None, interval, burst, log)
+    syslog_common.save_rate_limit_to_db(db.cfgdb, None, interval, burst, log)
 
 
 @syslog.command("rate-limit-container")
 @click.argument("service_name", required=True)
 @click.option("-i", "--interval", help="Configures syslog rate limit interval in seconds for specified containers", type=click.IntRange(0, 2147483647))
 @click.option("-b", "--burst", help="Configures syslog rate limit burst in number of messages for specified containers", type=click.IntRange(0, 2147483647))
+@click.option('--namespace', '-n', 'namespace', default=None, 
+              type=click.Choice(multi_asic_util.multi_asic_ns_choices() + ['default']), 
+              show_default=True, help='Namespace name or all')
 @clicommon.pass_db
-def rate_limit_container(db, service_name, interval, burst):
+def rate_limit_container(db, service_name, interval, burst, namespace):
     """ Configure syslog rate limit for containers """
     syslog_common.rate_limit_validator(interval, burst)
-    feature_data = db.cfgdb.get_table(syslog_common.FEATURE_TABLE)
+    features = db.cfgdb.get_table(syslog_common.FEATURE_TABLE)
+    syslog_common.service_validator(features, service_name)
+    
+    global_feature_data, per_ns_feature_data = syslog_common.extract_feature_data(features)
+    if not namespace:
+        # for all namespaces
+        for namespace, cfg_db in db.cfgdb_clients.items():
+            if namespace == multi_asic.DEFAULT_NAMESPACE:
+                feature_data = global_feature_data
+            else:
+                feature_data = per_ns_feature_data
+            if service_name and service_name not in feature_data:
+                continue
+            syslog_common.service_validator(feature_data, service_name)
+            syslog_common.save_rate_limit_to_db(cfg_db, service_name, interval, burst, log)
+        return
+    elif namespace == 'default':
+        # for default/global namespace only
+        namespace = multi_asic.DEFAULT_NAMESPACE
+        feature_data = global_feature_data
+    else:
+        # for a specific namespace
+        feature_data = per_ns_feature_data
+    
     syslog_common.service_validator(feature_data, service_name)
-    syslog_common.save_rate_limit_to_db(db, service_name, interval, burst, log)
+    syslog_common.save_rate_limit_to_db(db.cfgdb_clients[namespace], service_name, interval, burst, log)
 
 
 @syslog.group(
@@ -482,14 +510,70 @@ def rate_limit_feature():
     pass
 
 
+def get_feature_names_to_proceed(db, service_name, namespace):
+    """Get feature name list to be proceed by "config syslog rate-limit-feature enable" and
+    "config syslog rate-limit-feature disable" CLIs
+
+    Args:
+        db (object): Db object
+        service_name (str): Nullable service name to be enable/disable
+        namespace (str): Namespace provided by user
+
+    Returns:
+        list: A list of feature name
+    """
+    features = db.cfgdb.get_table(syslog_common.FEATURE_TABLE)
+    if service_name:
+        syslog_common.service_validator(features, service_name)
+        
+    global_feature_data, per_ns_feature_data = syslog_common.extract_feature_data(features)
+    if not namespace:
+        if not service_name:
+            feature_list = [feature_name for feature_name in global_feature_data.keys()]
+            if multi_asic.is_multi_asic():
+                asic_count = multi_asic.get_num_asics()
+                for i in range(asic_count):
+                    feature_list.extend([f'{feature_name}{i}' for feature_name in per_ns_feature_data.keys()])
+        else:
+            feature_config = features[service_name]
+            feature_list = []
+            if feature_config[syslog_common.FEATURE_HAS_GLOBAL_SCOPE].lower() == 'true':
+                feature_list.append(service_name)
+            
+            if multi_asic.is_multi_asic():
+                if feature_config[syslog_common.FEATURE_HAS_PER_ASIC_SCOPE].lower() == 'true':
+                    asic_count = multi_asic.get_num_asics()
+                    for i in range(asic_count):
+                        feature_list.append(multi_asic.get_container_name_from_asic_id(service_name, i))
+    elif namespace == 'default':
+        if not service_name:
+            feature_list = [feature_name for feature_name in global_feature_data.keys()]
+        else:
+            syslog_common.service_validator(global_feature_data, service_name)
+            feature_list = [service_name]
+    else:
+        asic_num = multi_asic.get_asic_id_from_name(namespace)
+        if not service_name:
+            feature_list = [multi_asic.get_container_name_from_asic_id(feature_name, asic_num) for feature_name in per_ns_feature_data.keys()]
+        else:
+            syslog_common.service_validator(per_ns_feature_data, service_name)
+            feature_list = [multi_asic.get_container_name_from_asic_id(service_name, asic_num)]
+    return feature_list
+
+
 @rate_limit_feature.command("enable")
+@click.argument("service_name", required=False)
+@click.option('--namespace', '-n', 'namespace', default=None, 
+              type=click.Choice(multi_asic_util.multi_asic_ns_choices() + ['default']), 
+              show_default=True, help='Namespace name or all')
 @clicommon.pass_db
-def enable_rate_limit_feature(db):
+def enable_rate_limit_feature(db, service_name, namespace):
     """ Enable syslog rate limit feature """
-    feature_data = db.cfgdb.get_table(syslog_common.FEATURE_TABLE)
-    for feature_name in feature_data.keys():
+    feature_list = get_feature_names_to_proceed(db, service_name, namespace)
+    for feature_name in feature_list:
         click.echo(f'Enabling syslog rate limit feature for {feature_name}')
-        output, _ = clicommon.run_command(['docker', 'ps', '-q', '-f', 'status=running', '-f', f'name={feature_name}'], return_cmd=True)
+        shell_cmd = f'docker ps -f status=running --format "{{{{.Names}}}}" | grep -E "^{feature_name}$"'
+        output, _ = clicommon.run_command(shell_cmd, return_cmd=True, shell=True)
         if not output:
             click.echo(f'{feature_name} is not running, ignoring...')
             continue
@@ -517,16 +601,21 @@ def enable_rate_limit_feature(db):
 
         if not failed:
             click.echo(f'Enabled syslog rate limit feature for {feature_name}')
-        
-            
+
+
 @rate_limit_feature.command("disable")
+@click.argument("service_name", required=False)
+@click.option('--namespace', '-n', 'namespace', default=None, 
+              type=click.Choice(multi_asic_util.multi_asic_ns_choices() + ['default']), 
+              show_default=True, help='Namespace name or all')
 @clicommon.pass_db
-def disable_rate_limit_feature(db):
+def disable_rate_limit_feature(db, service_name, namespace):
     """ Disable syslog rate limit feature """
-    feature_data = db.cfgdb.get_table(syslog_common.FEATURE_TABLE)
-    for feature_name in feature_data.keys():
+    feature_list = get_feature_names_to_proceed(db, service_name, namespace)
+    for feature_name in feature_list:
         click.echo(f'Disabling syslog rate limit feature for {feature_name}')
-        output, _ = clicommon.run_command(['docker', 'ps', '-q', '-f', 'status=running', '-f', f'name={feature_name}'], return_cmd=True)
+        shell_cmd = f'docker ps -f status=running --format "{{{{.Names}}}}" | grep -E "^{feature_name}$"'
+        output, _ = clicommon.run_command(shell_cmd, return_cmd=True, shell=True)
         if not output:
             click.echo(f'{feature_name} is not running, ignoring...')
             continue
@@ -553,4 +642,3 @@ def disable_rate_limit_feature(db):
 
         if not failed:
             click.echo(f'Disabled syslog rate limit feature for {feature_name}')
-

doc/Command-Reference.md

@@ -10149,7 +10149,7 @@ This command displays rate limit configuration for containers.
 
 - Usage
   ```
-  show syslog rate-limit-container [<service_name>]
+  show syslog rate-limit-container [<service_name>] -n [<namespace>]
   ```
 
 - Example:
@@ -10173,6 +10173,37 @@ This command displays rate limit configuration for containers.
   SERVICE         INTERVAL    BURST
   --------------  ----------  -------
   bgp             0           0
+
+  # Multi ASIC
+  show syslog rate-limit-container
+  SERVICE    INTERVAL     BURST
+  --------   ----------   --------
+  bgp        500          N/A
+  snmp       300          20000
+  swss       2000         12000
+  Namespace asic0:
+  SERVICE    INTERVAL     BURST
+  --------   ----------   --------
+  bgp        500          N/A
+  snmp       300          20000
+  swss       2000         12000
+
+  # Multi ASIC
+  show syslog rate-limit-container bgp
+  SERVICE    INTERVAL     BURST
+  --------   ----------   --------
+  bgp        500          5000
+  Namespace asic0:
+  SERVICE    INTERVAL     BURST
+  --------   ----------   --------
+  bgp        500          5000
+
+  # Multi ASIC
+  show syslog rate-limit-container bgp -n asic1
+  Namespace asic1:
+  SERVICE    INTERVAL     BURST
+  --------   ----------   --------
+  bgp        500          5000
   ```
 
 ### Syslog Config Commands
@@ -10251,10 +10282,19 @@ This command is used to configure syslog rate limit for containers.
 - Parameters:
   - _interval_: determines the amount of time that is being measured for rate limiting.
   - _burst_: defines the amount of messages, that have to occur in the time limit of interval, to trigger rate limiting
+  - _namespace_: namespace name or all. Value "default" indicates global namespace.
 
 - Example:
   ```
+  # Config bgp for all namespaces. For multi ASIC platforms, bgp service in all namespaces will be affected.
+  # For single ASIC platforms, bgp service in global namespace will be affected.
   admin@sonic:~$ sudo config syslog rate-limit-container bgp --interval 300 --burst 20000
+
+  # Config bgp for global namespace only.
+  config syslog rate-limit-container bgp --interval 300 --burst 20000 -n default
+
+  # Config bgp for asic0 namespace only.
+  config syslog rate-limit-container bgp --interval 300 --burst 20000 -n asic0
   ```
 
 **config syslog rate-limit-feature enable**
@@ -10263,12 +10303,28 @@ This command is used to enable syslog rate limit feature.
 
 - Usage:
   ```
-  config syslog rate-limit-feature enable
+  config syslog rate-limit-feature enable [<service_name>] -n [<namespace>]
   ```
 
 - Example:
   ```
+  # Enable syslog rate limit for all services in all namespaces
   admin@sonic:~$ sudo config syslog rate-limit-feature enable
+
+  # Enable syslog rate limit for all services in global namespace
+  config syslog rate-limit-feature enable -n default
+
+  # Enable syslog rate limit for all services in asic0 namespace
+  config syslog rate-limit-feature enable -n asic0
+
+  # Enable syslog rate limit for database in all namespaces
+  config syslog rate-limit-feature enable database
+
+  # Enable syslog rate limit for database in default namespace
+  config syslog rate-limit-feature enable database -n default
+
+  # Enable syslog rate limit for database in asci0 namespace
+  config syslog rate-limit-feature enable database -n asci0
   ```
 
 **config syslog rate-limit-feature disable**
@@ -10277,12 +10333,28 @@ This command is used to disable syslog rate limit feature.
 
 - Usage:
   ```
-  config syslog rate-limit-feature disable
+  config syslog rate-limit-feature disable [<service_name>] -n [<namespace>]
   ```
 
 - Example:
   ```
+  # Disable syslog rate limit for all services in all namespaces
   admin@sonic:~$ sudo config syslog rate-limit-feature disable
+
+  # Disable syslog rate limit for all services in global namespace
+  config syslog rate-limit-feature disable -n default
+
+  # Disable syslog rate limit for all services in asic0 namespace
+  config syslog rate-limit-feature disable -n asic0
+
+  # Disable syslog rate limit for database in all namespaces
+  config syslog rate-limit-feature disable database
+
+  # Disable syslog rate limit for database in default namespace
+  config syslog rate-limit-feature disable database -n default
+
+  # Disable syslog rate limit for database in asci0 namespace
+  config syslog rate-limit-feature disable database -n asci0
   ```
 
 Go Back To [Beginning of the document](#) or [Beginning of this section](#syslog)

show/syslog.py

@@ -1,9 +1,12 @@
+from unicodedata import name
 import click
 
 import tabulate
 from natsort import natsorted
 
 import utilities_common.cli as clicommon
+import utilities_common.multi_asic as multi_asic_util
+from sonic_py_common import multi_asic
 from syslog_util import common as syslog_common
 
 
@@ -83,25 +86,69 @@ def rate_limit_host(db):
     name='rate-limit-container'
 )
 @click.argument('service_name', metavar='<service_name>', required=False)
+@click.option('--namespace', '-n', 'namespace', default=None, 
+              type=click.Choice(multi_asic_util.multi_asic_ns_choices() + ['default']), 
+              show_default=True, help='Namespace name or all')
 @clicommon.pass_db
-def rate_limit_container(db, service_name):
+def rate_limit_container(db, service_name, namespace):
     """ Show syslog rate limit configuration for containers """
 
     header = [
         "SERVICE",
         "INTERVAL",
         "BURST",
     ]
-    body = []
+    
+    # Feature configuration in global DB
     features = db.cfgdb.get_table(syslog_common.FEATURE_TABLE)
-
+    if service_name:
+        syslog_common.service_validator(features, service_name)
+        
+    global_feature_data, per_ns_feature_data = syslog_common.extract_feature_data(features)
+    if not namespace:
+        # for all namespaces
+        is_first = True
+        for namespace, cfg_db in natsorted(db.cfgdb_clients.items()):
+            if is_first:
+                is_first = False
+            else:
+                # add a new blank line between each namespace
+                click.echo('\n')
+                
+            if namespace == multi_asic.DEFAULT_NAMESPACE:
+                if service_name and service_name not in global_feature_data:
+                    continue
+                echo_rate_limit_config(header, cfg_db, service_name, global_feature_data)
+            else:
+                if service_name and service_name not in per_ns_feature_data:
+                    continue
+                echo_rate_limit_config(header, cfg_db, service_name, per_ns_feature_data, namespace)
+    elif namespace == 'default':
+        # for default/global namespace only
+        echo_rate_limit_config(header, db.cfgdb, service_name, global_feature_data)
+    else:
+        # for a specific namespace
+        echo_rate_limit_config(header, db.cfgdb_clients[namespace], service_name, per_ns_feature_data, namespace)
+    
+
+def echo_rate_limit_config(header, db, service_name, features, namespace=None):
+    """Echo rate limit configuration
+
+    Args:
+        header (list): CLI headers
+        db (object): Db object
+        service_name (str): Nullable service name to be printed.
+        features (dict): Feature data got from CONFIG DB
+        namespace (str, optional): Namespace provided by user. Defaults to None.
+    """
+    body = []
     if service_name:
         syslog_common.service_validator(features, service_name)
         service_list = [service_name]
     else:
-        service_list = [name for name, service_config in features.items() if service_config.get(syslog_common.SUPPORT_RATE_LIMIT, '').lower() == 'true']
-
-    syslog_configs = db.cfgdb.get_table(syslog_common.SYSLOG_CONFIG_FEATURE_TABLE)
+        service_list = features.keys()
+    
+    syslog_configs = db.get_table(syslog_common.SYSLOG_CONFIG_FEATURE_TABLE)
     for service in natsorted(service_list):
         if service in syslog_configs:
             entry = syslog_configs[service]
@@ -110,5 +157,11 @@ def rate_limit_container(db, service_name):
                         entry.get(syslog_common.SYSLOG_RATE_LIMIT_BURST, 'N/A')])
         else:
             body.append([service, 'N/A', 'N/A'])
-
-    click.echo(format(header, body))
+    
+    if namespace:
+        click.echo(f'Namespace {namespace}:')
+    
+    if body:
+        click.echo(format(header, body))
+    else:
+        click.echo('N/A')