Event and alarm management by bhaveshdell · Pull Request #22617 · sonic-net/sonic-buildimage

bhaveshdell · 2025-05-14T22:08:37Z

Why I did it
This PR contains code changes for providing extension to the Event Framework as specified in the sonic-net/SONiC#1409

How I did it
Followed design specified in sonic-net/SONiC#1409.

How to verify it
Unit tests added.

This PR was originally reviewed and merged.
#17949

However, due to build error post-merge the PR was reverted.
#20052

The possible fix for build error has been fixed as per comments in PR
#20064

mssonicbld · 2025-05-14T22:08:45Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2025-05-14T22:08:57Z

Azure Pipelines successfully started running 1 pipeline(s).

bhaveshdell · 2025-05-15T17:51:38Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2025-05-15T17:51:55Z

Commenter does not have sufficient privileges for PR 22617 in repo sonic-net/sonic-buildimage

bhaveshdell · 2025-05-15T17:59:09Z

/AzurePipelines run Azure.sonic-buildimage

azure-pipelines · 2025-05-15T17:59:16Z

Commenter does not have sufficient privileges for PR 22617 in repo sonic-net/sonic-buildimage

prsunny · 2025-05-20T16:24:26Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2025-05-20T16:24:38Z

Azure Pipelines successfully started running 1 pipeline(s).

prsunny · 2025-05-20T16:25:11Z

/AzurePipelines run Azure.sonic-buildimage

@bhaveshdell , you can try with /azpw run Azure.sonic-buildimage

venkatmahalingam · 2025-05-20T21:20:15Z

/azpw run Azure.sonic-buildimage

mssonicbld · 2025-05-20T21:20:17Z

Only PR owner can use /azpw run

bhaveshdell · 2025-05-21T01:31:30Z

/azpw run Azure.sonic-buildimage

mssonicbld · 2025-05-21T01:31:33Z

/AzurePipelines run Azure.sonic-buildimage

azure-pipelines · 2025-05-21T01:31:44Z

Azure Pipelines successfully started running 1 pipeline(s).

zhangyanzhao · 2025-05-27T16:12:06Z

/azpw run Azure.sonic-buildimage

mssonicbld · 2025-05-27T16:12:08Z

Only PR owner can use /azpw run

qiluo-msft · 2025-06-05T17:44:29Z

/azp run Azure.sonic-buildimage #Closed

azure-pipelines · 2025-06-05T17:44:40Z

Azure Pipelines successfully started running 1 pipeline(s).

Copilot

Pull Request Overview

This PR extends the existing Event Framework by introducing alarm management via a new YANG model and by adding a standalone eventdb service alongside adjustments to eventd. Key changes include:

Adding sonic-alarm.yang to define alarm state and statistics.
Introducing eventdb daemon: source code, build/test integration, Debian install, and supervisor configuration.
Updating build scripts, test configs, and Docker templates to support both eventd and eventdb.

Reviewed Changes

Copilot reviewed 24 out of 24 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
src/sonic-yang-models/yang-models/sonic-alarm.yang	New YANG module for alarm operational data
src/sonic-eventd/var/evprofile/default.json	Empty default event profile
src/sonic-eventd/tests/subdir.mk	Added `eventdb_ut` dependency
src/sonic-eventd/tests/eventdb_database_config_*.json	Test database config for `eventdb`
src/sonic-eventd/tests/eventd.json	`eventd` JSON config for history limits
src/sonic-eventd/src/subdir.mk	Added `eventdb` build/test object lists
src/sonic-eventd/src/loghandler.{h,cpp}	Syslog helper API for events/alarm logging
src/sonic-eventd/src/eventutils.{h,cpp}	Parsing utilities for JSON configs and event profiles
src/sonic-eventd/src/eventdb.cpp	Entry point for `eventdb`, signal handling
src/sonic-eventd/src/eventconsume.{h,cpp}	Core logic for consuming events and updating stats
src/sonic-eventd/etc/eventd.json	Default `eventd` config
src/sonic-eventd/debian/sonic-eventd.install	Install rules for `eventdb` and its configs
src/sonic-eventd/Makefile	New `eventdb` targets and test targets
files/build_templates/docker_image_ctl.j2	Cold-boot Redis load logic
dockers/docker-eventd/supervisord.conf	Added `eventdb` supervisord program
dockers/docker-database/database_config.json.j2	Added `EVENT_DB` mapping

Comments suppressed due to low confidence (2)

src/sonic-yang-models/yang-models/sonic-alarm.yang:96

