Using the environment checker utility

The environment checker utility helps you identify connectivity issues between the PATROL Agent, the communication channel, and the JAVA process. This utility communicates with the JAVA process without the need to connect to a PATROL Agent.

When you face connection issues with an Apache Tomcat or Generic Java Server environment, it is difficult to identify the exact problem. It takes time and effort to understand if the issue is related to the PATROL Agent and the channel between the PATROL Agent and the JAVA process, or the issue is related to the JAVA process and the connection between the monitoring environment.

The environment checker tool acts like a JAVA client and connects directly to the Tomcat or Generic Java Server environment. When you provide the connection details to this utility, it tries to connect and discover the system. Based on the result, you know if the issue was related to the environment configuration or the PATROL Agent.

The environment checker utility is located at:

  • <<Patrol home>>/Patrol3/<<KM directory>>/envChecker.sh  (UNIX)
  • <<Patrol home>>\Patrol3\<<KM directory>>\envChecker.bat  (Windows)

Related topic

Troubleshooting

Use the following information to work with the checker utility:

Before you begin

  • Ensure that the PATROL_HOME environment variable is defined

  • Ensure that the JAVA_HOME environment variable is defined and set to JRE 1.8 and later versions

    Note

    Use the same JAVA path that is used to configure the problematic Tomcat or Generic Java Server environment from the PATROL Agent.

  1. Open a command prompt window or shell.
  2. Run the script <<Patrol home>>\Patrol3\<<KM directory>>\envChecker.bat (Use .sh script file for  UNIX)
  3. Provide the inputs to connect to the Tomcat or Generic Java Server system

To check the connection status with an Apache Tomcat environment

After you open a command prompt window or shell:

  1. Port: Enter the host name or the IP address of a local or remote host. The IP addresses can be in the IPv4 or IPv6 format. 
  2. Tomcat Username: Enter the user name for the monitored JVM.
  3. Tomcat password: Enter the password for the monitored JVM.
  4. SSL key type: Enter one of the following options for the SSL key type used to connect to the Tomcat or Generic Java Server environment:
    • 0–There is no SSL key used for the connection.
    • 1–A one-way SSL key is used for the connection.
    • 2–A two-way SSL key is used for the connection.

If you enter the option for one-way or two-way SSL key types, you need to enter the truststore file path and password, and a keystore file for two-way SSL key connections.

The envchecker utility starts checking the connection between the KM and the monitored environment.

If the connection is working, the utility displays the available data from the monitored environment.

If the connection is not working, the utility displays ERR_M_TCT_CONNECTION_ERROR. Contact your system administrator if there is a connection error.

To check the connection status with a Generic Java Server environment

 After you open a command prompt window or shell:

  1. Port: Enter the host name or the IP address of a local or remote host. The IP addresses can be in the IPv4 or IPv6 format. 
  2. Generic JVM server Username: Enter the user name for the monitored JVM.
  3. Generic JVM server password: Enter the password for the monitored JVM.
  4. Connection type: Enter the server type used to monitor the environment.
    • jmxrmi (default)
    • ARServer  (Remedy server)
  5. SSL key type: Enter one of the following options for the SSL key type used to connect to the Tomcat or Generic Java Server environment:
    • 0–There is no SSL key used for the connection.
    • 1–A one-way SSL key is used for the connection.
    • 2–A two-way SSL key is used for the connection.

If you enter the option for one-way or two-way SSL key types, you need to enter the truststore file path and password, and a keystore file for two-way SSL key connections.

The envchecker utility starts checking the connection between the KM and the monitored environment.

If the connection is working, the utility displays the available data from the monitored environment.

If the connection is not working, the utility displays ERR_M_GJS_CONNECTION_ERROR. Contact your system administrator if there is a connection error.

 

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*