WxckedEye

SwXtch WxckedEye Dashboard Metrics Collector

The purpose of this script module is to collect the WxckedEye dashboard api metrics from the SwXtch cloud transport system.

The data collection module has the below distinct abilities and features:

1. Collects total metric counters
2. Collects agent metric counters
3. Collects replicator metric counters

Minimum Requirements:

• inSITE Version 11 and service pack 2
• Python3 (already installed on inSITE machine)
• Python3 Requests library (already installed on inSITE machine)
• python3-dateutil (sudo apt-get install python3-dateutil)
• Quantiphy Python Package (If using the PTP Timing Metrics from WxckedEye)
  • pip install quantiphy
  • pip install quanitiphy==2.10 (For inSITE Servers on Ubuntu 16)

Installation:

Installation of the API collection module requires copying the below script into the poller modules folder:

1. Copy WxckedEye.py script to the poller python modules folder:

    cp scripts/WxckedEye.py /opt/evertz/insite/parasite/applications/pll-1/data/python/modules
   

2. Restart the poller application

Configuration:

To configure a poller to use the module start a new python poller configuration outlined below

1. Click the create a custom poller from the poller application settings page
2. Enter a Name, Summary and Description information
3. Enter the host value in the Hosts tab
4. From the Input tab change the Type to Python
5. From the Input tab change the Metric Set Name field to swxtch
6. Select the Script tab, then paste the contents of scripts/poller_config.py into the script panel.
7. Save changes, then restart the poller program.

Sample Output

{
   "l_pktcounters_nic2mcatotal": 313922,
   "l_pktcounters_nic2mcamc": 336743,
   "l_pktcounters_mca2nictotal": 329269,
   "l_pktcounters_mca2nicmc": 337535,
   "l_pktcounters_mca2nicigmp": 450849,
   "l_pktcounters_mca2nicdrops": 395667,
   "l_pktcounters_nic2mcadrops": 426963,
   "l_pktcounters_mca2knidrops": 350917,
   "l_pktcounters_kni2mcadrops": 360818,
   "l_pktcounters_mcapktdrops": 344067,
   "l_pktcounters_mcabigpktdrops": 349137,
   "l_bytecounters_nic2mcatotal": 409877,
   "l_bytecounters_nic2mcamc": 381385,
   "l_bytecounters_mca2nictotal": 458335,
   "l_bytecounters_mca2nicmc": 324917,
   "l_latencies_count": 0,
   "l_latencies_sum": 0,
   "l_info_timestamp": 1657216501229158000,
   "s_info_softwareversion": "v1.7.4.draft",
   "s_info_xnicversion": 2,
   "s_agent": "Agent-1"
}

{
  "fields": {
   "s_groupip": "239.0.0.2",
   "l_pktscount": 406640682,
   "l_bytescount": 551908910280,
   "s_lastupdate": "2023-04-19T13:05:33.40607357Z",
   "s_srcip": null,
   "i_srcport": 0,
   "i_protocoltype": 0,
   "i_numberofdestinations": 0,
   "b_multicast": true,
   "i_num_destinations": 3,
   "l_bitrate": 16491630,
   "s_source": "swxtch-VUE-2",
   "as_destinations": [
    "cvip-nab-demo",
    "swxtch-VUE-1",
    "swxtch-VUE-2"
   ]
  },
  "host": "20.85.176.94",
  "name": "repltotals_multicastgroups"
 }

 {
  "fields": {
   "s_hostName": "cloudswxtch001",
   "s_subscriptionId": "c02a16cc-c49a-49c4-ab3c-ced2938ef462",
   "s_replStatus": "running",
   "s_ipAddr": "10.60.30.143",
   "s_cloud": "AZURE",
   "s_swxtchName": "cloudswxtch001",
   "s_remfVersion": "v1.9.67",
   "i_numcores": 1,
   "b_authorized": true
  },
  "host": "20.85.176.94",
  "name": "top_info"
 }

{
  "fields": {
   "s_name": "swxtch-VUE-2",
   "b_xnicpresent": true,
   "b_timebeatpresent": true,
   "d_localoffset_ms": 0.02586,
   "d_rootoffset_ms": 0.03939,
   "d_localoffset_us": 25.857,
   "d_rootoffset_us": 39.39,
   "s_rootoffset": "39.39 us",
   "s_localoffset": "25.857 us"
  },
  "host": "20.85.176.94",
  "name": "timesyncslave"
 }

Usage

usage: WxckedEye.py [-h] [-host <ip>] [-port <port>] [-proto <http or https>] [-d] [-w] [-t]

wXcked Eye API Poller Program

options:
  -h, --help            show this help message and exit
  -host <ip>, --swxtch-host <ip>
                        Swxtch IP Address (default localhost)
  -port <port>, --swxtch-port <port>
                        Swxtch Port (default 3000)
  -proto <http or https>, --swxtch-protocol <http or https>
                        Swxtch Protocol (default http)
  -d, --dump            Dump the response payload to a file
  -w, --watch           Re-run the collection
  -t, --timesync        Collect TimeSync Metrics (quantiphy package needed)