docs/fault.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. SPDX-License-Identifier: CC-BY-4.0
   3 .. Copyright (C) 2020 highstreet technologies and others
   4
   5 .. contents::
   6    :depth: 3
   7 ..
   8
   9 Fault Management
  10 ================
  11
  12 To operate a network, it is important to get an overview about the
  13 currently raised alarms. The application offers basic fault management
  14 of devices supporting ONF-TR-532. The alarms are classified according to
  15 the severity level (warning, minor, major, critical).
  16
  17 Views
  18 -----
  19
  20 The graphical user interface is separated into three views.
  21
  22 Current Problem List
  23 ~~~~~~~~~~~~~~~~~~~~
  24
  25 Lists all current active faults in the network. In addition, it also
  26 lists alarms sent by the SDN controller itself, which detects connection
  27 losses to the NetConf server (connectionLossOAM) or to a device via a
  28 mediator to a device (connectionLossNeOAM).
  29
  30 Alarm Notifications
  31 ~~~~~~~~~~~~~~~~~~~
  32
  33 As long as the view is open, all alarm notifications received by the SDN
  34 Controller are listed. Please note that refreshing the view will start
  35 the collection again. Previous alarm notification can be viewed in the
  36 alarm log.
  37
  38 Alarm Log
  39 ~~~~~~~~~
  40
  41 Next to the current active alarms an alarm log lists all alarm
  42 notifications of the past.
  43
  44 Implementation
  45 --------------
  46
  47 The application has two parts. While the server is listening for NetConf
  48 notifications to store them in the database, the client retrieves the
  49 information from the database and displays them in a table.
  50
  51 The server synchronizes with the current alarm lists of the devices.
  52 Based on raised and cleared notifications, the current alarm status of
  53 the network is calculated. The current alarms are stored in a database.
  54 In addition, all Problem Notifications received by the SDN controller
  55 are stored. There is no logic implemented on the client side.
  56
  57 An alarm status bar in the header of the web application informs the
  58 operator about the health status of the network.
  59
  60 The ODLUX web application uses web sockets to update the graphical user
  61 interface of the Alarm Notifications (devices) and Connection Status
  62 Notifications in real-time.