Critical resource monitoring in SONiC
High Level Design Document
Rev 0.1
Table of Contents
List of Tables
Revision
| Rev | Date | Author | Change Description |
|---|---|---|---|
| 0.1 | Volodymyr Samotiy | Initial version | |
| 0.2 | Oleksandr Ivantsiv | Add DASH resources and counters |
About this Manual
This document provides general information about the Critical Resource Monitoring feature implementation in SONiC.
Scope
This document describes the high level design of the Critical Resource Monitoring feature.
Definitions/Abbreviation
Table 2: Abbreviations
| Definitions/Abbreviation | Description |
|---|---|
| CRM | Critical Resource Monitoring |
| API | Application Programmable Interface |
| SAI | Switch Abstraction Interface |
| VNET | Virtual Network |
| ENI | Elastic Network Interface |
1 Subsystem Requirements Overview
1.1 Functional requirements
Detailed description of the Critical Resource Monitoring feature requirements is here: CRM Requirements.
This section describes the SONiC requirements for Critical Resource Monitoring (CRM) feature. CRM should monitor utilization of ASIC resources by polling SAI attributes.
At a high level the following should be supported:
-
CRM should log a message if there are any resources that exceed defined threshold value.
-
CLI commands to check current usage and availability of monitored resources.
1.1.1 Resources to be monitored
-
IPv4 routes: query currently used and available number of entries
-
IPv6 routes: query currently used and available number of entries
-
IPv4 Nexthops: query currently used available number of entries
-
IPv6 Nexthops: query currently used and available number of entries
-
IPv4 Neighbors: query currently used and available number of entries
-
IPv6 Neighbors: query currently used and available number of entries
-
Next-hop group member: query currently used and available number of entries
-
Next-hop group objects: query currently used and available number of entries
-
ACL: query currently used and available number of entries
-
ACL Table
-
ACL Group
-
ACL Entries
-
ACL Counters/Statistics
-
-
FDB entries: query currently used and available entries
-
DASH entries: query currently used and available entries
-
VNET
-
ENI
-
ENI Ethernet Addresses
-
IPv4 Inbound Routes
-
IPv6 Inbound Routes
-
IPv4 Outbound Routes
-
IPv6 Outbound Routes
-
IPv4 Outbound CA to PA
-
IPv6 Outbound CA to PA
-
IPv4 PA Validation
-
IPv6 PA Validation
-
IPV4 ACL Groups
-
IPV6 ACL Groups
-
IPv4 ACL Rules
-
IPv6 ACL Rules
-
1.2 Monitoring process requirements
Monitoring process should periodically poll SAI counters for all required resources, then it should check whether retrieved values exceed defined thresholds and log appropriate SYSLOG message.
-
User should be able to configure LOW and HIGH thresholds.
-
User should be able to configure thresholds in the following formats:
-
percentage
-
actual used count
-
actual free count
-
-
CRM feature should log "SYSLOG" message if there are any resources that exceed LOW or HIGH threshold.
-
CRM should support two types of "SYSLOG" messages:
-
EXCEEDED for high threshold.
-
CLEAR for low threshold.
-
-
"SYSLOG" messages should be in the following format:
"<Date/Time> WARNING <Process name>: THRESHOLD_EXCEEDED for <TH_TYPE> <%> Used count <value> free count <value>"
"<Date/Time> WARNING <Process name>: THRESHOLD_CLEAR for <TH_TYPE> <%> Used count <value> free count <value>"
<TH_TYPE> = <TH_PERCENTAGE, TH_USED, TH_FREE>
-
Default polling interval should be set to 5 minutes.
-
Default HIGH threshold should be set to 85%.
-
Default LOW threshold should be set to 70%.
-
CRM feature should suppress SYSLOG messages after printing for 10 times.
1.3 CLI requirements
-
User should be able to query usage and availability of monitored resources.
-
User should be able to configure thresholds values.
2 Modules Design
2.1 Config DB
2.1.1 CRM Table
New "CRM" table should be added to ConfigDB in order to store CRM related configuration: polling interval and LOW/HIGH threshold values.
; Defines schema for CRM configuration attributes
key = CRM ; CRM configuration
; field = value
polling_interval = 1*4DIGIT ; CRM polling interval
ipv4_route_threshold_type = "percentage" / "used" / "free" ; CRM threshold type for 'ipv4 route' resource
ipv6_route_threshold_type = "percentage" / "used" / "free" ; CRM threshold type for 'ipv6 route' resource
ipv4_nexthop_threshold_type = "percentage" / "used" / "free" ; CRM threshold type for 'ipv4 next-hop' resource
ipv6_nexthop_threshold_type = "percentage" / "used" / "free" ; CRM threshold type for 'ipv6 next-hop' resource
ipv4_neighbor_threshold_type = "percentage" / "used" / "free" ; CRM threshold type for 'ipv4 neighbor' resource
ipv6_neighbor_threshold_type = "percentage" / "used" / "free" ; CRM threshold type for 'ipv6 neighbor' resource
nexthop_group_member_threshold_type = "percentage" / "used" / "free" ; CRM threshold type for 'next-hop group member' resource
nexthop_group_threshold_type = "percentage" / "used" / "free" ; CRM threshold type for 'next-hop group object' resource
acl_table_threshold_type = "percentage" / "used" / "free" ; CRM threshold type for 'acl table' resource
acl_group_threshold_type = "percentage" / "used" / "free" ; CRM threshold type for 'acl group' resource
acl_entry_threshold_type = "percentage" / "used" / "free" ; CRM threshold type for 'acl entry' resource
acl_counter_threshold_type = "percentage" / "used" / "free" ; CRM threshold type for 'acl counter' resource
fdb_entry_threshold_type = "percentage" / "used" / "free" ; CRM threshold type for 'fdb entry' resource
dash_vnet_threshold_type = "percentage" / "used" / "free" ; CRM threshold type for 'dash vnet' resource
dash_eni_threshold_type = "percentage" / "used" / "free" ; CRM threshold type for 'dash eni' resource
dash_eni_ether_address_map_threshold_type = "percentage" / "used" / "free" ; CRM threshold type for 'dash eni ether address' resource
dash_ipv4_inbound_routing_threshold_type = "percentage" / "used" / "free" ; CRM threshold type for 'dash ipv4 inbound routing' resource
dash_ipv6_inbound_routing_threshold_type = "percentage" / "used" / "free" ; CRM threshold type for 'dash ipv6 inbound routing' resource
dash_ipv4_outbound_routing_threshold_type = "percentage" / "used" / "free" ; CRM threshold type for 'dash ipv4 outbound routing' resource
dash_ipv6_outbound_routing_threshold_type = "percentage" / "used" / "free" ; CRM threshold type for 'dash ipv6 outbound routing' resource
dash_ipv4_pa_validation_threshold_type = "percentage" / "used" / "free" ; CRM threshold type for 'dash ipv4 pa validation' resource
dash_ipv6_pa_validation_threshold_type = "percentage" / "used" / "free" ; CRM threshold type for 'dash ipv6 pa validation' resource
dash_ipv4_outbound_ca_to_pa_threshold_type = "percentage" / "used" / "free" ; CRM threshold type for 'dash ipv4 outbound ca to pa' resource
dash_ipv6_outbound_ca_to_pa_threshold_type = "percentage" / "used" / "free" ; CRM threshold type for 'dash ipv6 outbound ca to pa' resource
dash_ipv4_acl_group_threshold_type = "percentage" / "used" / "free" ; CRM threshold type for 'dash ipv4 acl group' resource
dash_ipv6_acl_group_threshold_type = "percentage" / "used" / "free" ; CRM threshold type for 'dash ipv4 acl group' resource
dash_ipv4_acl_rule_threshold_type = "percentage" / "used" / "free" ; CRM threshold type for 'dash acl ipv4 rule' resource
dash_ipv6_acl_rule_threshold_type = "percentage" / "used" / "free" ; CRM threshold type for 'dash acl ipv6 rule' resource
ipv4_route_low_threshold = 1*4DIGIT ; CRM low threshold for 'ipv4 route' resource
ipv6_route_low_threshold = 1*4DIGIT ; CRM low threshold for 'ipv6 route' resource
ipv4_nexthop_low_threshold = 1*4DIGIT ; CRM low threshold for 'ipv4 next-hop' resource
ipv6_nexthop_low_threshold = 1*4DIGIT ; CRM low threshold for 'ipv6 next-hop' resource
ipv4_neighbor_low_threshold = 1*4DIGIT ; CRM low threshold for 'ipv4 neighbor' resource
ipv6_neighbor_low_threshold = 1*4DIGIT ; CRM low threshold for 'ipv6 neighbor' resource
nexthop_group_member_low_threshold = 1*4DIGIT ; CRM low threshold for 'next-hop group member' resource
nexthop_group_low_threshold = 1*4DIGIT ; CRM low threshold for 'next-hop group object' resource
acl_table_low_threshold = 1*4DIGIT ; CRM low threshold for 'acl table' resource
acl_group_low_threshold = 1*4DIGIT ; CRM low threshold for 'acl group' resource
acl_entry_low_threshold = 1*4DIGIT ; CRM low threshold for 'acl entry' resource
acl_counter_low_threshold = 1*4DIGIT ; CRM low threshold for 'acl counter' resource
fdb_entry_low_threshold = 1*4DIGIT ; CRM low threshold for 'fdb entry' resource
dash_vnet_low_threshold = 1*4DIGIT ; CRM low threshold for 'dash vnet' resource
dash_eni_low_threshold = 1*4DIGIT ; CRM low threshold for 'dash eni' resource
dash_eni_ether_address_map_low_threshold = 1*4DIGIT ; CRM low threshold for 'dash eni ether address' resource
dash_ipv4_inbound_routing_low_threshold = 1*4DIGIT ; CRM low threshold for 'dash ipv4 inbound routing' resource
dash_ipv6_inbound_routing_low_threshold = 1*4DIGIT ; CRM low threshold for 'dash ipv6 inbound routing' resource
dash_ipv4_outbound_routing_low_threshold = 1*4DIGIT ; CRM low threshold for 'dash ipv4 outbound routing' resource
dash_ipv6_outbound_routing_low_threshold = 1*4DIGIT ; CRM low threshold for 'dash ipv6 outbound routing' resource
dash_ipv4_pa_validation_low_threshold = 1*4DIGIT ; CRM low threshold for 'dash ipv4 pa validation' resource
dash_ipv6_pa_validation_low_threshold = 1*4DIGIT ; CRM low threshold for 'dash ipv6 pa validation' resource
dash_ipv4_outbound_ca_to_pa_low_threshold = 1*4DIGIT ; CRM low threshold for 'dash ipv4 outbound ca to pa' resource
dash_ipv6_outbound_ca_to_pa_low_threshold = 1*4DIGIT ; CRM low threshold for 'dash ipv6 outbound ca to pa' resource
dash_ipv4_acl_group_low_threshold = 1*4DIGIT ; CRM low threshold for 'dash ipv4 acl group' resource
dash_ipv6_acl_group_low_threshold = 1*4DIGIT ; CRM low threshold for 'dash ipv6 acl group' resource
dash_ipv4_acl_rule_low_threshold = 1*4DIGIT ; CRM low threshold for 'dash ipv4 acl rule' resource
dash_ipv6_acl_rule_low_threshold = 1*4DIGIT ; CRM low threshold for 'dash ipv6 acl rule' resource
ipv4_route_high_threshold = 1*4DIGIT ; CRM high threshold for 'ipv4 route' resource
ipv6_route_high_threshold = 1*4DIGIT ; CRM high threshold for 'ipv6 route' resource
ipv4_nexthop_high_threshold = 1*4DIGIT ; CRM high threshold for 'ipv4 next-hop' resource
ipv6_nexthop_high_threshold = 1*4DIGIT ; CRM high threshold for 'ipv6 next-hop' resource
ipv4_neighbor_high_threshold = 1*4DIGIT ; CRM high threshold for 'ipv4 neighbor' resource
ipv6_neighbor_high_threshold = 1*4DIGIT ; CRM high threshold for 'ipv6 neighbor' resource
nexthop_group_member_high_threshold = 1*4DIGIT ; CRM high threshold for 'next-hop group member' resource
nexthop_group_high_threshold = 1*4DIGIT ; CRM high threshold for 'next-hop group object' resource
acl_table_high_threshold = 1*4DIGIT ; CRM high threshold for 'acl table' resource
acl_group_high_threshold = 1*4DIGIT ; CRM high threshold for 'acl group' resource
acl_entry_high_threshold = 1*4DIGIT ; CRM high threshold for 'acl entry' resource
acl_counter_high_threshold = 1*4DIGIT ; CRM high threshold for 'acl counter' resource
fdb_entry_high_threshold = 1*4DIGIT ; CRM high threshold for 'fdb entry' resource
dash_vnet_high_threshold = 1*4DIGIT ; CRM high threshold for 'dash vnet' resource
dash_eni_high_threshold = 1*4DIGIT ; CRM high threshold for 'dash eni' resource
dash_eni_ether_address_map_high_threshold = 1*4DIGIT ; CRM high threshold for 'dash eni ether address' resource
dash_ipv4_inbound_routing_high_threshold = 1*4DIGIT ; CRM high threshold for 'dash ipv4 inbound routing' resource
dash_ipv6_inbound_routing_high_threshold = 1*4DIGIT ; CRM high threshold for 'dash ipv6 inbound routing' resource
dash_ipv4_outbound_routing_high_threshold = 1*4DIGIT ; CRM high threshold for 'dash ipv4 outbound routing' resource
dash_ipv6_outbound_routing_high_threshold = 1*4DIGIT ; CRM high threshold for 'dash ipv6 outbound routing' resource
dash_ipv4_pa_validation_high_threshold = 1*4DIGIT ; CRM high threshold for 'dash ipv4 pa validation' resource
dash_ipv6_pa_validation_high_threshold = 1*4DIGIT ; CRM high threshold for 'dash ipv6 pa validation' resource
dash_ipv4_outbound_ca_to_pa_high_threshold = 1*4DIGIT ; CRM high threshold for 'dash ipv4 outbound ca to pa' resource
dash_ipv6_outbound_ca_to_pa_high_threshold = 1*4DIGIT ; CRM high threshold for 'dash ipv6 outbound ca to pa' resource
dash_ipv4_acl_group_high_threshold = 1*4DIGIT ; CRM high threshold for 'dash ipv4 acl group' resource
dash_ipv6_acl_group_high_threshold = 1*4DIGIT ; CRM high threshold for 'dash ipv6 acl group' resource
dash_ipv4_acl_rule_high_threshold = 1*4DIGIT ; CRM high threshold for 'dash ipv4 acl rule' resource
dash_ipv6_acl_rule_high_threshold = 1*4DIGIT ; CRM high threshold for 'dash ipv6 acl rule' resource
2.2 Counters DB
Two new tables should be added to the CountersDB in order to represent currently used and available entries for the CRM resources.
2.2.1 CRM_STATS Table
This table should store all global CRM stats.
; Defines schema for CRM counters attributes
key = CRM_STATS ; CRM stats entry
; field = value
CRM_STATS_IPV4_ROUTE_AVAILABLE = 1*20DIGIT ; number of available entries for 'ipv4 route' resource
CRM_STATS_IPV6_ROUTE_AVAILABLE = 1*20DIGIT ; number of available entries for 'ipv6 route' resource
CRM_STATS_IPV4_NEXTHOP_AVAILABLE = 1*20DIGIT ; number of available entries for 'ipv4 next-hop' resource
CRM_STATS_IPV6_NEXTHOP_AVAILABLE = 1*20DIGIT ; number of available entries for 'ipv6 next-hop' resource
CRM_STATS_IPV4_NEIGHBOR_AVAILABLE = 1*20DIGIT ; number of available entries for 'ipv4 neighbor' resource
CRM_STATS_IPV6_NEIGHBOR_AVAILABLE = 1*20DIGIT ; number of available entries for 'ipv6 neighbor' resource
CRM_STATS_NEXTHOP_GROUP_MEMBER_AVAILABLE = 1*20DIGIT ; number of available entries for 'next-hop group member' resource
CRM_STATS_NEXTHOP_GROUP_OBJECT_AVAILABLE = 1*20DIGIT ; number of available entries for 'next-hop group object' resource
CRM_STATS_ACL_TABLE_AVAILABLE = 1*20DIGIT ; number of available entries for 'acl table' resource
CRM_STATS_ACL_GROUP_AVAILABLE = 1*20DIGIT ; number of available entries for 'acl group' resource
CRM_STATS_FDB_ENTRY_AVAILABLE = 1*20DIGIT ; number of available entries for 'fdb entry' resource
CRM_STATS_IPV4_ROUTE_USED = 1*20DIGIT ; number of available entries for 'ipv4 route' resource
CRM_STATS_IPV6_ROUTE_USED = 1*20DIGIT ; number of used entries for 'ipv6 route' resource
CRM_STATS_IPV4_NEXTHOP_USED = 1*20DIGIT ; number of used entries for 'ipv4 next-hop' resource
CRM_STATS_IPV6_NEXTHOP_USED = 1*20DIGIT ; number of used entries for 'ipv6 next-hop' resource
CRM_STATS_IPV4_NEIGHBOR_USED = 1*20DIGIT ; number of available entries for 'ipv4 neighbor' resource
CRM_STATS_IPV6_NEIGHBOR_USED = 1*20DIGIT ; number of available entries for 'ipv6 neighbor' resource
CRM_STATS_NEXTHOP_GROUP_MEMBER_USED = 1*20DIGIT ; number of used entries for 'next-hop group member' resource
CRM_STATS_NEXTHOP_GROUP_OBJECT_USED = 1*20DIGIT ; number of used entries for 'next-hop group object' resource
CRM_STATS_ACL_TABLE_USED = 1*20DIGIT ; number of used entries for 'acl table' resource
CRM_STATS_ACL_GROUP_USED = 1*20DIGIT ; number of used entries for 'acl group' resource
CRM_STATS_FDB_ENTRY_USED = 1*20DIGIT ; number of used entries for 'fdb entry' resource
CRM_STATS_DASH_VNET_AVAILABLE = 1*20DIGIT ; number of available entries for 'vnet' resource
CRM_STATS_DASH_VNET_USED = 1*20DIGIT ; number of used entries for 'vnet' resource
CRM_STATS_DASH_ENI_AVAILABLE = 1*20DIGIT ; number of available entries for 'eni' resource
CRM_STATS_DASH_ENI_USED = 1*20DIGIT ; number of used entries for 'eni' resource
CRM_STATS_DASH_ETHER_ADDRESS_MAP_AVAILABLE = 1*20DIGIT ; number of available entries for 'eni ethernet address map' resource
CRM_STATS_DASH_ETHER_ADDRESS_MAP_USED = 1*20DIGIT ; number of used entries for 'eni ethernet address map' resource
CRM_STATS_DASH_IPV4_INBOUND_ROUTING_AVAILABLE = 1*20DIGIT ; number of available entries for 'ipv4 inbound routing' resource
CRM_STATS_DASH_IPV4_INBOUND_ROUTING_USED = 1*20DIGIT ; number of used entries for 'ipv4 inbound routing' resource
CRM_STATS_DASH_IPV6_INBOUND_ROUTING_AVAILABLE = 1*20DIGIT ; number of available entries for 'ipv6 inbound routing' resource
CRM_STATS_DASH_IPV6_INBOUND_ROUTING_USED = 1*20DIGIT ; number of used entries for 'ipv6 inbound routing' resource
CRM_STATS_DASH_IPV4_OUTBOUND_ROUTING_AVAILABLE = 1*20DIGIT ; number of available entries for 'ipv4 outbound routing' resource
CRM_STATS_DASH_IPV4_OUTBOUND_ROUTING_USED = 1*20DIGIT ; number of used entries for 'ipv4 outbound routing' resource
CRM_STATS_DASH_IPV6_OUTBOUND_ROUTING_AVAILABLE = 1*20DIGIT ; number of available entries for 'ipv6 outbound routing' resource
CRM_STATS_DASH_IPV6_OUTBOUND_ROUTING_USED = 1*20DIGIT ; number of used entries for 'ipv6 outbound routing' resource
CRM_STATS_DASH_IPV4_PA_VALIDATION_AVAILABLE = 1*20DIGIT ; number of available entries for 'ipv4 pa validation' resource
CRM_STATS_DASH_IPV4_PA_VALIDATION_USED = 1*20DIGIT ; number of used entries for 'ipv4 pa validation' resource
CRM_STATS_DASH_IPV6_PA_VALIDATION_AVAILABLE = 1*20DIGIT ; number of available entries for 'ipv6 pa validation' resource
CRM_STATS_DASH_IPV6_PA_VALIDATION_USED = 1*20DIGIT ; number of used entries for 'ipv6 pa validation' resource
CRM_STATS_DASH_IPV4_OUTBOUND_CA_TO_PA_AVAILABLE = 1*20DIGIT ; number of available entries for 'ipv4 ca to pa' resource
CRM_STATS_DASH_IPV4_OUTBOUND_CA_TO_PA_USED = 1*20DIGIT ; number of used entries for 'ipv4 ca to pa' resource
CRM_STATS_DASH_IPV6_OUTBOUND_CA_TO_PA_AVAILABLE = 1*20DIGIT ; number of available entries for 'ipv6 ca to pa' resource
CRM_STATS_DASH_IPV6_OUTBOUND_CA_TO_PA_USED = 1*20DIGIT ; number of used entries for 'ipv6 ca to pa' resource
CRM_STATS_DASH_IPV4_ACL_GROUP_AVAILABLE = 1*20DIGIT ; number of available entries for 'ipv4 acl group' resource
CRM_STATS_DASH_IPV4_ACL_GROUP_USED = 1*20DIGIT ; number of used entries for 'ipv4 acl group' resource
CRM_STATS_DASH_IPV6_ACL_GROUP_AVAILABLE = 1*20DIGIT ; number of available entries for 'ipv6 acl group' resource
CRM_STATS_DASH_IPV6_ACL_GROUP_USED = 1*20DIGIT ; number of used entries for 'ipv6 acl group' resource
2.2.2 CRM_ACL_GROUP_STATS
This table should store all "per ACL group" CRM stats .
; Defines schema for CRM counters attributes
key = CRM_ACL_GROUP_STATS:OID ; CRM ACL group stats entry
; field = value
CRM_STATS_ACL_ENTRY_AVAILABLE = 1*20DIGIT ; number of available entries for 'acl entry' resource
CRM_STATS_ACL_COUNTER_AVAILABLE = 1*20DIGIT ; number of available entries for 'acl counter' resource
CRM_STATS_ACL_ENTRY_USED = 1*20DIGIT ; number of used entries for 'acl entry' resource
CRM_STATS_ACL_COUNTER_USED = 1*20DIGIT ; number of used entries for 'acl counter' resource
2.2.3 CRM_DASH_ACL_GROUP_STATS
This table should store all "per DASH ACL group" CRM stats.
; Defines schema for CRM counters attributes
key = CRM_DASH_ACL_GROUP_STATS:OID ; CRM DASH ACL group stats entry
; field = value
CRM_STATS_DASH_ACL_RULE_AVAILABLE = 1*20DIGIT ; number of available entries for 'DASH ACL rule' resource
CRM_STATS_DASH_ACL_RULE_USED = 1*20DIGIT ; number of used entries for ' DASH ACL rule' resource
2.4 Orchestration Agent
New "CrmOrch" class should be implemented and it should run new CRM thread for all monitoring logic.
CRM thread should check whether some threshold is exceeded and log appropriate (CLEAR/EXCEEDED) SYSLOG message. Also number of already logged EXCEEDED messages should be tracked and once it reached the pre-defined value all CRM SYSLOG messages should be suppressed. When CLEAR message is logged then counter for number of logged messages should be cleared.
CLI show command should be able to display currently USED and AVAILABLE number of entries, but SAI provides API to query the current AVAILABLE entries. So, OrchAgent (appropriate agent for each resource) should track respective entries that are programmed and update appropriate counter in "CrmOrch" cache. Also, "CrmOrch" should provide public API in order to allow other agents update local cache and then CRM thread should periodically update CountersDB from the cache.
2.6 SAI
Shown below table represents all the SAI attributes which should be used to get required CRM counters.
Table 3: CRM SAI attributes
| CRM resource | SAI attribute |
|---|---|
| IPv4 routes | SAI_SWITCH_ATTR_AVAILABLE_IPV4_ROUTE_ENTRY |
| IPv6 routes | SAI_SWITCH_ATTR_AVAILABLE_IPV6_ROUTE_ENTRY |
| IPv4 next-hops | SAI_SWITCH_ATTR_AVAILABLE_IPV4_NEXTHOP_ENTRY |
| IPv6 next-hops | SAI_SWITCH_ATTR_AVAILABLE_IPV6_NEXTHOP_ENTRY |
| IPv4 neighbors | SAI_SWITCH_ATTR_AVAILABLE_IPV4_NEIGHBOR_ENTRY |
| IPv6 neighbors | SAI_SWITCH_ATTR_AVAILABLE_IPV6_NEIGHBOR_ENTRY |
| Next-hop group members | SAI_SWITCH_ATTR_AVAILABLE_NEXT_HOP_GROUP_MEMBER_ENTRY |
| Next-hop group objects | SAI_SWITCH_ATTR_AVAILABLE_NEXT_HOP_GROUP_ENTRY |
| ACL tables | SAI_SWITCH_ATTR_AVAILABLE_ACL_TABLE |
| ACL groups | SAI_SWITCH_ATTR_AVAILABLE_ACL_TABLE_GROUP |
| ACL entries | SAI_ACL_TABLE_ATTR_AVAILABLE_ACL_ENTRY |
| ACL counters | SAI_ACL_TABLE_ATTR_AVAILABLE_ACL_COUNTER |
| FDB entries | SAI_SWITCH_ATTR_AVAILABLE_FDB_ENTRY |
| DASH VNETs | SAI_OBJECT_TYPE_VNET |
| DASH ENIs | SAI_OBJECT_TYPE_ENI |
| DASH ENI ethernet addresses | SAI_OBJECT_TYPE_ENI_ETHER_ADDRESS_MAP_ENTRY |
| DASH inbound routes | SAI_OBJECT_TYPE_INBOUND_ROUTING_ENTRY |
| DASH outbound routes | SAI_OBJECT_TYPE_OUTBOUND_ROUTING_ENTRY |
| DASH PA validation | SAI_OBJECT_TYPE_PA_VALIDATION_ENTRY |
| DASH outbound CA to PA | SAI_OBJECT_TYPE_OUTBOUND_CA_TO_PA_ENTRY |
| DASH ACL groups | SAI_OBJECT_TYPE_DASH_ACL_GROUP |
| DASH ACL rules | SAI_OBJECT_TYPE_DASH_ACL_RULE |
2.7 CLI
New CRM utility script should be implement in "sonic-utilities" in order to configure and display all CRM related information.
2.7.1 CRM utility interface
crm
Usage: crm [OPTIONS] COMMAND [ARGS]...
Utility to operate with CRM configuration and resources.
Options:
--help Show this message and exit.
Commands:
config Set CRM configuration.
show Show CRM information.
2.7.1.1 CRM utility config syntax
-
polling interval <value> -
thresholds all type [percentage|used|count] -
thresholds all [low|high] <value> -
thresholds [ipv4|ipv6] route type [percentage|used|count] -
thresholds [ipv4|ipv6] route [low|high] <value> -
thresholds [ipv4|ipv6] neighbor type [percentage|used|count] -
thresholds [ipv4|ipv6] neighbor [low|high] <value> -
thresholds [ipv4|ipv6] nexthop type [percentage|used|count] -
thresholds [ipv4|ipv6] nexthop [low|high] <value> -
thresholds nexthop group [member|object] type [percentage|used|count] -
thresholds nexthop group [member|object] [low|high] <value> -
thresholds acl [table|group] type [percentage|used|count] -
thresholds acl [table|group] [low|high] <value> -
thresholds acl group [entry|counter] type [percentage|used|count] -
thresholds acl group [entry|counter] [low|high] <value> -
thresholds fdb type [percentage|used|count] -
thresholds fdb [low|high] <value>
2.7.1.2 CRM utility show syntax
-
summary -
[resources|thresholds] all -
[resources|thresholds] [ipv4|ipv6] [route|neighbor|nexthop] -
[resources|thresholds] nexthop group [member|object] -
[resources|thresholds] acl [table|group] -
[resources|thresholds] acl group [entry|counter] -
[resources|thresholds] fdb
2.7.1.3 CRM utility DASH syntax
DASH CRM commands will be available for the user only if SONiC is running on the DPU. In the runtime CRM utility will query "switch_type" from "DEVICE_METADATA" table in Config DB. If switch_type is not equal to "dpu" the command won't be shown to the user.
2.7.1.3.1 CRM utility DASH config syntax
-
thresholds dash [vnet|eni|eni-ether-address] type [percentage|used|count] -
thresholds dash [vnet|eni|eni-ether-address] [low|high] <value> -
thresholds dash [ipv4|ipv6] [inbound|outbound] routing type [percentage|used|count] -
thresholds dash [ipv4|ipv6] [inbound|outbound] routing [low|high] <value> -
thresholds dash [ipv4|ipv6] pa-validation [percentage|used|count] -
thresholds dash [ipv4|ipv6] pa-validation [low|high] <value> -
thresholds dash [ipv4|ipv6] outbound ca-to-pa [percentage|used|count] -
thresholds dash [ipv4|ipv6] outbound ca-to-pa [low|high] <value> -
thresholds dash [ipv4|ipv6] acl group [percentage|used|count] -
thresholds dash [ipv4|ipv6] acl group [low|high] <value> -
thresholds dash [ipv4|ipv6] acl group rule [percentage|used|count] -
thresholds dash [ipv4|ipv6] acl group rule [low|high] <value>
2.7.1.3.2 CRM utility DASH show syntax
-
[resources|thresholds] dash [vnet|eni|eni-ether-address] -
[resources|thresholds] dash [ipv4|ipv6] [inbound|outbound] routing -
[resources|thresholds] dash [ipv4|ipv6] pa-validation -
[resources|thresholds] dash [ipv4|ipv6] outbound ca-to-pa -
[resources|thresholds] dash [ipv4|ipv6] acl group -
[resources|thresholds] dash [ipv4|ipv6] acl group rule
2.7.2 Config CLI command
Config command should be extended in order to add "crm" alias to the CRM utility.
Usage: config [OPTIONS] COMMAND [ARGS]...
SONiC command line - 'config' command
Options:
--help Show this message and exit.
Commands:
...
crm CRM related configuration.
2.7.3 Show CLI command
Show command should be extended in order to add "crm" alias to the CRM utility.
show
Usage: show [OPTIONS] COMMAND [ARGS]...
SONiC command line - 'show' command
Options:
-?, -h, --help Show this message and exit.
Commands:
...
crm Show CRM related information
2.8 YANG model Enhancements
container sonic-crm {
container CRM {
description "CRM part of config_db.json";
container Config {
import sonic-device_metadata {
prefix dm;
}
/* typedef specific to CRM */
typedef threshold {
type uint16;
}
leaf polling_interval {
type threshold;
}
/* For each legacy resource the following attributes are defined: */
leaf <resource>_threshold_type {
must "(((current()='PERCENTAGE' or current()='percentage') and
../<resource>_high_threshold<100 and
../<resource>_low_threshold<100) or
(current()!='PERCENTAGE' and current()!='percentage'))";
type stypes:crm_threshold_type;
}
leaf <resource>_high_threshold {
must "(current() > ../<resource>_low_threshold)"
{
error-message "high_threshold should be more than low_threshold";
}
type threshold;
}
leaf <resource>_low_threshold {
type threshold;
}
/* Thresholds for DASH resources should be available only when SONiC is running on the DPU.
* For each DASH resource the following attributes are defined: */
leaf <resource>_threshold_type {
when "(/dm:sonic-device_metadata/dm:DEVICE_METADATA/dm:localhost/dm:switch_type = 'dpu')";
must "(((current()='PERCENTAGE' or current()='percentage') and
../<resource>_high_threshold<100 and
../<resource>_low_threshold<100) or
(current()!='PERCENTAGE' and current()!='percentage'))";
type stypes:crm_threshold_type;
}
leaf <resource>_high_threshold {
when "(/dm:sonic-device_metadata/dm:DEVICE_METADATA/dm:localhost/dm:switch_type = 'dpu')";
must "(current() > ../<resource>_low_threshold)"
{
error-message "high_threshold should be more than low_threshold";
}
type threshold;
}
leaf <resource>_low_threshold {
when "(/dm:sonic-device_metadata/dm:DEVICE_METADATA/dm:localhost/dm:switch_type = 'dpu')";
type threshold;
}
}
}
}
3 Flows
3.1 CRM monitoring
3.2 CRM CLI config
3.3 CRM CLI show
4 Testing Requirements/Design
4.1 Unit Test cases
4.1.2 sonic-utilities
The existing unit tests should be extended to cover DASH resources. The same test cases should be reused.
For each DASH resource:
-
Verify command "crm config thresholds dash type"
-
Verify command "crm config thresholds dash low"
-
Verify command "crm config thresholds dash high"
-
Verify command "crm show thresholds dash "
-
Verify command "crm show resources dash "
4.1.3 VS tests
4.1.3.1 DASH VS tests
The existing unit tests should be extended to cover DASH resources. The same test cases should be reused.
For each DASH resource:
-
Configure thresholds
-
Create DASH entries in APP DB to exceed high threshold
-
Verify that THRESHOLD_EXCEEDED message is written to syslog
-
Verity that TH_USED counter from syslog message matches created entries
-
Remove DASH entries to fell above low threshold
-
Verify that THRESHOLD_CLEAR message is written to syslog
-
Verity that TH_USED counter from syslog message matches created entries
4.2 System Test cases
4.2.1 DASH System Test Cases
The existing system tests should be extended to cover DASH resources. The same test cases should be reused.