Commit 62f9c378 authored by Grzegorz Daniluk's avatar Grzegorz Daniluk

documents/wrs_failures: adding notes on MIB organization for General and Expert status

parent 91a51bea
\section{SNMP exports}
\section{SNMP exports (WIP)}
\subsection{Operator/basic objects (WIP)}
\subsection{Operator/basic objects}
Objects providing basic status of the WR Switch. It should be used by control
system operators and people without deep knowledge of the White Rabbit
internals. These values report the general status of the device and high level
\noindent \rule{\textwidth}{2pt}
{\bf Note}: Basically I think we should have another process monitoring various
stuff according to possible faults that may occur. This process should then be
used to report high-level information i.e. if this OK, is that OK, etc. At least
for more complex stuff, e.g. we can simply export temperature or CPU load and
let NMS to decide when it's bad.\\
\noindent \rule{\textwidth}{2pt}
{\bf Note}: We will need to change the SNMP code. There should be something like
a loop reading all information periodically (e.g. every 5s) from various SHM
areas (HAL, PPSi, SPLL), caching and calculating general status information.
This way, when we receive SNMP request we can feed the information from our
local SNMP cache. The same code could be later used to generate SNMP Traps.\\
\item [] \texttt{WR-SWITCH-MIB::status}\\ - general status word for WR Switch.
It is split into several 2-bit fields. Each of them describes one
function of the WR Switch and can be:
\item [] {\bf "00"} - Status OK
\item [] {\bf "01"} - Status Warning
\item [] {\bf "10"} - Status Failure
bits & description\\
\hline \hline
1:0 & PTP status\\
3:2 & SoftPLL status - OK if locked and aligned\\
5:4 & Switching status\\
7:6 & System status\\
& Redundancy status\\
\noindent {\bf General Status}:
\item WRS general status - OK / Warning / Error
\item Timing Status
\item Networking Status
\item System Statue
\item Detailed status
\item Timing
\item PTP (TRACK\_PHASE, offset, RTT, fixed deltas, deamon crash,
\item SoftPLL (DelCnt = 0; mode, SeqState, AlignState)
\item Slave link down
\item PTP frames flowing ?
\item (placeholder for Switchover)
\item (placeholder for Holdover)
\item Networking
\item (placeholder for Link down)
\item SFPs (portSfpError.<x> ?)
\item Endpoint status (2.2.2)
\item Swcore status (2.2.3, 2.2.5)
\item RTU status (2.2.4, 2.2.7)
\item (placeholder for TRU)
\item (placeholder for switchover or backup link state)
\item System
\item Boot ok
\item Free memory too low
\item Temperature
\item CPU load too high
\item Disk space too low (?)
\item Version (rewrite existing)
\item last date/time when firmware was updated\\
(save current time on restart, when new firmware is in /update so that it can be exported with SNMP)
\item contact info
\item build by
\item build date
\item hash, HW, SW,
\item (check what exists and add missing)
\item [] \texttt{WR-SWITCH-MIB::ptpMode}\\
Synchronization mode: Grand Master / Free-running Master / Slave
\item [] \texttt{WR-SWITCH-MIB::spllState}\\
\item [] \texttt{WR-SWITCH-MIB::spllState.mode}: (Grand Master /
Free-running Master / Slave)
%\item [] \texttt{WR-SWITCH-MIB::spllState.locked}: is Helper/Main locked (true / false)
%\item [] \texttt{WR-SWITCH-MIB::spllState.aligned}: is it phase-aligned (true / false)
\item [] \texttt{WR-SWITCH-MIB::spllState.hover}: is in holdover (true /
\item [] \texttt{WR-SWITCH-MIB::spllState.sover}: is it switched-over to a
backup link (true / false)
\subsection{Expert/extended status}
Expert objects can be used by White Rabbit experts for the in-depth diagnosis of
the switch failures. These values are verbose and should not be used by
\item [] \texttt{WR-SWITCH-MIB::ptpClockOffsetPs}\\
Clock offset calculated by PTP/PPSi
\item Operation Status
\item CPU Load (\%)
\item current time
\item TAI
\item date string
\item Boot status
\item boot cnt
\item restart reason
\item boot status values\\
(1 object for each: hwinfo readout, FPGA, LM32, kernel modules, userspace daemons, config retreived ok)
\item config source (tftp, flash, as string?)
\item Temperature
\item temp 1..4
\item threshold 1..4
\item [] \texttt{WR-SWITCH-MIB::tempFPGA}\\ - SCB temperature below the FPGA
\item [] \texttt{WR-SWITCH-MIB::tempScbPsu.1}\\ - SCB temperature near the
power supply circuit
\item [] \texttt{WR-SWITCH-MIB::tempScbPsu.2}\\ - SCB temperature near the
power supply circuit
\item [] \texttt{WR-SWITCH-MIB::tempPLL}\\ - SCB temperature near the VCXO and
\item Restart Counters
\item HAL
\item PPSi
\item RTUd
\item (..)
\item SPLL
\item SoftPLL state
\item mode, irqcnt, seqstate, alignstate, Hlock, Mlock, Block[18], Err[18], HY, MY, delCnt, holdover, holdoverTime
\item spll version
\item spll build date
\item (...)
\item [] \texttt{WR-SWITCH-MIB::portLink.<n>}
\item Networking
\item VLAN table dump
\item RTU table dump (check if management sw uses snmpwalk)
\item SW core status
\item Free pages
\item Pstats (pivot table, some of the counters should be used to fill
standard MIBs)
\item PtpData (make it an array for later switch-over needs)
\item per instance/ which port
\item Ports status (per-port information)
\item portEnable (enable/disable port via ifconfig)
\item ptpTxFrames (per port or per instance, depending on implementation)
\item ptpRxFrames (per port or per instance, depending on implementation)
\item Configuration
\item PPS width
\item Uptime
\item Firmware version
\item Hardware version
\item Manufacturer
\item Serial number
\item How WRS was configured (manually / .config fetched from server/...)
\item Current WR time
\item Last date/time when firmware was upgraded
\item Contact info
\item Link failure detected, switched over to a backup link No. X
\item WRS has booted successfully, none of the steps has failed (reading HW
info, programming FPGA and LM32, loading kernel modules, starting daemons)
\subsection{Expert objects}
Expert objects can be used by White Rabbit experts for the in-depth diagnosis of
the switch failures. These values are verbose and should not be used by
\subsection{Expert objects (to be updated, was first draft}
{\bf Note:} we will put here MIB file dump later.
\subsubsection{PTP/WR parameters}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment