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.
PrerequisitesTo collect Tomcat telemetry, you must install the Ops Agent:
This integration supports Tomcat versions 10.x and 9.0.x.
Configure your Tomcat instanceTo 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=8050Configure the Ops Agent for Tomcat
Following the guide to Configure the Ops Agent, add the required elements to collect telemetry from Tomcat instances, and restart the agent.
Example configurationThe following commands create the configuration to collect and ingest telemetry for Tomcat:
For these changes to take effect, you must restart the Ops Agent:
Linuxsudo systemctl restart google-cloud-ops-agent
sudo systemctl status "google-cloud-ops-agent*"
Restart-Service google-cloud-ops-agent -Force
Get-Service google-cloud-ops-agent*
To ingest logs from Tomcat, you must create a receiver for the logs that Tomcat produces and then create a pipeline for the new receiver.
To configure a receiver for your tomcat_system logs, specify the following fields:
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, 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:
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, 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:
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:
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 a receiver for the metrics that Tomcat produces and then create a pipeline for the new receiver.
This receiver does not support the use of multiple instances in the configuration, for example, to monitor multiple endpoints. All such instances write to the same time series, and Cloud Monitoring has no way to distinguish among them.
To configure a receiver for your tomcat metrics, specify the following fields:
collect_jvm_metrics true Configures the receiver to also collect the supported JVM metrics. collection_interval 60s A time duration value, 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, Typeworkload.googleapis.com/tomcat.errors CUMULATIVE, INT64
proto_handler workload.googleapis.com/tomcat.max_time GAUGE, INT64
proto_handler workload.googleapis.com/tomcat.processing_time CUMULATIVE, INT64
proto_handler workload.googleapis.com/tomcat.request_count CUMULATIVE, INT64
proto_handler workload.googleapis.com/tomcat.sessions GAUGE, DOUBLE
workload.googleapis.com/tomcat.threads GAUGE, INT64
proto_handler
state workload.googleapis.com/tomcat.traffic CUMULATIVE, INT64
direction
proto_handler 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 Tomcat logs are being sent to Cloud Logging, do the following:
In the Google Cloud console, go to the Logs Explorer page:
If you use the search bar to find this page, then select the result whose subheading is Logging.
resource.type="gce_instance"
(log_id("tomcat_system") OR log_id("tomcat_access"))
To verify that Tomcat metrics are being sent to Cloud Monitoring, do the following:
In the Google Cloud console, go to the leaderboard Metrics explorer page:
If you use the search bar to find this page, then select the result whose subheading is Monitoring.
{"workload.googleapis.com/tomcat.threads", monitored_resource="gce_instance"}
To view your Tomcat metrics, you must have a chart or dashboard configured. The Tomcat integration includes one or more dashboards for you. Any dashboards are automatically installed after you configure the integration and the Ops Agent has begun collecting metric data.
You can also view static previews of dashboards without installing the integration.
To view an installed dashboard, do the following:
In the Google Cloud console, go to the Dashboards page:
If you use the search bar to find this page, then select the result whose subheading is Monitoring.
If you have configured an integration but the dashboard has not been installed, then check that the Ops Agent is running. When there is no metric data for a chart in the dashboard, installation of the dashboard fails. After the Ops Agent begins collecting metrics, the dashboard is installed for you.
To view a static preview of the dashboard, do the following:
In the Google Cloud console, go to the Integrations page:
If you use the search bar to find this page, then select the result whose subheading is Monitoring.
For more information about dashboards in Cloud Monitoring, see Dashboards and charts.
For more information about using the Integrations page, see Manage integrations.
Install alerting policiesAlerting policies instruct Cloud Monitoring to notify you when specified conditions occur. The Tomcat integration includes one or more alerting policies for you to use. You can view and install these alerting policies from the Integrations page in Monitoring.
To view the descriptions of available alerting policies and install them, do the following:
In the Google Cloud console, go to the Integrations page:
If you use the search bar to find this page, then select the result whose subheading is Monitoring.
In the Configure notifications section, select one or more notification channels. You have the option to disable the use of notification channels, but if you do, then your alerting policies fire silently. You can check their status in Monitoring, but you receive no notifications.
For more information about notification channels, see Manage notification channels.
For more information about alerting policies in Cloud Monitoring, see Introduction to alerting.
For more information about using the Integrations page, see Manage integrations.
What's nextFor 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.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4