From 67863b8d57f8186a09cc44336e7edb44e03c4bb1 Mon Sep 17 00:00:00 2001
From: Stephen Sun <5379172+stephenxs@users.noreply.github.com>
Date: Thu, 24 Aug 2023 04:57:37 +0800
Subject: [PATCH] Add yang model for PFC watchdog debug information (#16206)

### Why I did it
When PFC WD is triggered there is no diagnosis information which makes it difficult to understand why PFC WD was triggered. So, we add a field `additional_information` to accommodate the diagnosis information.

### How to verify it
unit test
---
 .../tests/sonic-events-swss.json              | 11 ++++++
 .../tests_config/sonic-events-swss.json       | 36 +++++++++++++++++++
 .../yang-models/sonic-events-swss.yang        |  7 ++++
 3 files changed, 54 insertions(+)

diff --git a/src/sonic-yang-models/tests/yang_model_tests/tests/sonic-events-swss.json b/src/sonic-yang-models/tests/yang_model_tests/tests/sonic-events-swss.json
index 7762ec17db27..6592fd10136f 100644
--- a/src/sonic-yang-models/tests/yang_model_tests/tests/sonic-events-swss.json
+++ b/src/sonic-yang-models/tests/yang_model_tests/tests/sonic-events-swss.json
@@ -37,6 +37,17 @@
 	"SONIC_EVENTS_SWSS_PFC_STORM_VALID": {
 		"desc": "VALID IF_STATE EVENT."
 	},
+	"SONIC_EVENTS_SWSS_PFC_STORM_VALID_WITH_ADDITIONAL_INFO": {
+		"desc": "VALID IF_STATE EVENT."
+	},
+	"SONIC_EVENTS_SWSS_PFC_STORM_WITH_INVALID_ADDITIONAL_INFO_1": {
+	    "desc": "PFC_STORM_EVENT_INCORRECT_ADDITIONAL_INFO failure.",
+            "eStrKey": "Pattern"
+	},
+	"SONIC_EVENTS_SWSS_PFC_STORM_WITH_INVALID_ADDITIONAL_INFO_2": {
+	    "desc": "PFC_STORM_EVENT_INCORRECT_ADDITIONAL_INFO failure.",
+            "eStrKey": "Pattern"
+	},
 	"SONIC_EVENTS_SWSS_CHK_CRM_THRESHOLD_INCORRECT_PERCENT": {
 		"desc": "CHK_CRM_THRESHOLD_EVENT_INCORRECT_PERCENT failure.",
 		"eStrKey": "Range"
diff --git a/src/sonic-yang-models/tests/yang_model_tests/tests_config/sonic-events-swss.json b/src/sonic-yang-models/tests/yang_model_tests/tests_config/sonic-events-swss.json
index 90ca2b7df124..6b50ccd55acf 100644
--- a/src/sonic-yang-models/tests/yang_model_tests/tests_config/sonic-events-swss.json
+++ b/src/sonic-yang-models/tests/yang_model_tests/tests_config/sonic-events-swss.json
@@ -101,6 +101,42 @@
             }
         }
     },
+    "SONIC_EVENTS_SWSS_PFC_STORM_VALID_WITH_ADDITIONAL_INFO": {
+        "sonic-events-swss:sonic-events-swss": {
+            "sonic-events-swss:pfc-storm": {
+                "ifname": "Ethernet0",
+                "queue_index": 0,
+                "queue_id": 0,
+                "port_id": 0,
+                "additional_info": "info1:1|info2:2",
+                "timestamp": "1985-04-12T23:20:50.52Z"
+            }
+        }
+    },
+    "SONIC_EVENTS_SWSS_PFC_STORM_WITH_INVALID_ADDITIONAL_INFO_1": {
+        "sonic-events-swss:sonic-events-swss": {
+            "sonic-events-swss:pfc-storm": {
+                "ifname": "Ethernet0",
+                "queue_index": 0,
+                "queue_id": 0,
+                "port_id": 0,
+                "additional_info": "info1:1|info2",
+                "timestamp": "1985-04-12T23:20:50.52Z"
+            }
+        }
+    },
+    "SONIC_EVENTS_SWSS_PFC_STORM_WITH_INVALID_ADDITIONAL_INFO_2": {
+        "sonic-events-swss:sonic-events-swss": {
+            "sonic-events-swss:pfc-storm": {
+                "ifname": "Ethernet0",
+                "queue_index": 0,
+                "queue_id": 0,
+                "port_id": 0,
+                "additional_info": "info1:1|",
+                "timestamp": "1985-04-12T23:20:50.52Z"
+            }
+        }
+    },
     "SONIC_EVENTS_SWSS_CHK_CRM_THRESHOLD_INCORRECT_PERCENT": {
         "sonic-events-swss:sonic-events-swss": {
             "sonic-events-swss:chk_crm_threshold": {
diff --git a/src/sonic-yang-models/yang-models/sonic-events-swss.yang b/src/sonic-yang-models/yang-models/sonic-events-swss.yang
index af5bfd905672..f7b3ca3ea5e6 100644
--- a/src/sonic-yang-models/yang-models/sonic-events-swss.yang
+++ b/src/sonic-yang-models/yang-models/sonic-events-swss.yang
@@ -78,6 +78,13 @@ module sonic-events-swss {
                 type uint64;
             }
 
+            leaf additional_info {
+                type string {
+                    pattern '[-a-zA-Z0-9_]+:[-a-zA-Z0-9_]+(\|{1}[-a-zA-Z0-9_]+:[-a-zA-Z0-9_]+)*';
+                }
+                description "Additional information to investigate PFC storm";
+            }
+
             uses evtcmn:sonic-events-cmn;
         }