Skip to content

[yang] Support ASIC/SDK health event #17879

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
May 7, 2024
Merged

[yang] Support ASIC/SDK health event #17879

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
00ea737
Support ASIC/SDK health event
stephenxs Nov 30, 2023
67143d5
Minor changes
stephenxs Dec 8, 2023
90c18de
Update documentation
stephenxs Dec 12, 2023
9d5406d
Address community review comments
stephenxs Jan 11, 2024
6f6984c
Update sonic-suppress-asic-sdk-health-event.yang
stephenxs Apr 17, 2024
5bc6b43
Update the sample config_db.json
stephenxs Apr 17, 2024
ebeb0ba
Fix error in sampe config_db.json
stephenxs Apr 18, 2024
d6565e2
Fix compiling issue
stephenxs Apr 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions src/sonic-yang-models/doc/Configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Table of Contents

* [ACL and Mirroring](#acl-and-mirroring)
* [BGP BBR](#bgp-bbr)
* [ASIC SDK health event](#asic-sdk-health-event)
* [BGP Device Global](#bgp-device-global)
* [BGP Sessions](#bgp-sessions)
* [BUFFER_PG](#buffer_pg)
Expand Down Expand Up @@ -382,6 +383,27 @@ The **BGP_BBR** table contains device-level BBR state.
}
}
```
### ASIC SDK health event

ASIC/SDK health event related configuration is defined in **SUPPRESS_ASIC_SDK_HEALTH_EVENT** table.

```
"SUPPRESS_ASIC_SDK_HEALTH_EVENT": {
"notice": {
"categories": [
"asic_hw"
],
"max_events": "1000"
},
"warning": {
"categories": [
"software",
"cpu_hw"
]
}
}
```

### BGP Device Global

The **BGP_DEVICE_GLOBAL** table contains device-level BGP global state.
Expand Down
14 changes: 14 additions & 0 deletions src/sonic-yang-models/tests/yang_model_tests/tests/sonic-events-swss.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,5 +89,19 @@
},
"SONIC_EVENTS_SWSS_SELECT_OPERATION_FAILURE_VALID": {
"desc": "VALID SELECT_OPERATION_FAILURE EVENT."
},
"SONIC_EVENTS_SWSS_ASIC_SDK_HEALTH_VALID": {
"desc": "VALID ASIC_SDK_HEALTH EVENT."
},
"SONIC_EVENTS_SWSS_ASIC_SDK_HEALTH_VALID_MASIC": {
"desc": "VALID ASIC_SDK_HEALTH EVENT."
},
"SONIC_EVENTS_SWSS_ASIC_SDK_HEALTH_INVALID_SEVERITY": {
"desc": "ASIC_SDK_HEALTH_INVALID_SEVERITY failure.",
"eStrKey": "InvalidValue"
},
"SONIC_EVENTS_SWSS_ASIC_SDK_HEALTH_INVALID_CATEGORY": {
"desc": "ASIC_SDK_HEALTH_INVALID_CATEGORY failure.",
"eStrKey": "InvalidValue"
}
}
23 changes: 23 additions & 0 deletions src/sonic-yang-models/tests/yang_model_tests/tests/suppress_asic_sdk_health_event.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"SUPPRESS_ASIC_SDK_HEALTH_EVENT_LIST_VALID_FATAL": {
"desc": "Load suppress ASIC/SDK health event list for fatal."
},
"SUPPRESS_ASIC_SDK_HEALTH_EVENT_LIST_VALID_WARNING": {
"desc": "Load suppress ASIC/SDK health event list for warning."
},
"SUPPRESS_ASIC_SDK_HEALTH_EVENT_LIST_VALID_NOTICE": {
"desc": "Load suppress ASIC/SDK health event list for notice."
},
"SUPPRESS_ASIC_SDK_HEALTH_EVENT_LIST_INVALID_SEVERITY": {
"desc": "Load suppress ASIC/SDK health event list for notice.",
"eStrKey": "InvalidValue"
},
"SUPPRESS_ASIC_SDK_HEALTH_EVENT_LIST_NEGATIVE_MAX_EVENTS": {
"desc": "Load suppress ASIC/SDK health event list missing name.",
"eStrKey": "InvalidValue"
},
"SUPPRESS_ASIC_SDK_HEALTH_EVENT_LIST_INVALID_MAX_EVENTS": {
"desc": "Load suppress ASIC/SDK health event list missing name.",
"eStrKey": "InvalidValue"
}
}
45 changes: 44 additions & 1 deletion src/sonic-yang-models/tests/yang_model_tests/tests_config/sonic-events-swss.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,13 +232,56 @@
}
}
},
"SONIC_EVENTS_SWSS_SELECT_OPERATION_FAILURE_VALID": {
"SONIC_EVENTS_SWSS_SELECT_OPERATION_FAILURE_VALID": {
"sonic-events-swss:sonic-events-swss": {
"sonic-events-swss:select-operation-failure": {
"operation_result": "operation_result",
"command": "command",
"timestamp": "1985-04-12T23:20:50.52Z"
}
}
},
"SONIC_EVENTS_SWSS_ASIC_SDK_HEALTH_VALID": {
"sonic-events-swss:sonic-events-swss": {
"sonic-events-swss:asic-sdk-health-event": {
"severity": "fatal",
"category": "asic_hw",
"description": "\ndescription\n",
"timestamp": "1985-04-12T23:20:50.52Z",
"sai_timestamp": "1985-04-12 23:20:50"
}
}
},
"SONIC_EVENTS_SWSS_ASIC_SDK_HEALTH_VALID_MASIC": {
"sonic-events-swss:sonic-events-swss": {
"sonic-events-swss:asic-sdk-health-event": {
"severity": "fatal",
"category": "asic_hw",
"asic_name": "asic0",
"description": "\ndescription\n",
"timestamp": "1985-04-12T23:20:50.52Z",
"sai_timestamp": "1985-04-12 23:20:50"
}
}
},
"SONIC_EVENTS_SWSS_ASIC_SDK_HEALTH_INVALID_SEVERITY": {
"sonic-events-swss:sonic-events-swss": {
"sonic-events-swss:asic-sdk-health-event": {
"severity": "unknown",
"category": "asic_hw",
"description": "\ndescription\n",
"timestamp": "1985-04-12T23:20:50.52Z"
}
}
},
"SONIC_EVENTS_SWSS_ASIC_SDK_HEALTH_INVALID_CATEGORY": {
"sonic-events-swss:sonic-events-swss": {
"sonic-events-swss:asic-sdk-health-event": {
"severity": "fatal",
"category": "unknown",
"description": "\ndescription\n",
"timestamp": "1985-04-12T23:20:50.52Z"
}
}
}
}
93 changes: 93 additions & 0 deletions ...sonic-yang-models/tests/yang_model_tests/tests_config/suppress_asic_sdk_health_event.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
{
"SUPPRESS_ASIC_SDK_HEALTH_EVENT_LIST_VALID_FATAL": {
"sonic-suppress-asic-sdk-health-event:sonic-suppress-asic-sdk-health-event": {
"sonic-suppress-asic-sdk-health-event:SUPPRESS_ASIC_SDK_HEALTH_EVENT": {
"SUPPRESS_ASIC_SDK_HEALTH_EVENT_LIST": [
{
"severity": "fatal",
"categories": ["software","firmware"]
}
]
}
}
},

"SUPPRESS_ASIC_SDK_HEALTH_EVENT_LIST_VALID_WARNING": {
"sonic-suppress-asic-sdk-health-event:sonic-suppress-asic-sdk-health-event": {
"sonic-suppress-asic-sdk-health-event:SUPPRESS_ASIC_SDK_HEALTH_EVENT": {
"SUPPRESS_ASIC_SDK_HEALTH_EVENT_LIST": [
{
"severity": "warning",
"categories": ["asic_hw","cpu_hw"]
}
]
}
}
},

"SUPPRESS_ASIC_SDK_HEALTH_EVENT_LIST_VALID_NOTICE": {
"sonic-suppress-asic-sdk-health-event:sonic-suppress-asic-sdk-health-event": {
"sonic-suppress-asic-sdk-health-event:SUPPRESS_ASIC_SDK_HEALTH_EVENT": {
"SUPPRESS_ASIC_SDK_HEALTH_EVENT_LIST": [
{
"severity": "notice",
"categories": ["software","firmware","cpu_hw","asic_hw"],
"max_events": "100"
}
]
}
}
},

"SUPPRESS_ASIC_SDK_HEALTH_EVENT_LIST_INVALID_SEVERITY": {
"sonic-suppress-asic-sdk-health-event:sonic-suppress-asic-sdk-health-event": {
"sonic-suppress-asic-sdk-health-event:SUPPRESS_ASIC_SDK_HEALTH_EVENT": {
"SUPPRESS_ASIC_SDK_HEALTH_EVENT_LIST": [
{
"severity": "unknown",
"categories": ["software","firmware","cpu_hw","asic_hw"]
}
]
}
}
},

"SUPPRESS_ASIC_SDK_HEALTH_EVENT_LIST_INVALID_CATEGORY": {
"sonic-suppress-asic-sdk-health-event:sonic-suppress-asic-sdk-health-event": {
"sonic-suppress-asic-sdk-health-event:SUPPRESS_ASIC_SDK_HEALTH_EVENT": {
"SUPPRESS_ASIC_SDK_HEALTH_EVENT_LIST": [
{
"severity": "notice",
"categories": ["software","unknown","cpu_hw","asic_hw"]
}
]
}
}
},

"SUPPRESS_ASIC_SDK_HEALTH_EVENT_LIST_NEGATIVE_MAX_EVENTS": {
"sonic-suppress-asic-sdk-health-event:sonic-suppress-asic-sdk-health-event": {
"sonic-suppress-asic-sdk-health-event:SUPPRESS_ASIC_SDK_HEALTH_EVENT": {
"SUPPRESS_ASIC_SDK_HEALTH_EVENT_LIST": [
{
"severity": "notice",
"max_events": "-1"
}
]
}
}
},

"SUPPRESS_ASIC_SDK_HEALTH_EVENT_LIST_INVALID_MAX_EVENTS": {
"sonic-suppress-asic-sdk-health-event:sonic-suppress-asic-sdk-health-event": {
"sonic-suppress-asic-sdk-health-event:SUPPRESS_ASIC_SDK_HEALTH_EVENT": {
"SUPPRESS_ASIC_SDK_HEALTH_EVENT_LIST": [
{
"severity": "notice",
"max_events": "NaN"
}
]
}
}
}
}
36 changes: 36 additions & 0 deletions src/sonic-yang-models/yang-models/sonic-events-swss.yang
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,5 +148,41 @@ module sonic-events-swss {

uses evtcmn:sonic-events-cmn;
}

container asic-sdk-health-event {
evtcmn:ALARM_SEVERITY_MAJOR;
description
"Declares an event for ASIC/SDK health event.";
leaf asic_name {
type string {
pattern 'asic[0-9]{1,2}';
}
}
leaf severity {
type enumeration {
enum fatal;
enum warning;
enum notice;
}
}
leaf category {
type enumeration {
enum software;
enum firmware;
enum cpu_hw;
enum asic_hw;
}
}
leaf description {
type string;
}
leaf sai_timestamp {
type string {
pattern '[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}';
}
}

uses evtcmn:sonic-events-cmn;
}
}
}
58 changes: 58 additions & 0 deletions src/sonic-yang-models/yang-models/sonic-suppress-asic-sdk-health-event.yang
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
module sonic-suppress-asic-sdk-health-event {

yang-version 1.1;

namespace "http://github.com/sonic-net/sonic-suppress-asic-sdk-health-event";

prefix sch;

organization
"SONiC";

contact
"SONiC";

description
"Suppress ASIC/SDK health event yang Module for SONiC OS";

revision 2023-11-29 {
description
"Initial revision";
}

container sonic-suppress-asic-sdk-health-event {

container SUPPRESS_ASIC_SDK_HEALTH_EVENT {

description "SUPPRESS_ASIC_SDK_HEALTH_EVENT part of config_db.json";

list SUPPRESS_ASIC_SDK_HEALTH_EVENT_LIST {

key "severity";

leaf severity {
type enumeration {
enum fatal;
enum warning;
enum notice;
}
description "Severity of the ASIC/SDK health event to suppress";
}

leaf max_events {
type uint32;
}

leaf-list categories {
type enumeration {
enum software;
enum firmware;
enum cpu_hw;
enum asic_hw;
}
description "Category of the ASIC/SDK health event to suppress";
}
}
}
}
}