The Apache Tomcat integration collects traffic-related metrics, such as the
number of active sessions or network throughput. The integration also collects
access and Catalina logs. Access logs are parsed into a JSON payload
focused on request details, whereas Catalina logs are parsed for general
details. The tomcat
receiver collects telemetry from the Tomcat server's Java
Virtual Machine (JVM) via JMX.
For more information about Tomcat, see the Apache Tomcat documentation.
Prerequisites
To collect Tomcat telemetry, you must install the Ops Agent:
- For metrics, install version 2.9.0 or higher.
- For logs, install version 2.9.0 or higher.
This integration supports Tomcat versions 10.x and 9.0.x.
Configure your Tomcat instance
To expose a JMX endpoint, you must set the com.sun.management.jmxremote.port
system property when starting the JVM. We also recommend setting the
com.sun.management.jmxremote.rmi.port
system property to the same port. To
expose a JMX endpoint remotely, you must also set the java.rmi.server.hostname
system property.
By default, these properties are set in a Tomcat deployment's
tomcat-env.sh
file.
To set system properties by using command-line arguments, prepend the property
name with -D
when starting the JVM. For example, to set
com.sun.management.jmxremote.port
to port 8050
, specify the following when
starting the JVM:
-Dcom.sun.management.jmxremote.port=8050
Configure the Ops Agent for Tomcat
Following the guide for Configuring the Ops Agent, add the required elements to collect telemetry from Tomcat instances, and restart the agent.
Example configuration
The following commands create the configuration to collect and ingest telemetry for Tomcat and restarts the Ops Agent.
Configure logs collection
To ingest logs from Tomcat, you must create receivers for the logs that Tomcat produces and then create a pipeline for the new receivers.
To configure a receiver for your tomcat_system
logs, specify the following
fields:
Field | Default | Description |
---|---|---|
exclude_paths |
A list of filesystem path patterns to exclude from the set matched by include_paths . |
|
include_paths |
[/opt/tomcat/logs/catalina.out] |
A list of filesystem paths to read by tailing each file. A wild card (* ) can be used in the paths. |
record_log_file_path |
false |
If set to true , then the path to the specific file from which the log record was obtained appears in the output log entry as the value of the agent.googleapis.com/log_file_path label. When using a wildcard, only the path of the file from which the record was obtained is recorded. |
type |
The value must be tomcat_system . |
|
wildcard_refresh_interval |
60s |
The interval at which wildcard file paths in include_paths are refreshed. Given as a time duration parsable by time.ParseDuration , for example 30s or 2m . This property might be useful under high logging throughputs where log files are rotated faster than the default interval. |
To configure a receiver for your tomcat_access
logs, specify the following
fields:
Field | Default | Description |
---|---|---|
exclude_paths |
A list of filesystem path patterns to exclude from the set matched by include_paths . |
|
include_paths |
[/opt/tomcat/logs/localhost_access_log.*.txt] |
A list of filesystem paths to read by tailing each file. A wild card (* ) can be used in the paths. |
record_log_file_path |
false |
If set to true , then the path to the specific file from which the log record was obtained appears in the output log entry as the value of the agent.googleapis.com/log_file_path label. When using a wildcard, only the path of the file from which the record was obtained is recorded. |
type |
The value must be tomcat_access . |
|
wildcard_refresh_interval |
60s |
The interval at which wildcard file paths in include_paths are refreshed. Given as a time duration parsable by time.ParseDuration , for example 30s or 2m . This property might be useful under high logging throughputs where log files are rotated faster than the default interval. |
What is logged
The logName
is derived from
the receiver IDs specified in the configuration. Detailed fields inside the
LogEntry
are as follows.
The tomcat_system
logs contain the following fields in the LogEntry
:
Field | Type | Description |
---|---|---|
jsonPayload.level |
string | Log entry level |
jsonPayload.message |
string | Log message, including detailed stacktrace where provided |
jsonPayload.module |
string | Module of tomcat where the log originated |
jsonPayload.source |
string | Source of where the log originated |
severity |
string (LogSeverity ) |
Log entry level (translated). |
The tomcat_access
logs contain the following fields in the LogEntry
:
Field | Type | Description |
---|---|---|
httpRequest |
object | See HttpRequest |
jsonPayload.host |
string | Contents of the Host header |
jsonPayload.user |
string | Authenticated username for the request |
severity |
string (LogSeverity ) |
Log entry level (translated). |
Configure metrics collection
To ingest metrics from Tomcat, you must create receivers for the metrics that Tomcat produces and then create a pipeline for the new receivers.
To configure a receiver for your tomcat
metrics, specify the following
fields:
Field | Default | Description |
---|---|---|
collect_jvm_metrics |
true |
Configures the receiver to also collect the supported JVM metrics. |
collection_interval |
60s |
A time duration, such as 30s or 5m . |
endpoint |
localhost:8050 |
The JMX Service URL or host and port used to construct the service URL. This value must be in the form of service:jmx:<protocol>:<sap> or host:port . Values in host:port form are used to create a service URL of service:jmx:rmi:///jndi/rmi://<host>:<port>/jmxrmi . |
password |
The configured password if JMX is configured to require authentication. | |
type |
This value must be tomcat . |
|
username |
The configured username if JMX is configured to require authentication. |
What is monitored
The following table provides the list of metrics that the Ops Agent collects from the Tomcat instance.
Metric type | |
---|---|
Kind, Type Monitored resources |
Labels |
workload.googleapis.com/tomcat.errors
|
|
CUMULATIVE , INT64 gce_instance |
proto_handler
|
workload.googleapis.com/tomcat.max_time
|
|
GAUGE , INT64 gce_instance |
proto_handler
|
workload.googleapis.com/tomcat.processing_time
|
|
CUMULATIVE , INT64 gce_instance |
proto_handler
|
workload.googleapis.com/tomcat.request_count
|
|
CUMULATIVE , INT64 gce_instance |
proto_handler
|
workload.googleapis.com/tomcat.sessions
|
|
GAUGE , DOUBLE gce_instance |
|
workload.googleapis.com/tomcat.threads
|
|
GAUGE , INT64 gce_instance |
proto_handler state
|
workload.googleapis.com/tomcat.traffic
|
|
CUMULATIVE , INT64 gce_instance |
direction proto_handler
|
Sample dashboard
To view your Tomcat metrics, you must have a chart or dashboard configured. Cloud Monitoring provides a library of sample dashboards for integrations, which contain preconfigured charts. For information about installing these dashboards, see Installing sample dashboards.
Verify the configuration
This section describes how to verify that you correctly configured the Tomcat receiver. It might take one or two minutes for the Ops Agent to begin collecting telemetry.
To verify that the logs are ingested, go to the Logs Explorer and run the following query to view the Tomcat logs:
resource.type="gce_instance"
(log_id("tomcat_system") OR log_id("tomcat_access"))
To verify that the metrics are ingested, go to Metrics Explorer and run the following query in the MQL tab:
fetch gce_instance
| metric 'workload.googleapis.com/tomcat.threads'
| every 1m
What's next
For a walkthrough on how to use Ansible to install the Ops Agent, configure a third-party application, and install a sample dashboard, see the Install the Ops Agent to troubleshoot third-party applications video.