monitoring

Reference Documentation

product_line_custom
Intel® PAC
Napatech SmartNIC
category
Reference Information
Napatech Software Suite: monitoring

monitoring

The monitoring tool is an interactive tool used to monitor port statistics, sensors, color statistics, time synchronization, IEEE 1588 information and statistics, and stream statistics.

Syntax

monitoring [--help | -h]

Commands
Command Description
-h, --help Display the help text and exit

Overview

As a general rule the tool displays live information, which means that it depicts the current state information in the driver. Some information, such as the link load, reflects the current state while other information is based on statistical information from an extended time span, in some cases from the time when the driver started, and therefore reflects the history of the driver, but the value displayed by the tool is nevertheless current. In some places the tool provides a reset operation, which means that the information shown appears to be reset, but the reset is only in effect in the running instance of the tool and lasts until a new reset is carried out, or the tool stops. A reset does not affect the running driver or other running instances of the monitoring tool. The tool can sometimes calculate and display derived information based on information in the driver.

Note
For Time Synchronization statistics a reset is global and will affect the running driver or other running instances of the monitoring tool

The tool is divided into the following parts:

The tool uses various pages to display monitoring information. Each page contains a context-sensitive menu at the bottom of the screen. The first letter of a menu item is the key to type on the keyboard to carry out the command. The command's functionality is either to perform an action, such as resetting a counter, or to switch to a different page.

Some keys, such as the cursor up and down keys and the q key (that means quit), do not appear in the menu at the bottom but nevertheless work for all pages. Command keys are case-insensitive, so both lowercase q and uppercase Q mean quit.

Each page has a notion of an item that is currently selected. The tool usually displays the selected item in reverse colors, i.e., as white text on a black background. When performing an action, the action applies to that selected object although some actions apply to all items shown on the page.

Most pages are divided into multiple horizontally divided sections where the currently select object appears in the upper section and the section immediately below contains information that pertains to the selected object, while the third and lower section contains the page's context-sensitive menu. The two upper sections are also called views. For some pages, the Tab (tabulator) key moves the input focus for the cursor up and down between the two upper sections (views), in other words it shifts the area where the current object is chosen.

To illustrate a typical page consider the start-up of the tool. The tool initially displays the Port Statistics page, which contains three sections. The upper section displays the available ports, the middle section displays so-called RMON1 statistics, and the lower section is the page's menu that provides access to the Sensor Monitoring, Color Statistics, Time Synchronization, IEEE 1588 PTP, and Stream Statistics pages. Use the cursor up and down keys to switch between the ports (in the upper section); choose a new port and the tool shows the RMON1 counters that pertain to the chosen port in the middle section; at any time press the command keys shown in the menu in the lower section to invoke that command.


Port Statistics

The port statistics page provides the following commands menu at the bottom of the page.

Reset  Tx/Rx  0RMON  1ExtRMON  2Checksum  3Decode  4Drop 5IPF
Quit  Sensors Color stat  XTimeSync IEEE 1588 PTP DStream FDump
Port Statistics Menu and Command Keys
KeyAction
RResets all counters for all ports
TChanges between Transmit and Receive counters
0Displays RMON counters
1Displays extended RMON counters
2Displays checksum error counters
3Displays packet decode counters
4Displays drop counters
5Displays IP fragment table counters
QQuits the tool
SChanges to sensor monitoring
CChanges to color statistics monitoring
XChanges to time sync monitoring
IChanges to IEEE 1588 PTP monitoring
DChanges to stream statistics monitoring
FDump the screen to a file monitoring.scn
Arrow upMoves the cursor up
Arrow downMoves the cursor down

Port Statistics Main View

┌────────────────────────────────────────────────────────────────────────────────────────────────────┐
│ P  A       Type       Link    Down    Rx      Tx   Max   Temp.                                     │
│ -------------------------------------------------------------------------------------------------- │
│ 0  0       SFP+   10G Full     0   0.00M   0.00M  9018   59.0 C...                                 │
│ 1  0       SFP+   10G Full     0   0.00M   0.00M  9018   60.5 C...                                 │
│ 2  0       RJ45    1G Full     1   0.00M   0.00M  9018    N/A                                      │
│ 3  0       RJ45    1G Full     0   0.00M   0.00M  9018    N/A                                      │
│ 4  1       RJ45    1G Full     3   0.00M   0.00M  9018    N/A                                      │
│ 5  1       RJ45    1G Full     0   0.00M   0.00M  9018    N/A                                      │
│ 6  1       RJ45    1G Full     0   0.00M   0.00M  9018    N/A                                      │
│ 7  1       RJ45    1G Full     0   0.00M   0.00M  9018    N/A                                      │
│ 8  2       RJ45    1G Full     0   0.00M   0.00M  9018    N/A                                      │
│ 9  2       RJ45    1G Full     0   0.00M   0.00M  9018    N/A                                      │
│ 10 2       RJ45    1G Full     1   0.00M   0.00M  9018    N/A                                      │
│ 11 2       RJ45    1G Full     1   0.00M   0.00M  9018    N/A                                      │
│ 12 3       RJ45    1G Full     1   0.00M   0.00M  9018    N/A                                      │
│ 13 3       RJ45    1G Full     1   0.00M   0.00M  9018    N/A                                      │
│ 14 3       RJ45    1G Full     0   0.00M   0.00M  9018    N/A                                      │
│ 15 3       RJ45    1G Full     0   0.00M   0.00M  9018    N/A                                      │
└────────────────────────────────────────────────────────────────────────────────────────────────────┘

Use the cursor up and down keys to select a port.

The tool displays the counters shown below for the selected port.

