Add Structured Events w/ YANG Models

dockers/docker-fpm-frr/bgp_regex.json

@@ -3,6 +3,16 @@
         "tag": "bgp-state",
         "regex": "Peer .default\\|([0-9a-f:.]*[0-9a-f]*). admin state is set to .(up|down).",
         "params": [ "ip", "status" ]
+    },
+    {
+        "tag": "zebra-no-buff",
+        "regex": "No buffer space available",
+        "params": []
+    },
+    {
+        "tag": "notification",
+        "regex": "NOTIFICATION: (received|sent) (?:to|from) neighbor ([0-9a-f:.]*[0-9a-f+]*)\\s*.* (\\d*)\/(\\d*)",
+        "params": [ "is-sent", "ip", "major-code", "minor-code" ]
     }
 ]
 

files/build_templates/dhcp_relay_regex.json

@@ -0,0 +1,7 @@
+[
+    {
+        "tag": "dhcp-relay-discard",
+        "regex": "Discarding packet received on ([a-zA-Z0-9-_]*) interface that has no IPv4 address assigned.",
+        "params": [ "ifname" ]
+    }
+]

files/build_templates/dockerd_regex.json

@@ -0,0 +1,7 @@
+[
+    {
+        "tag": "invalid-freelist",
+        "regex": "invalid freelist",
+        "params": []
+    }
+]

files/build_templates/events_info.json

@@ -3,7 +3,7 @@
     "proclist": [
         {
             "name": "monit",
-	    "parse_json": "monit_regex.json"
+            "parse_json": "monit_regex.json"
         },
         {
             "name": "sshd",
@@ -12,6 +12,30 @@
         {
             "name": "systemd",
             "parse_json": "systemd_regex.json"
+        },
+        {
+            "name": "dhcp_relay",
+            "parse_json": "dhcp_relay_regex.json"
+        },
+        {
+            "name": "syncd",
+            "parse_json": "syncd_regex.json"
+        },
+        {
+            "name": "kernel",
+            "parse_json": "kernel_regex.json"
+        },
+        {
+            "name": "dockerd",
+            "parse_json": "dockerd_regex.json"
+        },
+        {
+            "name": "arista",
+            "parse_json": "seu_regex.json"
+        },
+        {
+            "name": "python3",
+            "parse_json": "seu_regex.json"
         }
     ]
 }

files/build_templates/kernel_regex.json

@@ -0,0 +1,7 @@
+[
+    {
+        "tag": "event-kernel",
+        "regex": "(write failed|Write protected|Remounting filesystem read-only|zlib decompression failed, data probably corrupt)",
+        "params": [ "fail_type:ret=(arg==\"write failed\")and\"write_failed\"or((arg==\"Write protected\")and\"write_protected\"or((arg==\"Remounting filesystem read-only\")and\"remount_read_only\"or((arg==\"zlib decompression failed, data probably corrupt\")and\"zlib_decompress\"or\"\")))" ]
+    }
+]

files/build_templates/seu_regex.json

@@ -0,0 +1,7 @@
+[
+    {
+        "tag": "event-seu",
+        "regex": "SEU error was detected",
+        "params": []
+    }
+]

files/build_templates/sonic_debian_extension.j2

@@ -328,6 +328,11 @@ j2 -f json $BUILD_TEMPLATES/rsyslog_plugin.conf.j2 $BUILD_TEMPLATES/events_info.
 sudo cp $BUILD_TEMPLATES/monit_regex.json $FILESYSTEM_ROOT_ETC/rsyslog.d/
 sudo cp $BUILD_TEMPLATES/sshd_regex.json $FILESYSTEM_ROOT_ETC/rsyslog.d/
 sudo cp $BUILD_TEMPLATES/systemd_regex.json $FILESYSTEM_ROOT_ETC/rsyslog.d/
