Jetty

The Jetty integration collects session and thread-usage metrics. The integration also collects access and system logs. Access logs are parsed into a JSON payload focused on request details.

For more information about Jetty, see the Jetty documentation.

Prerequisites

To collect Jetty telemetry, you must install the Ops Agent:

  • For metrics, install version 2.17.0 or higher.
  • For logs, install version 2.16.0 or higher.

This integration supports Jetty versions 9.4.x, 10.x, and 11.x.

Configure your Jetty instance

To collect metrics from this integration, you must expose a Java Management Extensions (JMX) endpoint.

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 the Jetty /etc/jetty-jmx.xml 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 1099, specify the following when starting the JVM:

-Dcom.sun.management.jmxremote.port=1099

Configure the Ops Agent for Jetty

Following the guide to Configure the Ops Agent, add the required elements to collect telemetry from Jetty instances, and restart the agent.

Example configuration

The following commands create the configuration to collect and ingest telemetry for Jetty and restart the Ops Agent.

# Configures Ops Agent to collect telemetry from the app and restart Ops Agent.

set -e

# Create a back up of the existing file so existing configurations are not lost.
sudo cp /etc/google-cloud-ops-agent/config.yaml /etc/google-cloud-ops-agent/config.yaml.bak

# Configure the Ops Agent.
sudo tee /etc/google-cloud-ops-agent/config.yaml > /dev/null << EOF
metrics:
  receivers:
    jetty_metrics:
      type: jetty
  service:
    pipelines:
      jetty_pipeline:
        receivers:
          - jetty_metrics
logging:
  receivers:
    jetty_access:
      type: jetty_access
  service:
    pipelines:
      jetty:
        receivers:
          - jetty_access
EOF

sudo service google-cloud-ops-agent restart

Configure logs collection

To ingest logs from Jetty, you must create a receiver for the logs that Jetty produces and then create a pipeline for the new receiver.

To configure a receiver for your jetty_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/logs/*.request.log"] 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 This value must be jetty_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 jetty_access logs contain the following fields in the LogEntry:

Field Type Description
httpRequest object See HttpRequest
severity string (LogSeverity) Log entry level (translated).

The syslog logs contain the following fields in the LogEntry:

Field Type Description
jsonPayload.message string Log message

Configure metrics collection

To ingest metrics from Jetty, you must create a receiver for the metrics that Jetty 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 jetty 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 value, such as 30s or 5m.
endpoint localhost:1099 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 jetty.
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 Jetty instance.

Metric type 
Kind, Type
Monitored resources		 Labels
workload.googleapis.com/jetty.select.count
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/jetty.session.count
CUMULATIVE, INT64
gce_instance 		resource
workload.googleapis.com/jetty.session.time.max
GAUGE, INT64
gce_instance 		resource
workload.googleapis.com/jetty.session.time.total
GAUGE, INT64
gce_instance 		resource
workload.googleapis.com/jetty.thread.count
GAUGE, INT64
gce_instance 		state
workload.googleapis.com/jetty.thread.queue.count
GAUGE, INT64
gce_instance 		 

Verify the configuration

This section describes how to verify that you correctly configured the Jetty receiver. It might take one or two minutes for the Ops Agent to begin collecting telemetry.

To verify that Jetty logs are being sent to Cloud Logging, do the following:

  1. In the Google Cloud console, go to the Logs Explorer page:

    Go to Logs Explorer

    If you use the search bar to find this page, then select the result whose subheading is Logging.

  2. Enter the following query in the editor, and then click Run query: 
    resource.type="gce_instance"
(log_id("jetty_access") OR log_id("syslog"))

To verify that Jetty metrics are being sent to Cloud Monitoring, do the following:

  1. In the Google Cloud console, go to the  Metrics explorer page:

    Go to Metrics explorer

    If you use the search bar to find this page, then select the result whose subheading is Monitoring.

  2. In the toolbar of the query-builder pane, select the button whose name is either  MQL or  PromQL.
  3. Verify that MQL is selected in the Language toggle. The language toggle is in the same toolbar that lets you format your query.
  4. Enter the following query in the editor, and then click Run query: 
    fetch gce_instance
| metric 'workload.googleapis.com/jetty.select.count'
| every 1m

View dashboard

To view your Jetty metrics, you must have a chart or dashboard configured. The Jetty 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:

  1. In the Google Cloud console, go to the  Dashboards page:

    Go to Dashboards

    If you use the search bar to find this page, then select the result whose subheading is Monitoring.

  2. Select the Dashboard List tab, and then choose the Integrations category.
  3. Click the name of the dashboard you want to view.

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:

  1. In the Google Cloud console, go to the  Integrations page:

    Go to Integrations

    If you use the search bar to find this page, then select the result whose subheading is Monitoring.

  2. Click the Compute Engine deployment-platform filter.
  3. Locate the entry for Jetty and click View Details.
  4. Select the Dashboards tab to see a static preview. If the dashboard is installed, then you can navigate to it by clicking View dashboard.

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 policies

Alerting policies instruct Cloud Monitoring to notify you when specified conditions occur. The Jetty 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:

  1. In the Google Cloud console, go to the  Integrations page:

    Go to Integrations

    If you use the search bar to find this page, then select the result whose subheading is Monitoring.

  2. Locate the entry for Jetty and click View Details.
  3. Select the Alerts tab. This tab provides descriptions of available alerting policies and provides an interface for installing them.
  4. Install alerting policies. Alerting policies need to know where to send notifications that the alert has been triggered, so they require information from you for installation. To install alerting policies, do the following:
    1. From the list of available alerting policies, select those that you want to install.

    2. 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.

    3. Click Create Policies.

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 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.