Port Statistics View
ColumnDescription
PPort number
AAdapter number
TypeConnection type
LinkLink speed and type
Down Link down counter. The number of times the link is down on the particular port. The adapter uses a sticky link down bit for each port. It means that if the time the link is down is too short for the driver to detect, the link down event still counts. This counter can be used to detect noisy or faulty lines.
RxReceive throughput in Mbps
TxTransmit throughtput in Mbps
MaxMax packet size. Packets larger than this size are considered oversize packets.
Temp.Port module temperature
Note
The rates are computed using the following formula: throughput (Mbps) = 8 * (ΔRMON1.octets+(ΔRMON1.pkts*(12B IFG + 8B preamble)) / Δtime ) / 1.000.000

RMON Counters

The RMON Counters RX view (For more information see the NtRMON1Counters_s structure)

┌───────────────────────────────────────────────────────────────────────────────────────────────┐
│                                     RX RMON1 counters                                         │
│ Packets         : 0x0000000000000000  Octets          : 0x0000000000000000                    │
│ Broadcast       : 0x0000000000000000  Multicast       : 0x0000000000000000                    │
│ 64 octets       : 0x0000000000000000  65-127 octets   : 0x0000000000000000                    │
│ 128-255 octets  : 0x0000000000000000  256-511 octets  : 0x0000000000000000                    │
│ 512-1023 octets : 0x0000000000000000  1024-1518 octets: 0x0000000000000000                    │
│ Undersize       : 0x0000000000000000  Oversize        : 0x0000000000000000                    │
│ Fragments       : 0x0000000000000000  Collisions      : 0x0000000000000000                    │
│ Drop events     : 0x0000000000000000  Crc/Align errors: 0x0000000000000000                    │
│ Jabbers         : 0x0000000000000000  Ext drops       : 0x0000000000000000                    │
│                                                                                               │
└───────────────────────────────────────────────────────────────────────────────────────────────┘

The RMON Counters TX view (For more information see the NtRMON1Counters_s structure)

┌───────────────────────────────────────────────────────────────────────────────────────────────┐
│                                     TX RMON1 counters                                         │
│ Packets         : 0x0000000000000000  Octets          : 0x0000000000000000                    │
│ Broadcast       : 0x0000000000000000  Multicast       : 0x0000000000000000                    │
│ 64 octets       : 0x0000000000000000  65-127 octets   : 0x0000000000000000                    │
│ 128-255 octets  : 0x0000000000000000  256-511 octets  : 0x0000000000000000                    │
│ 512-1023 octets : 0x0000000000000000  1024-1518 octets: 0x0000000000000000                    │
│ Undersize       : 0x0000000000000000  Oversize        : 0x0000000000000000                    │
│ Fragments       : 0x0000000000000000  Collisions      : 0x0000000000000000                    │
│ Drop events     : 0x0000000000000000  Crc/Align errors: 0x0000000000000000                    │
│ Jabbers         : 0x0000000000000000  Ext drops       : 0x0000000000000000                    │
│                                                                                               │
└───────────────────────────────────────────────────────────────────────────────────────────────┘
Note
The "Ext drops" field is calculated as the sum of packets dropped due to overflow in the port and MAC

Extended RMON Counters

The Extended RMON Counters RX view (For more information see the NtExtendedRMONCounters_s structure)

┌───────────────────────────────────────────────────────────────────────────────────────────────┐
│                                 RX extended RMON counters                                     │
│ 1519-2047 octets: 0x0000000000000000  2048-4095 octets: 0x0000000000000000                    │
│ 4096-8191 octets: 0x0000000000000000  8192-Max octets : 0x0000000000000000                    │
│ Hardsliced      : 0x0000000000000000  Hardslice jabber: 0x0000000000000000                    │
│ Unicast         : 0x0000000000000000  Crc             : 0x0000000000000000                    │
│ Align errors    : 0x0000000000000000  Code violation  : 0x0000000000000000                    │
│                                                                                               │
│                                                                                               │
│                                                                                               │
│                                                                                               │
│                                                                                               │
└───────────────────────────────────────────────────────────────────────────────────────────────┘

The Extended RMON Counters TX view (For more information see the NtExtendedRMONCounters_s structure)

┌───────────────────────────────────────────────────────────────────────────────────────────────┐
│                                 TX extended RMON counters                                     │
│ 1519-2047 octets: 0x0000000000000000  2048-4095 octets: 0x0000000000000000                    │
│ 4096-8191 octets: 0x0000000000000000  8192-Max octets : 0x0000000000000000                    │
│ Hardsliced      : 0x0000000000000000  Hardslice jabber: 0x0000000000000000                    │
│ Unicast         : 0x0000000000000000  Crc             : 0x0000000000000000                    │
│ Align errors    : 0x0000000000000000  Code violation  : 0x0000000000000000                    │
│                                                                                               │
│                                                                                               │
│                                                                                               │
│                                                                                               │
│                                                                                               │
└───────────────────────────────────────────────────────────────────────────────────────────────┘

Checksum Error Counters

The Checksum Error Counters RX view (For more information see the NtCheckSumCounters_s structure)

┌───────────────────────────────────────────────────────────────────────────────────────────────┐
│                                RX checksum error counters                                     │
│ IP errors       : 0x0000000000000000  TCP errors      : 0x0000000000000000                    │
│ UDP errors      : 0x0000000000000000                                                          │
│                                                                                               │
│                                                                                               │
│                                                                                               │
│                                                                                               │
│                                                                                               │
│                                                                                               │
│                                                                                               │
│                                                                                               │
└───────────────────────────────────────────────────────────────────────────────────────────────┘

The Checksum Error Counters TX view (For more information see the NtCheckSumCounters_s structure)

┌───────────────────────────────────────────────────────────────────────────────────────────────┐
│                                TX checksum error counters                                     │
│ IP errors       : 0x0000000000000000  TCP errors      : 0x0000000000000000                    │
│ UDP errors      : 0x0000000000000000                                                          │
│                                                                                               │
│                                                                                               │
│                                                                                               │
│                                                                                               │
│                                                                                               │
│                                                                                               │
│                                                                                               │
│                                                                                               │
└───────────────────────────────────────────────────────────────────────────────────────────────┘
Note
There are no checksum error counters for TX on 4GArch adapters.