+sudo cp $BUILD_TEMPLATES/dhcp_relay_regex.json $FILESYSTEM_ROOT_ETC/rsyslog.d/
+sudo cp $BUILD_TEMPLATES/syncd_regex.json $FILESYSTEM_ROOT_ETC/rsyslog.d/
+sudo cp $BUILD_TEMPLATES/kernel_regex.json $FILESYSTEM_ROOT_ETC/rsyslog.d/
+sudo cp $BUILD_TEMPLATES/dockerd_regex.json $FILESYSTEM_ROOT_ETC/rsyslog.d/
+sudo cp $BUILD_TEMPLATES/seu_regex.json $FILESYSTEM_ROOT_ETC/rsyslog.d/
 
 # Install custom-built monit package and SONiC configuration files
 sudo dpkg --root=$FILESYSTEM_ROOT -i $debs_path/monit_*.deb || \

files/build_templates/syncd_regex.json

@@ -0,0 +1,7 @@
+[
+    {
+        "tag": "syncd-failure",
+        "regex": "(MMU ERR Type|L3 route add failed with error|Assertion failed|Received switch event|SER Parity Check Error)",
+        "params": [ "fail_type:ret=(arg==\"Received switch event\")and\"switch_event\"or((arg==\"Assertion Failed\")and\"assert\"or((arg==\"SER Parity Check Error\")and\"parity_check\"or((arg==\"MMU ERR Type\")and\"mmu_err\"or((arg==\"route add failed\")and\"route_add_failed\"or\"\"))))" ]
+    }
+]

files/build_templates/systemd_regex.json

@@ -2,6 +2,11 @@
     {
         "tag": "event-stopped-ctr",
         "regex": "Stopped ([a-zA-Z-_\\s]*) container",
-        "params": [ "ctr-name" ]
+        "params": [ "ctr_name" ]
+    },
+    {
+        "tag": "watchdog-timeout",
+        "regex": "(?:watchdog|Watchdog) timeout .limit.([0-9])min.",
+        "params": [ "limit" ]
     }
 ]

files/image_config/monit/container_checker

@@ -158,7 +158,7 @@ def publish_events(lst):
     params = swsscommon.FieldValueMap()
 
     for ctr in lst:
-        params["name"] = ctr;
+        params["ctr_name"] = ctr;
         swsscommon.event_publish(events_handle, EVENTS_PUBLISHER_TAG, params)
 
     swsscommon.events_deinit_publisher(events_handle)

src/dhcpmon/src/dhcp_mon.cpp

@@ -15,6 +15,7 @@
 
 #include "dhcp_mon.h"
 #include "dhcp_devman.h"
+#include "events.h"
 
 /** DHCP device/interface state */
 typedef struct
@@ -40,6 +41,8 @@ static struct event *ev_sigterm;
 /** libevent SIGUSR1 signal event struct */
 static struct event *ev_sigusr1;
 
