Event/alarm framework HLD update. Integrate with event producer framework. #1409

bhaveshdell · 2023-06-30T20:03:14Z

The event/alarm framework HLD was reviewed and committed earlier.
With the availability of event producer framework, the design is updated to provide DB/persistent support for event history.
Also gnmi/rest openconfig interface for get operations and gnmi subscription.

Code PRs
sonic-net/sonic-swss-common#852
sonic-net/sonic-buildimage#17949

Add sonic-event-community.yang changes.

bhaveshdell · 2023-07-19T01:25:03Z

@zhangyanzhao Please assign reviewers.

bhaveshdell · 2023-08-17T17:46:43Z

@kwangsuk, Please review.

bhaveshdell · 2023-08-17T18:01:56Z

@renukamanavalan Please review update to the existing event framework HLD.
It is about integrating with the producer framework, to provide DB support.

jeff-yin · 2023-08-28T17:08:44Z

doc/event-alarm-framework/event-alarm-framework.md

-    } else {
-        LOG_EVENT(TEMPERATURE_EXCEEDED, sensor_name_p, CLEAR_ALARM, "Temperature for the sensor %s is %d degrees ", sensor_name_p, current_temp);
-    }
-```
 #### 3.1.1.2 Development Process


It seems like this is introducing differences in the way that an application/component needs to implement their events and alarms.
If this is the case, we should clearly outline what these changes are, ideally prepare an example, and raise this in the Community during one of the Tuesday calls.
If you agree, we can work with @zhangyanzhao to schedule something.

jeff-yin · 2023-09-07T18:26:02Z

The event/alarm framework HLD was reviewed and committed earlier. With the availability of event producer framework, the design is updated to provide DB/persistent support for event history. Also gnmi/rest openconfig interface for get operations and gnmi subscription.

To add some more background, the original event/alarm framework HLD was raised as #1064 and then approved and merged.
That HLD also had code PRs attached, but the code was never reviewed and merged.

#954 for Event Producer was merged and its code PRs were merged, so the events/alarm framework HLD needed to be updated, hence this PR.

event-id and event name used interchangeably.

adyeung · 2023-09-28T17:38:05Z

@rajendra-dendukuri pls help review the HLD

kwangsuk · 2023-09-28T22:09:44Z

doc/event-alarm-framework/event-alarm-framework.md

@@ -175,14 +167,11 @@ This modified file can then be uploaded to the device to /etc/evprofile/.
 Operator can select any of these custom event profiles to change default properties of events.


Event profiling to change properties lie severity etc. would be managed by controllers as per their OAM policy. Hence, can we remove the support to change the profile settings?

zhangyanzhao · 2023-10-12T03:33:48Z

Reviewed in community on 9/21/2023

zhangyanzhao · 2023-10-12T03:35:28Z

community review recording https://zoom.us/rec/share/P44xWGduoa6Q2Q6D8lNiWyoQlWwlyx5NB2TzgT6QjOaL5ky9QdbwYvAA8tk-iNEh.XPqm29vRYgCiDMz8

jeff-yin · 2023-10-18T22:17:39Z

@zhangyanzhao @renukamanavalan can we merge this HLD now?

shyam77git · 2023-11-01T23:21:11Z

doc/event-alarm-framework/event-alarm-framework.md

@@ -102,7 +94,7 @@ Such a change has an important metric called *severity* to indicate how critical
   The set of alarms and their severities are an indication to health of various applications of the system and System LED can be deduced from alarms.
   An acknowledged alarm means that operator is aware of the condition so, acknowledged alarm will be taken out of consideration.

-Both events and alarms get recorded in a new DB called EVENT DB in a new redis instance.
+Both events and alarms get recorded in redis DB.


which redisDB? could you update if its some existing redisDB or a new one?

Also, as of now, when applications (processes/daemons) publish their event(s)/alarm(s), they do NOT get stored in any redis (or persistent DB) - right? In that case, are they stored by eventD framework/container in memory? no EVENT DB as of now?

shyam77git · 2023-11-03T19:56:55Z

doc/event-alarm-framework/event-alarm-framework.md

+| 5.2.4 | Openconfig interface  to acknowledge an alarm.                                  |                     |
+| 6     | CLI commands                                                                    |                     |
+| 6.1   | show alarm [ detail \| summary \| severity \| timestamp <from> <to> \| recent <5min\|1hr\|1day> \| sequence-number <from> <to> \| all]          |                    |
+| 6.2   | show event [ detail \| summary \| severity \| timestamp <from> <to> \| recent <5min\|1hr\|1day> \| sequence-number <from> <to>]                 |                     |


In 202305 present codebase, do not see support for these CLIs (i.e. show alarm, show event).
[1] In their absence, how does one check eventD's cache-services contents? as to what events, alarms are received and stored in eventD's cache-services?
Is it there as part of some changeset not merged yet? or not there at all?

#1064 has some unmerged PRs. Does this support reside there?
If so, what's the plan to commit, merge these pending PRs to sonic mainstream repositories?

The present codebase does not have CLI support. It supports event publish via telemetry streaming.
The implementation for doc/event-alarm-framework/event-alarm-framework.md, is not merged.
#1064 unmerged PRs have the support for CLIs.
The current plan is to first get this PR merged. @shyam77git Please review and approve this PR.
Then rework changes in #1064 PRs to support these design updates and submit to community for coming release.

zhangyanzhao · 2023-11-08T23:50:06Z

merge this with reviewers approval

zhangyanzhao · 2023-12-11T21:12:25Z

@bhaveshdell can you please help to update the code PRs for this HLD by referring to #806 ? So that we can track this feature completeness clearly. Thanks.

stephenxs · 2023-12-14T03:45:02Z

Hi @bhaveshdell
Looks like the corresponding PRs are still tracked in a closed PR #761 which is confusing.
Could you please track the code PRs in this HLD which is latest?
Thanks

venkatmahalingam · 2023-12-14T05:29:16Z

Hi @bhaveshdell Looks like the corresponding PRs are still tracked in a closed PR #761 which is confusing. Could you please track the code PRs in this HLD which is latest? Thanks

@stephenxs Yes, we'll add code PRs to this HLD.

shyam77git · 2023-12-14T20:35:46Z

Hi @bhaveshdell Looks like the corresponding PRs are still tracked in a closed PR #761 which is confusing. Could you please track the code PRs in this HLD which is latest? Thanks

@stephenxs Yes, we'll add code PRs to this HLD.

Thanks @venkatmahalingam .
That would help reviewers as to what all code PRs to be reviewed in context of this HLD.
Also, would it there be some new code PRs related to updates in this HLD?
@bhaveshdell - it would be good if you can provide a full view here w.r.t code PRs (existing, new/upcoming etc.)

shyam77git · 2024-01-10T01:26:15Z

@bhaveshdell
Based on last comment, could you please update the latest and further plan on this?
Please add code PRs list to this HLD for review

zhangyanzhao · 2024-01-12T01:56:15Z

Copy the code PRs from #761

Corresponding Coding PRs:
sonic-net/sonic-buildimage#7813
sonic-net/sonic-swss-common#490
sonic-net/sonic-mgmt-framework#85
sonic-net/sonic-mgmt-common#48

zhangyanzhao · 2024-01-12T01:58:21Z

The event/alarm framework HLD was reviewed and committed earlier. With the availability of event producer framework, the design is updated to provide DB/persistent support for event history. Also gnmi/rest openconfig interface for get operations and gnmi subscription. Code PRs copied from

sonic-net/sonic-buildimage#7813 sonic-net/sonic-swss-common#490 sonic-net/sonic-mgmt-framework#85 sonic-net/sonic-mgmt-common#48

@venkatmahalingam @bhaveshdell can you please check if above code PRs are accurate or others should be added? I copied them from #761. Code PRs should be included in HLD per community agreement. Thanks.

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. Add new tables for events and alarms.

bhaveshdell added 2 commits June 30, 2023 12:54

Updates. Integrate with event producer framework.

9a3740d

Udpates. Change to sonic-event-history.

5a42f80

Add sonic-event-community.yang changes.

bhaveshdell marked this pull request as ready for review July 13, 2023 20:51

bhaveshdell changed the title ~~HLD Update. Integrate with event producer framework.~~ Event/alarm framework HLD update. Integrate with event producer framework. Aug 22, 2023

jeff-yin requested review from kwangsuk and renukamanavalan August 28, 2023 17:05

jeff-yin reviewed Aug 28, 2023

View reviewed changes

bhaveshdell added 2 commits September 21, 2023 02:29

Updates to sonic-yang model.w

fb36ac7

Updates.Add sonic-yang changes.

fc95cb6

event-id and event name used interchangeably.

kwangsuk reviewed Sep 28, 2023

View reviewed changes

mint570 approved these changes Oct 3, 2023

View reviewed changes

Remove custom event profile.

80efe0d

kwangsuk approved these changes Oct 17, 2023

View reviewed changes

jeff-yin self-requested a review October 17, 2023 23:27

jeff-yin approved these changes Oct 17, 2023

View reviewed changes

shyam77git reviewed Nov 1, 2023

View reviewed changes

shyam77git reviewed Nov 3, 2023

View reviewed changes

zhangyanzhao merged commit 6f86d7a into sonic-net:master Nov 8, 2023
1 check passed

jeff-yin mentioned this pull request Dec 8, 2023

Events/Alarms Framework #1549

Open

venkatmahalingam mentioned this pull request Dec 12, 2023

Handle ASIC/SDK health event #1533

Merged

This was referenced Jan 30, 2024

Event and alarm management sonic-net/sonic-buildimage#17949

Open

Event and alarm management: Add tables for event and alarms. sonic-net/sonic-swss-common#852

Merged

shyam77git mentioned this pull request Feb 1, 2024

SONiC FM (Fault Mgmt) infrastructure -Base version sonic-net/sonic-platform-daemons#421

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Event/alarm framework HLD update. Integrate with event producer framework. #1409

Event/alarm framework HLD update. Integrate with event producer framework. #1409

bhaveshdell commented Jun 30, 2023 •

edited

bhaveshdell commented Jul 19, 2023

bhaveshdell commented Aug 17, 2023

bhaveshdell commented Aug 17, 2023

jeff-yin Aug 28, 2023

jeff-yin Sep 26, 2023

jeff-yin commented Sep 7, 2023

adyeung commented Sep 28, 2023

kwangsuk Sep 28, 2023 •

edited

zhangyanzhao commented Oct 12, 2023

zhangyanzhao commented Oct 12, 2023

jeff-yin commented Oct 18, 2023 •

edited

shyam77git Nov 1, 2023

shyam77git Nov 3, 2023

bhaveshdell Nov 8, 2023

zhangyanzhao commented Nov 8, 2023

zhangyanzhao commented Dec 11, 2023

stephenxs commented Dec 14, 2023

venkatmahalingam commented Dec 14, 2023

shyam77git commented Dec 14, 2023

shyam77git commented Jan 10, 2024

zhangyanzhao commented Jan 12, 2024

zhangyanzhao commented Jan 12, 2024

		@@ -175,14 +167,11 @@ This modified file can then be uploaded to the device to /etc/evprofile/.
		Operator can select any of these custom event profiles to change default properties of events.

Event/alarm framework HLD update. Integrate with event producer framework. #1409

Event/alarm framework HLD update. Integrate with event producer framework. #1409

Conversation

bhaveshdell commented Jun 30, 2023 • edited

bhaveshdell commented Jul 19, 2023

bhaveshdell commented Aug 17, 2023

bhaveshdell commented Aug 17, 2023

jeff-yin Aug 28, 2023

Choose a reason for hiding this comment

jeff-yin Sep 26, 2023

Choose a reason for hiding this comment

jeff-yin commented Sep 7, 2023

adyeung commented Sep 28, 2023

kwangsuk Sep 28, 2023 • edited

Choose a reason for hiding this comment

zhangyanzhao commented Oct 12, 2023

zhangyanzhao commented Oct 12, 2023

jeff-yin commented Oct 18, 2023 • edited

shyam77git Nov 1, 2023

Choose a reason for hiding this comment

shyam77git Nov 3, 2023

Choose a reason for hiding this comment

bhaveshdell Nov 8, 2023

Choose a reason for hiding this comment

zhangyanzhao commented Nov 8, 2023

zhangyanzhao commented Dec 11, 2023

stephenxs commented Dec 14, 2023

venkatmahalingam commented Dec 14, 2023

shyam77git commented Dec 14, 2023

shyam77git commented Jan 10, 2024

zhangyanzhao commented Jan 12, 2024

zhangyanzhao commented Jan 12, 2024

bhaveshdell commented Jun 30, 2023 •

edited

kwangsuk Sep 28, 2023 •

edited

jeff-yin commented Oct 18, 2023 •

edited