Packet Decode Counters

The Packet Decode Counters RX view (For more information see NtDecodeCounters_s structure)

┌───────────────────────────────────────────────────────────────────────────────────────────────┐
│                                 RX packet decode counters                                     │
│ Giant undersize : 0x0000000000000000  Baby giant      : 0x0000000000000000                    │
│ No ISL/VLAN/MPLS: 0x0000000000000000  ISL             : 0x0000000000000000                    │
│ VLAN            : 0x0000000000000000  ISL/VLAN        : 0x0000000000000000                    │
│ MPLS            : 0x0000000000000000  ISL/MPLS        : 0x0000000000000000                    │
│ VLAN/MPLS       : 0x0000000000000000  ISL/VLAN/MPLS   : 0x0000000000000000                    │
│                                                                                               │
│                                                                                               │
│                                                                                               │
│                                                                                               │
│                                                                                               │
└───────────────────────────────────────────────────────────────────────────────────────────────┘
Note
There are no packet decode counters for TX.

Drop Counters

The Drop Counters RX view (For more information see NtExtendedDropCounters_s structure)

┌───────────────────────────────────────────────────────────────────────────────────────────────┐
│                                 RX extended drop counters                                     │
│ Overflow packets: 0x0000000000000000  Overflow octets : 0x0000000000000000                    │
│ Dedup packets   : 0x0000000000000000  Dedup octets    : 0x0000000000000000                    │
│ No filter pkts  : 0x0000000000000000  No filter octets: 0x0000000000000000                    │
│ Mac bandwidth   : 0x0000000000000000                                                          │
│                                                                                               │
│                                                                                               │
│                                                                                               │
│                                                                                               │
│                                                                                               │
│                                                                                               │
└───────────────────────────────────────────────────────────────────────────────────────────────┘
Note
There are no drop counters for TX.

IPF Table Counters

The IP fragment table counters RX view (For more information see NtIpFragTableCounters_s structure)

┌───────────────────────────────────────────────────────────────────────────────────────────────┐
│                                    IPF table counters                                         │
│ First frag hits : 0x0000000000000000  First frag miss : 0x0000000000000000                    │
│ Mid frag hits   : 0x0000000000000000  Mid frag miss   : 0x0000000000000000                    │
│ Last frag hits  : 0x0000000000000000  Last frag miss  : 0x0000000000000000                    │
│                                                                                               │
│                                                                                               │
│                                                                                               │
│                                                                                               │
│                                                                                               │
│                                                                                               │
│                                                                                               │
└───────────────────────────────────────────────────────────────────────────────────────────────┘
Note
There are no IPF table counters for TX.

Sensor Monitoring

The Sensor Monitoring page provides the following commands menu.

Quit  Port stat  Color stat XTimeSync  IEEE 1588 PTP  DStream FDump

The sensor monitoring page provides the following menu and command keys.

Sensor Monitoring Menu and Action Keys
KeyAction
QQuits the tool
PChanges to port statistics monitoring
CChanges to color statistics monitoring
XChanges to time sync monitoring
IChanges to IEEE 1588 PTP monitoring
DChanges to stream statistics monitoring
FDump the screen to a file monitoring.scn
Arrow upSelects the previous source - if any - in the view that has input focus
Arrow downSelects the next source - if any - in the view that has input focus
Page upMoves the split between top and bottom views upwards
Page downMoves the split between top and bottom views downwards
TabMoves the input focus between views

Sensor Monitoring Main View

┌─────────────────────  monitoring (v.  3.3.0.14-d6c49)  ──────────────────────┐
│ Source     Description              Temp.    Temp.    Temp.    State         │
│                                     curr.     min      max                   │
│ Adapter0   NT100E3_1_PTP            51.9 C   50.3 C   52.9 C   Normal        │
│   Port0    CFP4_SR4                 42.7 C   36.7 C   43.3 C   Normal        │
│ Adapter1   NT200A01                 52.5 C   49.7 C   54.1 C   Normal        │
│   Port1    QSFP28-SR4               46.3 C   35.7 C   46.8 C   Normal        │
│   Port2    QSFP28-SR4               49.8 C   32.5 C   50.9 C   Normal        │
│                                                                              │
│                                                                              │
│                                                                              │
└──────────────────────────────────────────────────────────────────────────────┘

The upper view shows the sensor sources. Each source can be either an adapter or a port. The ports associated with an adapter are listed in numerical order below the adapter so that the first port listed is the first physical port/interface on that adapter.

Use the arrow up and down keys to select a source in the upper view. The tool displays the sensor values—if any—for the selected source in the Sensor Value View below.

Sensor Monitoring Main View
Column Description
SourceThe location of the sensors
DescriptionDescription of the source
Temp. curr. The current temperature for either adapter FPGA or port NIM (Network Interface Module)
Temp. min The lowest measured temperature for either adapter FPGA or port NIM
Temp. max The highest measured temperature for either adapter FPGA or port NIM
State The temperature sensor state for either adapter FPGA or port NIM

Sensor Value View

The Sensor Value view (For more information see the NtInfoSensor_s structure)

