SNMP:: TRAM MIB does have UUID in its field, and does not match with document

[Takamasa Takenaka]

Brief Description
-----------------
The document "SNMP Active Alarms Table" says,
https://docs.starlingx.io/fault-mgmt/kubernetes/snmp-active-alarm-table.html

"The active alarm table contains a list of all active or set alarms in the system.
Each entry in the table includes the following variables:"

But when SNMP trap is received. it does not container "UUID" and "ReasonText"
in it. To parse Alarm Event, UUID need to each trap to identify further
operation.

For example, run "system modify --contact test_admin".
It will send Major alarm trap then Clear alarm trap.

In /var/log/fm-manager.log, we found there is no UUID (ReasonText is set properly)
-----------
2022-05-03T15:49:11.743 fmSnmpUtils.cpp(329): SNMP trap metadata sent succesfully {
   "operation_type": "wrsAlarmMajor",
   "alarm": {
     "wrsAlarmActiveUuid": "f45b7fb8-4681-4b42-acc4-b8c391c3bfb6",
     "wrsAlarmActiveAlarmId": "250.001",
     "wrsAlarmActiveEntityInstanceId": "region=RegionOne.system=vbox.host=controller-0",
     "wrsAlarmActiveDateAndTime": "2022-05-03,15:49:11.0,+0:0",
     "wrsAlarmActiveAlarmSeverity": "3",
     "wrsAlarmActiveReasonText": "controller-0 Configuration is out-of-date. (applied: 0b3e71db-62e7-4277-9127-841e0e0422f7 target: 2995b0fe-5106-44a9-8b41-e515f031bb4d)",
     "wrsAlarmActiveEventType": "7",
     "wrsAlarmActiveProbableCause": "0",
     "wrsAlarmActiveProposedRepairAction": "Lock and unlock host controller-0 to update config.",
     "wrsAlarmActiveServiceAffecting": "1",
     "wrsAlarmActiveSuppressionAllowed": "0"
   }
 } 800
----------

In snmptapd log, we found there is no UUID nor ReasonText;
UUID: oid=iso.3.6.1.4.1.731.1.1.1.1.1.1.2.0
ReasonText: oid=iso.3.6.1.4.1.731.1.1.1.1.1.1.7.0
Both data are missing but DateAndTime(iso.3.6.1.4.1.731.1.1.1.1.1.1.5.0)
is duplicated (and one of them contains value of ReasonText)
----------
2022-05-04 16:59:54 <UNKNOWN> [UDP: [192.168.88.97]:45197->[192.168.88.97]:162]:
iso.3.6.1.2.1.1.3.0 = Timeticks: (18968) 0:03:09.68
iso.3.6.1.6.3.1.1.4.1.0 = OID:
iso.3.6.1.4.1.731.1.1.1.1.0.2
iso.3.6.1.4.1.731.1.1.1.1.1.1.3.0 = STRING: "250.001"
iso.3.6.1.4.1.731.1.1.1.1.1.1.4.0 = STRING: "region=RegionOne.system=vbox.host=controller-0"
iso.3.6.1.4.1.731.1.1.1.1.1.1.5.0 = STRING: "2022-05-03,15:49:11.0,+0:0"
iso.3.6.1.4.1.731.1.1.1.1.1.1.6.0 = INTEGER: 3
iso.3.6.1.4.1.731.1.1.1.1.1.1.5.0 = STRING: "controller-0 Configuration is out-of-date. (applied: 0b3e71db-62e7-4277-9127-841e0e0422f7 target: 2995b0fe-5106-44a9-8b41-e515f031bb4d)"
iso.3.6.1.4.1.731.1.1.1.1.1.1.8.0 = INTEGER: 7
iso.3.6.1.4.1.731.1.1.1.1.1.1.9.0 = INTEGER: 0
iso.3.6.1.4.1.731.1.1.1.1.1.1.10.0 = STRING: "Lock and unlock host controller-0 to update config."
iso.3.6.1.4.1.731.1.1.1.1.1.1.11.0 = INTEGER: 1
iso.3.6.1.4.1.731.1.1.1.1.1.1.12.0 = INTEGER: 0
----------

Severity
--------
Major: System/Feature is usable but degraded

Steps to Reproduce
------------------
1. Enable SNMP trap followed by document,
https://docs.starlingx.io/fault-mgmt/kubernetes/enabling-snmp-support.html#enabling-snmp-support
2. Run snmptrapd or any system which can receive SNMP trap.
3. Cause alarm and sent trap. (Run "system modify --contact test_admin")
4. Observe received SNMP trap.

Expected Behavior
------------------
SNMP trap includes the UUID and ReasonText.

Actual Behavior
----------------
UUID and ReasonText are missing. Especially UUID is required
to identify each alarm message, so it should be included.

Reproducibility
---------------
100%

System Configuration
--------------------
Found in System controller, Sub cloud with AIO-DX
But controller in any type would have the same issue
when SNMP app is applied.

