Capture sends & receives to troubleshoot slow or unresponsive devices

Important Note:

You must be in Runtime Mode in the Configuration to be able to access the diagnostics. See Offline Editing for more information.

Real-time monitoring of sends and receives to your devices

The Communications Diagnostics feature in the TOP Server provides a streaming protocol view and real-time performance data for your TOP Server communications driver. All read and write operations can be viewed in the diagnostic display window or can be tracked directly in your Client Application using TOP Server’s built-in Statistics tags.

These diagnostics make it easy to debug tough communication issues. See the guide to Using the TOP Server Channel Diagnostics for detailed information on using the Channel Diagnostics.

Analyze whether your devices are responding and how long it took

TOP Server communications diagnostics at both the channel and device level can be persisted to file for longer term troubleshooting purposes. This allows greater flexibility in troubleshooting issues with specific devices that sometimes occur when you may not be around.

And each send and receive is timestamped.  This helps with analyzing the roundtrip communications time with a device to diagnose responsiveness for a particular device.  You can easily see how long it took a device to respond to the last request, allowing you to confirm if an issue is the device or something else.

Communication diagnostics are supported for most TOP Server drivers

While Communication Diagnostics are supported for most Ethernet and serial driver, there are some driver, due to their nature, that do not support diagnostics.

Drivers NOT supporting device-level communications diagnostics at this time are highlighted in the diagram to the left.

 

Enabling TOP Server Communication Diagnostics

The TOP Server Communication Diagnostics can be found under the Diagnostics for any channel or device configured. The diagnostics must be enabled in the channel properties to take be available.

Right-click on your channel and choose Properties and in the General section select Enable for "Diagnostics Capture".

Once enabled, you can view the diagnostics through right-clicking on the desired channel or device and selecting "Diagnostics".

Communications Diagnostics Log Settings:

You can right-click on the black area of the diagnostics window and you can change your options and save or copy the protocol information shown. Sending this to our support team with an Application Report allows them to see exactly what communications is happening between your hardware and the TOP Server.

Settings for configuring persistence to file for channel or device diagnostics are accessed from the TOP Server Administration Settings under the Event Log tab.

  • Persistence Mode
    • Memory (no persistence) - The default option follows the legacy behavior of communications diagnostics and are not persisted to file in this mode.
    • Single File - All diagnostics records will be persisted to one file only.
    • Extended Data Store - Enables spanning of diagnostics records across multiple files based on the other settings.
  • Max Records - Maximum number of records that the log can contain before the oldest records start being overwritten (Only available for Memory or Single File modes).
  • Log File Path - File system directory where log files will be stored
  • Max single file size (KB) - Maximum size in KB that any one log file can contain. (Only available for Extended Data Store Mode).
  • Min days to preserve - Once log files are older than this number, they will be deleted. (Only available for Extended Data Store Mode).

Get Started Now

The demo is the full product once licensed. Once a client application connects to the  TOP Server, the TOP Server runtime will operate for 2 hours at a time. At the end of the 2 hour demo period, the demo timer must be reset by restarting the TOP Server runtime service.

Connect with Us

1-888-665-3678 (US + Canada toll free)
+1-704-849-2773 (Global)
support.softwaretoolbox.com