┌─────────────────────────────────── Port0 ────────────────────────────────────┐
│ # Sensor        Sensor   Value Unit  Value  Value  Limit  Limit State        │
│   target        type     curr.         min    max    low   high              │
│  0 CFP4         Temp.     42.8 C      36.7   43.3   -3.0   73.0 Normal       │
│  1 GEARBOX      Temp.     57.7 C      52.5   58.0    0.0  115.0 Normal       │
│  2 Supply       Voltage   3.24 V      3.24   3.25   3.12   3.46 Normal       │
│  3 Tx Bias 1    Current   7.52 mA     7.39   7.62   1.54  11.78 Normal       │
│  4 Tx Bias 2    Current   7.46 mA     7.40   7.64   1.54  11.78 Normal       │
│  5 Tx Bias 3    Current   7.49 mA     7.40   7.62   1.54  11.78 Normal       │
│  6 Tx Bias 4    Current   7.53 mA     7.35   7.61   1.54  11.78 Normal       │
│  7 Tx 1(AVG)    Power      897 uW      860    934     51   3456 Normal       │
│  8 Tx 2(AVG)    Power      809 uW      776    835     51   3456 Normal       │
│  9 Tx 3(AVG)    Power      875 uW      822    902     51   3456 Normal       │
│ 10 Tx 4(AVG)    Power      868 uW      850    926     51   3456 Normal       │
│ 11 Rx 1(AVG)    Power      747 uW      741    814     77   1715 Normal       │
│ 12 Rx 2(AVG)    Power      795 uW      790    859     77   1715 Normal       │
│ 13 Rx 3(AVG)    Power      762 uW      751    818     77   1715 Normal       │
│ 14 Rx 4(AVG)    Power      809 uW      801    869     77   1715 Normal       │
│                                                                              │
└──────────────────────────────────────────────────────────────────────────────┘

Press the Tab key to switch the input focus between the main view and the sensor value view. This is useful if there is insufficient screen estate to display all sources or sensors. Resizing of the whole terminal window resizes the view that has the input focus while the other view as well as the menu at the bottom remain fixed.

Sensor Value View
Column Description
# Sensor item number. Two dots indicate that not all sources can be shown.
Sensor targetWhat is measured
Sensor typeThe type of measurement
Value curr.The current value
UnitThe unit used for all values and limits
Value minThe lowest measured value
Value maxThe highest measured value
Limit lowThe lower limit for generating an alarm. Not all sensors have a lower limit
Limit highThe upper limit for generating an alarm. Not all sensors have an upper limit
StateSensor state e.g. Normal, Alarm, Not present etc

Color Statistics

The Color Statistics page provides the following commands menu.

 Reset
 Quit  Sensors  Port stat  XTimeSync  IEEE 1588 PTP  DStream FDump
Color statistics Menu and Action Keys
Key Action
RResets all counters
QQuits the tool
SChanges to sensor monitoring
PChanges to port statistics monitoring
XChanges to time sync monitoring
IChanges to IEEE 1588 PTP monitoring
DChanges to stream statistics monitoring
FDump the screen to a file monitoring.scn
Arrow upMoves the cursor up
Arrow downMoves the cursor down

Color Statistics Main View

┌───────────────────────────────────────────────────────────────────────────────────────────────┐
│    Color   Packets             Bytes                                                          │
│ --------------------------------------------------------------------------------------------- │
│        0   0x0000000000000000  0x0000000000000000                                             │
│        1   0x0000000000000000  0x0000000000000000                                             │
│        2   0x0000000000000000  0x0000000000000000                                             │
│        3   0x0000000000000000  0x0000000000000000                                             │
│        4   0x0000000000000000  0x0000000000000000                                             │
│        5   0x0000000000000000  0x0000000000000000                                             │
│        6   0x0000000000000000  0x0000000000000000                                             │
│        7   0x0000000000000000  0x0000000000000000                                             │
│        8   0x0000000000000000  0x0000000000000000                                             │
│        9   0x0000000000000000  0x0000000000000000                                             │
│       10   0x0000000000000000  0x0000000000000000                                             │
│       11   0x0000000000000000  0x0000000000000000                                             │
│       12   0x0000000000000000  0x0000000000000000                                             │
│       13   0x0000000000000000  0x0000000000000000                                             │
│       14   0x0000000000000000  0x0000000000000000                                             │
│       15   0x0000000000000000  0x0000000000000000                                             │
└───────────────────────────────────────────────────────────────────────────────────────────────┘

Use the arrow up and down keys to select a color in the color statistics main view.

The color statistics view provides the following information for the selected color.

Color Statistics View
Column Description
ColorColor number
PacketsNumber of packets received with current color
BytesNumber of bytes received with current color

Color Statistics Value View

The Color Statistics Value view (For more information see the NtStatGroupAdapter_s structure)

┌───────────────────────────────────────────────────────────────────────────────────────────────┐
│                                                                                               │
│ Adapter 0: 0x0000000000000000  0x0000000000000000                                             │
│ Adapter 1: 0x0000000000000000  0x0000000000000000                                             │
│                                                                                               │
│                                                                                               │
│                                                                                               │
│                                                                                               │
│                                                                                               │
│                                                                                               │
│                                                                                               │
│                                                                                               │
└───────────────────────────────────────────────────────────────────────────────────────────────┘

Time Synchronization

The Napatech driver supports multiple time synchronization protocols, for instance NTTS (Napatech time synchronization), PPS, and IEEE 1588 PTP. It is possible to configure different synchronization protocols for an adapter and let the driver choose among them based on a prioritized list (as defined by the TimeSyncReferencePriority configuration parameter). The driver also supports different priority lists for each adapter in a server. This flexibility affects the monitoring tool in that the tool always displays the information that makes sense and is available, correct, and up-to-date for the active time synchronization protocol.

As an example, if the driver switches from a PTP master to a PPS input, information about the PTP master is no longer up-to-date and (or undefined). For this reason the monitoring tool no longer displays any information about the PTP master. Once the driver switches back to use the PTP master for time synchronization, information about the PTP master becomes available in the monitoring tool again.

As another example, consider a switch from PPS to NTTS. The driver calculates the standard deviation for PPS, but that information is no longer up-to-date after a switch to NTTS, so the PPS standard deviation is no longer available in the monitoring tool.

