Installing and Running VSD

Start the VSD tool, load statistics files, and maintain the view you want on your statistics.

Install VSD

VSD is a free analysis tool and is provided as-is.

VSD is distributed with Pivotal GemFire XD. To install VSD, install Pivotal GemFire XD. See Installing GemFire XD for instructions.

After you install GemFire XD, you can find VSD in the following location of your installation:

<gemfirexd-installdir>/tools/vsd

Where <gemfirexd-installdir> corresponds to the location where you installed GemFire XD. If you installed using the RPM, the default location is /opt/pivotal/gemfirexd.

The VSD tool installation has three subdirectories:
  • bin. The scripts and binaries that can be used to run VSD on a variety of operating systems. The following scripts are included with this release:
    • vsd
    • vsd.bat
    The following binaries are included with this release:
    • vsdwishSunOS - for Solaris
    • vsdwishLinux - for Linux
    • vsdwishWindows_NT.exe - for Windows
    • vsdwishDarwin - for Mac
  • lib. The jars and binary libraries needed to run VSD

Start VSD

To start VSD, execute the scripts directly by enter the following command at the prompt:
  • Windows:
    prompt>vsd
    Note: To run VSD on Windows 7 or later, go to the <gemfirexd-installdir>/tools/vsd/bin directory. Right-click on vsd.bat and select Properties. Click Compatibility and set it to Windows XP. Repeat this step for all other executables in the bin directory.
  • Linux/Unix, MacOS or Other OS:
    $ vsd

Load a Statistics File into VSD

You have several options for loading a statistics file into VSD:
  • Include the name of one or more statistics files on the VSD command line. Example:
    vsd <filename.gfs> ...
  • Browse for an existing statistics file through Main > Load Data File.
  • Type the full path in the File entry box, then press Enter.
  • Switch to a statistics file that you’ve already loaded by clicking the down-arrow next to the File entry.

After you load the data file, the VSD main window displays a list of entities for which statistics are available. VSD uses color to distinguish between entities that are still running (shown in green) and those that have stopped (shown in black).

Maintain a Current View of the Data File

If you select the menu item File > Auto Update, VSD automatically updates your display, and any associated charts, whenever the data file changes. Alternatively, you can choose File > Update periodically to update the display manually.

About Statistics

The statistics values (Y-axis) are plotted over time (X-axis). This makes it easy to see how statistics are trending, and to correlate different statistics.

Some statistics are cumulative from when the GemFire XD system was started. Other statistics are instantaneous values that may change in any way between sample collection.

Cumulative statistics are best charted per second or per sample, so that the VSD chart is readable. Absolute values are best charted as No Filter.