The id leaf in ALARM_STATS_LIST uses an enumeration with only a single member state and no explicit value; this is likely incomplete. Define all intended enum values with associated numeric values or revisit the choice of type.

type enumeration {

files/build_templates/docker_image_ctl.j2:103

Typo in comment: change emtpy to empty.

# Create an emtpy file and overwrite any RDB if already there

Copilot · 2025-06-05T17:45:54Z

src/sonic-eventd/src/loghandler.h

@@ -0,0 +1,5 @@
+#include <iostream>
+extern "C" void openSyslog();
+extern "C" void writeToSyslog(std::string ev_id, int ev_sev, std::string ev_type, std::string ev_act, std::string ev_msg, std::string ev_static_msg);


Using std::string in extern "C" declarations breaks the C ABI and can lead to undefined behavior. Change signatures to use C-compatible types (e.g., const char*).

Suggested change

extern "C" void writeToSyslog(std::string ev_id, int ev_sev, std::string ev_type, std::string ev_act, std::string ev_msg, std::string ev_static_msg);

extern "C" void writeToSyslog(const char* ev_id, int ev_sev, const char* ev_type, const char* ev_act, const char* ev_msg, const char* ev_static_msg);

``` #Closed

this is valid comment.

Copilot · 2025-06-05T17:45:55Z

src/sonic-eventd/src/loghandler.cpp

+extern "C" void writeToSyslog(std::string ev_id, int ev_sev, std::string ev_type, std::string ev_act, std::string ev_msg, std::string ev_static_msg) {
+    int SYSLOG_FACILITY = LOG_LOCAL4;
+    if (ev_act.empty()) {
+        const char LOG_FORMAT[] = "[%s], %%%s: %s %s"; 


The format string uses %%%s, which will emit a literal % before the %s. It should likely be %s instead of %%%s to correctly interpolate the event name.

Suggested change

const char LOG_FORMAT[] = "[%s], %%%s: %s %s";

const char LOG_FORMAT[] = "[%s], %s: %s %s";

Copilot · 2025-06-05T17:45:55Z

src/sonic-eventd/src/eventutils.h

+using namespace std;
+
+const string EVENT_SEVERITY_CRITICAL_STR = "CRITICAL";
+const string EVENT_SEVERITY_MAJOR_STR    = "MAJOR";
+const string EVENT_SEVERITY_MINOR_STR    = "MINOR";
+const string EVENT_SEVERITY_WARNING_STR  = "WARNING";
+const string EVENT_SEVERITY_INFORMATIONAL_STR = "INFORMATIONAL";
+
+const string EVENT_ENABLE_TRUE_STR  = "true";
+const string EVENT_ENABLE_FALSE_STR = "false";
+
+const string EVENT_ACTION_RAISE_STR  = "RAISE";
+const string EVENT_ACTION_CLEAR_STR  = "CLEAR";
+const string EVENT_ACTION_ACK_STR    = "ACKNOWLEDGE";
+const string EVENT_ACTION_UNACK_STR  = "UNACKNOWLEDGE";
+


[nitpick] Avoid using namespace std; in a header file to prevent namespace pollution; qualify standard types explicitly.

Suggested change

using namespace std;

const string EVENT_SEVERITY_CRITICAL_STR = "CRITICAL";

const string EVENT_SEVERITY_MAJOR_STR = "MAJOR";

const string EVENT_SEVERITY_MINOR_STR = "MINOR";

const string EVENT_SEVERITY_WARNING_STR = "WARNING";

const string EVENT_SEVERITY_INFORMATIONAL_STR = "INFORMATIONAL";

const string EVENT_ENABLE_TRUE_STR = "true";

const string EVENT_ENABLE_FALSE_STR = "false";

const string EVENT_ACTION_RAISE_STR = "RAISE";

const string EVENT_ACTION_CLEAR_STR = "CLEAR";

const string EVENT_ACTION_ACK_STR = "ACKNOWLEDGE";

const string EVENT_ACTION_UNACK_STR = "UNACKNOWLEDGE";

const std::string EVENT_SEVERITY_CRITICAL_STR = "CRITICAL";

const std::string EVENT_SEVERITY_MAJOR_STR = "MAJOR";

const std::string EVENT_SEVERITY_MINOR_STR = "MINOR";

const std::string EVENT_SEVERITY_WARNING_STR = "WARNING";

const std::string EVENT_SEVERITY_INFORMATIONAL_STR = "INFORMATIONAL";

const std::string EVENT_ENABLE_TRUE_STR = "true";

const std::string EVENT_ENABLE_FALSE_STR = "false";

const std::string EVENT_ACTION_RAISE_STR = "RAISE";

const std::string EVENT_ACTION_CLEAR_STR = "CLEAR";

const std::string EVENT_ACTION_ACK_STR = "ACKNOWLEDGE";

const std::string EVENT_ACTION_UNACK_STR = "UNACKNOWLEDGE";

``` #Closed

this is a valid comment

Will address the comments

Copilot · 2025-06-05T17:45:55Z

src/sonic-eventd/src/eventdb.cpp

+static EventConsume *evtd_instance = NULL;
+
+void signalHandler(const int signal) { 
+    SWSS_LOG_NOTICE("in signalHandler");
+
+    if (signal == SIGINT) {
+        evtd_instance->read_eventd_config();


Calling non-async-signal-safe functions inside a signal handler is unsafe and can cause undefined behavior. Consider deferring configuration reload to the main loop or using a flag checked outside the handler.

Suggested change

static EventConsume *evtd_instance = NULL;

void signalHandler(const int signal) {

SWSS_LOG_NOTICE("in signalHandler");

if (signal == SIGINT) {

evtd_instance->read_eventd_config();

#include <atomic>

static EventConsume *evtd_instance = NULL;

static std::atomic<bool> reload_config_flag(false);

void signalHandler(const int signal) {

SWSS_LOG_NOTICE("in signalHandler");

if (signal == SIGINT) {

reload_config_flag.store(true);

mssonicbld · 2025-09-15T23:35:20Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2025-09-15T23:35:33Z

Azure Pipelines successfully started running 1 pipeline(s).

mssonicbld · 2025-09-16T08:20:21Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2025-09-16T08:20:35Z

Azure Pipelines successfully started running 1 pipeline(s).

mssonicbld · 2025-09-16T23:50:19Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2025-09-16T23:50:32Z

Azure Pipelines successfully started running 1 pipeline(s).

bhaveshdell · 2025-09-17T17:29:04Z

/azpw run Azure.sonic-buildimage

change to github path for submodules Modify config to disable some features not used on ot platform Fix EOL mirror issues for Buster and Bullseye by updating MIRROR_URLS The Bullseye release is now end-of-life, and the `bullseye-backports` entry is no longer available on the standard Debian mirrors, causing Docker image builds to fail. Due to the way `files/apt/sources.list.j2` is templated, the backports URL is generated using the shared `MIRROR_URLS` variable, which also affects the main and updates entries. Rather than restructuring the template to special- case `bullseye-backports`, this commit updates `DEFAULT_MIRROR_URLS` entirely for Bullseye to point to archive-capable mirrors that support all required repositories. In the case of Buster, `DEFAULT_MIRROR_SECURITY_URLS` was also updated to resolve similar build failures. - For Bullseye: uses `archive.debian.org` for main, updates, and backports, and `debian-archive.trafficmanager.net` specifically for security. - For Buster: uses `archive.debian.org` for main, updates backports and security. This approach keeps the templating logic simple and ensures stable builds for EOL releases using fully supported mirror endpoints. Fixes sonic-net#23430 and sonic-net#23336 Signed-off-by: Alberto Martin <alberto.martin@htecgroup.com> Support otn-kvm platform for OTN devices Signed-off-by: oplklum <lu.mao@molex.com> merge event and alarm management related to official sonic-net#22617 extend event function for platform event function changed libsai version to 1.1.0 use hal server version 1.1.0 supervisord does not spawn hal and HalApiServer anymore Fix submodule pointer for sonic-platform-daemons Update submodule sonic-swss-common to 202411_otn Update submodule sonic-sairedis to 202411_otn Update submodule sonic-swss 202411_otn Update submodule sonic-utilities 202411_otn

mssonicbld · 2025-12-01T23:05:58Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2025-12-01T23:06:10Z

Azure Pipelines successfully started running 1 pipeline(s).

bhaveshdell · 2025-12-02T18:02:18Z

/azpw run Azure.sonic-buildimage

mssonicbld · 2025-12-02T18:02:20Z

/AzurePipelines run Azure.sonic-buildimage

azure-pipelines · 2025-12-02T18:02:33Z

Azure Pipelines successfully started running 1 pipeline(s).

mssonicbld · 2026-01-16T22:14:46Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2026-01-16T22:14:58Z

Azure Pipelines successfully started running 1 pipeline(s).

venkatmahalingam · 2026-01-27T18:59:13Z

@zbud-msft do you have any comments?

bhaveshdell · 2026-01-28T20:41:40Z

/azpw run Azure.sonic-buildimage

mssonicbld · 2026-01-28T20:41:43Z

/AzurePipelines run Azure.sonic-buildimage

azure-pipelines · 2026-01-28T20:41:55Z

Azure Pipelines successfully started running 1 pipeline(s).

qiluo-msft · 2026-02-06T18:54:51Z

dockers/docker-database/database_config.json.j2

        }
 {% endif %}
+        ,
+        "EVENT_DB" : {


In some use cases, we just disable eventd.

Will this feature work as expected if eventd disabled?

Did you tested? Do you need adding a testcase?

Do you need a standalone feature enablement/disablement flag?

bhaveshdell requested review from lguohan and qiluo-msft as code owners May 14, 2025 22:08

qiluo-msft requested a review from Copilot June 5, 2025 17:42

Copilot AI reviewed Jun 5, 2025

View reviewed changes

jeff-yin mentioned this pull request Aug 12, 2025

Events/Alarms Framework sonic-net/SONiC#1549

Open

kmathewm mentioned this pull request Nov 25, 2025

Support OTN sonic-molex/sonic-buildimage#1

Closed

11 tasks

Remove eventdb loading as persistence is not added with this infra

b5b3887

oplklum pushed a commit to sonic-molex/sonic-buildimage that referenced this pull request Dec 3, 2025

Event and alarm management (sonic-net#22617)

a6d4909

Merge branch 'master' into eventd-comm

213003c

qiluo-msft approved these changes Jan 22, 2026

View reviewed changes

qiluo-msft requested a review from make1980 February 6, 2026 18:42

qiluo-msft reviewed Feb 6, 2026

View reviewed changes

bhaveshdell dismissed venkatmahalingam’s stale review via 213003c March 10, 2026 03:12

dudu579 mentioned this pull request Mar 17, 2026

Support eventdb to record reported alarms sonic-molex/sonic-buildimage#5

Merged

	extern "C" void writeToSyslog(std::string ev_id, int ev_sev, std::string ev_type, std::string ev_act, std::string ev_msg, std::string ev_static_msg);
	extern "C" void writeToSyslog(const char* ev_id, int ev_sev, const char* ev_type, const char* ev_act, const char* ev_msg, const char* ev_static_msg);
	``` #Closed

	const char LOG_FORMAT[] = "[%s], %%%s: %s %s";
	const char LOG_FORMAT[] = "[%s], %s: %s %s";

Conversation

bhaveshdell commented May 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mssonicbld commented May 14, 2025

Uh oh!

azure-pipelines bot commented May 14, 2025

Uh oh!

bhaveshdell commented May 15, 2025

Uh oh!

azure-pipelines bot commented May 15, 2025

Uh oh!

bhaveshdell commented May 15, 2025

Uh oh!

azure-pipelines bot commented May 15, 2025

Uh oh!

prsunny commented May 20, 2025

Uh oh!

azure-pipelines bot commented May 20, 2025

Uh oh!

prsunny commented May 20, 2025

Uh oh!

venkatmahalingam commented May 20, 2025

Uh oh!

mssonicbld commented May 20, 2025

Uh oh!

bhaveshdell commented May 21, 2025

Uh oh!

mssonicbld commented May 21, 2025

Uh oh!

azure-pipelines bot commented May 21, 2025

Uh oh!

zhangyanzhao commented May 27, 2025

Uh oh!

mssonicbld commented May 27, 2025

Uh oh!

qiluo-msft commented Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

azure-pipelines bot commented Jun 5, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jun 5, 2025 • edited by qiluo-msft Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

qiluo-msft Jun 10, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jun 5, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jun 5, 2025 • edited by qiluo-msft Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

qiluo-msft Jun 10, 2025

Choose a reason for hiding this comment

Uh oh!

venkatmahalingam Jun 10, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jun 5, 2025

Choose a reason for hiding this comment

Uh oh!

mssonicbld commented Sep 15, 2025

Uh oh!

azure-pipelines bot commented Sep 15, 2025

Uh oh!

mssonicbld commented Sep 16, 2025

Uh oh!

azure-pipelines bot commented Sep 16, 2025

Uh oh!

mssonicbld commented Sep 16, 2025

Uh oh!

azure-pipelines bot commented Sep 16, 2025

bhaveshdell commented May 14, 2025 •

edited

Loading

qiluo-msft commented Jun 5, 2025 •

edited

Loading

Copilot AI Jun 5, 2025 •

edited by qiluo-msft

Loading

Copilot AI Jun 5, 2025 •

edited by qiluo-msft

Loading