The two examples illustrate that when the driver switches from one time synchronization protocol to another, the state information of the old protocol is not available in the monitoring tool.

Note
The driver creates an event when it switches time synchronization protocol. This means that a program can catch the event as the switch happens, or a user can use the ntlog command to find out when the switch happened.

The Time Synchronization page provides the following commands menu at the bottom of the page.

Reset  0Overview  1Sampling  2PPS stat  3TS stat  4External Status
Quit  Sensors  Port stat  Color stat  IEEE 1588 PTP  DStream FDump
Time Synchronization Menu and Command Keys
Key Action
R Reset time to reference time. Allow time jump to get in-sync once
0Displays the time synchronization overview view
1Displays the time stamp sampling view
2Displays the PPS statistics view
3Displays the time synchronization statistics view
4Displays the NTTS external status view
QQuits the tool
SChanges to sensor monitoring
PChanges to port statistics monitoring
CChanges to color statistics monitoring
IChanges to IEEE 1588 PTP monitoring
DChanges to stream statistics monitoring
FDump the screen to a file monitoring.scn
Arrow upMoves the cursor up
Arrow downMoves the cursor down

Time Synchronization Main View

┌───────────────────────────────────────────────────────────────────────────────────────────────┐
│ Adapter  In-Sync   TimeStamp    Int1         Int2         Ext1                                │
│ ----------------------------------------------------------------------------------------------│
│ 0        yes       Native Unix  NttsIn       PpsIn        PpsIn                               │
│ 1        yes       Native Unix  PpsOut       None         None                                │
│                                                                                               │
└───────────────────────────────────────────────────────────────────────────────────────────────┘

Use the arrow up and down keys to select an adapter in the time synchronization main view.

The time synchronization main view provides the following information for the selected adapter.

Time Synchronization Main View
Column Description
AdapterAdapter number
in-SyncSpecifies the adapter in-sync status
TimeStampTimestamp format used by the adapter
Int1TimeSyncConnectorInt1 configuration
Int2TimeSyncConnectorInt2 configuration
Ext1TimeSyncConnectorExt1 configuration

Time Synchronization Overview View

The time synchronization overview view (For more information see the NtInfoTimeSync_s structure).

┌───────────────────────────────── Timesync ────────────────────────────────────┐
│ Overview                                                                      │
│ Adapter time (UTC)    : Fri 24-Oct-2014 09:05:05.529506840                    │
│ Reference priority    : NT-TS(Int1),FreeRun     Freq priority: FreeRun        │
│ Current reference     : NT-TS(Int1)             Current freq : FreeRun        │
│ Skew (ns)             : -42                                                   │
│ Clock rate adjustment : 4192                                                  │
│ Input connector status: Signal Present                                        │
│                                                                               │
│                                                                               │
│ Clock hard reset      : Enabled                                               │
│ Time offset (ns)      : 0                                                     │
└───────────────────────────────────────────────────────────────────────────────┘
Time Synchronization Overview View
Column Description
Adapter time (UTC) Current adapter time
Reference priority The configured clock reference priority list
Current reference The active clock reference in use
Freq priority The configured reference priority list used for frequency synchronization
Skew (ns) The measured offset between adapter clock and current reference clock
Current freq The active reference used for frequency synchronization
Input connector status The active connector status
Jump threshold The threshold that specifies when to jump in time
Time offset (ns) The specified time offset for cable delay compensation

Time Synchronization Sampling View

┌───────────────────────────────────────────────────────────────────────────────────────────────┐
│ Sampling                     Timesync                                                         │
│                                                                                               │
│ Int1: NT-TS sampled time : 1369814607000000022                                                │
│       External time      : 1369814607000000000                                                │
│                                                                                               │
│                                                                                               │
│                                                                                               │
│                                                                                               │
│                                                                                               │
│ Time offset (ns) : 0                                                                          │
└───────────────────────────────────────────────────────────────────────────────────────────────┘

The time synchronization sampling view shows the sampled time stamps for connectors configured for either PPS or NTTS input.

For PTP-enabled adapters, and if the PtpPpsSampling configuration parameter is enabled, the tool may also show the sampled time stamps.

PPS Statistics View

┌───────────────────────────────────────────────────────────────────────────────────────────────┐
│Cnt   A  Con   Peak jitter Mean      Skew      Std. dev  Min       Max                         │
│ --------------------------------------------------------------------------------------------- │
│ 60    0  Ext1  6           66        66        1.8       64        70                         │
│ 0     0  Int1  0           0         0         0.0       0         0                          │
│ 0     0  Int2  0           0         0         0.0       0         0                          │
│ 0     1  Ext1  0           0         0         0.0       0         0                          │
│ 0     1  Int1  0           0         0         0.0       0         0                          │
│ 0     1  Int2  0           0         0         0.0       0         0                          │
│                                                                                               │
└───────────────────────────────────────────────────────────────────────────────────────────────┘

The PPS Statistics view shows the present statistical calculations for each PPS input connector. The displayed skew is measured against the time stamp clock on the adapter.

PPS Statistics information View
Column Description
CntThe number of samples (seconds) the statistics is based on
AAdapter number this connector is placed on
ConThe specific timesync connector
Peak jitterThe measured peak-to-peak jitter
MeanThe statistical mean or average offset value
SkewThe last received PPS skew
Std. devThe statistical standard deviation
MinThe lowest offset measured
MaxThe largest offset measured

Time Synchronization Statistics View

The time synchronization statistics view (For more information see the NtInfoTimeSyncStatistics_s structure).

