Skip to content

Commit 2691f76

Browse files
committed
few rewording of sentences
Signed-off-by: Srinadh Penugonda <[email protected]>
1 parent e294f65 commit 2691f76

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -61,11 +61,11 @@ Event and Alarm Framework
6161

6262
# About this Manual
6363
This document provides general information on the implementation and functionality of Event and Alarm Framework in SONiC.
64-
Wherever CLI is specified, it is the CLISH cli that is referred; SONiC native (CLICK) CLI is not updated.
64+
Wherever CLI is specified, it is the CLISH cli that is referred - SONiC native (CLICK) CLI is not updated for this feature.
6565

6666
# Scope
67-
This document describes the high-level design of Event and Alarm Framework feature.
68-
It is not in the scope of this feature to update ANY of the applications to raise events and alarms.
67+
This document describes the high-level design of Event and Alarm Framework.
68+
It is not in the scope of the framework to update ANY of the applications to raise events and alarms.
6969

7070
# 1 Feature Overview
7171

@@ -94,10 +94,10 @@ Such a change has an important metric called *severity* to indicate how critical
9494

9595
An application *raises* an alarm when it encounters a faulty condition by sending an event with action: *raise*.
9696
After the application recovers from the condition, that alarm is *cleared* by sending an event with action: *clear*.
97-
An operator could *acknowledge* an alarm. This indicates that the user is aware of the faulty condition.
97+
An operator could *acknowledge* an alarm. This indicates that the operator is aware of the faulty condition.
9898

99-
System LED can be deduced from the severities of alarms.
100-
An acknowledged alarm should be taken out of consideration from deciding system LED state.
99+
The set of alarms and their severities informs overall health of various applications of the system and System LED can be deduced from alarms.
100+
An acknowledged alarm means that operator is aware of the condition so, acknowledged alarm should be taken out of consideration from deciding system LED state.
101101

102102
Both events and alarms get recorded in the EVENT_DB.
103103

0 commit comments

Comments
 (0)