Oracle® Enterprise Manager

System Monitoring Plug-in Installation Guide for Apache Tomcat

Release 12.1.0.1.0

E28545-04

February 2014

This document provides installation instructions and configuration information for the Non-Oracle Middleware plug-in for Apache Tomcat. You can find the following information in this document:

- Description

- Supported Versions

- Prerequisites

- Downloading the Plug-in

- Deploying the Plug-in

- Discovering Targets

- Verifying and Validating the Plug-in

- Metrics Collected by the Plug-in

- Reports

- Alerts

- Upgrading the Plug-in

- Undeploying the Plug-in

1 Description

Apache Tomcat is an open source application server that implements the Java Servlet and Java Server Pages (JSP) specifications, providing an environment for Java code to run in. The Non-Oracle Middleware plug-in for Apache Tomcat extends Oracle Enterprise Manager Cloud Control 12c to add support for managing it.

By deploying the plug-in within your Cloud Control environment, you can use management features, such as availability and performance metrics, reports, and alerts.

2 Supported Versions

This plug-in supports the following versions of products:

- Enterprise Manager Cloud Control 12c Release 1 or higher (Oracle Management Service and Oracle Management Agent)

- Apache Tomcat 7.x and earlier.

3 Prerequisites

The following prerequisites must be met before you can deploy the plug-in:

- Apache Tomcat is installed.

- Apache Tomcat is running on JDK 1.5. Therefore, remote JMX monitoring must be enabled when you start Apache Tomcat.
You can enable JMX by adding -Dcom.sun.management.jmxremote.port to the following startup scripts:

For UNIX and Linux:

catalina.sh

For Microsoft Windows:

catalina.bat

For more information about remote monitoring and management, refer to the following link:

http://download.oracle.com/javase/1.5.0/docs/guide/management/agent.html

- The following are installed:
Enterprise Manager Cloud Control 12c Release 1 or higher (Oracle Management Service and Oracle Management Agent) is installed.

You can install the Management Agent on the same computer as Apache Tomcat (referred to as local Agent monitoring) or on a different computer (referred to as remote Agent monitoring). The way you configure the local or remote Management Agent is the same.

If you are using a remote Management Agent, then ensure that the Management Agent has access to the computer on which Apache Tomcat instance is running and the JMX port on which it is listening.

- For monitoring an Apache Tomcat target, do not use a Management Agent that is already monitoring one of the following:

- Oracle WebLogic Managed Server

- IBM WebSphere Application Server

- JBoss Application Server

This is because different target types use different JMX versions, which could lead to metric collection errors for Apache Tomcat.

The following is an example of such a metric collection error for Apache Tomcat:

oracle.sysman.emSDK.emd.fetchlet.FetchletException:
oracle.sysman.emSDK.emd.fetchlet_FetchletException:
java.lang.SecurityException: sealing violation: package javax.management is sealed

4 Downloading the Plug-in

You can download plug-ins in online or offline mode. Online mode refers to an environment where you have Internet connectivity, and can download the plug-in directly through Enterprise Manager from My Oracle Support. Offline mode refers to an environment where you do not have Internet connectivity, or where the plug-in is not available from My Oracle Support.

See the Managing Plug-ins chapter in the Oracle Enterprise Manager Cloud Control Administrator's Guide for details on downloading the plug-in in either mode:

http://docs.oracle.com/cd/E24628_01/doc.121/e24473/plugin_mngr.htm#CJGBEAHJ

5 Deploying the Plug-in

You can deploy plug-ins to an OMS instance using the Enterprise Manager Cloud Control interface or the EM Command Line Interface (EMCLI). While the graphical interface mode enables you to deploy one plug-in at a time, the command line interface mode enables you to deploy multiple plug-ins at a time, thus saving plug-in deployment time and downtime, if applicable.

See the Managing Plug-ins chapter in the Oracle Enterprise Manager Cloud Control Administrator's Guide for instructions on deploying the plug-in:

http://docs.oracle.com/cd/E24628_01/doc.121/e24473/plugin_mngr.htm#CJGCDHFG

6 Discovering Targets

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

1. Log in to Enterprise Manager Cloud Control.

2. Click Setup, then Add Targets, and finally Add Targets Manually.

3. Select Add Non-Host Targets by Specifying Target Monitoring Properties. From the Target Type drop-down, select the Apache Tomcat target type. Click Add Manually.

4. On the Add Apache Tomcat page, provide the following information for the properties:

- Host — Host of the Apache Tomcat instance. This property is always required.

- JMX Port Number — Remote JMX port. This property is always required.

- JMX User Name — Required when authentication is enabled for JMX.

- JMX Password — Required when authentication is enabled for JMX.

- Communication Protocol — Communication protocol used by remote JMX client. Do not change the default value specified unless the remote JMX implementation has changed.

- Service Name — JMX service name. Do not change the default value specified unless the remote JMX implementation has changed.

- SSL Trust Store — Required when SSL is enabled for Apache Tomcat.

- SSL Trust Store JMX Password — Required when SSL is enabled for Apache Tomcat.

- Apache Tomcat Version — Version of Apache Tomcat (for example, 7.0, 6.0, 5.5.23, etc.). This property is always required and is used to determine the specific performance metrics to be monitored and/or collected.

Note:
You must not change the default values of Communication Protocol and Service Name unless the remote JMX implementation has changed.

