Registering an Apache Tomcat environment

Providing configuration information that defines your Apache Tomcat environment to the PATROL monitoring environment includes registering the Apache Tomcat environment.

Before you begin

You must have installed and loaded PATROL for Apache Tomcat.

The operating system user account must have read and execute permissions for the Java Home directory, and full access to the ../Patrol3/TCT directory.

To register an Apache Tomcat environment

1. Choose Apache Tomcat > KM Commands > Register...
    The Register Apache Tomcat Environment  dialog box is displayed, as shown in the following figure:
   
   Register Apache Tomcat Environment dialog box
    

2. In Host/IP, enter the host name or IP address of a local or remote host. 
   IP addresses can be in the IPv4 or IPv6 format. 
   
   

   Example

   [2001:db8:28:3:f98a:5b31:67b7:67ef] is an IPv6 address.

3. In Port, enter the JVM port number that the KM will use.
4. (Optional) In User name, enter a valid Apache Tomcat account user name.

5. (Required only if you enter a Apache Tomcat user name in the preceding step) In Password, enter the password for the Apache Tomcat account.

   Note

   To determine whether you need to specify username and password, log into the JConsole and open the VM Summary tab. In the connection name: field, you can see if a user has been entered or not. 

   The JConsole binary comes with the JDK installation and resides in the Tomcat bin directory.

6. In the TrustStore Filename text box, enter the TrustStore filename, for 1 and 2 way SSL.

7. In the TrustStore Password text box, enter the TrustStore password, for 1 and 2 way SSL.

8. In the Keystore Filename text box, enter the Keystore filename, for 2 way SSL.

9. In the Keystore Password text box, enter the Keystore filename, for 2 way SSL.

10. In Java Home Directory, enter the path of the directory in which Java is installed on the local host. 

11. In Local Administrator OS Account, enter a valid operating-system user name for the computer on which Apache Tomcat is installed.

12. In Local Administrator OS password, enter the password for the operating system user account.
13. In the Monitoring Options pane, select one or more of the following options:

    • Server Availability - monitors the availability status of the Tomcat Server.

    • General Health - monitors the availability status, Thread Pool, Memory, and Operating System groups.

    • Full - monitors all groups supported by the Tomcat KM.

    • Custom - monitors the availability status and then select individual Custom Monitoring Options from the next dialog box.

    Note

    -Option Full is the same as Custom with all the boxes selected.

    -Option Server Availability is the same as Custom with none of the boxes selected.

14. If you have selected the Custom option in the previous step, click Custom selection (applied only if Custom option has been chosen). The custom monitoring options dialog box is displayed.  In the Custom Monitoring Options dialog box, select one or more custom monitoring options.
    
    Custom Monitoring Options dialog box
    
    
15. (Optional) In the PATROL Defined ID (optional) text box, enter the PATROL defined ID.
16. Click OK.

Related topic

Editing an Apache Tomcat environment