swx-top

WHAT TO EXPECT

swx-top is a text-based UI that displays real-time statistics and configuration of a cloudSwXtch environment. This includes data regarding streams, adaptors, clusters, high availability, etc.

In this article, users will learn how to navigate through the different pages in swx-top and get better visibility on how data flows in a cloudSwXtch instance. 

Running swx-top

In an xNIC or a cloudSwXtch VM, execute:

swx-top

On the bridge, or if the VM has the swx-tools installed, users also need to tell the program the IP of the cloudSwXtch to connect to: 

swx-top -swxtch <cloudSwXtch-ctrl-IP>

NOTE

To copy some part of the window (using the clipboard), press the SHIFT key while selecting the element. Depending on the terminal emulation this will automatically copy that selection to the clipboard.

Navigating swx-top Dashboard

The swx-top dashboard is organized into 3 panels as shown in the screenshot above. While the top panel 1 will remain static (although it can be collapsed to one line), displaying information regarding the cloudSwXtch, the bottom 2 and 3 panels will change depending on the selected view. The swx-top dashboard has several different views. Pressing over Views, users can see the menu:

NOTE

Users can see the Help menu on the lower right corner showing all the shortcuts available.

Switching Between swx-top Views

To switch between views, click on the Views option in the left-hand corner of swx-top and select the desired view from the menu. Alternatively, users can press CTRL + V to open the menu and then CTRL + the highlighted letter to switch to that view. For example, to toggle to “StreamLinks", enter CTRL + V and CTRL + K.

NOTE

Opening the menu with the CTRL key is not necessary. Simply entering CTRL + the corresponding letter will open the view.

Also, if the console supports it, mouse interaction is supported.

Customizing views (F3)

Users can modify the columns visible in each view and adjust the width of those columns.

NOTE

These changes will persist between swx-top sessions.

To do this:

1. Select the [+] next to the first column. This will open the Columns Setup menu for that specific panel
   

2. Alternatively, click a panel to select it and press F3 to open the menu. Users can tell the selected panel by the increased thickness of its border.

3. Click one of the blue checkboxes under Visible to highlight the column to add. An X will appear.
   

4. Users can also change the width of the columns in swx-top in this panel, and on numeric fields, it can also be selected to see the raw number (displaying the number in its base units, without using G, M, or K).

5. Hit OK to confirm the selection.

The new column should now appear in the swx-top view. In this example, the Region column was added by the user and is now displayed in the Components view.

Changing swx-top Colors (CTRL+ r)

Users can change the colors displayed in swx-top. There are pre-made schemes that can be selected, or a Custom scheme where all the colors can be hand-picked by keying in different hex codes in the Colors Set-Up menu.

To do this:

1. Click Colors at the bottom of swx-top or enter CTRL + r.

   

2. Select Custom from the Scheme dropdown menu.

3. Enter the desired hex codes into one of the fields.

4. Click Confirm.

   

5. swx-top should now display the assigned colors.
   

Panel 1: Information

The first panel of the swx-top dashboard provides users with:

• Information regarding their cloudSwXtch.

• Information about their licensing plan.

• Information about the cloud.

Each cloud provider will have alternative titles for some of the listed items, but for the most part, the information is the same.

On the left side of the section:

• cloudSwXtch name (in this case, the name is ip-172-51-128-88)

• Cloud (Azure, AWS, GCP, OCI) (in this case, AWS)

• SubscriptionID (Azure), Account ID (AWS), or ID (GCP) (in this case, an Account Id from AWS)

• ResourceGroupName (Azure) or Region (AWS and GCP) (in this case, us-west-1)

• SwXtchID (in this case i-0d7e1ccca7ee30d11)

• Status (in this case, OK)

On the right side of the section:

• Bandwidth (actual/max allowed)

• Number of Clients (actual/max allowed)

• Number of Bridges (actual/max allowed)

• License Expiration Date

The Information panel is fully collapsible by either selecting the (+) or (-) buttons or pressing the F2 key on their keyboard. The collapsed view will only display the cloudSwXtch name, the status, and a warning if there are new notifications.

Panels 2 and 3: Views

Panels 2 and 3 default to the Components view. However, the display changes based on view selection. To change views, key in CTRL + <the associated letter for that view>. 

NOTE

Not all views have a 3rd panel.

Filter Bar

At the top of each view’s main panel, there is a white search “Filter” bar. This allows users to filter through the contents in the current view. Simply type the information to filter the list by, followed by an asterisk (*), and hit Enter. For example, v1* to see all the fields that have “v1” in them.

Components (CTRL+o)

