Running DataBrowser

Run the installed DataBrowser with a running vFabric GemFire system.

DataBrowser connects to a running GemFire JMX admin agent to run its queries.
Note: DataBrowser creates a temporary directory on startup. Hence, the user should have write permissions to the DataBrowser directory.

  • In the GemFire product bin directory, execute agent start to start the AdminAgent in the GemFire distributed system. Refer to Starting the vFabric GemFire JMX Agent in the GemFire User's Guide for information on starting the AdminAgent with non-default options. By default, the AdminAgent listens on port 1099 for RMI clients.
  • Set the GEMFIRE environment variable to point to the product directory containing the same gemfire.jar used by the AdminAgent.
  • Add any application classes in the classpath. These can also be set in the DataBrowser's preferences.
  • To start the DataBrowser, execute databrowser.bat (Microsoft Windows) or the databrowser shell script (Linux).
    Note: You may want to explicitly set the JVM heap size in these start scripts to a value suitable for the result sizes that you expect for your queries.
  • To specify SSL configuration for Data Browser when JMX Agent has SSL enabled, use the environment variable JAVA_ARGS. Windows example:
    set 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"

    Linux example:

    export 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"
  • Data Browser also connects as a cache client to GemFire Distributed System members that are running cache servers . If the servers have SSL enabled, in addition to the above properties, you may need to specify additional properties such as the following when starting Data Browser:
    • ssl-enabled
    • ssl-protocols
    • ssl-require-authentication
    • ssl-ciphers
    For information on these properties, see SSL in the "Managing GemFire" section of the GemFire User's Guide. To specify these properties, use the environment variable JAVA_ARGS after adding a prefix "-Dgemfire" when starting up the DataBrowser. For example:
    -Dgemfire.ssl-enabled=true
    -Dgemfire.ssl-protocols=any
    -Dgemfire.ssl-require-authentication=true
    -Dgemfire.ssl-ciphers=SSL_RSA_WITH_NULL_SHA"
The DataBrowser connects to a running AdminAgent 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.