Running DataBrowser

Run the installed DataBrowser with a running Pivotal GemFire system.

DataBrowser connects directly to a running GemFire JMX Manager or GemFire Locator to run its queries.

The DataBrowser connects to a running JMX Manager to discover the data regions and cache servers in a GemFire distributed system and display them in the user interface. Queries must be executed by selecting data region, and optionally, a member that is hosting the region. If no member is indicated, the DataBrowser automatically selects the first region host that it finds.

Note: The DataBrowser does not guard against executing complex queries such as those that do a join across regions on a cache server that does not have all the regions required by the query.
To run the DataBrowser tool, perform the following steps:
  1. Make sure that at least a JMX Manager or a Locator has been started and is running in the GemFire distributed system that you want to connect to and query. See Starting a JMX Manager or Pivotal GemFire Locator Process for information on starting or viewing status of JMX Manager or Locators.
  2. Add any application classes in the CLASSPATH so that DataBrowser can deserialize objects that it receives from queries. These application classes can also be set in the DataBrowser's preferences.
  3. Since the DataBrowser creates a temporary directory upon startup, make sure you have write permissions to the DataBrowser directory.
  4. You can start the DataBrowser either by executing the DataBrowser scripts directly or by starting the tool through the gfsh console.
    To execute DataBrowser using the scripts, run one of the following scripts (depending on your OS) located in the <product_directory>/Tools/DataBrowser/bin directory:
    • Windows
      prompt>databrowser.bat
    • Unix/Linux
      databrowser

    When starting DataBrowser directly through the DataBrowser script, you may want to explicitly set the JVM heap size to a value suitable for the result sizes that you expect for your queries. Set the desired JVM heap size using your JAVA_ARGS variable.

    To start the DataBrowser using the gfsh console:
    1. Start gfsh. See Starting gfsh if you're new to gfsh.
    2. Connect to a running Locator or JMX Manager node.
      Note: If you do not have a running Locator or JMX Manager node, start one. See start locator.
    3. At the gfsh prompt, enter the following:
      gfsh>start data-browser
    The DataBrowser window appears and will be automatically connected to the running Locator.
  5. For SSL connections: If you need to connect DataBrowser to a SSL-enabled JMX Manager, locator or server, then you need to specify SSL authentication when starting up DataBrowser.

    Use SSL authentication for DataBrowser by setting the JAVA_ARGS environment variable. For example:

    Unix/Linux:
    JAVA_ARGS=${JAVA_ARGS} \
    -Djavax.net.ssl.keyStoreType=jks \
    -Djavax.net.ssl.keyStore=/path/to/trusted.keystore \ 
    -Djavax.net.ssl.keyStorePassword=password \
    -Djavax.net.ssl.trustStore=/path/to/trusted.keystore \
    -Djavax.net.ssl.trustStorePassword=password;
    export JAVA_ARGS
    Windows:
    set JAVA_ARGS="%JAVA_ARGS% ^
    -Djavax.net.ssl.keyStoreType=jks ^
    -Djavax.net.ssl.keyStore=/path/to/trusted.keystore ^ 
    -Djavax.net.ssl.keyStorePassword=password ^
    -Djavax.net.ssl.trustStore=/path/to/trusted.keystore ^
    -Djavax.net.ssl.trustStorePassword=password