docs/doc/source/fault-mgmt/kubernetes/traps.rst
Ron Stone f125a8b892 Remove spurious escapes (r8,dsR8)
This change addresses a long-standing issue in rST documentation imported from XML.
That import process added backslash escapes in front of various characters. The three
most common being '(', ')', and '_'.
These instances are removed.

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: Id43a9337ffcd505ccbdf072d7b29afdb5d2c997e
2023-03-01 11:19:04 +00:00

1.8 KiB

Traps

supports SNMP (Simple Network Management Protocol) traps. Traps send unsolicited information to monitoring software when significant events occur.

The following traps are defined.

  • wrsAlarmCritical
  • wrsAlarmMajor
  • wrsAlarmMinor
  • wrsAlarmWarning
  • wrsAlarmMessage
  • wrsAlarmClear
  • wrsAlarmHierarchicalClear

alarms are mapped into one of the above traps based on severity, and customer logs are mapped into the 'Message' trap.

Note

uses Wind River Systems (wrs) Enterprise Registration and Alarm MIBs. See SNMP Overview <snmp-overview> for details.

For Critical, Major, Minor, Warning, and Message traps, all variables in the active alarm table are included as varbinds (variable bindings), where each varbind is a pair of fields consisting of an object identifier and a value for the object.

For the Clear trap, varbinds include only the following variables:

  • wrsAlarmActiveAlarmID
  • wrsAlarmActiveEntityInstanceID
  • wrsAlarmActiveDateAndTime
  • wrsAlarmActiveReasonText

For the HierarchicalClear trap, varbinds include only the following variables:

  • wrsAlarmActiveEntityInstanceID
  • wrsAlarmActiveDateAndTime
  • wrsAlarmActiveReasonText

For all alarms, the Notification Type is based on the severity of the trap or alarm. This is done to facilitate the interaction with most SNMP trap viewers which use the Notification Type to drive the coloring of traps, that is, red for critical, yellow for minor, and so on.

See https://opendev.org/starlingx/snmp-armada-app/src/branch/master/stx-snmp-helm/docker/stx-snmp/mibs/wrsAlarmMib.mib.txt for alarm details.