Branch/Pull Time/Commit
-----------------------
N/A

Last Pass
---------
N/A

Timestamp/Logs
--------------
N/A

Test Activity
-------------
N/A

Workaround
----------
No workaround.

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.opendev.org/c/starlingx/fault/+/840535

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.opendev.org/c/starlingx/snmp-armada-app/+/840536

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/starlingx/fault/+/840535
Committed: https://opendev.org/starlingx/fault/commit/ad1d95fdf5a76b4ca38055a5a46960e76e94b63f
Submitter: "Zuul (22348)"
Branch: master

commit ad1d95fdf5a76b4ca38055a5a46960e76e94b63f
Author: Takamasa Takenaka <email address hidden>
Date: Wed May 4 17:16:42 2022 -0300

    Add UUID in SNMP trap

    FM sends alarm information for SNMP trap but it is lacking
    Alarm UUID, which needs to identify the alarm.
    This fix is adding uuid for all type of trap information.

    Closes-bug: 1971626

    TEST PLAN:
    PASS: Confirm UUID is included in trap information
          in log /var/log/fm-manager.log.
          [Trap type]
          - wrsAlarmCritical
          - wrsAlarmMajor
          - wrsAlarmMinor
          - wrsAlarmWarning
          - wrsAlarmMessage
          - wrsAlarmClear
          - wrsAlarmHierarchicalClear

    Signed-off-by: Takamasa Takenaka <email address hidden>
    Change-Id: I3e2b7e4a6a07876ff08e6a13d46d50285465a6b2

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/starlingx/snmp-armada-app/+/840536
Committed: https://opendev.org/starlingx/snmp-armada-app/commit/a52305a17f6a09b45a0b4b14886790a1fb0c188a
Submitter: "Zuul (22348)"
Branch: master

commit a52305a17f6a09b45a0b4b14886790a1fb0c188a
Author: Takamasa Takenaka <email address hidden>
Date: Wed May 4 17:28:37 2022 -0300

    Add UUID and ReasonText in SNMP trap

    Trap subagent send traps based on the alarm trap information
    from FM. But SNMP trap did not include UUID and ReasonText.

    This fix is adding UUID and ReasonText in all types of SNMP trap.

    Closes-bug: 1971626

    TEST PLAN:
    PASS: Confirm UUID and ReasonText are included in SNMP trap.
          [Trap type]
          - wrsAlarmCritical
          - wrsAlarmMajor
          - wrsAlarmMinor
          - wrsAlarmWarning
          - wrsAlarmMessage
          - wrsAlarmClear
          - wrsAlarmHierarchicalClear

    Depends-On: https://review.opendev.org/c/starlingx/fault/+/840535/
    Signed-off-by: Takamasa Takenaka <email address hidden>
    Change-Id: I5c03562a84ae2e4f7ed17e5dd70dcad4c33a4841

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.opendev.org/c/starlingx/root/+/841263

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.opendev.org/c/starlingx/snmp-armada-app/+/841267

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/starlingx/root/+/841263
Committed: https://opendev.org/starlingx/root/commit/d84c83411ac466ad6e0392478e045553a289d1ef
Submitter: "Zuul (22348)"
Branch: master

commit d84c83411ac466ad6e0392478e045553a289d1ef
Author: Takamasa Takenaka <email address hidden>
Date: Tue May 10 09:41:40 2022 -0300

    Update tag for stx-fm-trap-subagent to stx.7.0-v1.0.3

    Update yaml file with a new tag for stx-fm-trap-subagent, due to
    a new fix to add uuid and reason text in snmp trap.

    Closes-bug: 1971626

    Signed-off-by: Takamasa Takenaka <email address hidden>
    Change-Id: Id566d55c20afb2d95121495b0cef67a53e179dc5

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/starlingx/snmp-armada-app/+/841267
Committed: https://opendev.org/starlingx/snmp-armada-app/commit/32a32d301ed365d5bc78de00bca58a6f254c8f20
Submitter: "Zuul (22348)"
Branch: master

commit 32a32d301ed365d5bc78de00bca58a6f254c8f20
Author: Takamasa Takenaka <email address hidden>
Date: Tue May 10 10:27:18 2022 -0300

    Update tag for stx-fm-trap-subagent to stx.7.0-v1.0.3

    Update yaml file with a new tag for stx-fm-trap-subagent, due to
    a new fix to add uuid and reason text in snmp trap.

    Closes-bug: 1971626

    TEST PLAN:
    PASS Helm charts in armada tar includes tag stx.7.0-v1.0.3
         in values.yaml for trap subagent
    PASS When snmp app is applied, stx-fm-trap-subagent:
         stx.7.0-v1.0.3 is downloaded and running.

    Signed-off-by: Takamasa Takenaka <email address hidden>
    Change-Id: Ia29091b4534c851c09b24343db7f6e8ac5ef1f63