Installing and Uninstalling GFMon

Install GFMon to the location of your choice and customize your environment settings as needed to run GFMon.

To obtain GFMon, go to the VMware download center at http://downloads.vmware.com/d/. Navigate to the vFabric GemFire download page, under the Drivers & Tools tab.

Installation Procedure
  1. The GFMon installation program is distributed as an executable JAR file. Ensure that the path to a supported version of the Java executable is in your PATH environment variable:
    java -version
  2. Change to the directory where you downloaded the GFMon software, and execute the JAR file installer. On the command line, type the following command for your operating system:
    • UNIX and Linux (Bourne and Korn shells - sh, ksh, bash)
      java -jar vFabric_GFMonXX_Installer.jar
      where XX corresponds to the version of GFMon that you are installing.
    • Windows:
       
      java.exe -jar vFabric_GFMonXX_Installer.jar
      where XX corresponds to the version of GFMon that you are installing.
  3. When the License Agreement (EULA) is displayed, press Enter to scroll and read. Enter agree to accept the license.
  4. At the prompt, enter the full path of the directory in which you will install GFMon.

    By default, GFMon is installed in the directory where you executed the JAR file.

  5. Enter yes to create the directory if necessary, or to verify that the installation directory is correct.

    The installer copies the license agreement and installs GemFire to a top-level GemFire directory in the location you specified.

    Note: If you have difficulties getting the installer to work correctly, you can unzip the jar file directly with any common zip extraction tool.

The gfmon.bat and gfmon files are created in the location where you extract the JAR file. Use these files to run GFMon on Microsoft Windows and Linux, respectively.

Note: By default, gfmon.bat and gfmon use the environment variable java to point to the JDK version that is available in the system. If you want to execute GFMon using a specific version of JDK, you can specify the location of the Java executable file using the environment variable GF_JAVA.

You do not need a special GFMon license to run GFMon. GFMon uses your GemFire licensing when you run it with the JMX admin agent.

Uninstall GFMon by deleting the GFMon product tree.

Setting Environment Variables

Set the environment variable GEMFIRE to point to the GemFire product directory. This directory must be the same as the GemFire product directory that is being used by the JMX admin agent that GFMon connects to monitor the distributed system. The GFMon start-up scripts launch GFMon using the gemfire.jar in the GemFire product lib directory.

To use a specific JVM, set the environment variable GF_JAVA to the required JVM binary. For example, on Windows platforms, execute the following command:
set GF_JAVA=C:\jdk1.5.0\bin\java.exe
On Linux platforms, execute:
export GF_JAVA=/jdk1.5.0/bin/java
To specify JVM arguments, use the environment variable JAVA_ARGS. Windows example:
set JAVA_ARGS=-Xms256m
Linux example:
export JAVA_ARGS=-Xms256m
To specify multiple arguments or arguments with equal-to (=), use double quotes (""). Windows example:
set JAVA_ARGS="-Xms256m -Xmx512m"
Linux example:
export JAVA_ARGS="-Xms256m -Xmx512m"
To specify the SSL configuration of GFMon when the 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"