Try TT Now

ICE Gateway

Troubleshooting Connection Quality

Overview

The Connection Quality Tools help troubleshoot problems associated with downed or improperly connected feeds.

There are three Connection Quality Tools available:

  • TT ICE Tester - quickly checks the standard connection between the ICE Gateway and the Exchange.
  • TT ICE Bandwidth - checks the multicast feed for packet loss.
  • TT ICE Listen - listens to the price data that the ICE sends.

You can either use the tools on the server machine that hosts the ICE Gateway or a standalone server. In both approaches, you use the same procedure to run the tests however, you must pre-configure the server as described below.

Before Using the Tools on a ICE Gateway

Use the following procedure to use the TT ICE Tester, TT ICE Bandwidth, and/or the TT ICE Listen tools on a server that hosts the ICE Gateway.

Note

The following procedure describes the default setup and behavior of the Connection Quality Tools. For a description of the available command line parameters to modify the default behavior, refer to Command Line Parameters.

To use Connection Quality Tools on a ICE Gateway:

  1. Copy your current hostinfo.cfg file from the ttconfig directory and paste this file into the ttExchange-flavor directory.

    When running the tools on a ICE Gateway, this directory is considered the working directory.

    Note

    By default, all tools create log files and utilize the hostinfo.cfg file within the working directory.

  2. Rename the copied hostinfo.cfg file as ICE_IPEHostinfo.cfg.
  3. Copy your current MulticastGroups.cfg file from the ttconfig directory and paste this file into the ttExchange-flavor directory.

    This allows you to test your existing configuration settings.

    You can now execute the Connection Quality Tools as described in Executing the Tests.

Before Using the Tools on a Standalone Server

Use the following procedure to use the TT ICE Tester, TT ICE Bandwidth, and/or the TT ICE Listen tools on a standalone server (i.e., a server that does not host a ICE Gateway).

To use Connection Quality Tools on a standalone server:

  1. Contact your TAM to obtain the ICETools.zip file.
  2. Using an unzip program, extract the contents of the ICETools.zip file into any directory.

    This creates a folder called ice_tools. When running the tools on a standalone server, this location is considered the working directory.

    Note

    By default, all tools create log files and utilize the hostinfo.cfg file within the working directory.

  3. In the working directory, double-click the vcredist_x86.exe file to install the required runtime libraries on the standalone server.

    You can now execute the Connection Quality Tools as described in Executing the Tests.

Executing the Tests

After performing the appropriate configuration above, you can start the TT ICE Tester, TT ICE Bandwidth, and/or the TT ICE Listen tools by double-clicking the executable file (.exe) located in the working directory.

By default, the connection quality tool outputs the results to the console window and creates a separate log file for each channel with the naming convention: tt_ice_tool_channel.Mode_Date.log where:

  • tool: is the name of the connection quality tool: bandwidth, listen or tester.
  • channel: equals the name of the multicast channel. For example: CanadaOptions.
  • Mode: equals either Live for the live feed or Snapshot for the snapshot feed.
  • Date: equals four-digit year, two-digit month, two-digit day.

Example Connection Quality Tool log file

tt_ice_bandwidth_CanadaOptions.Snapshot_2010_06_03.log

The TT ICE Tester utility checks that it has received any message from the Exchange (heartbeat included) for a specified number of time. The default amount of time it waits for a message is 60 seconds. After the this time, the user must enter q to complete the test.

In addition to testing the overall status of the connection, the TT ICE Bandwidth tool also checks for packet loss. By default, this tool runs for 60 seconds and prints statistics for each feed. After the this time, the user must enter q to complete the test.

The TT ICE Listen tool records each message received from the price feed and continues listening to the feed until the user enters q to stop the test.

Command Line Parameters

You can use the command line to access the following features in the Connection Quality tools with the following arguments:

Command Line Arguments

Command

Description

-oname

Sets the tool to output all messages to a single logfile. You can replace name with any value. The tool automatically adds the current date and the .log extension to the filename.