┌───────────────────────────────────────────────────────────────────────────────────────────────┐
│ Time Synchronization Statistics                                                               │
│                                                                                               │
│ Time reference        : PTP         Reference signal lost : 0                                 │
│                                     Synchronization lost  : 0                                 │
│ Seconds since reset   : 1575        Time hard reset       : 1                                 │
│                                                                                               │
│                                                                                               │
│ Number of samples     : 1575                                                                  │
│ Skew                  : -3          Mean                  : 0                                 │
│ Std. dev              : 13.3        Min                   : -155                              │
│ Peak jitter           : 361         Max                   : 206                               │
│                                                                                               │
└───────────────────────────────────────────────────────────────────────────────────────────────┘

The time synchronization statistics view shows the adapter overall time synchronization performance statistics. This means that the statistics spans over all fail over and fall back events that might had occurred. The time sync performance statistics calculation is done in the driver and calculated skew values are continuously added to it until manually reset through the NTAPI. If free running no skew may be calculated and thus no value added to the statistics calculation.

Time Synchronization Statistics View
Column Description
Time reference Current running time synchronization algorithm or protocol
Reference signal lost Counter for how many lost signals has occurred since last statistics reset
Synchronization lost Counter for how may out-of-sync events has occurred since last statistics reset
Seconds since reset How many seconds has elapsed since last statistics reset (OS seconds)
Time hard reset How many clock hard-reset events has occurred since last statistics reset
Number of samples Actual number of samples used in the current statistics result
Skew Last read clock skew in ns (offset from master)
Mean The calculated mean value in ns
Std. dev The calculated standard deviation in ns
Min The calculated minimum value in ns
Peak jiter The calculated peak-to-peak value in ns
Max The calculated maximum value in ns

External Status View

┌───────────────────────────────────────────────────────────────────────────────────────────────┐
│                                External Status                                                │
│ External Status valid                   : VALID                                               │
│ External device OS timesync enabled     : NO                                                  │
│ External device is in sync with the OS  : NO                                                  │
│ Master ID of the external device        : NT adapter with PTP support (0x6)                   │
│                                                                                               │
│                                                                                               │
│                                                                                               │
│                                                                                               │
│                                                                                               │
└───────────────────────────────────────────────────────────────────────────────────────────────┘

The External Status View only applies to NTTS synchronization. It shows the status of the external NTTS master device.


IEEE 1588 PTP

The IEEE 1588 PTP Monitoring page provides the following commands menu at the bottom of the page.

 Reset 0Overview  1Dataset 1 2Dataset 2 3Dataset 3 4Stats 5Clk Descr 6IP
 Quit  Sensors  Port stat  Color stat  XTimeSync  DStream FDump
IEEE 1588 PTP Menu and Command Keys
Key Action
RResets the sync statistics counters
1Displays the IEEE 1588 v2 data sets view: portDS and CurrentDS
2Displays the IEEE 1588 v2 data sets view: defaultDS and timePropertiesDS
3Displays the IEEE 1588 v2 data sets view: parentDS
4Displays the PTP Ethernet port statistics view
5Displays the IEEE 1588 v2 clock description view
6Displays the PTP Ethernet port IP settings view
QQuits the tool
SChanges to sensor monitoring
PChanges to port statistics monitoring
CChanges to Color statistics monitoring
XChanges to time sync monitoring
FDump the screen to a file monitoring.scn
Arrow upMoves the cursor up
Arrow downMoves the cursor down
Note
The IEEE 1588 v2 data sets views only display information not already displayed in the Overview view.

IEEE 1588 PTP Main View

┌───────────────────────────────────────────────────────────────────────────────────────────────┐
│ Adapter  Link   Clock Id  domain  Vlan  Netw Prot   Del  Filter     Asym                      │
│ --------------------------------------------------------------------------------------------- │
│ 0        100M   02:e5:99  0       0     IPv4/UDP    E2E  NONE          0                      │
│ 1        100M   02:e5:02  0       0     IPv4/UDP    E2E  PDV        3000                      │
│                                                                                               │
└───────────────────────────────────────────────────────────────────────────────────────────────┘

Use the cursor up and down keys to select an adapter. The tool displays the following information for the selected adapter.

IEEE 1588 PTP Main View
Column Description
AdapterThe adapter number
LinkThe PTP ethernet port link status
Clock IDThe PTP clock ID for this adapter. The full clock ID is 00:0d:e9:ff:fe:xx:xx:xx where the last 3 numbers are the values shown here
domainThe configured or currently used PTP domain number
VlanThe Vlan ID configured for this adapter
Netw ProtThe selected PTP network protocol
DelThe PTP Delay request mechanism configured
FilterThe used filter for this adapter
AsymThe PTP delay asymmetry compensation parameter currently applied.

IEEE 1588 PTP Information Views

The IEEE 1588 PTP information views (For more information see the NtInfoCmdPTP_s structure)

IEEE 1588 PTP Overview View

┌───────────────────────────────────────────────────────────────────────────────────────────────┐
│ Overview                     IEEE 1588 PTP                                                    │
│                                                                                               │
│ Clock state         : Slave           GM clock identity   : 000de9fffe02e599                  │
│ Mean path delay     : 53              UTC offset from TAI : 35                                │
│                                       Offset known valid  : No                                │
│                                                                                               │
│                                                                                               │
│                                                                                               │
│                                                                                               │
│                                                                                               │
│ PTP Time            : Wed 29-May-2013 10:43:04.882891304                                      │
│                                                                                               │
└───────────────────────────────────────────────────────────────────────────────────────────────┘
IEEE 1588 PTP Overview View
Column Description
Clock stateThe current PTP clock state
Mean path delayThe last calculated mean path delay (OWD)
PTP TimeThe actual time received from the PTP master
GM clock identityThe clock id of the Grand Master in the domain
UTC offset from TAIThe UTC offset from TAI as reported by the master
Offset known validIndicates whether the above mentioned UTC offset is known valid

IEEE 1588 v2 Data Set 1 Overview View