+event_handle_t g_events_handle;
+
 /** DHCP monitor state data for aggregate device for mgmt device */
 static dhcp_mon_state_t state_data[] = {
     [0] = {
@@ -95,7 +98,15 @@ static void check_dhcp_relay_health(dhcp_mon_state_t *state_data)
     {
     case DHCP_MON_STATUS_UNHEALTHY:
         if (++state_data->count > dhcp_unhealthy_max_count) {
-            syslog(LOG_ALERT, state_data->msg, state_data->count * window_interval_sec, context->intf);
+            auto duration = state_data->count * window_interval_sec;
+	    std::string vlan(context->intf);
+            syslog(LOG_ALERT, state_data->msg, duration, vlan);
+            if (state_data->check_type == DHCP_MON_CHECK_POSITIVE) {
+                event_params_t params = {
+                    { "vlan", vlan },
+                    { "duration", std::to_string(duration) }};
+                event_publish(g_events_handle, "dhcp-relay-disparity", &params);
+            }
             dhcp_devman_print_status(context, DHCP_COUNTERS_SNAPSHOT);
             dhcp_devman_print_status(context, DHCP_COUNTERS_CURRENT);
         }
@@ -179,6 +190,8 @@ int dhcp_mon_init(int window_sec, int max_count)
             break;
         }
 
+        g_events_handle = events_init_publisher("sonic-events-dhcp-relay");
+
         rv = 0;
     } while (0);
 
@@ -203,6 +216,8 @@ void dhcp_mon_shutdown()
     event_free(ev_sigusr1);
 
     event_base_free(base);
+
+    events_deinit_publisher(g_events_handle);
 }
 
 /**

src/sonic-yang-mgmt/tests/libyang-python-tests/test_sonic_yang.py

@@ -292,11 +292,13 @@ def test_validate_yang_models(self, sonic_yang_data):
         '''
         test_file = sonic_yang_data['test_file']
         syc = sonic_yang_data['syc']
-        # Currently only 3 YANG files are not directly related to config
+        # Currently only 3 YANG files are not directly related to config, along with event YANG models
         # which are: sonic-extension.yang, sonic-types.yang and sonic-bgp-common.yang. Hard coding
         # it right now.
+        # event YANG models do not map directly to config_db and are included to NON_CONFIG_YANG_FILES at run time
         # If any more such helper yang files are added, we need to update here.
-        NON_CONFIG_YANG_FILES = 3
+        EVENT_YANG_FILES = sum(1 for yang_model in syc.yangFiles if 'sonic-events' in yang_model)
+        NON_CONFIG_YANG_FILES = 3 + EVENT_YANG_FILES
         # read config
         jIn = self.readIjsonInput(test_file, 'SAMPLE_CONFIG_DB_JSON')
         jIn = json.loads(jIn)

src/sonic-yang-models/setup.py

@@ -105,6 +105,12 @@ def run(self):
                          './yang-models/sonic-device_neighbor.yang',
                          './yang-models/sonic-device_neighbor_metadata.yang',
                          './yang-models/sonic-dhcpv6-relay.yang',
+                         './yang-models/sonic-events-bgp.yang',
+                         './yang-models/sonic-events-common.yang',
+                         './yang-models/sonic-events-dhcp-relay.yang',
+                         './yang-models/sonic-events-host.yang',
+                         './yang-models/sonic-events-swss.yang',
+                         './yang-models/sonic-events-syncd.yang',
                          './yang-models/sonic-extension.yang',
                          './yang-models/sonic-flex_counter.yang',
                          './yang-models/sonic-feature.yang',
@@ -174,6 +180,12 @@ def run(self):
                          './cvlyang-models/sonic-crm.yang',
                          './cvlyang-models/sonic-device_metadata.yang',
                          './cvlyang-models/sonic-device_neighbor.yang',
+                         './cvlyang-models/sonic-events-bgp.yang',
+                         './cvlyang-models/sonic-events-common.yang',
+                         './cvlyang-models/sonic-events-dhcp-relay.yang',
+                         './cvlyang-models/sonic-events-host.yang',
+                         './cvlyang-models/sonic-events-swss.yang',
+                         './cvlyang-models/sonic-events-syncd.yang',
                          './cvlyang-models/sonic-device_neighbor_metadata.yang',
                          './cvlyang-models/sonic-extension.yang',
                          './cvlyang-models/sonic-flex_counter.yang',

src/sonic-yang-models/tests/yang_model_tests/tests/sonic-events-bgp.json

@@ -0,0 +1,47 @@
+{
+	"SONIC_EVENTS_BGP_BGP_STATE_INCORRECT_IP": {
+		"desc": "BGP_STATE_EVENT_INCORRECT_IP failure.",
+		"eStrKey": "InvalidValue"
+	},
+	"SONIC_EVENTS_BGP_BGP_STATE_INCORRECT_STATUS": {
+		"desc": "BGP_STATE_EVENT_INCORRECT_STATUS failure.",
+		"eStrKey": "InvalidValue"
+	},
+	"SONIC_EVENTS_BGP_BGP_STATE_INCORRECT_TIMESTAMP": {
+		"desc": "BGP_STATE_EVENT_INCORRECT_TIMESTAMP failure.",
+		"eStrKey": "Pattern"
+	},
+	"SONIC_EVENTS_BGP_BGP_STATE_VALID": {
+		"desc": "VALID BGP STATE EVENT."
+	},
+	"SONIC_EVENTS_BGP_NOTIFICATION_INCORRECT_MAJOR_CODE": {
+		"desc": "BGP_NOTIFICATION_INCORRECT_MAJOR_CODE failure.",
+		"eStrKey": "InvalidValue"
+	},
+	"SONIC_EVENTS_BGP_NOTIFICATION_INCORRECT_MINOR_CODE": {
+		"desc": "BGP_NOTIFICATION_INCORRECT_MINOR_CODE failure.",
+		"eStrKey": "InvalidValue"
+	},
+	"SONIC_EVENTS_BGP_NOTIFICATION_INCORRECT_IP": {
+		"desc": "BGP_NOTIFICATION_INCORRECT_IP failure.",
+		"eStrKey": "InvalidValue"
+	},
+	"SONIC_EVENTS_BGP_NOTIFICATION_INCORRECT_IS-SENT": {
+		"desc": "BGP_NOTIFICATION_INCORRECT_IS-SENT failure.",
+		"eStrKey": "InvalidValue"
+	},
+	"SONIC_EVENTS_BGP_NOTIFICATION_INCORRECT_TIMESTAMP": {
+		"desc": "BGP_NOTIFICATION_INCORRECT_TIMESTAMP failure.",
+		"eStrKey": "Pattern"
+	},
+	"SONIC_EVENTS_BGP_NOTIFICATION_VALID": {
+		"desc": "VALID BGP NOTIFICATION."
+	},
+	"SONIC_EVENTS_BGP_ZEBRA_NO_BUFF_INCORRECT_TIMESTAMP": {
+		"desc": "ZEBRA_NO_BUFF_EVENT_INCORRECT_TIMESTAMP.",
+		"eStrKey": "Pattern"
+	},
+	"SONIC_EVENTS_BGP_ZEBRA_NO_BUFF_VALID": {
+		"desc": "VALID ZEBRA_NO_BUFF EVENT."
+	}
+}

src/sonic-yang-models/tests/yang_model_tests/tests/sonic-events-dhcp-relay.json

@@ -0,0 +1,28 @@
+{
+	"SONIC_EVENTS_DHCP_RELAY_DHCP_RELAY_DISCARD_INCORRECT_IFNAME": {
+		"desc": "DHCP_RELAY_DISCARD_EVENT_INCORRECT_IFNAME failure.",
+		"eStrKey": "Pattern"
+	},
+	"SONIC_EVENTS_DHCP_RELAY_DHCP_RELAY_DISCARD_INCORRECT_TIMESTAMP": {
+		"desc": "DHCP_RELAY_DISCARD_EVENT_INCORRECT_TIMESTAMP failure.",
+		"eStrKey": "Pattern"
+	},
+	"SONIC_EVENTS_DHCP_RELAY_DHCP_RELAY_DISCARD_VALID": {
+		"desc": "VALID DHCP_RELAY_DISCARD EVENT."
+	},
+	"SONIC_EVENTS_DHCP_RELAY_DHCP_RELAY_DISPARITY_INCORRECT_VLAN": {
+		"desc": "DHCP_RELAY_DISPARITY_EVENT_INCORRECT_VLAN failure.",
+		"eStrKey": "Pattern"
+	},
+	"SONIC_EVENTS_DHCP_RELAY_DHCP_RELAY_DISPARITY_INCORRECT_DURATION": {
+		"desc": "DHCP_RELAY_DISPARITY_EVENT_INCORRECT_DURATION failure.",
+		"eStrKey": "InvalidValue"
+	},
+	"SONIC_EVENTS_DHCP_RELAY_DHCP_RELAY_DISPARITY_INCORRECT_TIMESTAMP": {
+		"desc": "DHCP_RELAY_DISPARITY_EVENT_INCORRECT_TIMESTAMP failure.",
+		"eStrKey": "Pattern"
+	},
+	"SONIC_EVENTS_DHCP_RELAY_DHCP_RELAY_DISPARITY_VALID": {
+		"desc": "VALID DHCP_RELAY_DISPARITY EVENT."
+	}
+}