For example, entering: tt_ice_listen.exe -o test causes the TT ICE Listen tool to write all output to a file similar to test_2010_06_03.log in the working directory.

-ttime

Sets the tool to run for the amount of time, in seconds, listed after the -t. By default, the TT ICE Bandwidth and TT ICE Tester tools run for 60 seconds.

The TT ICE Listen tool ignores this parameter and runs until the user enters q to quit.

-h

Access the help menu and display the complete list of commands.

-eexchangename

Sets the exchangename (e.g. ICE_IPE-A) of the hostinfo.cfg file. By default, the connection quality tools use the ICE_IPE exchangename.

-l

Sets whether the tool writes output to the command window. This argument allows two values:

  • Y: The tool writes all output to the command window and the log file.
  • N: The tool only writes output to the log file.

By default, the tools behave as set to Y and forward all output to both the command window and the log file.

Setting the file directories

-ddirectory

Sets the output directory for the logfile. The directory must already exist.

By default, the tools use the working directory.

-cdirectory

Sets the location of the hostinfo.cfg file.

By default, the tools use the working directory.

Set custom configuration values: The arguments below work in tandem to configure the connection quality tools. When all values are present, the tools ignore values set in the hostinfo.cfg file and use the specified values to test the connection.

-pIP address

Sets the IP address of the local network interface card (NIC) that listens to the multicast traffic. Similar to the MulticastNetworkInterface parameter in the hostinfo.cfg file.

-mMulticast

Sets the multicast channel for the tool to use. Must appear in the form IP:port.

For example: -m 255.1.2.3:20001.

-fFeed

Sets whether the tool should use L for the Live feed or S for the Snapshot feed.

TT ICE Tester Results

By default, the TT ICE Tester creates a separate log file for each channel. TT recommneds using the -o command line parameter to cause the tool to create a single log file.

The following illustrates the results the TT ICE Tester writes to a single log file:

To interpret the TT ICE Tester results:

  1. The utility then prints the IP address of each test channel and returns a PASSED or FAILED message.

    Example

    Run test starting

    19.02.2010 15:09:20.734 | tt_ice_tester.exe | 1196 | INFO | 00000000 | Test FAILED for EuropeOilFutures.Live

    19.02.2010 15:09:20.734 | tt_ice_tester.exe | 1196 | INFO | 00000000 | Test PASSED for EuropeOilFutures.Snapshot

    19.02.2010 15:09:20.734 | tt_ice_tester.exe | 1196 | INFO | 00000000 | Test PASSED for USFinFutures.Live

    19.02.2010 15:09:20.734 | tt_ice_tester.exe | 1196 | INFO | 00000000 | Test FAILED for USFinFutures.Snapshot

    19.02.2010 15:09:20.734 | tt_ice_tester.exe | 1196 | INFO | 00000000 | Test FAILED for USAggFutures.Live

  2. The utility produces a FAILED test result when no message is received within 60 seconds.

TT ICE Bandwidth Results

The following illustrates the results the TT ICE Bandwidth tool writes to the tt_ice_bandwidth.exe_<Date>.log logfile:

At the end of the test, the utility prints a summary that shows the number of received and number of dropped packets.

The example below shows a summary with no dropped packets.

Example tt_ice_bandwidth.exe Summary

12.02.2010 11:29:49.574 | tt_ice_bandwidth.exe | 8208 | INFO | 00000000 | Statistics for EuropeOilFutures.Live on local Address 191.157.18.24

12.02.2010 11:29:49.574 | tt_ice_bandwidth.exe | 8208 | INFO | 00000000 | Packets Received: 62

12.02.2010 11:29:49.574 | tt_ice_bandwidth.exe | 8208 | INFO | 00000000 | Packets Dropped: 0

12.02.2010 11:29:49.574 | tt_ice_bandwidth.exe | 8208 | INFO | 00000000 |