┌───────────────────────────────────────────────────────────────────────────────────────────────┐
│ Data Set 1                     IEEE 1588 PTP                                                  │
│                                                                                               │
│ PTP portDS:                         PTP currentDS:                                            │
│ Sync interval          : 0          Steps removed   : 1                                       │
│ Delay request interval : 0                                                                    │
│ Announce interval      : 1                                                                    │
│ Announce timeout       : 3                                                                    │
│ Peer mean path delay   : 0                                                                    │
│ Peer delay interval    : 0                                                                    │
│ IEEE 1588 version      : 2                                                                    │
│ Port Identifier        : 000de9fffe02e502                                                     │
│                                                                                               │
└───────────────────────────────────────────────────────────────────────────────────────────────┘
IEEE 1588 v2 Data Sets View: portDS and currentDS
Column Description
Sync intervalThe configured sync interval (log2 seconds)
Delay request intervalThe actual delay request interval (log2 seconds)
Announce intervalThe configured announce interval (log2 seconds)
Announce timeoutthe configured announce timeout (multiplier)
Peer mean path delayP2P mean path delay measured (only in P2P mode)
Peer delay intervalThe configured P2P delay interval
Port IdentifierThe clock Id of this port
Steps removedSteps removed information from the current GM announce messages

IEEE 1588 v2 data set 2 Overview View

┌───────────────────────────────────────────────────────────────────────────────────────────────┐
│ Data Set 2                     IEEE 1588 PTP                                                  │
│                                                                                               │
│ PTP defaultDS:                      PTP timePropertiesDS:                                     │
│ Clock quality class    : 255        Leap59                 : No                               │
│ Clock quality accuracy : 254        Leap61                 : No                               │
│ Clock quality variance : 18944      Time traceable         : No                               │
│ Priority 1             : 128        Frequency traceable    : No                               │
│ Priority 2             : 128        PTP timescale          : No                               │
│ Slave only             : Yes        Time source            : Other                            │
│ Two step clock         : No                                                                   │
│                                                                                               │
└───────────────────────────────────────────────────────────────────────────────────────────────┘
IEEE 1588 v2 Data Sets View: defaultDS and timepropertiesDS
Column Description
Clock quality class Clock class used for this PTP clock. When an adapter is PTP master, the value may change
Clock quality accuracy Clock accuracy used for this PTP clock. When an adapter is PTP master, the value may change
Clock quality varianceCalculated clock variance used for this PTP clock
Priority 1The PTP priority 1 property configured. Only used if master mode is allowed
Priority 2The PTP priority 1 property configured. Only used if master mode is allowed
Slave onlyIndicates whether Slave only mode is enabled (master mode is disallowed)
Two step clockIndicates whether sync messages are sent in one step. Only relevant when running in master mode.
Leap59Indicates whether the last minute of the current UTC day contains 59 sec
Leap61Indicates whether the last minute of the current UTC day contains 61 sec
Time traceableIndicates whether the UTC offset is traceable to a primary reference
Frequency traceableIndicates whether the frequency is traceable to a primary reference
PTP timescaleIndicates whether the timescale is PTP
Time sourceThe time source use by the master

IEEE 1588 v2 Data Set 3 Overview View

┌───────────────────────────────────────────────────────────────────────────────────────────────┐
│ Data Set 3                     IEEE 1588 PTP                                                  │
│                                                                                               │
│ PTP parentDS:                                                                                 │
│ Parent port identity  : 000de9fffe02e599   GM priority 1       : 128                          │
│ Parent stats          : Yes                GM priority 2       : 128                          │
│   Parent variance     : 19200                                                                 │
│   Parent phase change : 5447884                                                               │
│ GM quality class      : 248                                                                   │
│ GM quality accuracy   : 254                                                                   │
│ GM quality variance   : 18944                                                                 │
│                                                                                               │
└───────────────────────────────────────────────────────────────────────────────────────────────┘
IEEE 1588 v2 Data Sets View: parentDS
Column Description
Parent port identityThe clock Id of the parent port (if not Grand Master, this may be a boundary clock)
Parent statsIndicates whether statistics has been calculated for the parent clock
Parent varianceCalculated parent variance
Parent phase changeEstimated parent phase change rate
GM quality classThe clock class of the Grand Master
GM quality accuracyThe clock accuracy of the Grand Master
GM quality varianceThe clock variance of the Grand Master
GM priority 1The PTP priority 1 property of the Grand Master
GM priority 2The PTP priority 2 property of the Grand Master

PTP Port Statistics Overview View

┌───────────────────────────────────────────────────────────────────────────────────────────────┐
│ PTP Port Statistics                     IEEE 1588 PTP                                         │
│                                                                                               │
│ Receive:                                                                                      │
│ Octets               : 0x00217B3A   Discarded Packets    : 0x00000000                         │
│ Broadcast Packets    : 0x00000001                                                             │
│ Multicast Packets    : 0x0000560C   Transmit:                                                 │
│ Unicast Packets      : 0x00000000   Octets               : 0x000C238E                         │
│ Legal Length Packets : 0x00000000   Broadcast Packets    : 0x00000001                         │
│ Fragmented  Packets  : 0x00000000   Multicast Packets    : 0x00002288                         │
│ Jabber Packets       : 0x00000000   Unicast Packets      : 0x00000000                         │
│ Bad Octets           : 0x00000000                                                             │
└───────────────────────────────────────────────────────────────────────────────────────────────┘

The monitoring tool displays PTP port statistics including CRC errors (Bad Octets) for debugging purposes. That same information is available via the NTAPI too.