After deploying and configuring the plug-in to monitor one or more targets in the environment, you can customize the monitoring settings of the plug-in. This alters the collection intervals and threshold settings of the metrics to meet specific needs of your environment. If you decide to disable one or more metric collections, this could impact the reports that the metric is a part of.

7 Verifying and Validating the Plug-in

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

1. On the Agent home page, from the Monitored Targets table, click the Apache Tomcat target link.
The Apache Tomcat home page appears.

2. Verify that no metric collection errors are reported in the Alerts section.

3. Ensure that reports can be seen and no errors are reported by selecting the Reports property page.

8 Metrics Collected by the Plug-in

Metrics are units of measurement used to determine the health of a target. To find a complete list of all the metrics for a target, click All Metrics in the Related Links section of the target home page. From the All Metrics page, you can view all the metric categories for the target and then drill down to any particular metric for additional information.

After adding the target to Enterprise Manager, you can then customize the monitoring configuration of the target; for instance, you can modify metric threshold values, change metric collection schedules, and disable collection for some metrics.

9 Reports

Several predefined, performance-based reports are provided for Apache Tomcat. Such reports include:

- Apache Tomcat Load - Charts of total load on all global request processors

- All Applications Load - Applications load charts at server level

- Apache Tomcat Thread Pools - Thread pools active threads and total thread charts

- Datasources - Datasources active connections and idle connections charts

- Global Request Processors Load And Performance - Global request processor load and performance charts

- Memory Utilization - Resource utilization charts

- Top 10 Applications Based On Total Sessions - Top 10 applications based on sessions created during the last 24 hours

- Top 10 Servlets Based On Total Requests - Top 10 servlets by number of requests on each servlet during the last 24 hours

Additionally, custom reports can also be generated based on data stored in the Management Repository.

10 Alerts

You can configure Enterprise Manager to send alerts notifying you of problems with the target. To receive alerts on the console, specify warning and/or critical threshold levels for those metrics of importance to you.

To edit a threshold:

1. Choose Metric and Policy Settings on any target home page.

2. From the Metric Thresholds page, you can either modify warning and/or critical thresholds directly from the table.
Alternatively, click the Edit icon (pencil) to access the Edit Advanced Settings page.

An alert is triggered when one of the following conditions is true:

- A metric threshold is reached.

- The availability of a monitored service changes.

- A metric-specific condition occurs.

11 Upgrading the Plug-in

The Self Update feature allows you to expand Enterprise Manager's capabilities by updating Enterprise Manager components whenever new or updated features become available. Updated plug-ins are made available via the Enterprise Manager Store, an external site that is periodically checked by Enterprise Manager Cloud Control to obtain information about updates ready for download. See the Updating Cloud Control chapter in the Oracle Enterprise Manager Cloud Control Administrator's Guide for steps to update the plug-in:

http://docs.oracle.com/cd/E24628_01/doc.121/e24473/self_update.htm

12 Undeploying the Plug-in

See the Managing Plug-ins chapter in the Oracle Enterprise Manager Cloud Control Administrator's Guide for steps to undeploy the plug-in:

http://docs.oracle.com/cd/E24628_01/doc.121/e24473/plugin_mngr.htm#CJGEFADI

13 Documentation Accessibility

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

Access to Oracle Support

Oracle customers have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.

System Monitoring Plug-in Installation Guide for Apache Tomcat, Release 12.1.0.1.0

E28545-04

Copyright © 2014, Oracle and/or its affiliates. All rights reserved.

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). Oracle America, Inc., 500 Oracle Parkway, Redwood City, CA 94065.

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

This software or hardware and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.

Oracle Legal Notices

Copyright Notice

Copyright © 1994-2016, Oracle and/or its affiliates. All rights reserved.

License Restrictions Warranty/Consequential Damages Disclaimer

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

Warranty Disclaimer

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

Restricted Rights Notice

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

Hazardous Applications Notice

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Trademark Notice

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

Third-Party Content, Products, and Services Disclaimer

This software or hardware and documentation may provide access to or information about content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.

Alpha and Beta Draft Documentation Notice

If this document is in preproduction status:

This documentation is in preproduction status and is intended for demonstration and preliminary use only. It may not be specific to the hardware on which you are using the software. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to this documentation and will not be responsible for any loss, costs, or damages incurred due to the use of this documentation.

Private Alpha and Beta Draft Documentation Notice

If this document is in private preproduction status:

The information contained in this document is for informational sharing purposes only and should be considered in your capacity as a customer advisory board member or pursuant to your beta trial agreement only. It is not a commitment to deliver any material, code, or functionality, and should not be relied upon in making purchasing decisions. The development, release, and timing of any features or functionality described in this document remains at the sole discretion of Oracle.

This document in any form, software or printed matter, contains proprietary information that is the exclusive property of Oracle. Your access to and use of this confidential material is subject to the terms and conditions of your Oracle Master Agreement, Oracle License and Services Agreement, Oracle PartnerNetwork Agreement, Oracle distribution agreement, or other license agreement which has been executed by you and Oracle and with which you agree to comply. This document and information contained herein may not be disclosed, copied, reproduced, or distributed to anyone outside Oracle without prior written consent of Oracle. This document is not part of your license agreement nor can it be incorporated into any contractual agreement with Oracle or its subsidiaries or affiliates.

Documentation Accessibility

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

Access to Oracle Support

Oracle customers that have purchased support have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.