2 Discovering Apache Tomcat Target

To discover your Apache Tomcat target with Enterprise Manager you can:

Discovering Targets

After successfully deploying the plug-in, follow these steps to add the plug-in target to Enterprise Manager for central monitoring and management:

  1. Log in to Enterprise Manager.
  2. Click Setup, select Add Targets, and then select Add Targets Manually.
  3. In the Add Targets Manually page, select Add Target Manually under Add Non-Host Targets Manually, select Target Type as Apache Tomcat, select a Monitoring Agent and click Add Manually.
  4. In the Add Apache Tomcat page, enter the following properties:
    • Target Name: Unique target name across all targets, such as Apache_Tomcat_Hostname. This is the display name in Enterprise Manager. It represents this SQL Server target across all user interfaces within Enterprise Manager.
    • Apache Tomcat Monitoring Credentials
      • Apache Tomcat JMX Username: The username used to connect via JMX to Apache Tomcat. This is optional and should only be used if you are using authentication.
      • Apache Tomcat JMX Password:The password for the account used to connect via JMX to Apache Tomcat. This is optional and should only be used if you are using authentication.
    • Apache Tomcat SSL Truststore Password: The password for the truststore used to connect via JMX to Apache Tomcat. This is optional and should only be used if you are connecting with SSL.

      Note:

      The Trust Store path is required under properties.
    • Properties
      • Communication Protocol:This is the protocol used by JMX to connect to Apache Tomcat. In most cases, this will be ‘rmi’.
      • Host: This is the hostname of the server Apache Tomcat is running on.
      • JMX Port Number: This is the port used to connect to Apache Tomcat via JMX.
      • SSL Trust Store: This is the trust path to the trust store being used to connect to Apache Tomcat via SSL. This is optional and should only be used if you are connecting using SSL.
      • Service Name: This is the unique identifier used to connect to help make the JMX Connection to Apache Tomcat. In most cases this will be ‘jmxrmi’.

Adding Targets with EMCLI

Add Apache Tomcat targets with EMCLI.

To add Apache Tomcat targets with EMCLI, use the add_target verb:

emcli.bat add_target    
    -name=”Tomcat Target”    
    -type=”apache_tomcat”    
    -host=”HostTargetName”   
    -properties=”host:HostTargetName;                
                JMXProtocol:rmi;                
                JMXService:jmxrmi;
                JMXPort:1099” 

You will need to specify the following options:

Target name: *-name* It must begin with an alphabetic character contain only alphanumeric characters, multibyte characters, a space, -, _, ., :, /, (, ) and have a maximum length of 256 characters.

Target type: *-type* Always use "apache_tomcat" (including the quotes).

Host name: *-host* Network name of the machine running the Management Agent that is collecting data for this target instance.

Target instance Properties: *-properties* Name-value pair list of properties for the target instance. The available property names are as follows.
Host
JMXPort
JMXUsername
JMXPassword
JMXProtocol 
JMXService
SSLTrustStore 
SSLTrustStorePassword

Properties separator delimiter: *-separator=properties* Specify a string delimiter to use between name-value pairs for the value of the -properties option. The default separator delimiter is “;”.

Properties subseparator delimiter: *-subseparator=properties* Specify a string delimiter to use between name and value in each name-value pair for the value of the -properties option. The default subseparator delimiter is “:”.

Verifying and Validating the Plug-in

After waiting a few minutes for the plug-in to start collecting data, use the following steps to verify and validate that Enterprise Manager is properly monitoring the plug-in target:

  1. Click the Apache Tomcat target link from the All Targets page.
  2. Verify no metric collection errors are reported by clicking Monitoring and then Metric Collection Errors from the Target menu.
  3. Ensure that reports can be seen, and no errors are reported by clicking Information Publisher Reports in the Target menu and viewing reports for the Apache Tomcat target type.
  4. Ensure that configuration data can be seen by clicking Configuration and then Last Collected in the Target menu. If configuration data does not immediately appear, click Refresh in the Latest Configuration page.