starlingx/docs
Code Issues Proposed changes
47040fa69b
docs/doc/source/fault-mgmt/kubernetes/fault-management-overview.rst
Ron Stone c3444e384d Implement alarm parsing 
Configure tox+content to fetch event and convert alarms and logs
to rst for use in build.
Handle non-existant tmp dir in zuul builds
Add static events.yaml for CI/CD testingx
Generalize label construction to prevent namespace conflicts
Consume events directly from fm repo (required changes merged)
Update logs template for legibility.
Add clean up for temporary rst files.
Point parser at dynamically downloaded events file
Restore logs template

Note: This review deletes static alarm and log files
Note: This review excludes alarm files from git as they are now
      build-time temp files.
Note: This review uses a static copy of events.yaml to pass tox
      until the dep. below is met. It will need reconfiguration
      at that time.

Depends-On: https://review.opendev.org/c/starlingx/fault/+/863574

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I0bb8d0a77b9d3cf22b33f8930c569b3e70b7291c
2022-11-18 11:34:27 -05:00

2.7 KiB
Raw Blame History

Fault Management Overview

An admin user can view fault management alarms and logs in order to monitor and respond to fault conditions.

See Alarm Messages <100-series-alarm-messages-starlingx> for the list of alarms and Customer Log Messages <200-series-log-messages-starlingx> for the list of customer logs reported by .

You can access active and historical alarms, and customer logs using the CLI, GUI, REST APIs and .

To use the CLI, see Viewing Active Alarms Using the CLI <viewing-active-alarms-using-the-cli> and Viewing the Event Log Using the CLI <viewing-the-event-log-using-the-cli>.

Using the GUI, you can obtain fault management information in a number of places.

  • The Fault Management pages, available from Admin > Fault Management in the left-hand pane, provide access to the following:

    • The Global Alarm Banner in the page header of all screens provides the active alarm counts for all alarm severities, see The Global Alarm Banner <the-global-alarm-banner>.

    • Admin > Fault Management > Active Alarms—Alarms that are currently set, and require user action to clear them. For more information about active alarms, see Viewing Active Alarms Using the CLI <viewing-active-alarms-using-the-cli> and Deleting an Alarm Using the CLI <deleting-an-alarm-using-the-cli>.

    • Admin > Fault Management > Events—The event log consolidates historical alarms that have occurred in the past, that is, both set and clear events of active alarms, as well as customer logs.

      For more about the event log, which includes historical alarms and customer logs, see Viewing the Event Log Using Horizon <viewing-the-event-log-using-horizon>.

    • Admin > Fault Management > Events Suppression—Individual events can be put into a suppressed state or an unsuppressed state. A suppressed alarm is excluded from the Active Alarm and Events displays. All alarms are unsuppressed by default. An event can be suppressed or unsuppressed using the Horizon Web interface, the CLI, or REST APIs.

  • The Data Network Topology view provides real-time alarm information for data networks and associated worker hosts and data/pci-passthru/pci-sriov interfaces.

To use SNMP, see SNMP Overview <snmp-overview>.