The Components view gives a detailed list of all the connected components in a cloudSwXtch’s network. To navigate to this view, press CTRL+e or click on the view’s name. To switch between components, use the up and down directional keys on the keyboard.

This view includes the following default columns:

• Name - The name of the component

• Class - Either cloudSwXtch, xNIC, or VM (non-xNIC)

• Type

  • X1 or X2 for cloudSwXtch.

  • Type 1, 2, or 3 for xNIC.

  • 1, 2, or 3 for the swXtchBridge.

• RX bps - The total ingress bits per second that the component is receiving.

• RX pps - The total ingress packets per second that the component is receiving.

• TX bps - The total egress bits per second that the component is transmitting.

• TX pps - The total egress packets per second that the xNIC is transmitting.

• Primary IP - The primary (ctrl) interface IP address

• OS - Operating System (if reported)

• Version - Version of the component

• Primary Swxtch - This lists the cloudSwXtch the xNIC or swXtchBrige was installed against

NOTE

Any component that has a version mismatch regarding the cloudSwXtch will be displayed in red

There are additional columns users can add to the view (with F3 key):

In panel 3, Interfaces are displayed when in the Component view, detailing the interfaces of a selected component (see above).

Filtering Out Components

Next to the Filter search bar, there is a selector that allows users to filter by the type of objects. Simply pressing the Class button, a small window will appear that lets the user choose the objects to show (several objects may be selected at once):

Streams (CTRL+s)

This tree view shows all the multicast groups that are being received and/or transmitted by the cloudSwXtch and how they interact with the various endpoints.

This view includes the following columns:

• Streams - The name of the stream IP and Port. This could also be an Alias set in wXcked Eye. For example, BaseballCamera1 and BaseballCamera2 were Aliases assigned in wXcked Eye.

• Components: swxtch, xNIC or VM (Virtual Machine w/o xNIC)

• Protocol: Multicast or Broadcast

• RX Pkts: The total ingress packets per second (PPS) received by the component.

• RX Bits: The total ingress bits per second (BPS) received by the component.

• TX Pkts: The total egress PPS transmitted by the component.

• TX Bits: The total egress BPS transmitted by the component.

In the example above, stream 239.1.1.1:10000 is listed. It is being transmitted by an endpoint (ip-172-51-128-126) to the cloudSwXtch (ip-172-51-128-88), and the cloudSwXtch (ip-172-51-128-132), which is then sent to the endpoint ip-172-51-128-204 by both cloudSwXtches (this configuration is called High Availability and gives redundancy; users can learn about it in the High Availability section).

Stream Links (CTRL+k)

The Stream Links view displays all the cloudSwXtch network components and the streams they are linked to. To expand a component, simply use the up and down keys on the keyboard and hit ENTER to select, or click with a mouse if the console supports it.

The default columns are:

• Components: cloudSwXtch, bridge or endpoints (xNICs)

• Direction: Either Ingress or Egress, depending on whether data is being ingested or transmitted by the component

• Protocol: The protocol used in the stream

• Bits (bps): Bits per second

• Pkts (pps): Packets per second

• Frag-Pkts (fpps): Fragmented packets per second

• Frags/Pkts: Total # of Fragmented Packets

• Missing Packets: Packets that did not reach their destination

• OOO Pkts: Out of order packets

Adaptors (CTRL+d)

HA - High Availability (CTRL+a)

Lossless (CTRL+L)

Aliases (CTRL+e)

The Aliases section provides users with a detailed list of user-assigned names for components and streams. It is split into two sections: Component Aliases and Stream Aliases.

For Component Aliases, the following columns will display:

• Alias  

• Primary IP

• Hostname

• Class

For Stream Aliases, there are only two columns:

• Alias

• Stream

PTP (CTRL+p)

**At this time PTP  can only be manually installed please contact support@swxtch.io for further instructions. Therefore this page will appear blank.

Subscriptions (CTRL+u)

The Subscriptions page details the different source list configurations for single-source multicast (SSM) and multiple multicast (MMC) groups. Here, users will get a detailed list of included and excluded streams and the source they originate from.

Notifications (CTRL+n)

Configurations (CTRL+f)

The Configurations view gives users a visualization of the xNICs’ configuration JSON files.

Licensing (CTRL+g)

The Licensing view gives a breakdown of the entitlements allotted to each of the cloudSwXtches included in the network.

Depending on their license, users will have a set number for their Max bandwidth, Max clients. and Max bridges.

In addition to the Licensing details, the Details panel lists the expiration date of the license and the license type for a selected cloudSwXtch.