PTP Port Statistics View
Column Description
Octets (Receive)Number of octets received
Broadcast PacketsNumber of broadcast packets received
Multicast PacketsNumber of multicast packets received
Unicast PacketsNumber of unicast packets received
Legal Length PacketsNumber of packets received with legal length
fragmented PacketsNumber of fragmented packets received
Jabber PacketsNumber of jabber packets received
Bad OctetsNumber of octets received in bad packets
Discarded PacketsNumber of dropped packets
Octets (Transmit)Number of octets transmittet
Broadcast PacketsNumber of broadcast packets transmitted
Multicast PacketsNumber of multicast packets transmitted
Unicast PacketsNumber of unicast packets transmitted

PTP Clock Description Overview View

┌───────────────────────────────────────────────────────────────────────────────────────────────┐
│ Clock description                     IEEE 1588 PTP                                           │
│                                                                                               │
│ Receive:                                                                                      │
│ Clock type          : Ordinary Clock                                                          │
│ Physical Protocol   : Ethernet IEEE 802.3                                                     │
│ Physical Address    : 00:0d:e9:02:e5:02                                                       │
│ Protocol Address    : IPv4:192.168.0.2                                                        │
│ Manufacturer Id     : 00:0d:e9                                                                │
│ Product description : Napatech A/S; NT20E2-PTP-CAP; Snr:0000122915                            │
│ Revision data       : V1.0                                                                    │
│ User description    : Napatech adapter                                                        │
│ Profile Id          : 00:1b:19:00:01:00 (Default)                                             │
└───────────────────────────────────────────────────────────────────────────────────────────────┘
PTP Clock Description View
Column Description
Clock typeThe PTP clock type configured for this adapter
Physical ProtocolEither Layer2 or IPv4
Physical AddressThe PTP port MAC address
Protocol AddressThe used protocol address used for the selected physical protocol
Manufacturer IdAdapter manufacturer Id (Napatech)
Product descriptionAdapter description
Revision dataThe current revision
User descriptionThis string can be specified in the ntservice.ini file
Profile IdThe Id of the currently running profile

PTP Port IP Settings Overview View

┌───────────────────────────────────────────────────────────────────────────────────────────────┐
│ IP settings                     IEEE 1588 PTP                                                 │
│                                                                                               │
│ IPv4 IP address     : 192.168.0.2                                                             │
│ Subnet Mask         : 255.255.255.0                                                           │
│ IP Gateway          : 192.168.0.1                                                             │
│ DHCP enabled        : No                                                                      │
│                                                                                               │
│                                                                                               │
│                                                                                               │
│                                                                                               │
│                                                                                               │
│                                                                                               │
└───────────────────────────────────────────────────────────────────────────────────────────────┘
PTP Port IP Settings View
Column Description
IPv4 IP addressThe assigned IP address
Subnet MaskThe assigned subnet mask
IP GatewayThe assigned gateway
DHCP enabledIndicates whether IP is assigned from a DHCP server

Stream Statistics

The stream statistics page page provides the following commands menu at the bottom of the page.

 Reset
 Quit  Sensors  Port stat  Color stat  XTimeSync IEEE 1588 PTP FDump
Stream statistics Menu Keys
Key Action
RResets the counters
QQuits the tool
SChanges to sensor monitoring
PChanges to port statistics monitoring
CChanges to Color statistics monitoring
IChanges to IEEE 1588 PTP monitoring
XChanges to time sync monitoring
FDump the screen to a file monitoring.scn
Arrow upMoves the cursor up
Arrow downMoves the cursor down

Stream Statistics Main View

┌──────────────────────────────────────────────────────────────────────────────┐
│ SID  Packets             Bytes               Drop bytes          Drop pkts   │
│   0  0x0000000000000000  0x0000000000000000  0x0000000000000000  0x00000000  │
│   1  0x0000000000000000  0x0000000000000000  0x0000000000000000  0x00000000  │
│   2  0x0000000000000000  0x0000000000000000  0x0000000000000000  0x00000000  │
│   3  0x0000000000000000  0x0000000000000000  0x0000000000000000  0x00000000  │
│   4  0x0000000000000000  0x0000000000000000  0x0000000000000000  0x00000000  │
│   5  0x0000000000000000  0x0000000000000000  0x0000000000000000  0x00000000  │
│   6  0x0000000000000000  0x0000000000000000  0x0000000000000000  0x00000000  │
│   7  0x0000000000000000  0x0000000000000000  0x0000000000000000  0x00000000  │
│   8  0x0000000000000000  0x0000000000000000  0x0000000000000000  0x00000000  │
│   9  0x0000000000000000  0x0000000000000000  0x0000000000000000  0x00000000  │
│  10  0x0000000000000000  0x0000000000000000  0x0000000000000000  0x00000000  │
│  11  0x0000000000000000  0x0000000000000000  0x0000000000000000  0x00000000  │
│  12  0x0000000000000000  0x0000000000000000  0x0000000000000000  0x00000000  │
│  13  0x0000000000000000  0x0000000000000000  0x0000000000000000  0x00000000  │
│  14  0x0000000000000000  0x0000000000000000  0x0000000000000000  0x00000000  │
│  15  0x0000000000000000  0x0000000000000000  0x0000000000000000  0x00000000  │
└──────────────────────────────────────────────────────────────────────────────┘

Use the cursor up and down keys to select a stream.

The tool displays the values shown below for the selected stream.

Stream Statistics View
Column Description
Streamidstream ID number. The same stream ID as used in the NTPL command that defines the stream.
PacketsNumber of packets received on the stream
BytesNumber of bytes received on the stream

Stream Statistics Values View

┌──────────────────────────────────────────────────────────────────────────────┐
│ StreamId:  0                                                                 │
│                                                                              │
│ Drop:      0x0000000000000000  0x0000000000000000                            │
│ Flush:     0x0000000000000000  0x0000000000000000                            │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
└──────────────────────────────────────────────────────────────────────────────┘

The stream statistics values view displays the information shown below.

Stream Statistics View
Column Description
DropNumber of packets dropped on the stream
FlushNumber of bytes flushed on the stream