Tomcat (JMX)Tomcat (JMX)
JMX monitoring of Tomcat connection and thread pools, and web request activity.
Extension
- Product information
- Release notes
Overview
Apache Tomcat is an open-source web server developed by the Apache Software Foundation (ASF) and one of the most popular servlet containers available today. It’s an incredibly lightweight, flexible and extremely stable platform to build on. The OneAgent will allow you to trace activity on and through your Tomcat applications. Using this JMX extension you'll be able to collect additional key performance data to identify issues and optimize your Tomcat configurations.
Use cases
- Identify issues with connection pool utilization and activity that could impact your web applications
- Optimize your thread and connection pool configurations to increase efficiency while not impacting your application clients
- Monitor your web application by viewing web request activity and performance data from Tomcat's perspective in context with other key metrics
Get started
This extension collects connection pool, thread pool, and web request activity and performance for Tomcat.
Prerequisites:
- Tomcat process that runs on a supported Linux or Windows operating system.
- OneAgent version 1.273+
- Dynatrace version 1.273+
To get metric insight:
- Install OneAgent on the virtual machine or server of your Tomcat process.
- Activate the OneAgent feature
Java Metric Extensions 2.0 (JMX).- When enabling for the first time each process will need to be restarted for this feature to become active
- Select in this same tile Add to environment to configure the extension
Details
Metrics are organized into feature sets you can enable/disable as desired.
Additionally, there is one calculated metric included:
- Average request processing time (
func:tomcat.processingTimePerRequest): Request processing time divided by request count
Compatibility information
The following Mbeans are used for collecting data. If you not seeing metrics check that the following Mbeans exist using the tool of your choice (e.g. JConsole).
- Connection pools:
Catalina:type=DataSource,name=*,class=*,context=*,host=*orCatalina:type=DataSource,name=*,class=*
- Thread pools:
Catalina:type=ThreadPool,name=*
- Web request activity
Catalina:type=GlobalRequestProcessor,name=*
For connection pools specifically, this extension only supports the standard Tomcat connection pooling implementation with Mbeans under the Catalina domain. It is not uncommon for a different pooling implementation to be used and in these cases you may need to create your own custom JMX extension to collect similar data (if it is available via JMX). You should consult your implementation's documentation or review available Mbeans in your Tomcat process to get started with this.
Licensing
There is no charge for obtaining the extension, only for the data that the extension ingests. The details of license consumption will depend on which licensing model you are using. This will either be Dynatrace classic licensing or the Dynatrace Platform Subscription (DPS) model.
Metrics
License consumption is based on the number of metric data points ingested. The following formula will provide approximate annual data points ingested assuming all feature sets are enabled.
((16 * <number_of_connection_pools) + (5 * <number_of_web_apps>) + (3 * <number_of_thread_pools>)) * 60 minutes * 24 hours * 365 days data points per year
Classic licensing
In the classic licensing model, metric ingestion will consume Davis Data Units (DDUs) at the rate of .001 DDUs per metric data point.
Multiply the above formula for annual data points by .001 to estimate annual DDU usage.
Extension content
Feature sets
Below is a complete list of the feature sets provided in this version. To ensure a good fit for your needs, individual feature sets can be activated and deactivated by your administrator during configuration.
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| Active connections | tomcat.connectionPool.activeConnections | Currently used connections | Count |
| Created connections | tomcat.connectionPool.createdConnections | Number of connections created | Count |
| Idle connections | tomcat.connectionPool.idleConnections | Number of open but unused connections | Count |
| Waiting connections | tomcat.connectionPool.numWaiters | Currently waiting connections | Count |
| Abandoned connections | tomcat.connectionPool.removeAbandoned | Number of connections that have not been properly released | Count |
| Abandoned connection timeout | tomcat.connectionPool.removeAbandonedTimeout | Timeout before an abandoned connection can be removed | Second |
| Waiting connection requests | tomcat.connectionPool.waitCount | Number of connection requests currently waiting | Count |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| Bytes recieved | tomcat.bytesReceived.count | Bytes recieved | Byte |
| Bytes sent | tomcat.bytesSent.count | Bytes sent | Byte |
| Request count | tomcat.requestCount.count | Request count | Count |
| Error count | tomcat.errorCount.count | Error count | Count |
| Request processing time | tomcat.processingTime.count | Request processing time | MilliSecond |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| Borrowed connections | tomcat.connectionPool.borrowedConnections | - | Count |
| Reconnected connections | tomcat.connectionPool.reconnectedConnections | - | Count |
| Released connections | tomcat.connectionPool.releasedConnections | - | Count |
| Returned connections | tomcat.connectionPool.returnedConnections | - | Count |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| Max total connections | tomcat.connectionPool.maxTotal | Maximum total amount of connections | Count |
| Max active connections | tomcat.connectionPool.maxActive | Maximum amount of active connections allowed concurrently | Count |
| Max idle connections | tomcat.connectionPool.maxIdle | The maximum number of connections that should be kept in the pool at all times | Count |
| Max wait time | tomcat.connectionPool.maxWait | The maximum number of milliseconds that the pool will wait (when there are no available connections) for a connection to be returned before throwing an exception | Millisecond |
| Minimum idle | tomcat.connectionPool.minIdle | The minimum number of established connections that should be kept in the pool at all times | Count |
| Metric name | Metric key | Description | Unit |
|---|---|---|---|
| Current thread count | tomcat.threadPool.currentThreadCount | Current thread count | Count |
| Current threads busy | tomcat.threadPool.currentThreadsBusy | Current threads busy | Count |
| Max threads allowed | tomcat.threadPool.maxThreads | Max threads allowed | Count |
Full version history
Full version history
Update that makes this a more general Tomcat extension
- Includes feature sets and changes for App Server metrics
- Thread pools
- Web requests
Full version history
- Added metrics:
- tomcat.connectionPool.numWaiters
- tomcat.connectionPool.maxTotal
- func:tomcat.connectionPool.currentUsage
- Added new charts in UA screens for these metrics
Full version history
- Fix a bug which prevented the extension from being imported in some environments.
Full version history
- Includes support for 'global' data source resources (i.e. Mbeans with no 'host' or 'context' attribute)
Full version history
Solved a bug where the name dimension was not being ingested correctly, which prevented custom topology entities from being created.
Full version history
EF1 to EF2 Tomcat Connection Pool conversion:
- Add Tomcat connection pool entity and its relation to the tomcat process
- Custom unified analysis screen for Tomcat connection pools
- Metric chart injection into Process Group Instance screen
- Overview dashboard for Tomcat connection pools
- Add feature sets to control included metrics
- New metric func:tomcat.connectionPool.availableConnections that shows the current available connections
- All metrics have changed key from the EF1 version. The prefix builtin:tech.tomcat has been removed. This is a breaking change for any configuration you had which used the metric key, such as metric events.
