starlingx/fault
Code Issues Proposed changes

Extend events.yaml schema with usage context field

Browse Source 
The events.yaml file contains every alarm and log used by platform and
openstack. There is no way to know which one relates to one or
the other.
In order to know that, it is required an additional field as part of
each record to differential between platform and openstack.

Story: 2010143
Task: 46723

Test plan
PASS: Build the fm-api and fm-doc packages.
      Install fm-api first and then fm-doc.
      No errors are found during build and installation process.

Signed-off-by: Agustin Carranza <agustin.carranza@windriver.com>
Change-Id: I8598afc77d27d107c4f9a108dd46b2ebc79b30a1
This commit is contained in:
Agustin Carranza 2022-11-03 14:29:21 -03:00
parent 8596fc8fc5
commit d161fe5922
3 changed files with 497 additions and 116 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
fm-api/source/fm_api/constants.py
View File

@ -1,5 +1,5 @@
#
# Copyright (c) 2013-2017 Wind River Systems, Inc.
# Copyright (c) 2013-2022 Wind River Systems, Inc.
#
# SPDX-License-Identifier: Apache-2.0
#
@ -402,6 +402,9 @@ FM_ALARM_STATE_CLEAR = 'clear'
FM_ALARM_STATE_MSG = 'msg'
FM_ALARM_STATE_LOG = 'log'
FM_ALARM_CONTEXT_STARLINGX = 'starlingx'
FM_ALARM_CONTEXT_OPENSTACK = 'openstack'
FM_ALARM_TYPE_0 = 'other'
FM_ALARM_TYPE_1 = 'communication'
FM_ALARM_TYPE_2 = 'qos'
@ -521,6 +524,8 @@ ALARM_SEVERITY = [FM_ALARM_SEVERITY_CLEAR, FM_ALARM_SEVERITY_WARNING,
ALARM_STATUS = [FM_ALARM_OK_STATUS, FM_ALARM_DEGRADED_STATUS,
FM_ALARM_CRITICAL_STATUS]
ALARM_CONTEXT = [FM_ALARM_CONTEXT_STARLINGX, FM_ALARM_CONTEXT_OPENSTACK]
ALARM_PROBABLE_CAUSE = [ALARM_PROBABLE_CAUSE_1, ALARM_PROBABLE_CAUSE_2,
ALARM_PROBABLE_CAUSE_3, ALARM_PROBABLE_CAUSE_4,
ALARM_PROBABLE_CAUSE_5, ALARM_PROBABLE_CAUSE_6,

594
fm-doc/fm_doc/events.yaml
View File

File diff suppressed because it is too large Load Diff

12
fm-doc/fm_doc/parseEventYaml.py
View File

@ -1,5 +1,5 @@
#
# Copyright (c) 2016 Wind River Systems, Inc.
# Copyright (c) 2016-2022 Wind River Systems, Inc.
#
# SPDX-License-Identifier: Apache-2.0
#
@ -29,6 +29,7 @@ import constants
# Suppression: True
# Management_Affecting_Severity: warning
# Degrade_Affecting_Severity: none
# Context: starlingx
#
type_FieldName = 'Type'
@ -71,6 +72,9 @@ managementAffectingSeverity_FieldValues = constants.ALARM_SEVERITY.append('none'
degradeAffecting_FieldName = 'Degrade_Affecting_Severity'
degradeAffecting_FieldValues = constants.ALARM_SEVERITY.append('none')
context_FieldName = 'Context'
context_FieldValues = constants.ALARM_CONTEXT
alarmFields = {
type_FieldName: type_FieldValues,
description_FieldName: description_FieldValues,
@ -84,7 +88,8 @@ alarmFields = {
serviceAffecting_FieldName: serviceAffecting_FieldValues,
suppression_FieldName: suppression_FieldValues,
managementAffectingSeverity_FieldName: managementAffectingSeverity_FieldValues,
degradeAffecting_FieldName: degradeAffecting_FieldValues
degradeAffecting_FieldName: degradeAffecting_FieldValues,
context_FieldName: context_FieldValues
}
logFields = {
@ -94,7 +99,8 @@ logFields = {
severity_FieldName: severity_FieldValues,
alarmType_FieldName: alarmType_FieldValues,
probableCause_FieldName: probableCause_FieldValues,
serviceAffecting_FieldName: serviceAffecting_FieldValues
serviceAffecting_FieldName: serviceAffecting_FieldValues,
context_FieldName: context_FieldValues
}